openstack/tempest

History

Lee Yarwood 1bd6059454 compute: Rework attach_volume waiters and cleanup This change reworks both the waiters while attaching a volume and the ordering of the waiters when detaching. This is done to ensure the wait_for_volume_attachment_remove_from_server waiter is called first as this uses the servers client and is able to dump the contents of the instance console when we hit a timeout. The contents of the instance console being incredibly useful to debug issues within the guestOS when detaching devices as seen in bug #. The wait_for_volume_attachment_remove_from_server waiter is also extended to ignore missing Nova volume attachments as this can easily happen if tests have manually detached volumes ahead of the cleanups being called. TODOs are also left to move away from using the volume status to determine when a given volume has been attached and instead use the state of volume attachments both in Nova and Cinder. Related-Bug: #1931702 Change-Id: I8f7986dc6d8689d569b7fba74cca38de4236c6d6		2021-08-06 08:16:02 +00:00
..
api	compute: Rework attach_volume waiters and cleanup	2021-08-06 08:16:02 +00:00
cmd	Merge "Update subunit_describe_calls about new ports"	2021-03-04 21:27:11 +00:00
common	compute: Rework attach_volume waiters and cleanup	2021-08-06 08:16:02 +00:00
hacking	Fix hacking check for service client	2021-04-30 10:32:13 -05:00
lib	Merge "Replace deprecated import of ABCs from collections"	2021-07-29 08:42:16 +00:00
scenario	Add tests for glance unified quotas	2021-07-16 08:11:08 -07:00
services	Remove usage of six	2021-02-18 10:43:57 +08:00
test_discover	Remove usage of six	2021-02-23 00:38:55 +00:00
tests	compute: Rework attach_volume waiters and cleanup	2021-08-06 08:16:02 +00:00
__init__.py
clients.py	Add keystone unified limits client	2021-07-15 07:58:53 -07:00
config.py	Merge "Add test to verify FQDN hostname sanitization"	2021-07-27 00:31:37 +00:00
exceptions.py	Break wait_for_volume_resource_status when error_extending	2019-06-03 15:37:13 +08:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
test.py	Remove usage of six	2021-04-15 09:25:19 +00: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.