summaryrefslogtreecommitdiffstats
path: root/docs/testing
diff options
context:
space:
mode:
authorGeorg Kunz <georg.kunz@ericsson.com>2018-09-06 10:45:01 +0200
committerGeorg Kunz <georg.kunz@ericsson.com>2018-09-17 12:30:25 +0200
commita18e2b0d45c631709e457530f6f9d0b52f552156 (patch)
treef66ee65b5293d9279270970c1d27f94e8fac7aca /docs/testing
parent60f1c35c294d5d94a862db348315f8f3b9f870ba (diff)
Adapting local docs build and remove build warnings
The OPNFV docs project will remove its submodules and enable local docs builds. This patch prepares the Dovetail repo according to the official transition guide: https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html This patch also applies syntactical changes which eliminate the sphinx doc build warnings. Change-Id: Ief8fd2d1c3e39b232d214a9ab392879ee4a492c8 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
Diffstat (limited to 'docs/testing')
-rw-r--r--docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst2
-rw-r--r--docs/testing/user/reviewerguide/index.rst2
-rw-r--r--docs/testing/user/systempreparation/index.rst2
-rw-r--r--docs/testing/user/testspecification/highavailability/index.rst7
-rw-r--r--docs/testing/user/testspecification/index.rst42
-rw-r--r--docs/testing/user/testspecification/stress/index.rst4
-rw-r--r--docs/testing/user/testspecification/tempest_identity_v3/index.rst6
-rw-r--r--docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst8
-rw-r--r--docs/testing/user/testspecification/tempest_network_scenario/index.rst (renamed from docs/testing/user/testspecification/tempest_network/network_scenario.rst)0
-rw-r--r--docs/testing/user/testspecification/tempest_trunk_ports/index.rst4
-rw-r--r--docs/testing/user/userguide/cli_reference.rst2
11 files changed, 41 insertions, 38 deletions
diff --git a/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst b/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst
index b446611..aaac6c4 100644
--- a/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst
+++ b/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst
@@ -89,7 +89,7 @@ Example: additional attributes per VM for HA policy
---------------------------------------------------
This fictional example showcases the presence of an additional attribute in an
-API response. The example shows that the 'server details', i.e. the VM
+API response. The example shows that the 'server details' [3]_, i.e. the VM
metadata, includes an additional attribute 'ha-policy' which is used to
associate high-availability policies with a VM instance. This attribute is
utilized by a proprietary add-on component to manage VM migration and recovery
diff --git a/docs/testing/user/reviewerguide/index.rst b/docs/testing/user/reviewerguide/index.rst
index 25dc2f6..dd9456c 100644
--- a/docs/testing/user/reviewerguide/index.rst
+++ b/docs/testing/user/reviewerguide/index.rst
@@ -155,7 +155,7 @@ The bottlenecks log must contain the 'SUCCESS' result as shown in following exam
Functest logs opens an html page that lists all test cases as shown in figure 7. All test cases must have run
successfuly.
-.. image:: images/ovp_log_functest_image.png
+.. image:: images/ovp_log_files_functest_image.png
:align: center
:scale: 100%
diff --git a/docs/testing/user/systempreparation/index.rst b/docs/testing/user/systempreparation/index.rst
index 4e10114..5bc150a 100644
--- a/docs/testing/user/systempreparation/index.rst
+++ b/docs/testing/user/systempreparation/index.rst
@@ -52,7 +52,7 @@ The SUT is expected to be connected with high performance networks. These networ
are expected in the SUT:
- A management network by which the Test Node can reach all identity, image, network,
-and compute services in the SUT
+ and compute services in the SUT
- A data network that supports the virtual network capabilities and data path testing
Additional networks, such as Light Out Management or storage networks, may be
diff --git a/docs/testing/user/testspecification/highavailability/index.rst b/docs/testing/user/testspecification/highavailability/index.rst
index e024b1f..dd98ba9 100644
--- a/docs/testing/user/testspecification/highavailability/index.rst
+++ b/docs/testing/user/testspecification/highavailability/index.rst
@@ -810,9 +810,10 @@ For second monitor is used a process monitor and the main purpose is to watch
whether the database processes on the host node are killed properly.
Therefore, in this test case, there are two metrics:
-- service_outage_time, which indicates the maximum outage time (seconds)
+
+* service_outage_time, which indicates the maximum outage time (seconds)
of the specified OpenStack command request
-- process_recover_time, which indicates the maximum time (seconds) from the
+* process_recover_time, which indicates the maximum time (seconds) from the
process being killed to recovered
Test execution
@@ -1056,7 +1057,7 @@ Process recovery is verified by checking the existence of processes of
Test execution
''''''''''''''
* Test action 1: Two host VMs are booted, these two hosts are in two different
-networks, the networks are connected by a virtual router.
+ networks, the networks are connected by a virtual router.
* Test action 2: Start monitors: each monitor will run with independently process.
The monitor info will be collected.
* Test action 3: Do attacker: Connect the host through SSH, and then execute the kill
diff --git a/docs/testing/user/testspecification/index.rst b/docs/testing/user/testspecification/index.rst
index fff07ee..9fff468 100644
--- a/docs/testing/user/testspecification/index.rst
+++ b/docs/testing/user/testspecification/index.rst
@@ -25,24 +25,24 @@ All tests areas addressed in the OVP are covered in the following test
specification documents.
.. toctree::
- :maxdepth: 1
-
- ./highavailability/index.rst
- ./tempest_osinterop/index.rst
- ./vping/index.rst
- ./tempest_trunk_ports/index.rst
- ./security_patrole/index.rst
- ./tempest_ipv6/index.rst
- ./tempest_network_security/index.rst
- ./tempest_network/network_scenario.rst
- ./tempest_vm_lifecycle/index.rst
- ./tempest_multi_node_scheduling/index.rst
- ./vpn/index.rst
- ./vnf/index.rst
- ./stress/index.rst
- ./snaps_smoke/index.rst
- ./tempest_compute/index.rst
- ./tempest_identity_v3/index.rst
- ./tempest_image/index.rst
- ./tempest_network/index.rst
- ./tempest_volume/index.rst \ No newline at end of file
+ :maxdepth: 2
+
+ highavailability/index
+ security_patrole/index
+ snaps_smoke/index
+ stress/index
+ tempest_compute/index
+ tempest_identity_v3/index
+ tempest_image/index
+ tempest_ipv6/index
+ tempest_multi_node_scheduling/index
+ tempest_network_api/index
+ tempest_network_scenario/index
+ tempest_network_security/index
+ tempest_osinterop/index
+ tempest_trunk_ports/index
+ tempest_vm_lifecycle/index
+ tempest_volume/index
+ vnf/index
+ vping/index
+ vpn/index
diff --git a/docs/testing/user/testspecification/stress/index.rst b/docs/testing/user/testspecification/stress/index.rst
index 41c84e7..74961fd 100644
--- a/docs/testing/user/testspecification/stress/index.rst
+++ b/docs/testing/user/testspecification/stress/index.rst
@@ -18,7 +18,7 @@ the SUT is able to absorb failures while providing an acceptable level of servic
References
-================
+==========
This test area references the following specifications, definitions and reviews:
@@ -96,7 +96,7 @@ Basic test flow execution description and pass/fail criteria
------------------------------------------------------------
Methodology for validating capacity of the SUT
-'''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''
Validating capacity of the SUT based on life-cycle ping test generally involves
2 subtests which provides secondary validation for the SUT furnishing users with
reliable capacity without being crushed.
diff --git a/docs/testing/user/testspecification/tempest_identity_v3/index.rst b/docs/testing/user/testspecification/tempest_identity_v3/index.rst
index e5e8f90..bb60b20 100644
--- a/docs/testing/user/testspecification/tempest_identity_v3/index.rst
+++ b/docs/testing/user/testspecification/tempest_identity_v3/index.rst
@@ -31,7 +31,7 @@ These runtime operations may include that create, list, verify and delete:
References
==========
-`Identity API v3.0 <https://developer.openstack.org/api-ref/identity/v3/index.html.`_
+`Identity API v3.0 <https://developer.openstack.org/api-ref/identity/v3/index.html>`_
System Under Test (SUT)
=======================
@@ -52,7 +52,7 @@ OVP test suite.
- `Create, Get, Update and Delete Credentials <https://github.com/openstack/tempest/blob/12.2.0/tempest/api/identity/admin/v3/test_credentials.py#L21>`_
- tempest.api.identity.admin.v3.test_credentials.CredentialsTestJSON.test_credentials_create_get_update_delete
-- `Create and Verify Domain <https://github.com/openstack/tempest/blob/12.2.0/tempest/api/identity/admin/v3/test_domains.py#L159>`_
+- `Create and Verify Domain <https://github.com/openstack/tempest/blob/12.2.0/tempest/api/identity/admin/v3/test_domains.py#L159>`_
- tempest.api.identity.admin.v3.test_domains.DefaultDomainTestJSON.test_default_domain_exists
- `Create, Update and Delete Domain <https://github.com/openstack/tempest/blob/12.2.0/tempest/api/identity/admin/v3/test_domains.py>`_
@@ -80,4 +80,4 @@ OVP test suite.
- tempest.api.identity.admin.v3.test_trusts.TrustsV3TestJSON.test_get_trusts_all
- `List API Versions <https://github.com/openstack/tempest/blob/18.0.0/tempest/api/identity/v3/test_api_discovery.py>`_
- - tempest.api.identity.v3.test_api_discovery.TestApiDiscovery.test_list_api_versions \ No newline at end of file
+ - tempest.api.identity.v3.test_api_discovery.TestApiDiscovery.test_list_api_versions
diff --git a/docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst b/docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst
index 7900532..60a5633 100644
--- a/docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst
+++ b/docs/testing/user/testspecification/tempest_ipv6/ipv6_api.rst
@@ -161,10 +161,12 @@ Test preconditions
------------------
1. The SUT has at least one external network.
-2. In the external network list, there is no network without external router, i.e.,
-all networks in this list are with external router.
+
+2. In the external network list, there is no network without external router,
+ i.e., all networks in this list are with external router.
+
3. There is one external network with configured public network id and there is
-no subnet on this network
+ no subnet on this network
Basic test flow execution description and pass/fail criteria
------------------------------------------------------------
diff --git a/docs/testing/user/testspecification/tempest_network/network_scenario.rst b/docs/testing/user/testspecification/tempest_network_scenario/index.rst
index 6c17247..6c17247 100644
--- a/docs/testing/user/testspecification/tempest_network/network_scenario.rst
+++ b/docs/testing/user/testspecification/tempest_network_scenario/index.rst
diff --git a/docs/testing/user/testspecification/tempest_trunk_ports/index.rst b/docs/testing/user/testspecification/tempest_trunk_ports/index.rst
index 0507cd9..fd60a32 100644
--- a/docs/testing/user/testspecification/tempest_trunk_ports/index.rst
+++ b/docs/testing/user/testspecification/tempest_trunk_ports/index.rst
@@ -36,7 +36,7 @@ test. For detailed information on the individual steps and assertions performed
by the tests, review the Python source code accessible via the following links:
- `Neutron Trunk API tests <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk.py>`_
-- `Neutron Trunk API negative tests <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_details.py>`_
+- `Neutron Trunk API trunk details <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_details.py>`_
- `Neutron Trunk API negative tests <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_negative.py>`_
@@ -117,7 +117,7 @@ These group of tests comprise negative tests which verify that invalid operation
are handled correctly by the system under test.
Implementation:
-`TrunkTestJSON <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_negative.py#L24>`_
+`TrunkTestNegative <https://github.com/openstack/neutron/blob/stable/pike/neutron/tests/tempest/api/test_trunk_negative.py#L24>`_
- neutron.tests.tempest.api.test_trunk_negative.TrunkTestJSON.test_add_subport_duplicate_segmentation_details
- neutron.tests.tempest.api.test_trunk_negative.TrunkTestJSON.test_add_subport_passing_dict
diff --git a/docs/testing/user/userguide/cli_reference.rst b/docs/testing/user/userguide/cli_reference.rst
index 891617a..97eccff 100644
--- a/docs/testing/user/userguide/cli_reference.rst
+++ b/docs/testing/user/userguide/cli_reference.rst
@@ -72,7 +72,7 @@ Commands List
| dovetail run --optional --testsuite <test_suite_name> | Run Dovetail with all optional test cases within test suite <test_suite_name> |
| | |
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
-| dovetail run --debug | -d | Run Dovetail with debug mode and show all debug logs |
+| dovetail run --debug | -d | Run Dovetail with debug mode and show all debug logs |
| | |
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| dovetail run --offline | Run Dovetail offline, use local docker images instead of download online |