summaryrefslogtreecommitdiffstats
path: root/utils/README.md
diff options
context:
space:
mode:
authorScott Dodson <sdodson@redhat.com>2017-01-10 16:27:29 -0500
committerGitHub <noreply@github.com>2017-01-10 16:27:29 -0500
commit393eccd3a5347a13eda5d627f3cc35aeeb42f1cc (patch)
tree668806139fc108ce6763cc95a640aedffa8a4ecf /utils/README.md
parent706c582b2482d5cc3a4fb28b348ce5b856fc9c26 (diff)
parent33da32dbcdc5e93e26bccf59d0781a60386b6b04 (diff)
downloadopenshift-393eccd3a5347a13eda5d627f3cc35aeeb42f1cc.tar.gz
openshift-393eccd3a5347a13eda5d627f3cc35aeeb42f1cc.tar.bz2
openshift-393eccd3a5347a13eda5d627f3cc35aeeb42f1cc.tar.xz
openshift-393eccd3a5347a13eda5d627f3cc35aeeb42f1cc.zip
Merge pull request #3007 from detiber/toxification
More Toxification
Diffstat (limited to 'utils/README.md')
-rw-r--r--utils/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/utils/README.md b/utils/README.md
index 2abf2705e..c37ab41e6 100644
--- a/utils/README.md
+++ b/utils/README.md
@@ -6,6 +6,47 @@ Run the command:
to run an array of unittests locally.
+Underneath the covers, we use [tox](http://readthedocs.org/docs/tox/) to manage virtualenvs and run
+tests. Alternatively, tests can be run using [detox](https://pypi.python.org/pypi/detox/) which allows
+for running tests in parallel
+
+
+```
+pip install tox detox
+```
+
+List the test environments available:
+```
+tox -l
+```
+
+Run all of the tests with:
+```
+tox
+```
+
+Run all of the tests in parallel with detox:
+```
+detox
+```
+
+Running a particular test environment (python 2.7 flake8 tests in this case):
+```
+tox -e py27-ansible22-flake8
+```
+
+Running a particular test environment in a clean virtualenv (python 3.5 pylint
+tests in this case):
+```
+tox -r -e py35-ansible22-pylint
+```
+
+If you want to enter the virtualenv created by tox to do additional
+testing/debugging (py27-flake8 env in this case):
+```
+source .tox/py27-ansible22-flake8/bin/activate
+```
+
You will get errors if the log files already exist and can not be
written to by the current user (`/tmp/ansible.log` and
`/tmp/installer.txt`). *We're working on it.*