89c213fb35
Volume service has 2 versions of APIs, v2 and v3. v3 base
version 'v3.0' is supposed to be identical to v2 APIs.
Current supported API is v3 and all future development
will be on v3 with microversion.
Base API v3.0 == v2
API versioning v3.0 + microversion (v3.1, v3.2 etc)
In current situation, Tempest tests v2 API mainly and
v3 microversion specific change. As Cinder already made v3 as
current supported APIs which are supposed to be identical to v2,
it's is good to test v3 API as default with ability to configure
to test v2 APIs also.
Tempest should have flexibility to run existing test against any
of the API version. All existing tests which used to run on v2 APIs
should pass on v3.0 without any change.
Idea to achieve that is:
- Use config option ``[volume].catalog_type`` to switch the target API
version for testing. For example-
If it is configured to v3 endpoints, all tests will run against v3 APIs. like
'volumev3' in case of devstack [1].
If it is configured to v2 endpoints, all tests will run against v2 APIs. like
'volumev2' in case of devstack.
Changes required:
Tempest: this commit
1. Change the default value of the config option ``[volume].catalog_type`` to ``volumev3``
so that all gate job test v3 as default.
2. Make all volume service clients version less.
Devstack: I531f3b32e81ac5d282461597ca286c09429cb143
3. Make Devstack to configure the ``[volume].catalog_type`` on tempest for v2 job.
4. If Tempest if configured to tests v2 APIs, configure tempest to skip microversion tests
as no microversion supported in v2 APIs.
v2 API Job: TODO
5. Add new job for v2 APIs testing and set ``[volume].catalog_type`` to ``volumev2``
to run all tests against v2 APIs.
This way we will have:
- default gate testing of v3 APIs.
- separate job testing v2 APIs till it is required.
..1
|
||
|---|---|---|
| .. | ||
| api | ||
| cmd | ||
| common | ||
| hacking | ||
| lib | ||
| scenario | ||
| services | ||
| 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 overview of the Tempest respository 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.