From f22e6ec651f6b76bff1a4e6c43f0bcf5ad0f7421 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Sat, 3 Nov 2018 17:51:18 -0400 Subject: [PATCH] docs: Include information about the list of supported projects This documentation is included in HACKING at the top to let newcomers know that Tempest's testing scope is confined to the following projects: * Cinder * Glance * Keystone * Neutron * Nova * Swift The user is directed to [0] for additional Tempest plugin repos where they can add their tests for other projects. Note that [0] currently appears to not be rendering correctly, but this is an unrelated issue. [0] https://docs.openstack.org/tempest/latest/plugin-registry.html#detected-plugins Change-Id: I800a3f6ac4c347d4322574f649cb052070127db6 --- HACKING.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/HACKING.rst b/HACKING.rst index e767b253fe..c9d21500f7 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -35,6 +35,30 @@ Test Data/Configuration - Clean up test data at the completion of each test - Use configuration files for values that will vary by environment +Supported OpenStack Components +------------------------------ + +Tempest's :ref:`library` and :ref:`plugin interface ` can be +leveraged to support integration testing for virtually any OpenStack component. + +However, Tempest only offers **in-tree** integration testing coverage for the +following components: + +* Cinder +* Glance +* Keystone +* Neutron +* Nova +* Swift + +Historically, Tempest offered in-tree testing for other components as well, but +since the introduction of the `External Plugin Interface`_, Tempest's in-tree +testing scope has been limited to the projects above. Integration tests for +projects not included above should go into one of the +`relevant plugin projects`_. + +.. _External Plugin Interface: https://specs.openstack.org/openstack/qa-specs/specs/tempest/implemented/tempest-external-plugin-interface.html +.. _relevant plugin projects: https://docs.openstack.org/tempest/latest/plugin-registry.html#detected-plugins Exception Handling ------------------