update the Euphrates docs
[bottlenecks.git] / docs / testing / user / userguide / overview.rst
index a930229..5d76c76 100644 (file)
@@ -2,30 +2,45 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) Huawei Technologies Co.,Ltd and others.
 
-*********************
-Project Testing Guide
-*********************
+**********
+User Guide
+**********
 
 For each *testsuite*, you can either setup *teststory* or *testcase* to run
 certain test. *teststory* comprises several *testcases* as a set in one
 configuration file. You could call *teststory* or *testcase* by using
-Bottlencks user interfaces.
+Bottlenecks user interfaces.
 Details will be shown in the following section.
 
 Brief Introdcution of the Test suites in Project Releases
 =============================================================
 
-Brahmaputra: rubbos is introduced, which is an end2end NFVI perforamnce tool.
-Virtual switch test framework(VSTF) is also introduced,
-which is an test framework used for vswitch performance test.
+Brahmaputra:
 
-Colorado: rubbos is refactored by using puppet, which makes it quite flexible
-to configure with different number of load generator (Client), worker (tomcat).
-vstf is refactored by extracting the test case's configuration information.
+* rubbos is introduced, which is an end2end NFVI perforamnce tool.
+* Virtual switch test framework (VSTF) is also introduced, which is an test framework used for vswitch performance test.
 
-Danube: posca testsuite is introduced to implementing stress (factor), scenario and
-tuning test in parametric manner. Two testcases are developed and integrated into
-community CI pipeline. Rubbos and VSTF are not supported any more.
+Colorado:
+
+* rubbos is refactored by using puppet, and ease the integration with several load generators(Client) and worker(Tomcat).
+* VSTF is refactored by extracting the test case's configuration information.
+
+Danube:
+
+* posca testsuite is introduced to implement stress (factor), feature and tuning test in parametric manner.
+* Two testcases are developed and integrated into community CI pipeline.
+* Rubbos and VSTF are not supported any more.
+
+Euphrates:
+
+* Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
+* Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
+* Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
+* Testing framework is revised to support installer-agnostic testing.
+
+These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
+Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
+Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.
 
 Integration Description
 =======================
@@ -38,6 +53,8 @@ Integration Description
 +-------------+----------------------+----------------------+
 | Danube      |    Compass           | POSCA                |
 +-------------+----------------------+----------------------+
+| Euphrates   |    Any               | POSCA                |
++-------------+----------------------+----------------------+
 
 Test suite & Test case Description
 ==================================
@@ -45,32 +62,13 @@ Test suite & Test case Description
 |POSCA   | posca_factor_ping             |
 |        +-------------------------------+
 |        | posca_factor_system_bandwidth |
-+--------+-------------------------------+
-|Rubbos  | rubbos_basic                  |
-|        +-------------------------------+
-|        | rubbos_TC1101                 |
-|        +-------------------------------+
-|        | rubbos_TC1201                 |
 |        +-------------------------------+
-|        | rubbos_TC1301                 |
+|        | posca_facotor_througputs      |
 |        +-------------------------------+
-|        | rubbos_TC1401                 |
+|        | posca_feature_scaleup         |
 |        +-------------------------------+
-|        | rubbos_heavy_TC1101           |
-+--------+-------------------------------+
-|vstf    | vstf_Ti1                      |
-|        +-------------------------------+
-|        | vstf_Ti2                      |
-|        +-------------------------------+
-|        | vstf_Ti3                      |
-|        +-------------------------------+
-|        | vstf_Tn1                      |
-|        +-------------------------------+
-|        | vstf_Tn2                      |
-|        +-------------------------------+
-|        | vstf_Tu1                      |
-|        +-------------------------------+
-|        | vstf_Tu2                      |
-|        +-------------------------------+
-|        | vstf_Tu3                      |
+|        | posca_feature_scaleout        |
 +--------+-------------------------------+
+
+As for the abandoned test suite in the previous Bottlenecks releases, please
+refer to http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/deprecated.html.