diff --git a/docker-testing/README.md b/docker-testing/README.md new file mode 100644 index 00000000..3c11da08 --- /dev/null +++ b/docker-testing/README.md @@ -0,0 +1,23 @@ +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 tests suite can also be run on any workstation with "docker compose" installed: + + 1. cd into top level of $REPO + + 2. run: + ``` + ./docker-testing/start_containers.sh 3.6 + ``` + This builds and runs the docker images. "3.6" is the version of python desired. + + 3. run: + ``` + docker exec /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