openstack
/
tempest
Code Issues Proposed changes

fix: Re-clarify unit test REVIEWING documentation 

This patch set corrects some misleading documentation under "Unit
Tests" section in REVIEWING.rst.

It currently claims that service clients do not require unit test
coverage -- but this is false. This is because Tempest now places
all of its service clients in tempest.lib. And as per
https://docs.openstack.org/tempest/latest/library.html#testing it
is required to add unit tests for all service client interfaces.

Thus this makes the documentation language clear that service clients
require unit tests.

Change-Id: Iac6ba71496e20b6724a6a2ca4ec2beb42f2a58c8
This commit is contained in:
Felipe Monteiro 2018-09-21 20:32:56 +01:00
parent 7e3c936898
commit a7365ae219
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
REVIEWING.rst
View File

@ -36,8 +36,11 @@ Unit Tests
For any change that adds new functionality to either common functionality or an
out-of-band tool unit tests are required. This is to ensure we don't introduce
future regressions and to test conditions which we may not hit in the gate runs.
Tests, and service clients aren't required to have unit tests since they should
be self verifying by running them in the gate.
API and scenario tests aren't required to have unit tests since they should
be self-verifying by running them in the gate. All service clients, on the
other hand, `must have`_ unit tests, as they belong to ``tempest/lib``.
.. _must have: https://docs.openstack.org/tempest/latest/library.html#testing
API Stability