openstack/tempest
Code Issues Proposed changes

Add documentation to HACKING.rst describing idempotent_id

Browse Source 
All Tempest tests require an idempotent_id decorator to uniquely
identify test functionlity. Previously this requirement was not
documented, leading to some confusion regarding its use and
implemtation. This patch includes documentation in the HACKING.rst
file that describes the purpose, format, and tool for working
with idempotent_id metadata.

Change-Id: I569bb68adc498f428664ed0b49d5943a353124b9
This commit is contained in:
Chris Hoge 2015-07-28 14:19:53 -05:00
parent 74647862be
commit 0e000ed1dd
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
HACKING.rst
View File

@ -314,6 +314,39 @@ example of this would be::
* Check written content in the instance booted from snapshot
"""
Test Identification with Idempotent ID
--------------------------------------
Every function that provides a test must have an ``idempotent_id`` decorator
that is a unique ``uuid-4`` instance. This ID is used to complement the fully
qualified test name and track test funcionality through refactoring. The
format of the metadata looks like::
@test.idempotent_id('585e934c-448e-43c4-acbf-d06a9b899997')
def test_list_servers_with_detail(self):
# The created server should be in the detailed list of all servers
...
Tempest includes a ``check_uuid.py`` tool that will test for the existence
and uniqueness of idempotent_id metadata for every test. By default the
tool runs against the Tempest package by calling::
python check_uuid.py
It can be invoked against any test suite by passing a package name::
python check_uuid.py --package <package_name>
Tests without an ``idempotent_id`` can be automatically fixed by running
the command with the ``--fix`` flag, which will modify the source package
by inserting randomly generated uuids for every test that does not have
one::
python check_uuid.py --fix
The ``check_uuid.py`` tool is used as part of the tempest gate job
to ensure that all tests have an ``idempotent_id`` decorator.
Branchless Tempest Considerations
---------------------------------