diff options
| author |   Ana C <ana.cunha@ericsson.com> | 2015-12-26 15:50:13 +0100 |
|---|---|---|
| committer |   Jörgen Karlsson <jorgen.w.karlsson@ericsson.com> | 2016-01-07 10:26:59 +0000 |
| commit | 00296cd85133d4f38a510e7ad3ecb0ff3fe4d56c (patch) | |
| tree | 5cce02ecfb8c5c6bfabc61f55ba6d55a47702227 /docs/yardstick/opnfv_yardstick_tc010.rst | |
| parent | 65e32e513544392ce84c190434d23281b5c1afd2 (diff) | |
Structure test case descriptions
This commit structures the test case descriptions.
The file index.rst lists the subsequent chapters.
01-introduction.rst contains an overview of the project and deliverables.
02-methodology.rst describes the methodology for the generic test cases.
03-list-of-tcs.rst contains a list of merged generic test cases and a
sub-chapter for the feature test cases.
Glossary extracts definitions and abbreviations.
TC001, TC002, TC008, TC009, TC010, TC012 were adapted to work for pdf.
Template testcase_description_v2_template.rst was adapted to work for pdf.
Change-Id: Ia11e27e5d508f1a784e2a412b50739e32b13797f
Signed-off-by: Ana C <ana.cunha@ericsson.com>
Diffstat (limited to 'docs/yardstick/opnfv_yardstick_tc010.rst')
| -rw-r--r-- | docs/yardstick/opnfv_yardstick_tc010.rst | 58 |
1 files changed, 35 insertions, 23 deletions
diff --git a/docs/yardstick/opnfv_yardstick_tc010.rst b/docs/yardstick/opnfv_yardstick_tc010.rst index c2f8eb4e2..ebb74ea30 100644 --- a/docs/yardstick/opnfv_yardstick_tc010.rst +++ b/docs/yardstick/opnfv_yardstick_tc010.rst @@ -1,17 +1,23 @@ - ************************************* Yardstick Test Case Description TC010 ************************************* + +.. _man-pages: http://manpages.ubuntu.com/manpages/trusty/lat_mem_rd.8.html + +-----------------------------------------------------------------------------+ |Memory Latency | -+==============+==============================================================+ +| | ++--------------+--------------------------------------------------------------+ |test case id | OPNFV_YARDSTICK_TC010_Memory Latency | +| | | +--------------+--------------------------------------------------------------+ |metric | Latency in nanoseconds | +| | | +--------------+--------------------------------------------------------------+ |test purpose | Measure the memory read latency for varying memory sizes and | | | strides. Whole memory hierarchy is measured including all | | | levels of cache. | +| | | +--------------+--------------------------------------------------------------+ |configuration | File: opnfv_yardstick_tc010.yaml | | | | @@ -21,6 +27,7 @@ Yardstick Test Case Description TC010 | | * Iterations: 10 - test is run 10 times iteratively. | | | * Interval: 1 - there is 1 second delay between each | | | iteration. | +| | | +--------------+--------------------------------------------------------------+ |test tool | Lmbench | | | | @@ -28,38 +35,43 @@ Yardstick Test Case Description TC010 | | test uses lat_mem_rd tool from that suite. | | | Lmbench is not always part of a Linux distribution, hence it | | | needs to be installed in the test image | -| | (See :ref:`guest-image` for how to generate a Linux image | -| | for Glance with Lmbench included). | +| | | +--------------+--------------------------------------------------------------+ -|references |* http://manpages.ubuntu.com/manpages/trusty/lat_mem_rd.8.html| +|references | man-pages_ | +| | | +| | McVoy, Larry W.,and Carl Staelin. "lmbench: Portable Tools | +| | for Performance Analysis." USENIX annual technical | +| | conference 1996. | | | | -| |* McVoy, Larry W., and Carl Staelin. "lmbench: Portable Tools | -| | for Performance Analysis." *USENIX annual technical | -| | conference*. 1996. | +--------------+--------------------------------------------------------------+ -|applicability | Test can be configured with different | -| | * strides; | -| | * stop_size; | -| | * iterations and intervals; | +|applicability | Test can be configured with different: | +| | | +| | * strides; | +| | * stop_size; | +| | * iterations and intervals. | | | | | | There are default values for each above-mentioned option. | | | | -| | * SLA (optional). | -| | max_latency: The maximum memory latency that is | -| | accepted. | +| | SLA (optional) : max_latency: The maximum memory latency | +| | that is accepted. | +| | | +--------------+--------------------------------------------------------------+ |pre-test | The test case image needs to be installed into Glance | |conditions | with Lmbench included in the image. | | | | | | No POD specific requirements have been identified. | -+--------------+------+----------------------------------+--------------------+ -|test sequence | step | description | result | -| +------+----------------------------------+--------------------+ -| | 1 | The host is installed as client. | Logs are stored | -| | | Lmbench's lat_mem_rd tool is | | -| | | invoked and logs are produced and| | -| | | stored. | | -+--------------+------+----------------------------------+--------------------+ +| | | ++--------------+--------------------------------------------------------------+ +|test sequence | description and expected result | +| | | ++--------------+--------------------------------------------------------------+ +|step 1 | The host is installed as client. Lmbench's lat_mem_rd tool | +| | is invoked and logs are produced and stored. | +| | | +| | Result: logs are stored. | +| | | ++--------------+--------------------------------------------------------------+ |test verdict | Test fails if the measured memory latency is above the SLA | | | value or if there is a test case execution problem. | +| | | +--------------+--------------------------------------------------------------+ |