Merge "Add timing decorator utility"

[functest.git] / docs / devguide / index.rst

diff --git a/docs/devguide/index.rst b/docs/devguide/index.rst
index 6b98437..6b3e1f0 100644 (file)
--- a/docs/devguide/index.rst
+++ b/docs/devguide/index.rst
@@ -144,6 +144,7 @@ the test results from CI:
 
 
  http://testresults.opnfv.org/test/swagger/spec.html
+
  Authentication: opnfv/api@opnfv
 
 Any test project running on any lab integrated in CI can push the
@@ -249,12 +250,16 @@ Results::
     "build_tag": <such as "jenkins-functest-fuel-baremetal-daily-master-108">,
     "scenario": <Scenario on which the test was executed>,
     "criteria": <PASS or FAILED>,
-    "trust_indicator": <0~1>
+    "trust_indicator": {
+                        "current": 0,
+                        "histories": []
+                       }
   }
 
 The API can described as follows. For detailed information, please go to
 
  http://testresults.opnfv.org/test/swagger/spec.html
+
  Authentication: opnfv/api@opnfv
 
 Please notes that POST/DELETE/PUT operations for test or study purpose via
@@ -475,6 +480,9 @@ Dashboard url: http://testresults.opnfv.org/kibana_dashboards/
 
 Credentials for a guest account: opnfvuser/kibana
 
+A script has been developped to build elasticsearch data set. This
+script can be found in `[16]`_.
+
 
 Automatic reporting
 ===================
@@ -511,8 +519,14 @@ corresponding to this scenario.
  +---------------------+---------+---------+---------+---------+
  | promise             |         |         |    X    |    X    |
  +---------------------+---------+---------+---------+---------+
+ | doctor              |    X    |         |    X    |         |
+ +---------------------+---------+---------+---------+---------+
  | security_scan       |    X    |         |         |         |
  +---------------------+---------+---------+---------+---------+
+ | parser              |         |         |    X    |         |
+ +---------------------+---------+---------+---------+---------+
+ | moon                |         |    X    |         |         |
+ +---------------------+---------+---------+---------+---------+
  | copper              |    X    |         |         |    X    |
  +---------------------+---------+---------+---------+---------+
 
@@ -520,7 +534,7 @@ All the testcases listed in the table are runnable on
 os-odl_l2-nofeature scenarios.
 If no result is available or if all the results are failed, the test
 case get 0 point.
-If it was succesfull at least once but no anymore during the 4 runs,
+If it was succesfull at least once but not anymore during the 4 runs,
 the case get 1 point (it worked once).
 If at least 3 of the last 4 runs were successful, the case get 2 points.
 If the last 4 runs of the test are successful, the test get 3 points.
@@ -649,8 +663,6 @@ bgpvpn scenarios::
         scenario: '(ocl)|(nosdn)|^(os-odl)((?!bgpvpn).)*$'
 
 
-
-
 How to write and check constaint regex?
 =======================================
 
@@ -773,7 +785,7 @@ Dockerfile
 This file lists the repositories (internal or external) to be cloned in
 the Functest container. You can also add external packages::
 
- RUN git clone https://gerrit.opnfv.org/gerrit/<your project> ${repos_dir}/<your project>
+ RUN git clone https://gerrit.opnfv.org/gerrit/<your project> ${REPOS_DIR}/<your project>
 
 testcases.yaml
 --------------
@@ -914,15 +926,13 @@ _`[14]`: https://git.opnfv.org/cgit/releng/tree/jjb/functest/functest-daily.sh
 
 _`[15]`: https://git.opnfv.org/cgit/releng/tree/utils/test/result_collection_api/README.rst
 
-OPNFV main site: opnfvmain_.
+_`[16]`: https://git.opnfv.org/cgit/releng/tree/utils/test/scripts/mongo_to_elasticsearch.py
 
-OPNFV functional test page: opnfvfunctest_.
+OPNFV main site: http://www.opnfv.org
 
-IRC support chan: #opnfv-functest
+OPNFV functional test page: https://wiki.opnfv.org/opnfv_functional_testing
 
-_opnfvmain: http://www.opnfv.org
-
-_opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
+IRC support chan: #opnfv-functest
 
 _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html