summaryrefslogtreecommitdiffstats
path: root/docs/testing
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-11-09 18:46:18 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-11-09 18:46:18 +0000
commit5e9c1775e3c52258f5a230358c18d5fbfa949401 (patch)
tree659a84ba9183d45a782e049885fa8260dc3d9764 /docs/testing
parentc85a2be531eda41e3a634de67feb7ab49ac2397a (diff)
parente096c7fb3fd1c43dbf6588ced287ece1db7d1350 (diff)
Merge "Fix minor Documentation Formatting Errors"
Diffstat (limited to 'docs/testing')
-rw-r--r--docs/testing/developer/devguide/dev-guide.rst24
-rw-r--r--docs/testing/ecosystem/energy-monitoring.rst14
-rw-r--r--docs/testing/ecosystem/overview.rst13
-rw-r--r--docs/testing/testing-user.rst2
4 files changed, 28 insertions, 25 deletions
diff --git a/docs/testing/developer/devguide/dev-guide.rst b/docs/testing/developer/devguide/dev-guide.rst
index 50ddf3ad3..69058f26b 100644
--- a/docs/testing/developer/devguide/dev-guide.rst
+++ b/docs/testing/developer/devguide/dev-guide.rst
@@ -138,11 +138,11 @@ Code quality
It is recommended to control the quality of the code of the testing projects,
and more precisely to implement some verifications before any merge:
- * pep8
- * pylint
- * unit tests (python 2.7)
- * unit tests (python 3.5)
+* pep8
+* pylint
+* unit tests (python 2.7)
+* unit tests (python 3.5)
The code of the test project must be covered by unit tests. The coverage
shall be reasonable and not decrease when adding new features to the framework.
@@ -295,16 +295,17 @@ each test iteration):
* VNF scale out/up tests (also plan to measure storage usage simultaneously): https://wiki.opnfv.org/pages/viewpage.action?pageId=12390101
* Life-cycle event with throughputs (measure NFVI to support concurrent
- network usage from different VM pairs):
- https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Baseline+Stress+Test+Case+for+Bottlenecks+E+Release
+ network usage from different VM pairs):
+ https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Baseline+Stress+Test+Case+for+Bottlenecks+E+Release
In OPNFV E release, we also plan to do **long duration testing** over OS Ocata.
A separate CI pipe testing OPNFV XCI (OSA) is proposed to accomplish the job.
We have applied specific pod for the testing.
Proposals and details are listed below:
- * https://wiki.opnfv.org/display/testing/Euphrates+Testing+needs
- * https://wiki.opnfv.org/download/attachments/2926539/testing%20evolution%20v1_4.pptx?version=1&modificationDate=1503937629000&api=v2
- * https://wiki.opnfv.org/download/attachments/2926539/Testing%20over%20Long%20Duration%20POD.pptx?version=2&modificationDate=1502943821000&api=v2
+
+* https://wiki.opnfv.org/display/testing/Euphrates+Testing+needs
+* https://wiki.opnfv.org/download/attachments/2926539/testing%20evolution%20v1_4.pptx?version=1&modificationDate=1503937629000&api=v2
+* https://wiki.opnfv.org/download/attachments/2926539/Testing%20over%20Long%20Duration%20POD.pptx?version=2&modificationDate=1502943821000&api=v2
The long duration testing is supposed to be started when OPNFV E release is
published.
@@ -317,7 +318,7 @@ How TOs
=======
Where can I find information on the different test projects?
-===========================================================
+============================================================
On http://docs.opnfv.org! A section is dedicated to the testing projects. You
will find the overview of the ecosystem and the links to the project documents.
@@ -376,8 +377,9 @@ Click on *Spec*, the list of available methods must be displayed.
:alt: Testing Group Test API swagger
For the declaration of a new project use the POST /api/v1/projects method.
+
For the declaration of new test cases in an existing project, use the POST
- /api/v1/projects/{project_name}/cases method
+/api/v1/projects/{project_name}/cases method
.. figure:: ../../../images/CreateCase.png
:align: center
diff --git a/docs/testing/ecosystem/energy-monitoring.rst b/docs/testing/ecosystem/energy-monitoring.rst
index fa1f28214..0c2cd35a4 100644
--- a/docs/testing/ecosystem/energy-monitoring.rst
+++ b/docs/testing/ecosystem/energy-monitoring.rst
@@ -35,10 +35,10 @@ The energy monitoring system in based on 3 software components:
* Power info collector: poll server to collect instantaneous power consumption information
* Energy recording API + influxdb: On one leg receive servers consumption and
- on the other, scenarios notfication. It then able to establish te correlation
- between consumption and scenario and stores it into a time-series database (influxdb)
+ on the other, scenarios notfication. It then able to establish te correlation
+ between consumption and scenario and stores it into a time-series database (influxdb)
* Python SDK: A Python SDK using decorator to send notification to Energy
- recording API from testcases scenarios
+ recording API from testcases scenarios
Power Info Collector
--------------------
@@ -66,7 +66,7 @@ Redfish API has been successfully tested on:
* HP
* Dell
* Huawei (E9000 class servers used in OPNFV Community Labs are IPMI 2.0
- compliant and use Redfish login Interface through Browsers supporting JRE1.7/1.8)
+ compliant and use Redfish login Interface through Browsers supporting JRE1.7/1.8)
Several test campaigns done with physical Wattmeter showed that IPMI results
were notvery accurate but RedFish were. So if Redfish is available, it is
@@ -184,11 +184,11 @@ with
| Parameter name | Description |
+===========================+============================================+
| admin-influx-user-name | Influx user with admin grants to create |
-|---------------------------+--------------------------------------------+
++---------------------------+--------------------------------------------+
| admin-password | Influx password to set to admin user |
-|---------------------------+--------------------------------------------+
++---------------------------+--------------------------------------------+
| readonly-influx-user-name | Influx user with readonly grants to create |
-|---------------------------+--------------------------------------------+
++---------------------------+--------------------------------------------+
| user-password | Influx password to set to readonly user |
+---------------------------+--------------------------------------------+
diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst
index ef7705b6f..709989a92 100644
--- a/docs/testing/ecosystem/overview.rst
+++ b/docs/testing/ecosystem/overview.rst
@@ -188,11 +188,12 @@ The Test Database
-----------------
A Mongo DB Database was introduced for the Brahmaputra release.
The following collections are declared in this database:
- * pods: the list of pods used for production CI
- * projects: the list of projects providing test cases
- * test cases: the test cases related to a given project
- * results: the results of the test cases
- * scenarios: the OPNFV scenarios tested in CI
+
+* pods: the list of pods used for production CI
+* projects: the list of projects providing test cases
+* test cases: the test cases related to a given project
+* results: the results of the test cases
+* scenarios: the OPNFV scenarios tested in CI
This database can be used by any project through the Test API.
Please note that projects may also use additional databases. The Test
@@ -275,7 +276,7 @@ per scenario and show:
* the status of the deployment
* the score from each test suite. There is no overall score, it is determined
- by each test project.
+ by each test project.
* a trust indicator
diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst
index 278b4a67c..8bfb37ae7 100644
--- a/docs/testing/testing-user.rst
+++ b/docs/testing/testing-user.rst
@@ -33,7 +33,7 @@ Functest
* :doc:`Functest User Guide <functest:testing/user/userguide/index>`
NFVbench
------
+--------
.. toctree::
:maxdepth: 1