[state of supporting PR #772 as of the current Pull Request's creation]

[_697] Github workflows for running PRC tests

Co-authored-by: d-w-moore <dmoore@renci.org>

Includes a docker compose configuration in which the PRC test suite
can be run in a way representative of typical operational use, and the
version of iRODS server and python interpreter that we install are also easily
reconfigurable.

Additionally, this affords us the opportunity to run the test suite on a client
node all its own, the iRODS server being reachable only via the network.

[_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, included with the Github workflows (in a separate
commit) 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.

completely remove {send,recv}_oneshot sync mechanism

review comments

Comments moved to *.yml files.  README.md no longer needed.

update irods/harness/README

deindent

correct forgotten comment symbol

clearer comment in run_tests.sh

suggestions nr. 1 10-22-25 13:19

suggestions nr. 2 10-22-25

smchg

package repo chg

comments chg

Author: d-w-moore

.github/workflows/main.yml

@@ -2,6 +2,8 @@
 # https://github.com/actions/starter-workflows/blob/master/ci/python-package.yml
 # (C) Github, MIT License
 
+# Static type checking tests using `mypy`.
+
 name: "Python type checking"
 
 on: [push, pull_request]

.github/workflows/run-bats-tests.yml

@@ -0,0 +1,33 @@
+# Run a set of tests, each in its own container and with a potentially customized setup.
+# (Documentation and implementation for the test harness may be found in `irods/test/harness`.)
+
+name: run-bats-tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    timeout-minutes: 20
+
+    name: Python ${{ matrix.python }}, iRODS ${{ matrix.irods_server }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+          working-directory: ./irods/test/harness
+    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 ../scripts/test[0-9]*; do
+              ./docker_container_driver.sh -V $script
+          done

.github/workflows/run-local-suite.yml

@@ -0,0 +1,31 @@
+# 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-local-suite
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    timeout-minutes: 20
+
+    name: Python ${{ matrix.python }}, iRODS ${{ matrix.irods_server }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+          working-directory: ./irods/test/harness
+    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 ../scripts/run_suite_locally.sh

.github/workflows/run-the-tests.yml

@@ -0,0 +1,41 @@
+# Create a networked set of containers (via a Docker compose project) on which to run the client test suite.
+# (For further information, see the README in `docker-testing`.)
+
+name: run-the-tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    timeout-minutes: 20
+
+    name: Python ${{ matrix.python }}, iRODS ${{ matrix.irods_server }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+          working-directory: ./docker-testing
+    strategy:
+      matrix:
+        python: ['3.9','3.13']
+        irods_server: ['4.3.4','5.0.2']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Start containers
+        run: ./start_containers.sh "${{ matrix.irods_server }}" "${{ matrix.python }}"
+
+      - name: run test
+        run: |
+          while :; do
+            client_container=$(docker ps --format "{{.Names}}"|grep python.client)
+            [ -n "$client_container" ] && break
+            sleep 1
+          done
+          echo "client_container = [$client_container]"
+          docker exec "${client_container}" /repo_root/docker-testing/run_tests.sh
+
+      - name: Stop containers
+        if: always()
+        run: ./stop_containers.sh "${{ matrix.irods_server }}" "${{ matrix.python }}"

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

docker-testing/README.md

@@ -0,0 +1,47 @@
+# A Topological Setup for Testing the Python Client
+
+The `docker-testing` directory contains the necessary files for building and
+running tests from the perspective of a specific client node in a larger network.
+
+We currently allow a choice of Python interpreter and iRODS server to be installed
+on the client and provider nodes of a simulated network topology.
+
+The choice of versions are dictated when running the test:
+
+|:------------------:|:---------------:|
+|Environment Variable| Valid Range     |
+|:-------------------|-----------------|
+IRODS_PACKAGE_VERSION|4.3.1 to 5.0.2   |
+PYTHON_VERSION       |3.9 to 3.13      |
+|:-------------------|-----------------|
+
+Currently the database server is fixed as Postgres.
+
+## Details of usage
+
+The file `$REPO/.github/workflows/run-the-tests.yml`
+(where `$REPO` is the `/path/to/local/python-irodsclient` repository)
+contains commands for starting the server and client containers and running the PRC
+suite in response to a push or pull-request.
+
+The test suite can also be run on any workstation with docker compose installed.
+What follows is a short summary of how to run the test configuration at the bench.
+It is this procedure which is run within the Github workflows.
+
+   1. cd into top level of $REPO
+
+   2. run:
+      ```
+      ./docker-testing/start_containers.sh 4.3.4 3.11
+      ```
+      This builds and runs the docker images for the project,  with "4.3.4" being the iRODS
+      version installed on the provider and "3.11" is the version of python run on the client side.
+
+   3. run:
+      ```
+      docker exec <name-of-python-client-container> /repo_root/docker-testing/run_tests.sh
+      ```
+      (Note:  `/repo_root` is an actual literal path, internal to the container.)
+      You'll see the test output displayed on the console.  At completion, xmlrunner outputs are in /tmp.
+
+   4. use `docker logs -f` with the provider instance name to tail the irods server log output

docker-testing/harness-docker-compose-irods-4.yml

@@ -0,0 +1 @@
+harness-docker-compose.yml

docker-testing/harness-docker-compose-irods-5.yml

@@ -0,0 +1 @@
+harness-docker-compose.yml

docker-testing/harness-docker-compose.yml

@@ -0,0 +1,45 @@
+version: '3'
+
+services:
+    irods-catalog:
+        build:
+            context: irods_catalog_${irods_major}
+        # 5432 is exposed by default and can conflict with other postgres containers.
+        # When the metalnx-db service is no longer needed, this stanza can be removed.
+        ports:
+            - "5430:5432"
+        environment:
+            - POSTGRES_PASSWORD=testpassword
+
+    python-client:
+        build:
+            context: python_client
+            args:
+                python_version: ${python_version}
+        command:
+            tail -f /dev/null
+        volumes:
+            - ${repo_external}:/repo_root:ro
+            - /tmp/irods-client-share.py-${python_version}:/irods_shared
+        depends_on:
+            irods-catalog-provider:
+                condition: service_healthy
+
+    irods-catalog-provider:
+        volumes:
+            - /tmp/irods-client-share.py-${python_version}:/irods_shared
+        build:
+            context: irods_catalog_provider_${irods_major}
+            args:
+                irods_version: ${irods_version}
+        shm_size: 500mb
+        healthcheck:
+            test: ["CMD", "su", "-", "irods", "-c", "ils || exit 1"]
+            interval: 10s
+            timeout: 10s
+            retries: 3
+        ports:
+            - "1247:1247"
+        depends_on:
+            - irods-catalog
+