Go to file

Robert Myers 0a601ae45c Add missing api example for incremental backups

* Added Incremental backup test and resulting sample files.
* Fixed the example generator tests to actually fail when api
  changes.
* Added changes since the last example generation was run.
* Added a --fix-examples flag to the example generator to
  automatically correct the sample files.

Change-Id: I7ac355c80b251b0eccd3bd5b8d76d2287c255705
Closes-Bug: #1398119

2014-12-02 15:57:59 -06:00

apidocs

Add missing api example for incremental backups

2014-12-02 15:57:59 -06:00

contrib

Migrating trove to entry points

2014-02-01 01:19:58 +00:00

doc

Merge "Stop using intersphinx"

2014-10-09 19:45:44 +00:00

etc

Create example generator

2014-11-17 13:51:24 -06:00

rsdns

Merge "Use six.moves.urllib.parse instead of urlparse"

2014-04-17 22:25:30 +00:00

tools

rename and fix the db_wipe command

2014-03-10 10:16:03 +01:00

trove

Add missing api example for incremental backups

2014-12-02 15:57:59 -06:00

.coveragerc

Rename from reddwarf to trove.

2013-06-24 14:11:15 -07:00

.gitignore

Moved the apidocs from openstack/database-api

2014-04-24 14:41:40 -05:00

.gitreview

Renamed repos to trove.

2013-06-14 18:25:42 -04:00

.testr.conf

Rename from reddwarf to trove.

2013-06-24 14:11:15 -07:00

babel.cfg

Setup trove for translation

2014-03-19 15:06:23 +01:00

CONTRIBUTING.rst

Update contributing.rst to include guidelines on Code Review

2014-10-14 14:23:39 +00:00

doc-test.conf

Update database-api to follow OpenStack conventions

2014-05-23 07:32:29 +02:00

generate_examples.py

Add missing api example for incremental backups

2014-12-02 15:57:59 -06:00

LICENSE

Add Apache 2.0 LICENSE file.

2013-04-29 18:01:12 -04:00

MANIFEST.in

Package AUTHORS and ChangeLog file

2013-06-25 10:41:57 +02:00

openstack-common.conf

Sync jsonutils (and dependencies) from oslo-incubator

2014-06-27 12:32:51 -07:00

README.rst

document running a small set of tests

2014-07-23 17:49:19 +02:00

requirements.txt

Add missing api example for incremental backups

2014-12-02 15:57:59 -06:00

run_tests.py

Event simulator II

2014-09-29 10:32:29 -05:00

run_tests.sh

Remove extraneous vim configuration comments

2014-02-27 15:05:21 +08:00

setup.cfg

Merge "Mark trove as being a universal wheel"

2014-10-17 03:31:58 +00:00

setup.py

Updated from global requirements

2014-05-01 13:51:51 +00:00

test-requirements.txt

Updated from global requirements

2014-11-20 14:13:11 +00:00

tox.ini

Create example generator

2014-11-17 13:51:24 -06:00

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 tests

tox -e checksyntax - to run syntax checks

tox -e checkdeletions - to check that no deleted files are referenced

tox -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:

https://bugs.launchpad.net/openstack-api-site/

Installing

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.