diff options
| -rw-r--r-- | CONTRIBUTING.rst | 51 | ||||
| -rw-r--r-- | README.rst | 67 |
2 files changed, 73 insertions, 45 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 @@ -1,57 +1,34 @@ +===== Trove --------- +===== Trove is Database as a Service for OpenStack. +Getting Started +--------------- -============================= -Usage for integration testing -============================= -If you'd like to start up a fake Trove API daemon for integration testing -with your own tool, run: +If you'd like to run from the master branch, you can clone the git repo: -.. code-block:: bash + git clone https://github.com/openstack/trove - $ ./tools/start-fake-mode.sh -Stop the server with: +* Wiki: https://wiki.openstack.org/wiki/Trove +* Developer Docs: http://docs.openstack.org/developer/trove -.. code-block:: bash +You can raise bugs here: https://bugs.launchpad.net/trove - $ ./tools/stop-fake-mode.sh +Python client +------------- +https://git.openstack.org/cgit/openstack/python-troveclient +References +---------- -====== -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 +* Installation docs: + http://docs.openstack.org/developer/trove/dev/install.html +* Manual installation docs: + http://docs.openstack.org/developer/trove/dev/manual_install.html +* Trove integration: + https://github.com/openstack/trove-integration +* Build guest image: + http://docs.openstack.org/developer/trove/dev/building_guest_images.html |