Refine test case description for tc076
[yardstick.git] / docs / testing / user / userguide / opnfv_yardstick_tc076.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) OPNFV, Huawei Technologies Co.,Ltd and others.
5
6 *************************************
7 Yardstick Test Case Description TC076
8 *************************************
9
10
11 +-----------------------------------------------------------------------------+
12 |Monitor Network Metrics                                                      |
13 |                                                                             |
14 +--------------+--------------------------------------------------------------+
15 |test case id  | OPNFV_YARDSTICK_TC076_Monitor_Network_Metrics                |
16 |              |                                                              |
17 +--------------+--------------------------------------------------------------+
18 |metric        | IP datagram error rate, ICMP message error rate,             |
19 |              | TCP segment error rate and UDP datagram error rate           |
20 |              |                                                              |
21 +--------------+--------------------------------------------------------------+
22 |test purpose  | The purpose of TC076 is to evaluate the IaaS network         |
23 |              | reliability with regards to IP datagram error rate, ICMP     |
24 |              | message error rate, TCP segment error rate and UDP datagram  |
25 |              | error rate.                                                  |
26 |              |                                                              |
27 |              | TC076 monitors network metrics provided by the Linux kernel  |
28 |              | in a host and calculates IP datagram error rate, ICMP        |
29 |              | message error rate, TCP segment error rate and UDP datagram  |
30 |              | error rate.                                                  |
31 |              |                                                              |
32 |              | The purpose is also to be able to spot the trends.           |
33 |              | Test results, graphs and similar shall be stored for         |
34 |              | comparison reasons and product evolution understanding       |
35 |              | between different OPNFV versions and/or configurations.      |
36 |              |                                                              |
37 +--------------+--------------------------------------------------------------+
38 |test tool     | nstat                                                        |
39 |              |                                                              |
40 |              | nstat is a simple tool to monitor kernel snmp counters and   |
41 |              | network interface statistics.                                |
42 |              |                                                              |
43 |              | (nstat is not always part of a Linux distribution, hence it  |
44 |              | needs to be installed. nstat is provided by the iproute2     |
45 |              | collection, which is usually also the name of the package in |
46 |              | many Linux distributions.As an example see the               |
47 |              | /yardstick/tools/ directory for how to generate a Linux      |
48 |              | image with iproute2 included.)                               |
49 |              |                                                              |
50 +--------------+--------------------------------------------------------------+
51 |test          | Ping packets (ICMP protocol's mandatory ECHO_REQUEST         |
52 |description   | datagram) are sent from host VM to target VM(s) to elicit    |
53 |              | ICMP ECHO_RESPONSE.                                          |
54 |              |                                                              |
55 |              | nstat is invoked on the target vm to monitors network        |
56 |              | metrics provided by the Linux kernel.                        |
57 +--------------+--------------------------------------------------------------+
58 |configuration | file: opnfv_yardstick_tc076.yaml                             |
59 |              |                                                              |
60 |              | There is no additional configuration to be set for this TC.  |
61 |              |                                                              |
62 +--------------+--------------------------------------------------------------+
63 |references    | nstat man page                                               |
64 |              |                                                              |
65 |              | ETSI-NFV-TST001                                              |
66 |              |                                                              |
67 +--------------+--------------------------------------------------------------+
68 |applicability | This test case is mainly for monitoring network metrics.     |
69 |              |                                                              |
70 +--------------+--------------------------------------------------------------+
71 |pre_test      | The test case image needs to be installed into Glance        |
72 |conditions    | with fio included in it.                                     |
73 |              |                                                              |
74 |              | No POD specific requirements have been identified.           |
75 |              |                                                              |
76 +--------------+--------------------------------------------------------------+
77 |test sequence | description and expected result                              |
78 |              |                                                              |
79 +--------------+--------------------------------------------------------------+
80 |step 1        | Two host VMs are booted, as server and client.               |
81 |              |                                                              |
82 +--------------+--------------------------------------------------------------+
83 |step 2        | Yardstick is connected with the server VM by using ssh.      |
84 |              | 'ping_benchmark' bash script is copyied from Jump Host to    |
85 |              | the server VM via the ssh tunnel.                            |
86 |              |                                                              |
87 +--------------+--------------------------------------------------------------+
88 |step 3        | Ping is invoked. Ping packets are sent from server VM to     |
89 |              | client VM. RTT results are calculated and checked against    |
90 |              | the SLA. nstat is invoked on the client vm to monitors       |
91 |              | network metrics provided by the Linux kernel. IP datagram    |
92 |              | error rate, ICMP message error rate, TCP segment error rate  |
93 |              | and UDP datagram error rate are calculated.                  |
94 |              | Logs are produced and stored.                                |
95 |              |                                                              |
96 |              | Result: Logs are stored.                                     |
97 |              |                                                              |
98 +--------------+--------------------------------------------------------------+
99 |step 4        | Two host VMs are deleted.                                    |
100 |              |                                                              |
101 +--------------+--------------------------------------------------------------+
102 |test verdict  | None.                                                        |
103 |              |                                                              |
104 +--------------+--------------------------------------------------------------+