From 6539445f014b4efc0baf29fa2169d2084010cbbb Mon Sep 17 00:00:00 2001 From: DeepaJon Date: Mon, 2 May 2016 15:32:25 +0530 Subject: Update Trove's README Updated the README.rst, In which updated about trove, getting started, python client for trove and reference, Removed the Usage for integration testing Tests and moved into CONTRIBUTION.rst Taken reference from other component's README.rst file. Change-Id: Ic3ce38155ecb120fc6fde1098fabb60be5383a64 Closes-Bug: #1572224 --- CONTRIBUTING.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) (limited to 'CONTRIBUTING.rst') 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 `_ 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 -- cgit v1.2.1