Doc for Xreview by other test projects
[yardstick.git] / docs / userguide / opnfv_yardstick_tc004.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 TC004
8 *************************************
9
10 .. _cachestat: https://github.com/brendangregg/perf-tools/tree/master/fs
11
12 +-----------------------------------------------------------------------------+
13 |Cache Utilization                                                            |
14 |                                                                             |
15 +--------------+--------------------------------------------------------------+
16 |test case id  | OPNFV_YARDSTICK_TC004_Cache Utilization                      |
17 |              |                                                              |
18 +--------------+--------------------------------------------------------------+
19 |metric        | Cache Utilization                                            |
20 |              |                                                              |
21 +--------------+--------------------------------------------------------------+
22 |test purpose  | To evaluate the IaaS compute capability with regards to      |
23 |              | cache utilization.This test case should be run in parallel   |
24 |              | to other Yardstick test cases and not run as a stand-alone   |
25 |              | test case.                                                   |
26 |              | Measure the cache usage statistics including cache hit,      |
27 |              | cache miss, hit ratio, page cache size and page cache size.  |
28 |              | Both average and maximun values are obtained.                |
29 |              | The purpose is also to be able to spot trends.               |
30 |              | Test results, graphs and similar shall be stored for         |
31 |              | comparison reasons and product evolution understanding       |
32 |              | between different OPNFV versions and/or configurations.      |
33 |              |                                                              |
34 +--------------+--------------------------------------------------------------+
35 |configuration | File: cachestat.yaml (in the 'samples' directory)            |
36 |              |                                                              |
37 |              | * interval: 1 - repeat, pausing every 1 seconds in-between.  |
38 |              |                                                              |
39 +--------------+--------------------------------------------------------------+
40 |test tool     | cachestat                                                    |
41 |              |                                                              |
42 |              | cachestat is not always part of a Linux distribution, hence  |
43 |              | it needs to be installed.                                    |
44 |              |                                                              |
45 +--------------+--------------------------------------------------------------+
46 |references    | cachestat_                                                   |
47 |              |                                                              |
48 |              | ETSI-NFV-TST001                                              |
49 |              |                                                              |
50 +--------------+--------------------------------------------------------------+
51 |applicability | Test can be configured with different:                       |
52 |              |                                                              |
53 |              |  * interval;                                                 |
54 |              |  * runner Duration.                                          |
55 |              |                                                              |
56 |              | There are default values for each above-mentioned option.    |
57 |              | Run in background with other test cases.                     |
58 |              |                                                              |
59 +--------------+--------------------------------------------------------------+
60 |pre-test      | The test case image needs to be installed into Glance        |
61 |conditions    | with cachestat included in the image.                        |
62 |              |                                                              |
63 |              | No POD specific requirements have been identified.           |
64 |              |                                                              |
65 +--------------+--------------------------------------------------------------+
66 |test sequence | description and expected result                              |
67 |              |                                                              |
68 +--------------+--------------------------------------------------------------+
69 |step 1        | The host is installed as client. The related TC, or TCs, is  |
70 |              | invoked and cachestat logs are produced and stored.          |
71 |              |                                                              |
72 |              | Result: logs are stored.                                     |
73 |              |                                                              |
74 +--------------+--------------------------------------------------------------+
75 |test verdict  | None. Cache utilization results are fetched and stored.      |
76 |              |                                                              |
77 +--------------+--------------------------------------------------------------+