diff options
author | Jason DeTiberus <jdetiber@redhat.com> | 2016-12-21 17:15:42 -0500 |
---|---|---|
committer | Jason DeTiberus <jdetiber@redhat.com> | 2017-01-10 11:45:30 -0500 |
commit | be949e0a0a2420205aaf80de514432a76596a854 (patch) | |
tree | be5edc6198f976215c1521a490d788f46b29e227 /CONTRIBUTING.md | |
parent | 9d316d3091b28820e3840c535fc9bc4b6603ed72 (diff) | |
download | openshift-be949e0a0a2420205aaf80de514432a76596a854.tar.gz openshift-be949e0a0a2420205aaf80de514432a76596a854.tar.bz2 openshift-be949e0a0a2420205aaf80de514432a76596a854.tar.xz openshift-be949e0a0a2420205aaf80de514432a76596a854.zip |
More toxification
- Move pylint tests to tox
- Move yamllint tests to tox
- Create separate tox config (and setup.py) for root
- bump ansible requirement
- unify pylint config
- add docs
- remove git directory containing old testing tools
- install python-six if not present for openshift-facts
- add python-six as a dependency for openshift-ansible-utils
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 |