History

Ghanshyam Mann 81bd0e9e19 Add test for compute server external event API Adding test as well as the service client for the compute server external event API - https://docs.openstack.org/api-ref/compute/?expanded=run-events-detail#run-events Change-Id: I1c9a99d036de760a15a5725db87ca4e9d6f2263d		2022-11-21 20:30:35 +00:00
..
api	Add test for compute server external event API	2022-11-21 20:30:35 +00:00
cmd	Remove compute api_extensions config option	2022-05-05 18:15:29 -05:00
common	Fix error KeyError: 'addresses' for two tests	2022-11-14 16:19:43 +03:00
hacking	Use LOG.warning instead of deprecated LOG.warn	2022-01-19 13:38:21 +09:00
lib	Add test for compute server external event API	2022-11-21 20:30:35 +00:00
scenario	Clean up scenario floating IP waiting	2022-07-27 18:52:32 +00:00
test_discover	Remove usage of unittest2	2022-01-24 17:49:25 -05:00
tests	Add test for compute server external event API	2022-11-21 20:30:35 +00:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
__init__.py	…
clients.py	Add test for compute server external event API	2022-11-21 20:30:35 +00:00
config.py	Merge "Clarify the enforce_scope config option help message"	2022-11-04 16:48:43 +00:00
exceptions.py	Break wait_for_volume_resource_status when error_extending	2019-06-03 15:37:13 +08:00
test.py	Remove usage of unittest2	2022-01-24 17:49:25 -05: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.