ffad78a29f
The recent commit I45d73891f3c0829a2378a032dfc02e5ac0ee34b7 deduplicated the base test class methods from the tempest.lib reintegration. However the surviving base class was put in the wrong namespace. The base class is just that a base to build the individual test subclass off of. It's very confusing for that to not live in the base tests namespace. While the code in lib is supposed to be self contained there isn't a reason to do that here for the unit tests, especially because in this case the import heiarchy becomes more confusing with the base living in a submodule. This commit moves the base class to the base tempest.tests namespace where it really belongs. Change-Id: I079eeb1135eed3254e5e9dbebac8a52b979303c7 |
||
|---|---|---|
| .. | ||
| api | ||
| api_schema | ||
| cmd | ||
| common | ||
| hacking | ||
| lib | ||
| scenario | ||
| services | ||
| stress | ||
| test_discover | ||
| tests | ||
| README.rst | ||
| __init__.py | ||
| clients.py | ||
| config.py | ||
| exceptions.py | ||
| manager.py | ||
| test.py | ||
| 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 proposed Havana restructuring for Tempest to make this clear.
api/ - API tests
scenario/ - complex scenario tests
stress/ - stress tests
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. This allows us to test both XML and JSON. Having raw clients also lets us pass invalid JSON and XML 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.
stress_field_guide
Stress tests are designed to stress an OpenStack environment by running a high workload against it and seeing what breaks. The stress test framework runs several test jobs in parallel and can run any existing test in Tempest as a stress job.
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.