History

zhangguoqing 6c0966470c Change LOG.warn to LOG.warning Python 3 deprecated the logger.warn method, see: https://docs.python.org/3/library/logging.html#logging.warning so we prefer to use warning to avoid DeprecationWarning. Change-Id: I3a057080b7b888b2c246ad9910ddba564b07dbd9 Closes-Bug: #1530742		2016-01-04 06:17:21 +00:00
..
api	Change LOG.warn to LOG.warning	2016-01-04 06:17:21 +00:00
api_schema	Use servers_client from tempest-lib	2015-12-21 14:20:55 +09:00
cmd	Change LOG.warn to LOG.warning	2016-01-04 06:17:21 +00:00
common	Change LOG.warn to LOG.warning	2016-01-04 06:17:21 +00:00
hacking	Merge "Fix T110 violation for database client"	2015-12-10 12:17:50 +00:00
scenario	Change LOG.warn to LOG.warning	2016-01-04 06:17:21 +00:00
services	Merge "Make v3 update_role use **kwargs & doc string"	2015-12-25 06:48:00 +00:00
stress	Change LOG.warn to LOG.warning	2016-01-04 06:17:21 +00:00
test_discover	Remove the ec2 api tests from tempest	2015-12-17 17:59:20 -05:00
tests	Merge "[V3] Renaming region_client into regions_client"	2015-12-25 04:20:21 +00:00
README.rst	Remove the ec2 api tests from tempest	2015-12-17 17:59:20 -05: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 "[V3] Renaming region_client into regions_client"	2015-12-25 04:20:21 +00:00
config.py	Merge "Get rid of unused env variable"	2015-12-18 18:04:53 +00:00
exceptions.py	Makes microversions config option clear about 'None'	2015-12-10 15:49:50 +09:00
manager.py	Fix H404/405 violations for remaining	2015-11-19 11:22:29 +00:00
test.py	Change LOG.warn to LOG.warning	2016-01-04 06:17:21 +00: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

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.

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