From 85235d229be7ee77640a68ffd8619518478d0805 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Mon, 13 Nov 2017 17:13:18 -0500 Subject: [PATCH] doc: fix link to creating unit tests in contributor guide The testing strategy doc was linking to the hacking repo docs on creating unit tests, which are very specific to creating unit tests for hacking rules. This changes the link to the 'creating unit tests' section in the HACKING.rst file, which has more information on testing within nova. Along with that change, the HACKING.rst testing section is updated a bit to point out that we use stestr now instead of testr and adds a proper link to the development environment quickstart docs. The nova/tests/unit/README.rst actually needs a lot of work, but that's left for another day. Change-Id: Ie5106d87d632286162b31ce132e947c306d21abd Closes-Bug: #1732024 --- HACKING.rst | 22 ++++++++++++---------- doc/source/contributor/testing.rst | 2 +- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index f0c4ccfbd852..466bde4c546a 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 1258a7df6236..64f6137b71c6 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 -----------------