diff options
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 94b2257c..66791a5b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -144,3 +144,54 @@ tox will use the `openstack-doc-tools package <https://github.com/openstack/openstack-doc-tools>`_ for execution of these tests. openstack-doc-tools has a requirement on maven for the build check. + +Usage for integration testing +----------------------------- + +If you'd like to start up a fake Trove API daemon for integration testing +with your own tool, run: + +.. code-block:: bash + + $ ./tools/start-fake-mode.sh + +Stop the server with: + +.. code-block:: bash + + $ ./tools/stop-fake-mode.sh + +Tests +----- + +To run all tests and PEP8, run tox, like so: + +.. code-block:: bash + + $ tox + +To run just the tests for Python 2.7, run: + +.. code-block:: bash + + $ tox -epy27 + +To run just PEP8, run: + +.. code-block:: bash + + $ tox -epep8 + +To generate a coverage report,run: + +.. code-block:: bash + + $ tox -ecover + +(note: on some boxes, the results may not be accurate unless you run it twice) + +If you want to run only the tests in one file you can use testtools e.g. + +.. code-block:: bash + + $ python -m testtools.run trove.tests.unittests.python.module.path |