diff options
author | Doug Hellmann <doug@doughellmann.com> | 2014-10-08 16:49:59 -0400 |
---|---|---|
committer | Doug Hellmann <doug@doughellmann.com> | 2014-10-08 16:49:59 -0400 |
commit | 19848e6cf1148ac80ed9e456c9e0e80b57cf075b (patch) | |
tree | a9384c00597a5c63f4fb9fe2efae0a58aa90263d /doc | |
parent | eb7238725ed1837bd69d957f711087a45b82b8ab (diff) | |
download | pbr-19848e6cf1148ac80ed9e456c9e0e80b57cf075b.tar.gz |
Clean up links and docs
Move some developer information for running tests out of the README to
the documentation.
Change the home page link to point to the launchpad page.
Add a link to the bug tracker to the README.
Change-Id: I29bdb071eb64bccc561844c130a256b8f998da5f
Closes-Bug: #1318548
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/index.rst | 1 | ||||
-rw-r--r-- | doc/source/testing.rst | 27 |
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index c0b9354..918be40 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -252,6 +252,7 @@ Additional Docs packagers semver + testing Indices and tables ================== diff --git a/doc/source/testing.rst b/doc/source/testing.rst new file mode 100644 index 0000000..eccb1e3 --- /dev/null +++ b/doc/source/testing.rst @@ -0,0 +1,27 @@ +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 |