[#502] test harness and container-based tests

A new test harness is introduced in which we construct a new
container (using either Docker or podman) for each test program
we run. This allows full customization of the container
environment for the particular needs of each test.

Accordingly, also included with the Github workflows is a
full run of the PRC test suite with the iRODS server and
catalog DB server running in the same container as the client.

In the process of putting old tests through new rigors, faults
were found and corrected in some of those tests.

Author: d-w-moore

.github/workflows/run-test-programs-single-node.yml

@@ -0,0 +1,40 @@
+# Run a set of tests, each in its own container and with a potentially customized setup.
+
+# To this end, each test is launched via docker_container_driver.sh, part of the single-node
+# test harness machinery whose implementation and documentation is to be found in the
+# `irods/test/harness` directory.
+
+# A test may be written as a Bash or BATS script, but the only real requirement is that it be
+# executable.
+
+name: run-test-programs-single-node
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    name: Python ${{ matrix.python }}, iRODS ${{ matrix.irods_server }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+          working-directory: ./test_harness/single_node
+    strategy:
+      matrix:
+        python: ['3.9','3.13']
+        irods_server: ['4.3.4','5.0.2']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build images
+        run: ./create_docker_images.sh "${{ matrix.irods_server }}" "${{ matrix.python }}"
+
+      - name: run tests
+        run: |
+          for script in \
+              ../../irods/test/scripts/test[0-9]* \
+              ../../irods/test/login_auth_test_*.py
+          do
+              ./docker_container_driver.sh -V $script
+          done

.github/workflows/run-test-suite-single-node.yml

@@ -0,0 +1,29 @@
+# Run the client test suite in a Docker container, targeting a locally running instance of the iRODS server.
+# (Documentation and implementation for the test harness may be found in `irods/test/harness`.)
+
+name: run-test-suite-single-node
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    name: Python ${{ matrix.python }}, iRODS ${{ matrix.irods_server }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+          working-directory: ./test_harness/single_node
+    strategy:
+      matrix:
+        python: ['3.9','3.13']
+        irods_server: ['4.3.4','5.0.2']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build images
+        run: ./create_docker_images.sh "${{ matrix.irods_server }}" "${{ matrix.python }}"
+
+      - name: run tests
+        run: |
+          ./docker_container_driver.sh -V ../../irods/test/scripts/run_suite_locally.sh

Dockerfile.prc_test.centos

@@ -24,6 +24,5 @@ RUN  python${py_N} repo/docker_build/iinit.py \
         password rods
 SHELL ["/bin/bash","-c"]
 CMD  echo "Waiting on iRODS server... " ; \
-     python${PY_N} repo/docker_build/recv_oneshot -h irods-provider -p 8888 -t 360 && \
      sudo groupadd -o -g $(stat -c%g /irods_shared) irods && sudo usermod -aG irods user && \
      newgrp irods < repo/run_python_tests.sh

Dockerfile.prc_test.ubuntu

@@ -31,6 +31,5 @@ SHELL ["/bin/bash","-c"]
 #  3. run python tests as the new group
 
 CMD  echo "Waiting on iRODS server... " ; \
-     python${PY_N} repo/docker_build/recv_oneshot -h irods-provider -p 8888 -t 360 && \
      sudo groupadd -o -g $(stat -c%g /irods_shared) irods && sudo usermod -aG irods user && \
      newgrp irods < repo/run_python_tests.sh

irods/message/__init__.py

@@ -181,7 +181,7 @@ def ET(xml_type=(), server_version=None):
 
 logger = logging.getLogger(__name__)
 
-IRODS_VERSION = (5, 0, 1, "d")
+IRODS_VERSION = (5, 0, 2, "d")
 
 UNICODE = str
 

irods/test/access_test.py

@@ -533,11 +533,7 @@ def test_iRODSAccess_cannot_be_constructed_using_unsupported_type__issue_558(sel
         # Before the fix in #558, this would have been allowed and only later would the type discrepancy be revealed,
         # leading to opaque error messages. Now, the types are checked on the way in to ensure clarity and correctness.
         # TODO(#480): We cannot use the unittest.assertRaises context manager as this was introduced in python 3.1.
-        assertCall = getattr(self, "assertRaisesRegex", None)
-        if assertCall is None:
-            assertCall = self.assertRaisesRegexp
-
-        assertCall(
+        self.assertRaisesRegex(
             TypeError,
             "'path' parameter must be of type 'str', 'irods.collection.iRODSCollection', "
             "'irods.data_object.iRODSDataObject', or 'irods.path.iRODSPath'.",

irods/test/exception_test.py

@@ -41,8 +41,8 @@ def test_400(self):
             excep_repr = repr(exc)
             errno_object = irods.exception.Errno(errno.EACCES)
             errno_repr = repr(errno_object)
-            self.assertRegexpMatches(errno_repr, r"\bErrno\b")
-            self.assertRegexpMatches(
+            self.assertRegex(errno_repr, r"\bErrno\b")
+            self.assertRegex(
                 errno_repr, """['"]{msg}['"]""".format(msg=os.strerror(errno.EACCES))
             )
             self.assertIn(errno_repr, excep_repr)

irods/test/login_auth_test.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+. "$(dirname "$0")/scripts/test_support_functions"
+. "$(dirname "$0")/scripts/update_json_for_test"
+
+IRODS_SERVER_CONFIG=/etc/irods/server_config.json
+IRODS_SERVICE_ACCOUNT_ENV_FILE=~irods/.irods/irods_environment.json
+LOCAL_ACCOUNT_ENV_FILE=~/.irods/irods_environment.json
+
+cannot_iinit=''
+tries=8
+while true; do
+    iinit_as_rods >/dev/null 2>&1 && break
+    [ $((--tries)) -le 0 ] && {
+        cannot_iinit=1
+        break
+    }
+    sleep 5
+done
+[ -n "$cannot_iinit" ] && {
+    echo >&2 "Could not iinit as rods."
+    exit 2
+}
+
+setup_preconnect_preference DONT_CARE
+
+add_irods_to_system_pam_configuration
+
+# set up /etc/irods/ssl directory and files
+set_up_ssl sudo
+
+sudo useradd -ms/bin/bash alissa
+sudo chpasswd <<<"alissa:test123"
+
+update_json_file $IRODS_SERVICE_ACCOUNT_ENV_FILE \
+    "$(newcontent $IRODS_SERVICE_ACCOUNT_ENV_FILE ssl_keys)"
+
+# This is mostly so we can call python3 as just "python"
+activate_virtual_env_with_prc_installed >/dev/null 2>&1 || {
+    echo >&2 "couldn't set up virtual environment"
+    exit 1
+}
+
+server_hup=
+if irods_server_version ge 5.0.0; then
+    server_hup="y"
+    update_json_file $IRODS_SERVER_CONFIG \
+        "$(newcontent $IRODS_SERVER_CONFIG tls_server_items tls_client_items)"
+
+    sudo su - irods -c "$IRODS_CONTROL_PATH/manage_irods5_procs rescan-config"
+fi
+
+# Configure clients with admin user + TLS
+
+update_json_file $LOCAL_ACCOUNT_ENV_FILE \
+    "$(newcontent $LOCAL_ACCOUNT_ENV_FILE ssl_keys encrypt_keys)"
+
+update_time=0
+# We won't time out, however we will warn for each minute the server
+# has not returned to readiness.
+if [ "$server_hup" = "y" ]; then
+    # wait for server to be ready after configuration reload
+    while true; do
+        sleep 2
+        if ils >/dev/null 2>&1; then
+            break
+        else
+            now=$(date +%s)
+            if [ $now -ge $((update_time + 60)) ]; then
+                echo >&2 "At [$(date)] ... still waiting on server reload"
+                update_time=$now
+            fi
+        fi
+    done
+fi
+
+if [ -n "$ORIGINAL_SCRIPT_RELATIVE_TO_ROOT" ]; then
+    original_script="/prc/$ORIGINAL_SCRIPT_RELATIVE_TO_ROOT"
+
+    # Run tests.
+    if [ -x "$original_script" ]; then
+        command "$original_script" $*
+    elif [[ $original_script =~ \.py$ ]]; then
+        python "$original_script" $*
+    elif [[ $original_script =~ \.bats$ ]]; then
+        bats "$original_script"
+    else
+        echo >&2 "I don't know how to run this: original_script=[$original_script]"
+    fi
+
+fi

irods/test/login_auth_test_1.py

@@ -0,0 +1 @@
+login_auth_test_must_run_manually.py

irods/test/login_auth_test_2.py

@@ -0,0 +1 @@
+login_auth_test_must_run_manually.py