summaryrefslogtreecommitdiff
path: root/test/python/dockerpy/README.md
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2020-06-24 12:40:55 -0700
committerJhon Honce <jhonce@redhat.com>2020-06-24 12:40:55 -0700
commitd7770df5ef9f6085a5e31e3260f7dc1f0056f162 (patch)
treee4b6b381ff67448209f3787483e24ae960e3911e /test/python/dockerpy/README.md
parent988fd27541dfa852ee9543c2d8a916896ef0c774 (diff)
downloadpodman-d7770df5ef9f6085a5e31e3260f7dc1f0056f162.tar.gz
podman-d7770df5ef9f6085a5e31e3260f7dc1f0056f162.tar.bz2
podman-d7770df5ef9f6085a5e31e3260f7dc1f0056f162.zip
Fix python dockerpy tests
* Refactor packaging so unittest discovery works * Refactor tests to use python3-docker.rpm that ships with Fedora32 * Flush image cache between tests suites * Update documentation to reflect changes Outstanding issue: * client.get_image() does not fail if image does not exist Signed-off-by: Jhon Honce <jhonce@redhat.com>
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
+
+```