Ken'ichi Ohmichi c0d96bec35 Add hacking rule for "GET /resources"
This patch is a prototype for "GET /resources" hacking rule.
black_list_T110.txt file contains the service client files which
are against this rule. So we need to fix them with removing them
from this file.

Partially implements blueprint consistent-service-method-names

Change-Id: I150fe2ef21d4d4d246a46d9baf2fb14cc7d79ee5
2015-11-16 05:32:01 +00:00
api Merge "Use skip_checks for live-migration feature in test" 2015-11-14 23:09:52 +00:00
api_schema Use Tempest-lib's compute hypervisor_client 2015-10-14 14:47:25 +09:00
cmd Merge "Apply a naming rule of GET to v2 keystone clients" 2015-11-11 08:42:19 +00:00
common Split out Neutron ports client 2015-11-02 09:26:19 -05:00
hacking Add hacking rule for "GET /resources" 2015-11-16 05:32:01 +00:00
scenario Merge "make schedule_to_every_node use real scheduler hint" 2015-11-13 18:07:26 +00:00
services Merge "Rename list_users_for_tenant to list_tenant_users" 2015-11-11 15:43:05 +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 "Split out Neutron ports client" 2015-11-11 08:39:00 +00:00
thirdparty Fix typos in scenario tests, etc. 2015-09-09 18:24:45 +09:00
README.rst Cleanup tempest docs a bit 2015-09-02 11:06:44 -04: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 Split out Neutron ports client 2015-11-02 09:26:19 -05:00
config.py Merge "Use choices kwarg when defining string options with defined choices" 2015-11-13 15:31:41 +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
test.py Remove CredentialProvider deps to CONF 2015-10-21 11:07:45 +01:00


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.

   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 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 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 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.


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 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.