summaryrefslogtreecommitdiffstats
path: root/docs/testing/developer/devguide/index.rst
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2018-04-04 05:45:36 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2018-04-04 20:15:45 +0200
commitd5aa5525f02c79a47504823eeb6e77496d6dbbf4 (patch)
tree4a0ed6123c8fd1ea641bd29d2dfe898132188e12 /docs/testing/developer/devguide/index.rst
parentfdc6191e3562b4ec327d899cd1a4c395ac1734ba (diff)
Fix Functest Developer Guide
It allows building this documentation via tox. rst files are now checked via doc8. Change-Id: I4f45dc2b6657466b05e7ceec60a751656552584e Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> (cherry picked from commit 1f0a0085222337691e8209851cac4ef57333a064)
Diffstat (limited to 'docs/testing/developer/devguide/index.rst')
-rw-r--r--docs/testing/developer/devguide/index.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst
index 19a1bdcb8..1812a4cb5 100644
--- a/docs/testing/developer/devguide/index.rst
+++ b/docs/testing/developer/devguide/index.rst
@@ -1,4 +1,3 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
************************
@@ -109,11 +108,12 @@ The main internal test cases are in the opnfv_tests subfolder of the
repository, the internal test cases can be grouped by domain:
* sdn: odl, odl_netvirt, odl_fds
- * openstack: api_check, connection_check, snaps_health_check, vping_ssh, vping_userdata, tempest_*, rally_*
+ * openstack: api_check, connection_check, snaps_health_check, vping_ssh,
+ vping_userdata, tempest_*, rally_*
* vnf: cloudify_ims
-If you want to create a new test case you will have to create a new folder under
-the testcases directory (See next section for details).
+If you want to create a new test case you will have to create a new folder
+under the testcases directory (See next section for details).
Functest external test cases
============================
@@ -157,10 +157,10 @@ Functest framework
Functest is a framework.
-Historically Functest is released as a docker file, including tools, scripts and
-a CLI to prepare the environment and run tests.
-It simplifies the integration of external test suites in CI pipeline and provide
-commodity tools to collect and display results.
+Historically Functest is released as a docker file, including tools, scripts
+and a CLI to prepare the environment and run tests.
+It simplifies the integration of external test suites in CI pipeline and
+provide commodity tools to collect and display results.
Since Colorado, test categories also known as **tiers** have been created to
group similar tests, provide consistent sub-lists and at the end optimize
@@ -250,8 +250,8 @@ In order to simplify the creation of test cases, Functest develops also some
functions that are used by internal test cases.
Several features are supported such as logger, configuration management and
Openstack capabilities (tacker,..).
-These functions can be found under <repo>/functest/utils and can be described as
-follows::
+These functions can be found under <repo>/functest/utils and can be described
+as follows::
functest/utils/
|-- config.py
@@ -262,8 +262,8 @@ follows::
|-- openstack_tacker.py
`-- openstack_utils.py
-It is recommended to use the SNAPS-OO library for deploying OpenStack instances.
-SNAPS `[4]`_ is an OPNFV project providing OpenStack utils.
+It is recommended to use the SNAPS-OO library for deploying OpenStack
+instances. SNAPS `[4]`_ is an OPNFV project providing OpenStack utils.
TestAPI