Add framework for extended tests that require additional configuration

or an extended period of time to run.

Author: anthony-tuininga

.gitignore

@@ -6,4 +6,5 @@ build/
 dist/
 doc/build
 src/oracledb/*.c
+tests/ext/config.ini
 .ipynb_checkpoints/

tests/ext/README.md

@@ -0,0 +1,15 @@
+This directory contains the extended test suite for python-oracledb. These
+tests either require specialized configuration or are timing dependent.
+Configuration for these extended tests can be found in the file pointed to by
+the environment variable `PYO_TEST_EXT_CONFIG_FILE` or, if the environment
+variable is not specified, then the file `config.ini` found in this directory.
+Configuration required to run the extended test is documented in each test
+file.
+
+All of the tests can be run by executing this command:
+
+    python -m unittest discover -s tests/ext -v
+
+Or each file can be run independently.
+
+A sample configuration file is found in `sample_config.ini`.

tests/ext/sample_config.ini

@@ -0,0 +1,59 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2024, Oracle and/or its affiliates.
+#
+# This software is dual-licensed to you under the Universal Permissive License
+# (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+# 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+# either license.
+#
+# If you elect to accept the software under the Apache License, Version 2.0,
+# the following applies:
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# sample_config.ini
+#
+# Sample file for running extended tests. Copy this file to config.ini in the
+# same directory (or another location of your choice and set the environment
+# variable PYO_TEST_EXT_CONFIG_FILE to point to that location).
+# -----------------------------------------------------------------------------
+
+# this section covers common configuration
+[DEFAULT]
+
+# boolean indicating whether to run tests that take a long period of time
+run_long_tests = False
+
+# boolean indicating whether the orapki binary is available (generally requires
+# a full Oracle Database installation)
+has_orapki = False
+
+# boolean indicating whether the client and server are running on the same
+# machine (required for BFILE tests, for example)
+local_database = False
+
+
+# this section contains references to other sections which have different
+# configurations
+[Databases]
+
+# each entry contains the section name (key) and connect string (value)
+db_23ai = localhost:1623/DB23PDB1
+
+
+# this section contains configuration for the named database which overrides
+# the values found in the DEFAULT section
+[db_23ai]
+local_database = True

tests/ext/test_env.py

@@ -0,0 +1,81 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2024, Oracle and/or its affiliates.
+#
+# This software is dual-licensed to you under the Universal Permissive License
+# (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+# 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+# either license.
+#
+# If you elect to accept the software under the Apache License, Version 2.0,
+# the following applies:
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# Loads the test environment found in the base directory and then extends it
+# with some methods used to determine which extended tests to run.
+# -----------------------------------------------------------------------------
+
+import configparser
+import os
+import secrets
+import string
+
+dir_name = os.path.dirname(os.path.dirname(__file__))
+file_name = os.path.join(dir_name, os.path.basename(__file__))
+exec(open(file_name).read(), globals(), locals())
+
+DATABASES_SECTION_NAME = "Databases"
+
+
+class ExtendedConfig:
+
+    def __init__(self):
+        default_file_name = os.path.join(
+            os.path.dirname(__file__), "config.ini"
+        )
+        file_name = os.environ.get(
+            "PYO_TEST_EXT_CONFIG_FILE", default_file_name
+        )
+        self.parser = configparser.ConfigParser()
+        self.parser.read(file_name)
+        self.section_name = "DEFAULT"
+        connect_string_to_use = get_connect_string().upper()  # noqa: F821
+
+        if self.parser.has_section(DATABASES_SECTION_NAME):
+            for section_name, connect_string in self.parser.items(
+                DATABASES_SECTION_NAME
+            ):
+                if connect_string.upper() == connect_string_to_use:
+                    self.section_name = section_name
+                    break
+
+
+_extended_config = ExtendedConfig()
+
+
+def get_extended_config_bool(name, fallback=False):
+    return _extended_config.parser.getboolean(
+        _extended_config.section_name, name, fallback=fallback
+    )
+
+
+def get_extended_config_str(name, fallback=None):
+    return _extended_config.parser.get(
+        _extended_config.section_name, name, fallback=fallback
+    )
+
+
+def get_random_string(length=10):
+    return "".join(secrets.choice(string.ascii_letters) for i in range(length))

tests/ext/test_ext_1000_pool_shrink.py

@@ -0,0 +1,90 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2024, Oracle and/or its affiliates.
+#
+# This software is dual-licensed to you under the Universal Permissive License
+# (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+# 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+# either license.
+#
+# If you elect to accept the software under the Apache License, Version 2.0,
+# the following applies:
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------------
+
+"""
+E1000 - Module for testing pool strinking. No special setup is required but the
+tests here will only be run if the run_long_tests value is enabled.
+"""
+
+import time
+import unittest
+
+import test_env
+
+
+@unittest.skipUnless(
+    test_env.get_extended_config_bool("run_long_tests"),
+    "extended configuration run_long_tests is disabled",
+)
+class TestCase(test_env.BaseTestCase):
+    def test_ext_1000(self):
+        "E1000 - test pool timeout with simple acquite after waiting"
+        pool = test_env.get_pool(min=3, max=10, increment=1, timeout=5)
+        conns = [pool.acquire() for i in range(7)]
+        self.assertEqual(pool.opened, 7)
+        for conn in conns:
+            conn.close()
+        time.sleep(7)
+        conn = pool.acquire()
+        self.assertEqual(pool.opened, 3)
+
+    def test_ext_1001(self):
+        "E1001 - test pool timeout with older connection returned first"
+        pool = test_env.get_pool(min=2, max=5, increment=1, timeout=3)
+        conns = [pool.acquire() for i in range(3)]
+        conns[2].close()
+        for i in range(10):
+            with pool.acquire() as conn:
+                with conn.cursor() as cursor:
+                    cursor.execute("select 1 from dual")
+        time.sleep(4)
+        conn = pool.acquire()
+        self.assertEqual(pool.opened, 3)
+
+    @unittest.skipIf(not test_env.get_is_thin(), "doesn't occur in thick mode")
+    def test_ext_1002(self):
+        "E1002 - test pool shrinks to min on pool inactivity"
+        pool = test_env.get_pool(min=3, max=10, increment=2, timeout=4)
+        conns = [pool.acquire() for i in range(6)]
+        self.assertEqual(pool.opened, 6)
+        for conn in conns:
+            conn.close()
+        time.sleep(6)
+        self.assertEqual(pool.opened, 3)
+
+    @unittest.skipIf(not test_env.get_is_thin(), "doesn't occur in thick mode")
+    def test_ext_1003(self):
+        "E1003 - test pool eliminates extra connections on inactivity"
+        pool = test_env.get_pool(min=4, max=10, increment=4, timeout=3)
+        conns = [pool.acquire() for i in range(5)]
+        self.assertEqual(pool.opened, 5)
+        time.sleep(2)
+        self.assertEqual(pool.opened, 8)
+        time.sleep(3)
+        self.assertEqual(pool.opened, 5)
+        del conns
+
+
+if __name__ == "__main__":
+    test_env.run_test_cases()