Unify TG and VNF names in infrastructure files
[yardstick.git] / docs / testing / user / userguide / opnfv_yardstick_tc043.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 TC043
8 *************************************
9
10 .. _cirros-image: https://download.cirros-cloud.net
11 .. _Ping: https://linux.die.net/man/8/ping
12
13 +-----------------------------------------------------------------------------+
14 |Network Latency Between NFVI Nodes                                           |
15 |                                                                             |
16 +--------------+--------------------------------------------------------------+
17 |test case id  | OPNFV_YARDSTICK_TC043_LATENCY_BETWEEN_NFVI_NODES             |
18 |              |                                                              |
19 +--------------+--------------------------------------------------------------+
20 |metric        | RTT (Round Trip Time)                                        |
21 |              |                                                              |
22 +--------------+--------------------------------------------------------------+
23 |test purpose  | The purpose of TC043 is to do a basic verification that      |
24 |              | network latency is within acceptable boundaries when packets |
25 |              | travel between different NFVI nodes.                         |
26 |              |                                                              |
27 |              | The purpose is also to be able to spot the trends.           |
28 |              | Test results, graphs and similar shall be stored for         |
29 |              | comparison reasons and product evolution understanding       |
30 |              | between different OPNFV versions and/or configurations.      |
31 |              |                                                              |
32 +--------------+--------------------------------------------------------------+
33 |test tool     | ping                                                         |
34 |              |                                                              |
35 |              | Ping is a computer network administration software utility   |
36 |              | used to test the reachability of a host on an Internet       |
37 |              | Protocol (IP) network. It measures the round-trip time for   |
38 |              | packet sent from the originating host to a destination       |
39 |              | computer that are echoed back to the source.                 |
40 |              |                                                              |
41 +--------------+--------------------------------------------------------------+
42 |test topology | Ping packets (ICMP protocol's mandatory ECHO_REQUEST         |
43 |              | datagram) are sent from host node to target node to elicit   |
44 |              | ICMP ECHO_RESPONSE.                                          |
45 |              |                                                              |
46 +--------------+--------------------------------------------------------------+
47 |configuration | file: opnfv_yardstick_tc043.yaml                             |
48 |              |                                                              |
49 |              | Packet size 100 bytes. Total test duration 600 seconds.      |
50 |              | One ping each 10 seconds. SLA RTT is set to maximum 10 ms.   |
51 |              |                                                              |
52 +--------------+--------------------------------------------------------------+
53 |applicability | This test case can be configured with different:             |
54 |              |                                                              |
55 |              |  * packet sizes;                                             |
56 |              |  * burst sizes;                                              |
57 |              |  * ping intervals;                                           |
58 |              |  * test durations;                                           |
59 |              |  * test iterations.                                          |
60 |              |                                                              |
61 |              | Default values exist.                                        |
62 |              |                                                              |
63 |              | SLA is optional. The SLA in this test case serves as an      |
64 |              | example. Considerably lower RTT is expected, and also normal |
65 |              | to achieve in balanced L2 environments. However, to cover    |
66 |              | most configurations, both bare metal and fully virtualized   |
67 |              | ones, this value should be possible to achieve and           |
68 |              | acceptable for black box testing. Many real time             |
69 |              | applications start to suffer badly if the RTT time is higher |
70 |              | than this. Some may suffer bad also close to this RTT, while |
71 |              | others may not suffer at all. It is a compromise that may    |
72 |              | have to be tuned for different configuration purposes.       |
73 |              |                                                              |
74 +--------------+--------------------------------------------------------------+
75 |references    | Ping_                                                        |
76 |              |                                                              |
77 |              | ETSI-NFV-TST001                                              |
78 |              |                                                              |
79 +--------------+--------------------------------------------------------------+
80 |pre_test      | Each pod node must have ping included in it.                 |
81 |conditions    |                                                              |
82 |              |                                                              |
83 +--------------+--------------------------------------------------------------+
84 |test sequence | description and expected result                              |
85 |              |                                                              |
86 +--------------+--------------------------------------------------------------+
87 |step 1        | Yardstick is connected with the NFVI node by using ssh.      |
88 |              | 'ping_benchmark' bash script is copyied from Jump Host to    |
89 |              | the NFVI node via the ssh tunnel.                            |
90 |              |                                                              |
91 +--------------+--------------------------------------------------------------+
92 |step 2        | Ping is invoked. Ping packets are sent from server node to   |
93 |              | client node. RTT results are calculated and checked against  |
94 |              | the SLA. Logs are produced and stored.                       |
95 |              |                                                              |
96 |              | Result: Logs are stored.                                     |
97 |              |                                                              |
98 +--------------+--------------------------------------------------------------+
99 |test verdict  | Test should not PASS if any RTT is above the optional SLA    |
100 |              | value, or if there is a test case execution problem.         |
101 |              |                                                              |
102 +--------------+--------------------------------------------------------------+