History

afazekas 40fcb9ba28 Add autopep8 to tox.ini autopep8 is an automated code formatting tool for python, it does not know everything, also not super fast, but it is faster than I can manually reformat the code. tools/format.sh will call the formatting, the tox will check did you called it. Also adding a tox -eautopep8 way to use it. autopep8 formats the lines in one way, where tempest used a another way it was changed. Change-Id: I6d51b14a5a5b87761071d0927fca23ba1651aa41		2019-03-08 16:04:05 +01:00
..
api	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
cmd	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
common	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
hacking	Merge "Bump hacking to 1.1.0"	2018-08-21 12:46:22 +00:00
lib	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
scenario	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
services	Move the object client to tempest.lib	2017-10-17 00:14:20 +00:00
test_discover	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
tests	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
__init__.py	…
clients.py	[Trivial fix]Remove unnecessary slash	2019-01-10 10:43:16 +08:00
config.py	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
exceptions.py	Remove unused RFCViolation	2017-09-11 14:20:20 +08: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	docs: Fix incorrect docstrings in reStructuredText format	2018-11-21 19:06:43 -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 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.