diff options
| -rw-r--r-- | README.rst | 14 | ||||
| -rw-r--r-- | doc/source/cli.rst | 5 | ||||
| -rw-r--r-- | doc/source/decorators.rst | 13 | ||||
| -rw-r--r-- | doc/source/index.rst | 33 | ||||
| -rw-r--r-- | doc/source/rest_client.rst | 11 | ||||
| -rw-r--r-- | doc/source/usage.rst | 19 | ||||
| -rw-r--r-- | doc/source/utils.rst | 11 |
7 files changed, 104 insertions, 2 deletions
@@ -9,7 +9,19 @@ OpenStack Functional Testing Library * Source: http://git.openstack.org/cgit/openstack/tempest-lib * Bugs: http://bugs.launchpad.net/tempest +tempest-lib is a library of common functionality that was originally in tempest +(or similar in scope to tempest) + Features -------- -* TODO +Some of the current functionality exposed from the library includes: + +* OpenStack python-* client CLI testing framework +* subunit-trace: A output filter for subunit streams. Useful in conjunction + with calling a test runner that emits subunit +* A unified REST Client +* Utility functions: + * skip_because: Skip a test because of a bug + * find_test_caller: Perform stack introspection to find the test caller. + common methods diff --git a/doc/source/cli.rst b/doc/source/cli.rst index 33e0110..301510e 100644 --- a/doc/source/cli.rst +++ b/doc/source/cli.rst @@ -1,3 +1,8 @@ +.. _cli: + +CLI Testing Framework Usage +=========================== + ------------------- The cli.base module ------------------- diff --git a/doc/source/decorators.rst b/doc/source/decorators.rst new file mode 100644 index 0000000..a0b7c78 --- /dev/null +++ b/doc/source/decorators.rst @@ -0,0 +1,13 @@ +.. _decorators: + +Decorators Usage Guide +====================== + +--------------------- +The decorators module +--------------------- + +.. automodule:: tempest_lib.decorators + :members: + + diff --git a/doc/source/index.rst b/doc/source/index.rst index d2a94bd..9c707ca 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,10 +16,43 @@ Contents: usage contributing cli + decorators Release Notes ============= +0.2.1 +----- + * Fix subunit-trace to enable stdout passthrough + +0.2.0 +----- + * Adds the skip_because decorator which was migrated from tempest + * Fixes to rest_client + * Separates the forbid + * Cleans up the exception classes to make inheritance simpler + * Doc typo fixes + +0.1.0 +----- + * Adds the RestClient class which was migrated from tempest + * Fix subunit-trace to handle when there isn't a worker tag in the subunit + stream + +0.0.4 +----- + * Fix subunit-trace when running with python < 2.7 + +0.0.3 +----- + * subunit-trace bug fixes: + * Switch to using elapsed time for the summary view + * Addition of --failonly option from nova's forked subunit-trace + +0.0.2 +----- + * Fix the MRO ordering in the base test class + 0.0.1 ----- * Adds cli testing framework diff --git a/doc/source/rest_client.rst b/doc/source/rest_client.rst new file mode 100644 index 0000000..513d8e4 --- /dev/null +++ b/doc/source/rest_client.rst @@ -0,0 +1,11 @@ +.. _rest_client: + +Rest Client Usage +================= + +---------------------- +The rest_client module +---------------------- + +.. automodule:: tempest_lib.common.rest_client + :members: diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 4aeb40f..e305244 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -4,4 +4,21 @@ Usage To use tempest-lib in a project:: - import tempest_lib
\ No newline at end of file + import tempest_lib + +:ref:`cli` +---------- +The CLI testing framework allows you to test the command line interface for +an OpenStack project's python-*client + + +:ref:`decorators` +----------------- +These decorators enable common utility functions inside of your test suite + + +:ref:`rest_client` +------------------ +The base building block for making a project specific client + + diff --git a/doc/source/utils.rst b/doc/source/utils.rst new file mode 100644 index 0000000..0e481b2 --- /dev/null +++ b/doc/source/utils.rst @@ -0,0 +1,11 @@ +.. _utils: + +Utils Usage +=========== + +--------------- +The misc module +--------------- + +.. automodule:: tempest_lib.common.utils.misc + :members: |