more README

Author: d-w-moore

.github/workflows/README.md

@@ -0,0 +1,20 @@
+Tests of Python iRODS Client
+============================
+
+Test PRC (Python iRODS Client) with an instance of the iRODS server.
+
+[iRODS](https://www.irods.org) is an open source distributed data management system. This is a client API implemented in Python.
+
+The tests we will run are
+
+a.   `main.yml`: static type tests using `mypy`.
+b.   `run-the-tests.yml`: set up separate nodes (via Docker compose) to run the client suite.  Nodes include a provider, catalog, and client.
+     (See the `docker-testing` subdirectory for the README documentation and implementation of this test mechanism.)
+c.   `run-local-suite.yml`: test suite run  within an OS-level virtualized container, also hosting iRODS server and managed by Docker or equivalent.
+d.   `run-bats-tests.yml`: run a set of tests, each in its own container under similar conditions to (c).  Each test may have its own unique setup.
+     (See the `harness` subdirectory for the README documentation and implementation of this test mechanism.)
+
+Running
+-------
+
+The tests are run each time a commit is pushed to this repository or a fork of it.  They are also run when a pull request is made.

irods/test/harness/README.txt

@@ -16,12 +16,14 @@ The test_script_parameters file, located in the irods/test/harness directory, co
 settings for each test script run, including:
 
    - Docker image name to be used.
-   - Wrapper to be invoked, if any.  Wrappers may perform common setup tasks prior to running the
-     test script itself.
+
+   - Wrapper to be invoked, if any.  Wrappers shall perform common setup tasks up to and including
+     invoking the test script itself.
+
    - Which user is running the test.  (Unless otherwise specified, this is the passwordless-sudo-
      enabled user 'testuser').
 
-When done with a test, docker_container_driver.sh exit code mirrors the return code from the
+When done with a test, the docker_container_driver.sh exit code mirrors the return code from the
 run of the test script. The container itself is removed unless the -L ("leak") option is given.
 
 b. SAMPLE RUNS