Migrate to using pytest as test runner.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -75,6 +75,7 @@ Common Changes
 #)  Fixed bug when attempting to append an element to a
     :ref:`DbObject <dbobjecttype>` which is not actually a collection.
 #)  API documentation is now generated from the source code.
+#)  The test suite now uses `pytest <https://docs.pytest.org/>`__.
 #)  Internal change: `typing_extensions <https://pypi.org/project/
     typing-extensions/>`__ is now a dependency.
 

pyproject.toml

@@ -53,6 +53,23 @@ Documentation = "http://python-oracledb.readthedocs.io"
 Issues = "https://github.com/oracle/python-oracledb/issues"
 Source = "https://github.com/oracle/python-oracledb"
 
+[project.optional-dependencies]
+test = [
+    "anyio",
+    "numpy",
+    "pandas",
+    "pyarrow",
+    "pytest",
+]
+oci_config = ["oci"]
+oci_auth = ["oci"]
+azure_config = [
+    "azure-appconfiguration",
+    "azure-identity",
+    "azure-keyvault-secrets"
+]
+azure_auth = ["msal"]
+
 [tool.setuptools]
 zip-safe = false
 packages = [
@@ -77,17 +94,8 @@ line-length = 79
 target-version = "py39"
 exclude = ["templates"]
 
-[project.optional-dependencies]
-test = [
-    "numpy",
-    "pandas",
-    "pyarrow",
-]
-oci_config = ["oci"]
-oci_auth = ["oci"]
-azure_config = [
-    "azure-appconfiguration",
-    "azure-identity",
-    "azure-keyvault-secrets"
+[tool.pytest.ini_options]
+minversion = "8.3.0"
+testpaths = [
+    "tests"
 ]
-azure_auth = ["msal"]

tests/README.md

@@ -1,19 +1,19 @@
 This directory contains the test suite for python-oracledb.
 
-1.  The schemas and SQL objects that are referenced in the test suite can be
-    created by running the Python script [create_schema.py][1]. The script
-    requires administrative privileges and will prompt for these credentials as
-    well as the names of the schemas that will be created, unless a number of
-    environment variables are set as documented in the Python script
-    [test_env.py][2]. Run the script using the following command:
+1.  Install pytest and tox:
+
+        python -m pip install pytest tox --upgrade
 
-        python create_schema.py
+2.  Set the required database credential and related environment variables
+    documented in [conftest.py][2].
 
-2.  Install tox:
+3.  The schemas and SQL objects that are referenced in the test suite can be
+    created by running the Python script [create_schema.py][1]. The script
+    requires administrative privileges to complete successfully:
 
-        python -m pip install tox --upgrade
+        python -m pytest tests/create_schema.py
 
-3.  Run the test suite by issuing the following command in the top-level
+4.  Run the test suite by issuing the following command in the top-level
     directory of your oracledb installation:
 
         python -m tox
@@ -23,22 +23,26 @@ This directory contains the test suite for python-oracledb.
     Alternatively, you can use the currently installed build of oracledb and
     run the following command instead:
 
-        python -m unittest discover -v -s tests
+        python -m pytest
 
     You may also run each of the test scripts independently, as in:
 
-        python test_1000_module.py
+        python -m pytest tests/test_1000_module.py
 
-4.  After running the test suite, the schemas can be dropped by running the
+    The tests run in thin mode by default. If you wish to run the tests in
+    thick mode, use the following command:
+
+        python -m pytest --use-thick-mode
+
+5.  After running the test suite, the schemas can be dropped by running the
     Python script [drop_schema.py][3]. The script requires administrative
-    privileges and will prompt for these credentials as well as the names of
-    the schemas that will be dropped, unless a number of environment variables
-    are set as documented in the Python script [test_env.py][2]. Run the
+    privileges to complete successfully. A set of environment variables should
+    be set as documented in the Python script [conftest.py][2]. Run the
     script using the following command:
 
-        python drop_schema.py
+        python -m pytest tests/drop_schema.py
 
-5.  Enable tests that require extra configuration
+6.  Enable tests that require extra configuration
 
     The following test(s) are automatically skipped if their required
     environment variable(s) and setup is not available.
@@ -64,7 +68,8 @@ This directory contains the test suite for python-oracledb.
                alter user <Schema Owner> grant connect through <External User>;
 
 
+
 [1]: https://github.com/oracle/python-oracledb/blob/main/tests/create_schema.py
-[2]: https://github.com/oracle/python-oracledb/blob/main/tests/test_env.py
+[2]: https://github.com/oracle/python-oracledb/blob/main/tests/conftest.py
 [3]: https://github.com/oracle/python-oracledb/blob/main/tests/drop_schema.py
 [4]: https://python-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#connecting-using-external-authentication