aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjose.lausuch <jose.lausuch@ericsson.com>2016-02-24 15:08:38 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-02-24 15:08:38 +0000
commit88243900b0645bf6ea34b8f49a22af439adc839c (patch)
treeaa0f07db73a54c65c9d82c33fd8eb2008c2d5412
parent331f246f2b8be355ecf07e3e207b66e124af3799 (diff)
parent9f02fb0b914b52336d04a5e8e25102a828fe6191 (diff)
Merge "Fix Doc errors detected in opnfv-docs-verify and add license"
-rw-r--r--docs/configguide/index.rst14
-rw-r--r--docs/devguide/index.rst40
-rw-r--r--docs/userguide/index.rst6
-rw-r--r--docs/userguide/introduction.rst3
-rw-r--r--docs/userguide/runfunctest.rst14
-rw-r--r--docs/userguide/troubleshooting.rst3
6 files changed, 44 insertions, 36 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 7519bb85b..e4a04330e 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -187,7 +187,7 @@ provide them to Functest:
Once the credentials are there, they shall be sourced before running the tests::
- source /home/opnfv/functest/conf/openstack.creds
+ source /home/opnfv/functest/conf/openstack.creds
Additional Options
------------------
@@ -196,12 +196,12 @@ In case you need to provide different configuration parameters to Functest (e.g.
commit IDs or branches for the repositories, ...) copy the config_functest.yaml
from the repository to your current directory and run docker with a volume::
- $ wget https://git.opnfv.org/cgit/functest/plain/testcases/config_functest.yaml
- $ cmd1 = "/home/opnfv/repos/functest/docker/prepare_env.sh"
- $ cmd2 = "/home/opnfv/repos/functest/docker/run_tests.sh"
- $ docker run -t -e "INSTALLER_TYPE=fuel" -e "INSTALLER_IP=10.20.0.2" opnfv/functest \
- -v $(pwd)/config_functest.yaml:/home/opnfv/functest/conf/config_functest.yaml \
- "${cmd1} && ${cmd2}"
+ $ wget https://git.opnfv.org/cgit/functest/plain/testcases/config_functest.yaml
+ $ cmd1 = "/home/opnfv/repos/functest/docker/prepare_env.sh"
+ $ cmd2 = "/home/opnfv/repos/functest/docker/run_tests.sh"
+ $ docker run -t -e "INSTALLER_TYPE=fuel" -e "INSTALLER_IP=10.20.0.2" opnfv/functest \
+ -v $(pwd)/config_functest.yaml:/home/opnfv/functest/conf/config_functest.yaml \
+ "${cmd1} && ${cmd2}"
Integration in CI
diff --git a/docs/devguide/index.rst b/docs/devguide/index.rst
index 7f3233c4c..210774be6 100644
--- a/docs/devguide/index.rst
+++ b/docs/devguide/index.rst
@@ -299,10 +299,8 @@ compare the results versus the installers, the scenario or the labs.
You can find more information about the dashboard from Testing Dashboard wiki
page `[3]`_.
-
Overall Architecture
---------------------
-
+====================
The Test result management in Brahmaputra can be summarized as follows::
+-------------+ +-------------+ +-------------+
@@ -344,8 +342,7 @@ per scenario for Brahmaputra release::
This Dashboard consumes the results retrieved thanks to the Test API.
Test API description
---------------------
-
+====================
The Test API is used to declare pods, projects, test cases and test results. An
additional method dashboard has been added to post-process the raw results. The
data model is very basic, 4 objects are created:
@@ -432,8 +429,8 @@ Pods:
| POST | /pods | Declare a new POD |
| | | Content-Type: application/json |
| | | { |
- | | | "name": "pod_foo", |
- | | | "creation_date": "YYYY-MM-DD HH:MM:SS"|
+ | | | "name": "pod_foo", |
+ | | | "creation_date": "YYYY-MM-DD HH:MM:SS" |
| | | } |
+--------+--------------------------+-----------------------------------------+
@@ -450,15 +447,15 @@ Projects:
| POST | /test_projects | Add a new test project |
| | | Content-Type: application/json |
| | | { |
- | | | "name": "project_foo", |
- | | | "description": "whatever you want" |
+ | | | "name": "project_foo", |
+ | | | "description": "whatever you want" |
| | | } |
+--------+--------------------------+-----------------------------------------+
| PUT | /test_projects/{project} | Update a test project |
| | | |
| | | Content-Type: application/json |
| | | { |
- | | | <the field(s) you want to modify> |
+ | | | <the field(s) you want to modify> |
| | | } |
+--------+--------------------------+-----------------------------------------+
| DELETE | /test_projects/{project} | Delete a test project |
@@ -476,17 +473,17 @@ Test cases:
| POST | /test_projects/{project}/| Add a new test case to {project} |
| | cases | Content-Type: application/json |
| | | { |
- | | | "name": "case_foo", |
- | | | "description": "whatever you want" |
- | | | "creation_date": "YYYY-MM-DD HH:MM:SS"|
- | | | "url": "whatever you want" |
+ | | | "name": "case_foo", |
+ | | | "description": "whatever you want" |
+ | | | "creation_date": "YYYY-MM-DD HH:MM:SS" |
+ | | | "url": "whatever you want" |
| | | } |
+--------+--------------------------+-----------------------------------------+
| PUT | /test_projects/{project}?| Modify a test case of {project} |
| | case_name={case} | |
| | | Content-Type: application/json |
| | | { |
- | | | <the field(s) you want to modify> |
+ | | | <the field(s) you want to modify> |
| | | } |
+--------+--------------------------+-----------------------------------------+
| DELETE | /test_projects/{project}/| Delete a test case |
@@ -523,12 +520,12 @@ Test Results:
| POST | /results | Add a new test results |
| | | Content-Type: application/json |
| | | { |
- | | | "project_name": "project_foo", |
- | | | "case_name": "case_foo", |
- | | | "pod_name": "pod_foo", |
- | | | "installer": "installer_foo", |
- | | | "version": "scenario_foo", |
- | | | "details": <your results> |
+ | | | "project_name": "project_foo", |
+ | | | "case_name": "case_foo", |
+ | | | "pod_name": "pod_foo", |
+ | | | "installer": "installer_foo", |
+ | | | "version": "scenario_foo", |
+ | | | "details": <your results> |
| | | } |
+--------+--------------------------+-----------------------------------------+
@@ -587,7 +584,6 @@ You can also reuse a python function defined in functest_utils.py::
% (db_url, case_name, pod_name, version, payload), e
return False
-::
==========
References
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 79620789f..dcfca16e0 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -1,9 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
=========================
OPNFV FUNCTEST user guide
=========================
.. toctree::
- :numbered:
:maxdepth: 2
@@ -385,7 +387,7 @@ The URL of this dashboard is TODO LF
References
==========
-.. _`[1]`: Functest configuration guide URL
+.. _`[1]`: http://artifacts.opnfv.org/functest/docs/configguide/#functional-testing-installation
.. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
.. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
.. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
index 4e4d33c2a..b130fe1cf 100644
--- a/docs/userguide/introduction.rst
+++ b/docs/userguide/introduction.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Overview of the functest suites
===============================
diff --git a/docs/userguide/runfunctest.rst b/docs/userguide/runfunctest.rst
index 364333740..573664acc 100644
--- a/docs/userguide/runfunctest.rst
+++ b/docs/userguide/runfunctest.rst
@@ -1,6 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Executing the functest suites
=============================
+
Manual testing
--------------
@@ -85,8 +89,10 @@ by editing *test_list.txt* file before executing *run_tests.sh* script. This fil
is located in *$repos_dir/functest/testcases/VIM/OpenStack/CI/custom_tests/test_list.txt*
Although *run_tests.sh* provides an easy way to run any test, it is possible to
-do a direct call to the desired test script. For example::
- python $repos_dir/functest/testcases/vPing/vPing.py -d
+do a direct call to the desired test script. For example:
+
+ python $repos_dir/functest/testcases/vPing/vPing.py -d
+
Automated testing
-----------------
@@ -135,8 +141,8 @@ The constraints per test case are defined in the Functest configuration file
scenario: 'onos'
....
-At the end of the Functest environment creation (prepare_env.sh see `[1]`_), a
-file */home/opnfv/functest/conf/testcase-list.txt* is created with the list of
+At the end of the Functest environment creation, a file
+*/home/opnfv/functest/conf/testcase-list.txt* is created with the list of
all the runnable tests.
Functest considers the static constraints as regular expressions and compare them
with the given scenario name.
diff --git a/docs/userguide/troubleshooting.rst b/docs/userguide/troubleshooting.rst
index f669025ff..7cea6e0c3 100644
--- a/docs/userguide/troubleshooting.rst
+++ b/docs/userguide/troubleshooting.rst
@@ -1,3 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
Troubleshooting
===============
@@ -82,7 +84,6 @@ TODO
OpenContrail
^^^^^^^^^^^^
-
Feature
-------