diff options
author | Pierre RAMBAUD <pierre.rambaud@numergy.com> | 2014-03-03 14:34:17 +0100 |
---|---|---|
committer | Pierre RAMBAUD <pierre.rambaud86@gmail.com> | 2014-03-05 20:48:31 +0100 |
commit | 757c18c7fb6524e0cf5213127a2acb8761ea9631 (patch) | |
tree | f55d7c182701edec73cdc3ce3cae1c38a352071a /README.rst | |
parent | c68d4e53ba367bfdd9bed9a8607c2b5c62a981c1 (diff) | |
download | trove-757c18c7fb6524e0cf5213127a2acb8761ea9631.tar.gz |
Improve readme.rst
This file must be readable and have sections to separate usage
from tests.
Path for using trove in integration are wrong, the directory
bin does not exists.
Change-Id: I75dcf229580ead055233f8d7f7ea4acc07baadcf
Closes-Bug: #1287186
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 50 |
1 files changed, 38 insertions, 12 deletions
@@ -4,22 +4,48 @@ Trove Trove is Database as a Service for Open Stack. +============================= +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: -$ tox -To quickly run the tests for Python 2.7, run: -$ tox -epy27 +.. code-block:: bash + + $ tox -To quickly run PEP8, run: -$ tox -epep8 +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: -$ tox -ecover -(note: on some boxes, the results may not be accurate unless you run it twice) -If you'd like to start up a fake Trove API daemon for integration testing -with your own tool, run: -$ ./bin/start_server +.. code-block:: bash -Stop the server with: -$ ./bin/stop_server + $ tox -ecover + +(note: on some boxes, the results may not be accurate unless you run it twice) |