37 lines
1.5 KiB
ReStructuredText
37 lines
1.5 KiB
ReStructuredText
==============
|
|
Contributing
|
|
==============
|
|
|
|
Basic Details
|
|
=============
|
|
|
|
.. include:: ../../../CONTRIBUTING.rst
|
|
|
|
Running the Tests for pbr
|
|
=========================
|
|
|
|
The testing system is based on a combination of `tox`_ and `testr`_. The canonical
|
|
approach to running tests is to simply run the command ``tox``. This will
|
|
create virtual environments, populate them with dependencies and run all of
|
|
the tests that OpenStack CI systems run. Behind the scenes, tox is running
|
|
``testr run --parallel``, but is set up such that you can supply any additional
|
|
testr arguments that are needed to tox. For example, you can run:
|
|
``tox -- --analyze-isolation`` to cause tox to tell testr to add
|
|
``--analyze-isolation`` to its argument list.
|
|
|
|
It is also possible to run the tests inside of a virtual environment
|
|
you have created, or it is possible that you have all of the dependencies
|
|
installed locally already. If you'd like to go this route, the requirements
|
|
are listed in ``requirements.txt`` and the requirements for testing are in
|
|
``test-requirements.txt``. Installing them via pip, for instance, is simply::
|
|
|
|
pip install -r requirements.txt -r test-requirements.txt
|
|
|
|
In you go this route, you can interact with the testr command directly.
|
|
Running ``testr run`` will run the entire test suite. ``testr run --parallel``
|
|
will run it in parallel (this is the default incantation tox uses). More
|
|
information about testr can be found at: http://wiki.openstack.org/testr
|
|
|
|
.. _tox: http://tox.testrun.org/
|
|
.. _testr: https://wiki.openstack.org/wiki/Testr
|