diff options
| -rw-r--r-- | docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst | 10 | ||||
| -rw-r--r-- | docs/testing/user/ovpaddendum/index.rst | 12 | ||||
| -rw-r--r-- | docs/testing/user/userguide/testing_guide.rst | 11 |
3 files changed, 29 insertions, 4 deletions
diff --git a/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst b/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst index 3acc6ee8..58b9283f 100644 --- a/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst +++ b/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst @@ -3,9 +3,11 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Ericsson and others -============================================================== -Exemption Process - Disabling Strict API Validation in Tempest -============================================================== +.. _dovetail-exemption_process_api_response_validation: + +========================================== +Disabling Strict API Validation in Tempest +========================================== .. toctree:: :maxdepth: 2 @@ -136,7 +138,7 @@ Exemption process for additional properties in API responses in the OVP The details of the exemption process for disabling strict validation of API responses is as follows: -#. The Dovetail tool provides a new command line option "--non-strict-api" for +#. The Dovetail tool provides a new command line option "--no-api-validation" for disabling strict API validation. This option needs to be explicitly given on the command line to disable strict API validation. If this command line option is omitted, the default behavior (i.e., strict API validation) is diff --git a/docs/testing/user/ovpaddendum/index.rst b/docs/testing/user/ovpaddendum/index.rst index a78d1997..054a3f11 100644 --- a/docs/testing/user/ovpaddendum/index.rst +++ b/docs/testing/user/ovpaddendum/index.rst @@ -414,6 +414,18 @@ documented and accepted by the reviewers. Applicants who choose to run the optional test cases can include the results of the optional test cases to highlight the additional compliance. + +Exemption from strict API response validation +============================================= + +Vendors of commercial NFVI products may have extended the Nova API to support +proprietary add-on features. These additions can cause Nova Tempest API tests +to fail due to unexpected data in API responses. In order to resolve this +transparently in the context of OVP, a temporary exemption process has been +created. More information on the exemption can be found in section +:ref:`dovetail-exemption_process_api_response_validation`. + + .. References .. _`OVP Governance Guidelines`: https://www.opnfv.org/wp-content/uploads/sites/12/2018/01/OVP-Governance-Guidelines-1.0.1-012218.pdf .. _`Pharos specification`: https://wiki.opnfv.org/display/pharos/Pharos+Specification diff --git a/docs/testing/user/userguide/testing_guide.rst b/docs/testing/user/userguide/testing_guide.rst index 54fa294b..3fc74028 100644 --- a/docs/testing/user/userguide/testing_guide.rst +++ b/docs/testing/user/userguide/testing_guide.rst @@ -553,6 +553,17 @@ arguments 'ipv6', 'sdnvpn' and 'tempest'. $ dovetail run --testarea mandatory +Dovetail allows the user to disable strict API response validation implemented +by Nova Tempest tests by means of the ``--no-api-validation`` option. Usage of +this option is only advisable if the SUT returns Nova API responses that +contain additional attributes. For more information on this command line option +and its intended usage, refer to +:ref:`dovetail-exemption_process_api_response_validation`. + +.. code-block:: bash + + $ dovetail run --no-api-validation + By default, results are stored in local files on the Test Host at ``$DOVETAIL_HOME/results``. Each time the 'dovetail run' command is executed, the results in the aforementioned directory are overwritten. To create a singular compressed result file for upload to the OVP portal or |