<commit_before>============================
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.

:ref:`api_field_guide`<commit_msg>Fix directory tree appearance in document<commit_after>============================
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.

 .. code-block:: console

    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.

:ref:`api_field_guide`
{'fraction_non_alphanumeric': 0.09391965255157438, 'fraction_numerical': 0.0, 'mean_word_length': 4.420588235294118, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3173941', 'n_tokens_mistral': 441, 'n_tokens_neox': 428, 'n_words': 250}