Merge "Suppress log outputs in test_task.py"
[yardstick.git] / docs / testing / user / userguide / nsb / tc_vims_context_sipp.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International
2 .. License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) 2019 Viosoft Corporation.
5
6 **********************************************
7 Yardstick Test Case Description: NSB VIMS
8 **********************************************
9
10 +-----------------------------------------------------------------------------+
11 |NSB VIMS test for vIMS characterization                                      |
12 |                                                                             |
13 +--------------+--------------------------------------------------------------+
14 |test case id  | tc_vims_{context}_sipp                                       |
15 |              |                                                              |
16 |              | * context = baremetal or heat;                               |
17 |              |                                                              |
18 +--------------+--------------------------------------------------------------+
19 |metric        | * Successful registrations per second;                       |
20 |              | * Total number of active registrations per server;           |
21 |              | * Successful de-registrations per second;                    |
22 |              | * Successful session establishments per second;              |
23 |              | * Total number of active sessions per server;                |
24 |              | * Mean session setup time;                                   |
25 |              | * Successful re-registrations per second;                    |
26 |              |                                                              |
27 +--------------+--------------------------------------------------------------+
28 |test purpose  | The vIMS test handles registration rate, call rate,          |
29 |              | round trip delay, and message statistics of vIMS system.     |
30 |              |                                                              |
31 |              | The vIMS test cases are implemented to run in baremetal      |
32 |              | and heat context default configuration.                      |
33 |              |                                                              |
34 +--------------+--------------------------------------------------------------+
35 |configuration | The vIMS test cases are listed below:                        |
36 |              |                                                              |
37 |              | * tc_vims_baremetal_sipp.yaml                                |
38 |              | * tc_vims_heat_sipp.yaml                                     |
39 |              |                                                              |
40 |              | Each test runs one time and collects all the KPIs.           |
41 |              | The configuration of vIMS and SIPp can be changed in each    |
42 |              | test.                                                        |
43 +--------------+--------------------------------------------------------------+
44 |test tool     | SIPp                                                         |
45 |              |                                                              |
46 |              | SIPp is an application that can simulate SIP scenarios, can  |
47 |              | generate RTP traffic and used for vIMS characterization.     |
48 |              |                                                              |
49 +--------------+--------------------------------------------------------------+
50 |applicability | The SIPp test cases can be configured with different:        |
51 |              |                                                              |
52 |              | * number of accounts;                                        |
53 |              | * the call per second (cps) of SIP test;                     |
54 |              | * the holding time;                                          |
55 |              | * RTP configuratioin;                                        |
56 |              |                                                              |
57 +--------------+--------------------------------------------------------------+
58 |pre-test      | For Openstack test case, only vIMS is deployed by external   |
59 |conditions    | heat template, SIPp needs pod.yaml file with the necessary   |
60 |              | system and NIC information                                   |
61 |              |                                                              |
62 |              | For Baremetal tests cases SIPp and vIMS must be installed in |
63 |              | the hosts where the test is executed. The pod.yaml file must |
64 |              | have the necessary system and NIC information                |
65 |              |                                                              |
66 +--------------+--------------------------------------------------------------+
67 |test sequence | description and expected result                              |
68 |              |                                                              |
69 +--------------+--------------------------------------------------------------+
70 |step 1        | For Baremetal test: The TG and VNF are started on the hosts  |
71 |              | based on the pod file.                                       |
72 |              |                                                              |
73 |              | For Heat test: One host VM for vIMS is booted, based on      |
74 |              | the test flavor. Another host for SIPp is booted as          |
75 |              | traffic generator, based on pod.yaml file                    |
76 |              |                                                              |
77 +--------------+--------------------------------------------------------------+
78 |step 2        | Yardstick is connected with the vIMS and SIPp via ssh.       |
79 |              | The test will resolve the topology, instantiate the vIMS and |
80 |              | SIPp and collect the KPIs/metrics.                           |
81 |              |                                                              |
82 +--------------+--------------------------------------------------------------+
83 |step 3        | The SIPp will run scenario tests with parameters configured  |
84 |              | in test case files (tc_vims_baremetal_sipp.yaml and          |
85 |              | tc_vims_heat_sipp.yaml files).                               |
86 |              | This is done until the KPIs of SIPp are within an acceptable |
87 |              | threshold.                                                   |
88 |              |                                                              |
89 +--------------+--------------------------------------------------------------+
90 |step 4        | In Baremetal test: The test quits the application.           |
91 |              |                                                              |
92 |              | In Heat test: The host VM of vIMS is deleted on test         |
93 |              | completion.                                                  |
94 +--------------+--------------------------------------------------------------+
95 |test verdict  | The test case will collect the KPIs and plot on Grafana.     |
96 +--------------+--------------------------------------------------------------+