openstack/tempest

History

Zuul ae784996c9 Merge "Add glance image import copy-image tests"		2020-11-05 22:30:11 +00:00
..
api	Merge "Add glance image import copy-image tests"	2020-11-05 22:30:11 +00:00
cmd	Use os.path.join as possible	2020-09-06 09:49:40 +00:00
common	Merge "Add glance image import copy-image tests"	2020-11-05 22:30:11 +00:00
hacking	Update hacking for Python3	2020-04-04 10:33:23 +02:00
lib	Merge "Retry on ServerFault in call_and_ignore_notfound_exc()"	2020-10-13 08:12:55 +00:00
scenario	Check port allocation for VM with resource request	2020-09-28 06:45:59 +00:00
services	Move the object client to tempest.lib	2017-10-17 00:14:20 +00:00
test_discover	Use os.path.join as possible	2020-09-06 09:49:40 +00:00
tests	Merge "Retry on ServerFault in call_and_ignore_notfound_exc()"	2020-10-13 08:12:55 +00:00
__init__.py
clients.py	Add placement API methods for testing routed provider nets	2020-09-28 06:45:37 +00:00
config.py	New list config option to list network features without API extension	2020-11-03 07:06:24 +01:00
exceptions.py	Break wait_for_volume_resource_status when error_extending	2019-06-03 15:37:13 +08:00
manager.py	Need to have stable tempest scenario manager	2020-09-03 15:49:53 +05:30
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
test.py	Add workaround to handle the testtool skip exception in CLI test	2019-10-12 01:40:29 +00: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 repository 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.