docs: Final report conclusions and recommendations
[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
39 {% for test in tests %}
40 Test results for packet size: {{ "%s"|format(test.result['packet_size']) }}
41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42 A detailed summary of the main results is outlined below.
43
44 Results/Metrics Collected
45 ^^^^^^^^^^^^^^^^^^^^^^^^^
46
47 The following are the metrics obtained during this test:
48
49 ========================== ==================================
50         Metric                          Result
51 ========================== ==================================
52 {%- for item, value in test.result.items() %}
53 {{ "%-30s %30s"|format(item,value)}}
54 {%- endfor %}
55 ========================== ==================================
56
57 Statistics collected
58 ^^^^^^^^^^^^^^^^^^^^
59
60 The following system statistics were collected during testcase execution:
61 {% for process in test.stats %}
62 ========================== ==================================
63 Process: {{ '_'.join(process.split('_')[:-1]) }}
64 -------------------------------------------------------------
65       Statistic                        Value
66 ========================== ==================================
67 {%- for item, value in test.stats[process].items() %}
68 {{ "%-30s %30s"|format(item,value)}}
69 {%- endfor %}
70 ========================== ==================================
71
72 {% endfor %}{% endfor %}
73
74 Anomalies
75 ~~~~~~~~~~
76 No anomalies were detected during the course of this test.
77
78 Testing Activities/Events
79 ~~~~~~~~~~~~~~~~~~~~~~~~~
80 There were no significant testing activities for this test.
81
82