History

Ilya Shakhat 1291bb4736 Add profiler support into Tempest The primary goal is to be able to run all Tempest tests and verify OpenStack when profiling is enabled. Also this patch allows to: * manually verify that certain services are properly instrumented and produce trace events when a scenario is executed; * write automatic tests for trace coverage; * profile certain tests from performance perspective. A new parameter is introduced into tempest.conf: * profiler.key - the key used to enable OSProfiler (should match the one configured in OpenStack services) To test the patch on DevStack: 1. Enable osprofiler with Redis collector in local.conf: enable_plugin osprofiler https://git.openstack.org/openstack/osprofiler master OSPROFILER_COLLECTOR=redis 2. Run all Tempest tests or select some, e.g.: tempest run --regex tempest.api.network.test_networks.NetworksTest.test_list_networks* Change-Id: I64f30c36adbf7fb26609142f22d3e305ac9e82b5		2019-02-16 08:10:28 +00:00
..
api	Merge "Update v3 project tests to work w/ pre-prov"	2019-02-12 08:46:51 +00:00
cmd	Fix tempest cleanup for python3	2019-02-07 14:43:05 +00:00
common	Merge "Ensure volume is deleted after build error"	2019-02-01 09:28:53 +00:00
hacking	Merge "Bump hacking to 1.1.0"	2018-08-21 12:46:22 +00:00
lib	Add profiler support into Tempest	2019-02-16 08:10:28 +00:00
scenario	Mark test_volume_boot_pattern as slow	2019-02-14 14:07:11 -05:00
services	Move the object client to tempest.lib	2017-10-17 00:14:20 +00:00
test_discover	Fix doc issue in plugin.py	2017-11-05 21:41:33 +11:00
tests	Add profiler support into Tempest	2019-02-16 08:10:28 +00: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 profiler support into Tempest	2019-02-16 08:10:28 +00: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	Add profiler support into Tempest	2019-02-16 08:10:28 +00:00
version.py	…

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.