545dd493e2435e53f886f1d96972a2f7d8d29d5a
[vswitchperf.git] / tools / report / report_rst.jinja
1 Test ID: {{ tests[0].ID }}
2 --------------------------
3
4 Test Environment
5 ~~~~~~~~~~~~~~~~
6 Below is the environment that the test was performed in:
7
8 * OS: {{tests[0].env.os}}
9 * Kernel Version: {{tests[0].env.kernel}}
10 * NIC(s):{% for nic in tests[0].env.nics %}
11     * {{nic}}{% endfor %}
12 * Board: {{tests[0].env.platform}}
13 * CPU: {{tests[0].env.cpu}}
14 * CPU cores: {{tests[0].env.cpu_cores}}
15 * Memory: {{tests[0].env.memory}}
16 * Virtual Switch Set-up: {{tests[0].deployment}}
17 * vswitchperf: GIT tag: {{tests[0].env.vsperf['git_tag']}}
18 * Traffic Generator: {{tests[0].env.traffic_gen['name']}}, Version: {{tests[0].env.traffic_gen['version']}}, GIT tag: {{tests[0].env.traffic_gen['git_tag']}}
19 * vSwitch: {{tests[0].env.vswitch['name']}}, Version: {{tests[0].env.vswitch['version']}}, GIT tag: {{tests[0].env.vswitch['git_tag']}}
20 {%- if 'dpdk' in tests[0].env %}
21 * DPDK Version: {{tests[0].env.dpdk['version']}}, GIT tag: {{tests[0].env.dpdk['git_tag']}}
22 {%- endif %}
23 {%- if 'vnf' in tests[0].env %}
24 * VNF: {{tests[0].env.vnf['name']}}, Version: {{tests[0].env.vnf['version']}}, GIT tag: {{tests[0].env.vnf['git_tag']}}
25 * VM images:{% for guest_image in tests[0].env.guest_image %}
26     * {{guest_image}}{% endfor %}
27 * VM loopback apps:{% for loopback_app in tests[0].env.loopback_app %}
28     * {{loopback_app['name']}}, Version: {{loopback_app['version']}}, GIT tag: {{loopback_app['git_tag']}}{% endfor %}
29 {%- endif %}
30
31 Below are test details:
32
33 * Test ID: {{ "%s"|format(tests[0].id) }}
34 * Description: {{ "%s"|format(tests[0].conf['Description']) }}
35 * Deployment: {{ "%s"|format(tests[0].deployment) }}
36 * Traffic type: {{ "%s"|format(tests[0].result['type']) }}
37 * Bidirectional : {{ "%s"|format(tests[0].conf['biDirectional']) }}
38 {%- if tests[0].result['tunnel_type'] %}
39 * Tunnel type: {{ "%s"|format(tests[0].result['tunnel_type']) }}
40 {%- endif %}
41 {% for test in tests %}
42 Test results for packet size: {{ "%s"|format(test.result['packet_size']) }}
43 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44 A detailed summary of the main results is outlined below.
45
46 Results/Metrics Collected
47 ^^^^^^^^^^^^^^^^^^^^^^^^^
48
49 The following are the metrics obtained during this test:
50
51 ========================== ==================================
52         Metric                          Result
53 ========================== ==================================
54 {%- for item, value in test.result.items() %}
55 {{ "%-30s %30s"|format(item,value)}}
56 {%- endfor %}
57 ========================== ==================================
58
59 Statistics collected
60 ^^^^^^^^^^^^^^^^^^^^
61
62 The following system statistics were collected during testcase execution:
63 {% for process in test.stats %}
64 ========================== ==================================
65 Process: {{ '_'.join(process.split('_')[:-1]) }}
66 -------------------------------------------------------------
67       Statistic                        Value
68 ========================== ==================================
69 {%- for item, value in test.stats[process].items() %}
70 {{ "%-30s %30s"|format(item,value)}}
71 {%- endfor %}
72 ========================== ==================================
73
74 {% endfor %}{% endfor %}
75
76 Anomalies
77 ~~~~~~~~~~
78 No anomalies were detected during the course of this test.
79
80 Testing Activities/Events
81 ~~~~~~~~~~~~~~~~~~~~~~~~~
82 pidstat is used to collect the process statistics, as such some values such as
83 %CPU and %USER maybe > 100% as the values are summed across multiple cores. For
84 more info on pidstat please see: http://linux.die.net/man/1/pidstat.
85
86 Known issues: Some reported metrics have the value "unkown". These values are
87 marked unknown as they are not values retrieved from the external tester
88 (traffic generator). They were incorrectly derived in a way that made assumptions
89 about packet sizes, as such they have been deprecated from vsperf and marked as
90 unknown. They will be resolved in the next release.
91
92 .. There must be blank lines around to ensure correct formatting.
93
94