openstack/trove
Code Issues Proposed changes

Update Trove's README

Browse Source 
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
This commit is contained in:
DeepaJon 2016-05-02 15:32:25 +05:30
parent a3b3fcbd7d
commit 6539445f01
2 changed files with 73 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
CONTRIBUTING.rst
View File

@ -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

67
README.rst
View File

@ -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
$ ./tools/start-fake-mode.sh
Stop the server with:
.. code-block:: bash
$ ./tools/stop-fake-mode.sh
git clone https://github.com/openstack/trove
======
Tests
======
To run all tests and PEP8, run tox, like so:
* 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
$ tox
Python client
-------------
https://git.openstack.org/cgit/openstack/python-troveclient
To run just the tests for Python 2.7, run:
References
----------
.. 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