Add test case description and modify task file for TC004

Change-Id: Ie67985ebf28acc08cc53b312b4f90e65923b5fc4
Signed-off-by: JingLu5 <lvjing5@huawei.com>

2 files changed, 77 insertions, 85 deletions

diff --git a/docs/userguide/opnfv_yardstick_tc004.rst b/docs/userguide/opnfv_yardstick_tc004.rst
new file mode 100644
index 000000000..301286126
--- /dev/null
+++ b/docs/userguide/opnfv_yardstick_tc004.rst
@@ -0,0 +1,77 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
+*************************************
+Yardstick Test Case Description TC004
+*************************************
+
+.. _cachestat: https://github.com/brendangregg/perf-tools/tree/master/fs
+
++-----------------------------------------------------------------------------+
+|Cache Utilization                                                            |
+|                                                                             |
++--------------+--------------------------------------------------------------+
+|test case id  | OPNFV_YARDSTICK_TC004_Cache Utilization                      |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|metric        | Cache Utilization                                            |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test purpose  | To evaluate the IaaS compute capability with regards to      |
+|              | cache utilization.This test case should be run in parallel   |
+|              | to other Yardstick test cases and not run as a stand-alone   |
+|              | test case.                                                   |
+|              | Measure the cache usage statistics including cache hit,      |
+|              | cache miss, hit ratio, page cache size and page cache size.  |
+|              | Both average and maximun values are obtained.                |
+|              | The purpose is also to be able to spot trends.               |
+|              | Test results, graphs and similar shall be stored for         |
+|              | comparison reasons and product evolution understanding       |
+|              | between different OPNFV versions and/or configurations.      |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|configuration | File: cachestat.yaml (in the 'samples' directory)            |
+|              |                                                              |
+|              | * interval: 1 - repeat, pausing every 1 seconds in-between.  |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test tool     | cachestat                                                    |
+|              |                                                              |
+|              | cachestat is not always part of a Linux distribution, hence  |
+|              | it needs to be installed.                                    |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|references    | cachestat_                                                   |
+|              |                                                              |
+|              | ETSI-NFV-TST001                                              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|applicability | Test can be configured with different:                       |
+|              |                                                              |
+|              |  * interval;                                                 |
+|              |  * runner Duration.                                          |
+|              |                                                              |
+|              | There are default values for each above-mentioned option.    |
+|              | Run in background with other test cases.                     |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|pre-test      | The test case image needs to be installed into Glance        |
+|conditions    | with cachestat included in the image.                        |
+|              |                                                              |
+|              | No POD specific requirements have been identified.           |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test sequence | description and expected result                              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 1        | The host is installed as client. The related TC, or TCs, is  |
+|              | invoked and cachestat logs are produced and stored.          |
+|              |                                                              |
+|              | Result: logs are stored.                                     |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test verdict  | None. Cache utilization results are fetched and stored.      |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
diff --git a/tests/opnfv/test_cases/opnfv_yardstick_tc004.yaml b/tests/opnfv/test_cases/opnfv_yardstick_tc004.yaml
deleted file mode 100644
index 2d10e4073..000000000
--- a/tests/opnfv/test_cases/opnfv_yardstick_tc004.yaml
+++ /dev/null
@@ -1,85 +0,0 @@
----
-# Yardstick TC004 config file
-# Measure cache hit/miss ratio and usage, network throughput and latency.
-# Different amounts of flows are tested with, from 2 up to 1001000.
-# All tests are run 2 times each. First 2 times with the least
-# amount of ports, then 2 times with the next amount of ports,
-# and so on until all packet sizes have been run with.
-#
-# During the measurements cache hit/miss ration, cache usage statistics and
-# network latency are recorded/measured using cachestat and ping, respectively.
-
-schema: "yardstick:task:0.1"
-
-scenarios:
--
-  type: CACHEstat
-  run_in_background: true
-
-  options:
-    interval: 1
-
-  host: demeter.yardstick
--
-  type: CACHEstat
-  run_in_background: true
-
-  options:
-    interval: 1
-
-  host: poseidon.yardstick
--
-  type: Ping
-  run_in_background: true
-
-  options:
-    packetsize: 100
-
-  host: demeter.yardstick
-  target: poseidon.yardstick
-
-  sla:
-    max_rtt: 10
-    action: monitor
-{% for num_ports in [1, 10, 50, 100, 300, 500, 750, 1000] %}
--
-  type: Pktgen
-  options:
-    packetsize: 64
-    number_of_ports: {{num_ports}}
-    duration: 20
-
-  host: demeter.yardstick
-  target: poseidon.yardstick
-
-  runner:
-    type: Iteration
-    iterations: 2
-    interval: 1
-
-  sla:
-    max_ppm: 1000
-    action: monitor
-{% endfor %}
-
-context:
-  name: yardstick
-  image: yardstick-trusty-server
-  flavor: yardstick-flavor
-  user: ubuntu
-
-  placement_groups:
-    pgrp1:
-      policy: "availability"
-
-  servers:
-    demeter:
-      floating_ip: true
-      placement: "pgrp1"
-    poseidon:
-      floating_ip: true
-      placement: "pgrp1"
-
-  networks:
-    test:
-      cidr: '10.0.1.0/24'