openstack/tempest

History

Jenkins 66e11c58c4 Merge "Add Tests for Groups Volume APIs - Part 3"		2017-08-08 06:35:26 +00:00
..
api	Merge "Add Tests for Groups Volume APIs - Part 3"	2017-08-08 06:35:26 +00:00
cmd	Merge "Fix object storage capabilities client return value"	2017-07-24 19:53:04 +00:00
common	Remove redundant comments in credentials_factory.py	2017-08-04 13:48:59 +08:00
hacking	Add T115 for admin test path	2017-05-23 14:00:27 -07:00
lib	Merge "Add Tests for Groups Volume APIs - Part 3"	2017-08-08 06:35:26 +00:00
scenario	Merge "Doc: fix markups, capitalization and add 2 REVIEWING advices"	2017-07-22 01:47:46 +00:00
services	Move object storage capabilities_client to lib interface	2017-07-25 01:01:15 +00:00
test_discover	Add docstring example for get_opt_lists	2017-04-24 10:07:39 +00:00
tests	Merge "Add Tests for Groups Volume APIs - Part 3"	2017-08-08 06:35:26 +00:00
__init__.py
clients.py	Add Tests for Groups Volume APIs - Part 2	2017-07-25 14:34:04 -07:00
config.py	Merge "Pause resource cleanup"	2017-07-05 07:40:05 +00:00
exceptions.py	Migrate the preprov creds module to tempest lib	2017-07-21 16:14:41 -04:00
manager.py	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
README.rst	Doc: fix markups, capitalization and add 2 REVIEWING advices	2017-07-11 20:26:32 +02:00
test.py	Migrate the preprov creds module to tempest lib	2017-07-21 16:14:41 -04:00
version.py	Add reno to tempest	2016-02-24 11:31:32 -05: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 overview of the Tempest respository structure to make this clear.

tempest/
   api/ - API tests
   scenario/ - complex scenario tests
   tests/ - unit tests for Tempest internals

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. Having raw clients let us pass invalid JSON 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.

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