diff --git a/tempest/README.rst b/tempest/README.rst index 18c7cf38ee..b840fba25c 100644 --- a/tempest/README.rst +++ b/tempest/README.rst @@ -23,9 +23,8 @@ 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 ---- +:ref:`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 @@ -39,8 +38,8 @@ projects themselves, possibly as functional tests in their unit test frameworks. -cli ---- +:ref:`cli_field_guide` +---------------------- CLI tests use the openstack CLI to interact with the OpenStack cloud. CLI testing in unit tests is somewhat difficult because unlike @@ -49,8 +48,8 @@ instantiate. Tempest seems like a logical place for this, as it prereqs having a running OpenStack cloud. -scenario --------- +:ref:`scenario_field_guide` +--------------------------- Scenario tests are complex "through path" tests for OpenStack functionality. They are typically a series of steps where complicated @@ -59,16 +58,16 @@ state requiring multiple services is set up exercised, and torn down. Scenario tests can and should use the OpenStack python clients. -stress ------- +:ref:`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. -thirdparty ----------- +:ref:`third_party_field_guide` +----------------------------- Many openstack components include 3rdparty API support. It is completely legitimate for Tempest to include tests of 3rdparty APIs, diff --git a/tempest/api/README.rst b/tempest/api/README.rst index 9eac19d213..91e6ad6b99 100644 --- a/tempest/api/README.rst +++ b/tempest/api/README.rst @@ -1,3 +1,5 @@ +.. _api_field_guide: + Tempest Field Guide to API tests ================================ diff --git a/tempest/cli/README.rst b/tempest/cli/README.rst index dcd940b10b..bc180843d4 100644 --- a/tempest/cli/README.rst +++ b/tempest/cli/README.rst @@ -1,3 +1,5 @@ +.. _cli_field_guide: + Tempest Field Guide to CLI tests ================================ diff --git a/tempest/scenario/README.rst b/tempest/scenario/README.rst index 835ba994f7..5a287d692f 100644 --- a/tempest/scenario/README.rst +++ b/tempest/scenario/README.rst @@ -1,3 +1,5 @@ +.. _scenario_field_guide: + Tempest Field Guide to Scenario tests ===================================== diff --git a/tempest/stress/README.rst b/tempest/stress/README.rst index 0a636798e8..4f1f56cbdf 100644 --- a/tempest/stress/README.rst +++ b/tempest/stress/README.rst @@ -1,3 +1,5 @@ +.. _stress_field_guide: + Tempest Field Guide to Stress Tests =================================== diff --git a/tempest/tests/README.rst b/tempest/tests/README.rst index 33d321feda..cb592e5181 100644 --- a/tempest/tests/README.rst +++ b/tempest/tests/README.rst @@ -1,3 +1,5 @@ +.. _unit_tests.rst: + Tempest Field Guide to Unit tests ================================= diff --git a/tempest/thirdparty/README.rst b/tempest/thirdparty/README.rst index 53cb54b785..b0bfdf7dd6 100644 --- a/tempest/thirdparty/README.rst +++ b/tempest/thirdparty/README.rst @@ -1,3 +1,5 @@ +.. _third_party_field_guide: + Tempest Field Guide to Third Party API tests ============================================