summaryrefslogtreecommitdiff
path: root/test/dockerpy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/dockerpy/README.md')
-rw-r--r--test/dockerpy/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/test/dockerpy/README.md b/test/dockerpy/README.md
new file mode 100644
index 000000000..2894fc8ab
--- /dev/null
+++ b/test/dockerpy/README.md
@@ -0,0 +1,35 @@
+# Dockerpy regression test
+
+Python test suite to validate Podman endpoints using dockerpy library
+
+Running tests
+=============
+To run the tests locally in your sandbox:
+
+#### Make sure that the Podman system service is running to do so
+
+```
+sudo podman --log-level=debug system service -t0 unix:/run/podman/podman.sock
+```
+#### Run the entire test
+
+```
+sudo PYTHONPATH=/usr/bin/python python -m dockerpy.images
+```
+
+Passing the -v option to your test script will instruct unittest.main() to enable a higher level of verbosity, and produce detailed output:
+
+```
+sudo PYTHONPATH=/usr/bin/python python -m unittest -v dockerpy.images
+```
+#### Run a specific test class
+
+```
+sudo PYTHONPATH=/usr/bin/python python -m unittest -v dockerpy.images.TestImages
+```
+
+#### Run a specific test within the test class
+
+```
+sudo PYTHONPATH=/usr/bin/python python -m unittest -v dockerpy.images.TestImages.test_list_images
+```