summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/opnfv_yardstick_tc028.rst
blob: 24206f33f5be0ef1ea8a3f11636f7fa9b6e6450b (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

.. 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 TC028
*************************************

.. _Cyclictest: https://rt.wiki.kernel.org/index.php/Cyclictest

+-----------------------------------------------------------------------------+
|KVM Latency measurements                                                     |
|                                                                             |
+--------------+--------------------------------------------------------------+
|test case id  | OPNFV_YARDSTICK_TC028_KVM Latency measurements               |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|metric        | min, avg and max latency                                     |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|test purpose  | To evaluate the IaaS KVM virtualization capability with      |
|              | regards to min, avg and max latency.                         |
|              | 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: samples/cyclictest-node-context.yaml                   |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|test tool     | Cyclictest                                                   |
|              |                                                              |
|              | (Cyclictest is not always part of a Linux distribution,      |
|              | hence it needs to be installed. As an example see the        |
|              | /yardstick/tools/ directory for how to generate a Linux      |
|              | image with cyclictest included.)                             |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|references    | Cyclictest_                                                  |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|applicability | This test case is mainly for kvm4nfv project CI verify.      |
|              | Upgrade host linux kernel, boot a gust vm update it's linux  |
|              | kernel, and then run the cyclictest to test the new kernel   |
|              | is work well.                                                |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|pre-test      | The test kernel rpm, test sequence scripts and test guest    |
|conditions    | image need put the right folders as specified in the test    |
|              | case yaml file.                                              |
|              | The test guest image needs with cyclictest included in it.   |
|              |                                                              |
|              | No POD specific requirements have been identified.           |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|test sequence | description and expected result                              |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|step 1        | The host and guest os kernel is upgraded. Cyclictest is      |
|              | invoked and logs are produced and stored.                    |
|              |                                                              |
|              | Result: Logs are stored.                                     |
|              |                                                              |
+--------------+--------------------------------------------------------------+
|test verdict  | Fails only if SLA is not passed, or if there is a test case  |
|              | execution problem.                                           |
|              |                                                              |
+--------------+--------------------------------------------------------------+
span> release = u'master' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = [] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { '**': [ 'relations.html', # needs 'show_related': True theme option to display 'searchbox.html', ] } # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'FunctestReleaseNotesdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'FunctestReleaseNotes.tex', u'Functest Release Notes Documentation', u'Functest \\textless{}opnfv-tech-discuss@lists.opnfv.org\\textgreater{}', 'manual'), ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'functestreleasenotes', u'Functest Release Notes Documentation', [author], 1) ] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'FunctestReleaseNotes', u'Functest Release Notes Documentation', author, 'FunctestReleaseNotes', 'One line description of project.', 'Miscellaneous'), ]