diff options
author | Scott Dodson <sdodson@redhat.com> | 2017-01-10 16:27:29 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-01-10 16:27:29 -0500 |
commit | 393eccd3a5347a13eda5d627f3cc35aeeb42f1cc (patch) | |
tree | 668806139fc108ce6763cc95a640aedffa8a4ecf /CONTRIBUTING.md | |
parent | 706c582b2482d5cc3a4fb28b348ce5b856fc9c26 (diff) | |
parent | 33da32dbcdc5e93e26bccf59d0781a60386b6b04 (diff) | |
download | openshift-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 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 49 |
1 files changed, 37 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1145da495..83c844e28 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,30 +66,55 @@ These are plugins used in playbooks and roles: └── test Contains tests. ``` -### Others - -``` -. -└── git Contains some helper scripts for repository maintenance. -``` - ## Building RPMs See the [RPM build instructions](BUILD.md). ## Running tests -We use [Nose](http://readthedocs.org/docs/nose/) as a test runner. Make sure it -is installed along with other test dependencies: +This section covers how to run tests for the root of this repo, running tests +for the oo-install wrapper is described in [utils/README.md](utils/README.md). + +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 -r utils/test-requirements.txt +pip install tox detox ``` -Run the tests with: +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): ``` -nosetests +source .tox/py27-ansible22-flake8/bin/activate ``` ## Submitting contributions |