diff options
| -rw-r--r-- | HACKING.rst | 22 | ||||
| -rw-r--r-- | doc/source/contributor/testing.rst | 2 |
2 files changed, 13 insertions, 11 deletions
diff --git a/HACKING.rst b/HACKING.rst index f0c4ccfbd8..466bde4c54 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -81,17 +81,17 @@ infrastructure in OpenStack Nova, please read ``nova/tests/unit/README.rst``. Running Tests ------------- -The testing system is based on a combination of tox and testr. The canonical +The testing system is based on a combination of tox and stestr. 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 +``stestr run``, but is set up such that you can supply any additional +stestr arguments that are needed to tox. For example, you can run: +``tox -- --analyze-isolation`` to cause tox to tell stestr to add --analyze-isolation to its argument list. Python packages may also have dependencies that are outside of tox's ability -to install. Please refer to ``doc/source/development.environment.rst`` for +to install. Please refer to `Development Quickstart`_ for a list of those packages on Ubuntu, Fedora and Mac OS X. To run a single or restricted set of tests, pass a regex that matches @@ -104,11 +104,13 @@ classes. 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. In this case, 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 +installed locally already. In this case, you can interact with the stestr +command directly. Running ``stestr run`` will run the entire test suite. +``stestr run --concurrency=1`` will run tests serially (by default, stestr runs +tests in parallel). More information about stestr can be found at: +http://stestr.readthedocs.io/ + +.. _Development Quickstart: https://docs.openstack.org/nova/latest/contributor/development-environment.html Building Docs ------------- diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index 1258a7df62..64f6137b71 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -79,7 +79,7 @@ The correct level of unit test coverage is very subjective, and as such we are not aiming for a particular percentage of coverage, rather we are aiming for good coverage. Generally, every code change should have a related unit test: -http://docs.openstack.org/developer/hacking/#creating-unit-tests +https://github.com/openstack/nova/blob/master/HACKING.rst#creating-unit-tests Integration tests ----------------- |