![]() Merging processutils.py and dependencies from oslo-incubator. Primarily, I want change d6b55fb but the rest come along for the ride. 0d7296f Add kwargs to jsonutils.load(s) functions 3310d8d update new requests logger to default WARN 33afb20 Fix broken formatting of processutils.execute log statement 3d90045 Backport code for i18n to check lazy at runtime 433fa0b Make logging_context_format_string optional in log.set_defaults 4d9328c Python 3: enable tests/unit/test_log.py 5fd77eb Ability to customize default_log_levels for each project 6751b30 Remove extra whitespace 726d00a Adjust oslo logging to provide adapter is enabled for ac92c06 Add default log level for websocket cb5a804 Move `mask_password` to strutils d6b55fb Remove `processutils` dependency on `log` e184dd3 Fix exception message in openstack.common.processutils.execute ef37e03 Added missing jsonutils.dump() function Change-Id: I567f514faed5a8467602257d35a98625801daf22 Closes-Bug: #1349890 |
||
---|---|---|
apidocs | ||
contrib | ||
doc | ||
etc | ||
rsdns | ||
tools | ||
trove | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
.testr.conf | ||
CONTRIBUTING.rst | ||
LICENSE | ||
MANIFEST.in | ||
README.rst | ||
babel.cfg | ||
doc-test.conf | ||
openstack-common.conf | ||
requirements.txt | ||
run_tests.py | ||
run_tests.sh | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
README.rst
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:
$ ./tools/start-fake-mode.sh
Stop the server with:
$ ./tools/stop-fake-mode.sh
Tests
To run all tests and PEP8, run tox, like so:
$ tox
To run just the tests for Python 2.7, run:
$ tox -epy27
To run just PEP8, run:
$ 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 want to run only the tests in one file you can use testtools e.g.
$ python -m testtools.run trove.tests.unittests.python.module.path
Docs
This repository contains the following OpenStack manual:
- Database Services API Reference
Prerequisites
Apache Maven must be installed to build the documentation.
To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:
apt-get install maven
On Fedora 15 and later:
yum install maven3
Building
The manuals are in the apidocs
directory.
To build a specific guide, look for a pom.xml
file
within a subdirectory, then run the mvn
command in that
directory. For example:
cd apidocs
mvn clean generate-sources
The generated PDF documentation file is:
apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdf
The root of the generated HTML documentation is:
apidocs/target/docbkx/webhelp/cdb-devguide/content/index.html
Testing of changes and building of the manual
Install the python tox package and run tox
from the
top-level directory to use the same tests that are done as part of our
Jenkins gating jobs.
If you like to run individual tests, run:
tox -e checkniceness
- to run the niceness teststox -e checksyntax
- to run syntax checkstox -e checkdeletions
- to check that no deleted files are referencedtox -e checkbuild
- to actually build the manual
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.
Contributing
Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.
The best way to get involved with the community is to talk with
others online or at a meetup and offer contributions through our
processes, the OpenStack wiki,
blogs, or on IRC at #openstack
on
irc.freenode.net
.
We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
If you would like to contribute to the documents, please see the Documentation HowTo.
Bugs
Bugs should be filed on Launchpad, not GitHub:
Installing
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.