openstack/tempest
Code Issues Proposed changes
402b8755e7
tempest/tempest
History
Ken'ichi Ohmichi 402b8755e7 Apply a naming rule of GET to v2 keystone clients 
[GET /resources] methods should be "list_<resource name>s"
or "show_<resource name>", so this patch applies the rule
to v2 keystone clients.
This patch changes some v3 parts also because some tests are
shared between v2 and v3 and the method names should be the same.

Partially implements blueprint consistent-service-method-names

Change-Id: Iea7dcb8839d0dfc300295f3e534d54224f9ec31c
2015-11-09 13:31:00 +00:00
..
api Apply a naming rule of GET to v2 keystone clients 2015-11-09 13:31:00 +00:00
api_schema Use Tempest-lib's compute hypervisor_client 2015-10-14 14:47:25 +09:00
cmd Apply a naming rule of GET to v2 keystone clients 2015-11-09 13:31:00 +00:00
common Prepare cred_client for migration 2015-10-30 15:32:10 +00:00
hacking Add hacking check for testtools.skip 2015-09-02 15:22:10 -04:00
scenario Merge "Refactor volume_boot_pattern test" 2015-11-06 01:22:15 +00:00
services Apply a naming rule of GET to v2 keystone clients 2015-11-09 13:31:00 +00:00
stress Apply a naming rule of GET to v2 keystone clients 2015-11-09 13:31:00 +00:00
test_discover Handle exceptions from plugins gracefully 2015-10-09 16:29:55 -04:00
tests Merge "Allow empty directories for tempest init" 2015-11-05 15:03:47 +00:00
thirdparty Fix typos in scenario tests, etc. 2015-09-09 18:24:45 +09:00
__init__.py Changes the namespace from storm to tempest, as well as adding addition tests and improvements 2011-12-06 16:48:03 -06:00
clients.py Merge "Use Tempest-lib's compute hypervisor_client" 2015-10-30 08:40:44 +00:00
config.py Merge "Add compute personality feature config" 2015-10-20 02:35:20 +00:00
exceptions.py Fix missing value types for log message 2015-09-11 18:51:02 +09:00
manager.py Stop validating pre-provisioned credentials 2015-10-21 11:06:56 +01:00
README.rst Cleanup tempest docs a bit 2015-09-02 11:06:44 -04:00
test.py Remove CredentialProvider deps to CONF 2015-10-21 11:07:45 +01:00

README.rst

Tempest Field Guide Overview

Tempest is designed to be useful for a large number of different environments. This includes being useful for gating commits to OpenStack core projects, being used to validate OpenStack cloud implementations for both correctness, as well as a burn in tool for OpenStack clouds.

As such Tempest tests come in many flavors, each with their own rules and guidelines. Below is the proposed Havana restructuring for Tempest to make this clear.

tempest/
   api/ - API tests
   scenario/ - complex scenario tests
   stress/ - stress tests
   thirdparty/ - 3rd party api tests

Each of these directories contains different types of tests. What belongs in each directory, the rules and examples for good tests, are documented in a README.rst file in the directory.

api_field_guide

API tests are validation tests for the OpenStack API. They should not use the existing python clients for OpenStack, but should instead use the tempest implementations of clients. This allows us to test both XML and JSON. Having raw clients also lets us pass invalid JSON and XML to the APIs and see the results, something we could not get with the native clients.

When it makes sense, API testing should be moved closer to the projects themselves, possibly as functional tests in their unit test frameworks.

scenario_field_guide

Scenario tests are complex "through path" tests for OpenStack functionality. They are typically a series of steps where complicated state requiring multiple services is set up exercised, and torn down.

Scenario tests should not use the existing python clients for OpenStack, but should instead use the tempest implementations of clients.

stress_field_guide

Stress tests are designed to stress an OpenStack environment by running a high workload against it and seeing what breaks. The stress test framework runs several test jobs in parallel and can run any existing test in Tempest as a stress job.

third_party_field_guide

Many openstack components include 3rdparty API support. It is completely legitimate for Tempest to include tests of 3rdparty APIs, but those should be kept separate from the normal OpenStack validation.

unit_tests_field_guide

Unit tests are the self checks for Tempest. They provide functional verification and regression checking for the internal components of tempest. They should be used to just verify that the individual pieces of tempest are working as expected.