Skip to content

Commit

Permalink
a bit of a test-running guide in README
Browse files Browse the repository at this point in the history
  • Loading branch information
d-w-moore committed Mar 19, 2024
1 parent f5da679 commit 5ca4744
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docker-testing/README.md
Original file line number Diff line number Diff line change
@@ -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 <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

0 comments on commit 5ca4744

Please sign in to comment.