diff options
| author | Joe Heck <heckj@mac.com> | 2012-07-12 16:16:34 +0000 |
|---|---|---|
| committer | Joe Heck <heckj@mac.com> | 2012-07-12 17:30:59 +0000 |
| commit | 60fa32b256424cc4927a02b3cbef36d7330174bc (patch) | |
| tree | e65418093559a24f0bea3cdf7be54aab42e6d4b5 /doc/source/developing.rst | |
| parent | 2a909ee83d23a38e2ae7ca8002e570788674521c (diff) | |
| download | keystone-60fa32b256424cc4927a02b3cbef36d7330174bc.tar.gz keystone-60fa32b256424cc4927a02b3cbef36d7330174bc.tar.xz keystone-60fa32b256424cc4927a02b3cbef36d7330174bc.zip | |
updating testing documentation
Change-Id: I78c55c3050573d6430028bfc3c3c5d8a8c3e93b0
Diffstat (limited to 'doc/source/developing.rst')
| -rw-r--r-- | doc/source/developing.rst | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/doc/source/developing.rst b/doc/source/developing.rst index 4acb3b2e..973ef815 100644 --- a/doc/source/developing.rst +++ b/doc/source/developing.rst @@ -90,8 +90,14 @@ Test Structure ``./run_test.sh`` uses its python cohort (``run_tests.py``) to iterate through the ``tests`` directory, using Nosetest to collect the tests and invoke them using an OpenStack custom test running that displays the tests -as well as the time taken to -run those tests. +as well as the time taken to run those tests. + +Not all of the tests in the tests directory are strictly unit tests. Keystone +intentionally includes tests that run the service locally and drives the +entire configuration to achieve basic functional testing. + +For the functional tests, an in-memory key-value store is used to keep the +tests fast. Within the tests directory, the general structure of the tests is a basic set of tests represented under a test class, and then subclasses of those @@ -104,9 +110,13 @@ this projects etc/ directory. ``test_backend_sql.py`` subclasses those tests, changing the configuration by overriding with configuration files stored in the tests directory aimed at enabling the SQL backend for the Identity module. -Likewise, ``test_cli.py`` takes advantage of the tests written aainst -``test_keystoneclient`` to verify the same tests function through different -drivers. +Likewise, ``test_keystoneclient.py`` takes advantage of the tests written +against ``KeystoneClientTests`` to verify the same tests function through +different drivers and releases of the Keystone client. + +The class ``CompatTestCase`` does the work of checking out a specific version +of python-keystoneclient, and then verifying it against a temporarily running +local instance to explicitly verify basic functional testing across the API. Testing Schema Migrations ------------------------- @@ -134,7 +144,7 @@ of your data during migration. Writing Tests ------------- -To add tests covering all drivers, update the base test class +To add tests covering all drivers, update the relevant base test class (``test_backend.py``, ``test_legacy_compat.py``, and ``test_keystoneclient.py``). |