openstack/python-tackerclient
Code Issues Proposed changes

Trivial: Update HACKING.rst with stestr

Browse Source 
The HACKING.rst testing section is updated a bit to point out
that we use stestr now instead of testr.

Change-Id: Ia4417994def85c989df315ebc17f5a0b8e0c0e98
This commit is contained in:
Nguyen Hai 2018-07-25 10:38:43 +09:00
parent c6f918cc51
commit 2beb75af6e
1 changed files with 11 additions and 11 deletions

22
HACKING.rst

@ -1,5 +1,5 @@
Tacker Style Commandments Tacker Style Commandments
================================ =========================
- Step 1: Read the OpenStack Style Commandments - Step 1: Read the OpenStack Style Commandments
https://docs.openstack.org/hacking/latest https://docs.openstack.org/hacking/latest
@ -8,19 +8,19 @@ Tacker Style Commandments
Running Tests 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 approach to running tests is to simply run the command ``tox``. This will
create virtual environments, populate them with dependencies and run all of create virtual environments, populate them with dependencies and run all of
the tests that OpenStack CI systems run. Behind the scenes, tox is running 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 ``stestr run``, but is set up such that you can supply any additional
testr arguments that are needed to tox. For example, you can run: stestr arguments that are needed to tox. For example, you can run:
`tox -- --analyze-isolation` to cause tox to tell testr to add ``tox -- --analyze-isolation`` to cause tox to tell stestr to add
--analyze-isolation to its argument list. --analyze-isolation to its argument list.
It is also possible to run the tests inside of a virtual environment 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 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 installed locally already. In this case, you can interact with the stestr
command directly. Running `testr run` will run the entire test suite. `testr command directly. Running ``stestr run`` will run the entire test suite.
run --parallel` will run it in parallel (this is the default incantation tox ``stestr run --concurrency=1`` will run tests serially (by default, stestr runs
uses.) More information about testr can be found at: tests in parallel). More information about stestr can be found at:
https://wiki.openstack.org/wiki/Testr http://stestr.readthedocs.io/