summaryrefslogtreecommitdiff
path: root/test/python/dockerpy/README.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-06-25 11:52:06 -0400
committerGitHub <noreply@github.com>2020-06-25 11:52:06 -0400
commit7766192293b197c53141aa07d0ba43d3d92bcbac (patch)
tree782409c219fd5e27a12b3bdd43f3d1080c88a833 /test/python/dockerpy/README.md
parentc036eef44d5fe07b754968ca1eef57034350c53b (diff)
parentd7770df5ef9f6085a5e31e3260f7dc1f0056f162 (diff)
downloadpodman-7766192293b197c53141aa07d0ba43d3d92bcbac.tar.gz
podman-7766192293b197c53141aa07d0ba43d3d92bcbac.tar.bz2
podman-7766192293b197c53141aa07d0ba43d3d92bcbac.zip
Merge pull request #6760 from jwhonce/wip/python
Fix podman python docker-py tests
Diffstat (limited to 'test/python/dockerpy/README.md')
-rw-r--r--test/python/dockerpy/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/test/python/dockerpy/README.md b/test/python/dockerpy/README.md
new file mode 100644
index 000000000..22908afc6
--- /dev/null
+++ b/test/python/dockerpy/README.md
@@ -0,0 +1,40 @@
+# Dockerpy regression test
+
+Python test suite to validate Podman endpoints using dockerpy library
+
+## Running Tests
+
+To run the tests locally in your sandbox (Fedora 32):
+
+```shell script
+# dnf install python3-docker
+```
+
+### Run the entire test suite
+
+```shell
+# cd test/python/dockerpy
+# PYTHONPATH=/usr/bin/python python -m unittest discover .
+```
+
+Passing the -v option to your test script will instruct unittest.main() to enable a higher level of verbosity, and produce detailed output:
+
+```shell
+# cd test/python/dockerpy
+# PYTHONPATH=/usr/bin/python python -m unittest -v discover .
+```
+
+### Run a specific test class
+
+```shell
+# cd test/python/dockerpy
+# PYTHONPATH=/usr/bin/python python -m unittest -v tests.test_images
+```
+
+### Run a specific test within the test class
+
+```shell
+# cd test/python/dockerpy
+# PYTHONPATH=/usr/bin/python python -m unittest tests.test_images.TestImages.test_import_image
+
+```