summaryrefslogtreecommitdiff
path: root/test/test_dockerpy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/test_dockerpy/README.md')
-rw-r--r--test/test_dockerpy/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/test/test_dockerpy/README.md b/test/test_dockerpy/README.md
new file mode 100644
index 000000000..32e426d58
--- /dev/null
+++ b/test/test_dockerpy/README.md
@@ -0,0 +1,30 @@
+# Dockerpy regression test
+
+Python test suite to validate Podman endpoints using dockerpy library
+
+Running tests
+=============
+To run the tests locally in your sandbox:
+
+#### 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
+```