History

Masayuki Igawa d0b8ebd84a Switch to use stestr for unit tests directly This commit switches to use stestr command to run unit tests directly. Recently, the latest ostestr command uses stestr instead of testr. However, we should use stestr directly because it's simple and straight forward. There is no reason to use ostestr for unit tests anymore. We still have the other ostestr/testr usage such as tempest run command and documentations. So, that will be changed with following patches. Change-Id: Iff4abef50178bdc83b868eed4a906e22d790762b		2017-09-14 16:00:31 -06:00
..
api	Use glance client to delete an image	2017-09-14 04:56:01 +00:00
cmd	Move test decorators to common	2017-08-23 17:09:33 +00:00
common	Add a validation resources fixture	2017-09-12 12:37:24 -06:00
hacking	Unsupported 'message' Exception attribute in PY3	2017-07-31 07:30:28 +00:00
lib	Remove unnecessary executable permissions	2017-09-12 12:50:46 -06:00
scenario	Merge "Move test decorators to common"	2017-08-24 06:48:00 +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	Switch to use stestr for unit tests directly	2017-09-14 16:00:31 -06:00
README.rst	Doc: fix markups, capitalization and add 2 REVIEWING advices	2017-07-11 20:26:32 +02:00
__init__.py	…
clients.py	Make sure test use the latest volume clients	2017-08-08 21:09:22 +00:00
config.py	Fix identity tests when domain specific drivers are enabled	2017-08-21 08:00:05 -03:00
exceptions.py	Move test decorators to common	2017-08-23 17:09:33 +00:00
manager.py	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
test.py	Make resource_cleanup stable	2017-09-12 12:37:30 -06: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.