From 89f5bfd7b3ba649fa753ae881861717d75f00a4d Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Wed, 25 Jul 2018 10:46:43 +0900 Subject: [PATCH] Trivial: Add running tests section to HACKING.rst The HACKING.rst testing section is added to point out that we use stestr now instead of testr. Change-Id: Ic2ef2a70134dacb79dedbbc75f581029e91d0eb6 --- HACKING.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/HACKING.rst b/HACKING.rst index 34cc20494..4a35d3d33 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -17,3 +17,22 @@ For every new feature, unit tests should be created that both test and bug that had no unit test, a new passing unit test should be added. If a submitted bug fix does have a unit test, be sure to add a new one that fails without the patch and passes with the patch. + +Running Tests +------------- +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 +``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. + +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 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/