Cinder decided to remove the v2 APIs[1] in Xena cycle, so in Tempest we need to modify the tempest-cinder-v2-api job to run against stable wallaby which is last release where volume v2 APIs are present. Also ad deprecation warning at v2 service clients module level import so that we can remove them once Tempest stop supporting stable wallaby. NOTE: we do not need to adjust any tests as we already moved all the Tempest tests to volume v3 APIs. Depends-On: https://review.opendev.org/c/openstack/devstack/+/791842 [1] https://wiki.openstack.org/wiki/CinderXenaPTGSummary#Removing_the_Block_Storage_API_v2 Change-Id: I98339f67239cf96d26aa4fa87df692139b36673d
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.