report: create test report for all executed TCs

Every testcase generates report with its results into separate file.
It is required to merge all partial reports into final overall
report for whole set of TCs executed by VSPERF.
Hugepages are mounted also for TestPMD packet forwarder.

Change-Id: Iee9466825cab35c96e36238f7e03d9da15c583e6
JIRA: VSPERF-181
Signed-off-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com>
>
(cherry picked from commit da081ab2603eb34baf7d7fe7b61f681ef15d865e)

4 files changed, 127 insertions, 111 deletions

diff --git a/tools/report/report_foot.rst b/tools/report/report_foot.rst
new file mode 100644
index 00000000..e1a55718
--- /dev/null
+++ b/tools/report/report_foot.rst
@@ -0,0 +1,29 @@
+.. _rationale:
+
+Rationale for decisions
+=======================
+TODO.
+
+.. _conclusions:
+
+Conclusions and recommendations
+===============================
+TODO.
+
+General
+========
+
+Glossary
+--------
+- NFV - Network Function Virtualization
+- Mbps - 1,000,000bps
+
+Document change procedures and history
+--------------------------------------
+=============================================== ================= =============
+             Document ID                            Author        Date Modified
+=============================================== ================= =============
+`OPNFV_vswitchperf_LTR_ver_1.0_Jan_15_CN_DRAFT` Christopher Nolan 23/01/2015
+`OPNFV_vswitchperf_LTR_ver_1.1_Jan_15_CN_DRAFT` Christopher Nolan 28/01/2015
+=============================================== ================= =============
+
diff --git a/tools/report/report_head.rst b/tools/report/report_head.rst
new file mode 100644
index 00000000..d16614cd
--- /dev/null
+++ b/tools/report/report_head.rst
@@ -0,0 +1,55 @@
+==========================================================================
+CHARACTERIZE VSWITCH PERFORMANCE FOR TELCO NFV USE CASES LEVEL TEST REPORT
+==========================================================================
+
+Introduction
+============
+The objective of the OPNFV project titled **"Characterise vSwitch Performance
+for Telco NFV Use Cases"**, is to evaluate a virtual switch to identify its
+suitability for a Telco Network Function Virtualization (NFV) environment. As
+well as this, the project aims to identify any gaps or bottlenecks in order to
+drive architectural changes to improve virtual switch performance and
+determinism. The purpose of this document is to summarize the results of the
+tests carried out on the virtual switch in the Network Function Virtualization
+Infrastructure (NFVI) and, from these results, provide evaluations and
+recommendations for the virtual switch. Test results will be outlined in
+details-of-LTR_, preceded by the document-identifier_ and the scope_ and
+references_).
+
+This document is currently in draft form.
+
+.. _document-identifier:
+
+Document identifier
+-------------------
+The document id will be used to uniquely identify versions of the LTR. The
+format for the document id will be:
+OPNFV\_vswitchperf\_LTR\_rel\_STATUS, the status is one of: DRAFT, REVIEWED,
+CORRECTED or FINAL. The document id for this version of the LTR is:
+OPNFV\_vswitchperf\_LTR\_Brahmaputra\_DRAFT.
+
+.. _scope:
+
+Scope
+-----
+The scope of this report is to detail the results of the tests that have been
+performed on the virtual switch. This report will also evaluate the results of
+these tests and, based on these evaluations, provide recommendations on the
+suitability of the virtual switch for use in a Telco NFV environment.
+
+.. _references:
+
+References
+----------
+`OPNFV_vswitchperf_LTD_Brahmaputra_REVIEWED
+<http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html>`__
+
+.. _details-of-LTR:
+
+Details of the Level Test Report
+================================
+This section provides a test-results-overview_. Also included are the rationale_
+and the conclusions_.
+
+.. _test-results-overview:
+
diff --git a/tools/report/report_rst.jinja b/tools/report/report_rst.jinja
index b3c2f2d0..b65980f3 100644
--- a/tools/report/report_rst.jinja
+++ b/tools/report/report_rst.jinja
@@ -1,60 +1,6 @@
-==========================================================================
-CHARACTERIZE VSWITCH PERFORMANCE FOR TELCO NFV USE CASES LEVEL TEST REPORT
-==========================================================================
+Test ID: {{ tests[0].ID }}
+--------------------------
 
-Introduction
-============
-The objective of the OPNFV project titled **"Characterise vSwitch Performance
-for Telco NFV Use Cases"**, is to evaluate a virtual switch to identify its
-suitability for a Telco Network Function Virtualization (NFV) environment. As
-well as this, the project aims to identify any gaps or bottlenecks in order to
-drive architectural changes to improve virtual switch performance and
-determinism. The purpose of this document is to summarize the results of the
-tests carried out on the virtual switch in the Network Function Virtualization
-Infrastructure (NFVI) and, from these results, provide evaluations and
-recommendations for the virtual switch. Test results will be outlined in
-details-of-LTR_, preceded by the document-identifier_ and the scope_ and
-references_).
-
-This document is currently in draft form.
-
-.. _document-identifier:
-
-Document identifier
--------------------
-The document id will be used to uniquely identify versions of the LTR. The
-format for the document id will be:
-OPNFV\_vswitchperf\_LTR\_rel\_STATUS, the status is one of: DRAFT, REVIEWED,
-CORRECTED or FINAL. The document id for this version of the LTR is:
-OPNFV\_vswitchperf\_LTR\_Brahmaputra\_DRAFT.
-
-.. _scope:
-
-Scope
------
-The scope of this report is to detail the results of the tests that have been
-performed on the virtual switch. This report will also evaluate the results of
-these tests and, based on these evaluations, provide recommendations on the
-suitability of the virtual switch for use in a Telco NFV environment.
-
-.. _references:
-
-References
-----------
-`OPNFV_vswitchperf_LTD_Brahmaputra_REVIEWED
-<http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html>`__
-
-.. details-of-LTR:
-
-Details of the Level Test Report
-================================
-This section provides a test-results-overview_ as well as
-detailed-test-results_. Also included are the rationale_ and the conclusions_.
-
-.. _test-results-overview:
-
-Overview of test results
-------------------------
 Test Environment
 ~~~~~~~~~~~~~~~~
 Below is the environment that the test was performed in:
@@ -80,30 +26,21 @@ Below is the environment that the test was performed in:
     * {{loopback_app['name']}}, Version: {{loopback_app['version']}}, GIT tag: {{loopback_app['git_tag']}}{% endfor %}
 {%- endif %}
 
-For each test, a summary of the key test results is provided.
-{% for test in tests %}
-Test ID: {{ test.ID }}
-~~~~~~~~~~~~~~~~~~~~~~~
 Below are test details:
 
-* Test ID: {{ "%s"|format(test.id) }}
-* Description: {{ "%s"|format(test.conf['Description']) }}
-* Deployment: {{ "%s"|format(test.deployment) }}
-* Traffic type: {{ "%s"|format(test.result['type']) }}
-* Packet size: {{ "%s"|format(test.result['packet_size']) }}
-* Bidirectional : {{ "%s"|format(test.conf['biDirectional']) }}
-{% endfor %}
-
-.. _detailed-test-results:
+* Test ID: {{ "%s"|format(tests[0].id) }}
+* Description: {{ "%s"|format(tests[0].conf['Description']) }}
+* Deployment: {{ "%s"|format(tests[0].deployment) }}
+* Traffic type: {{ "%s"|format(tests[0].result['type']) }}
+* Bidirectional : {{ "%s"|format(tests[0].conf['biDirectional']) }}
 
-Detailed test results
-======================
-A detailed summary of the main results for each test is outlined below.
 {% for test in tests %}
-Test ID: {{ test.ID }}
-----------------------
+Test results for packet size: {{ "%s"|format(test.result['packet_size']) }}
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A detailed summary of the main results is outlined below.
+
 Results/Metrics Collected
-~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The following are the metrics obtained during this test:
 
@@ -116,12 +53,10 @@ The following are the metrics obtained during this test:
 ========================== ==================================
 
 Statistics collected
-~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^
 
 The following system statistics were collected during testcase execution:
-
 {% for process in test.stats %}
-
 ========================== ==================================
 Process: {{ '_'.join(process.split('_')[:-1]) }}
 -------------------------------------------------------------
@@ -132,44 +67,13 @@ Process: {{ '_'.join(process.split('_')[:-1]) }}
 {%- endfor %}
 ========================== ==================================
 
-{%- endfor %}
-
+{% endfor %}{% endfor %}
 
 Anomalies
-~~~~~~~~~~
+~~~~~~~~~
 No anomalies were detected during the course of this test.
 
 Testing Activities/Events
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 There were no significant testing activities for this test.
-{% endfor %}
-
-.. _rationale:
-
-Rationale for decisions
-=======================
-TODO.
-
-.. _conclusions:
-
-Conclusions and recommendations
-===============================
-TODO.
-
-General
-========
-
-Glossary
---------
-- NFV - Network Function Virtualization
-- Mbps - 1,000,000bps
-
-Document change procedures and history
---------------------------------------
-=============================================== ================= =============
-             Document ID                            Author        Date Modified
-=============================================== ================= =============
-`OPNFV_vswitchperf_LTR_ver_1.0_Jan_15_CN_DRAFT` Christopher Nolan 23/01/2015
-`OPNFV_vswitchperf_LTR_ver_1.1_Jan_15_CN_DRAFT` Christopher Nolan 28/01/2015
-=============================================== ================= =============
 
diff --git a/vsperf b/vsperf
index 53699104..fff52483 100755
--- a/vsperf
+++ b/vsperf
@@ -27,6 +27,8 @@ import shutil
 import unittest
 import xmlrunner
 import locale
+import glob
+import subprocess
 
 sys.dont_write_bytecode = True
 
@@ -46,6 +48,10 @@ VERBOSITY_LEVELS = {
     'critical': logging.CRITICAL
 }
 
+_TEMPLATE_RST = {'head'  : 'tools/report/report_head.rst',
+                 'foot'  : 'tools/report/report_foot.rst',
+                 'final' : 'test_report.rst'
+                }
 
 def parse_arguments():
     """
@@ -250,6 +256,25 @@ def check_and_set_locale():
         logging.warning("Locale was not properly configured. Default values were set. Old locale: %s, New locale: %s",
                         system_locale, locale.getdefaultlocale())
 
+def generate_final_report(path):
+    """ Function will check if partial test results are available
+    and generates final report in rst format.
+    """
+
+    # check if there are any results in rst format
+    rst_results = glob.glob(os.path.join(path, 'result*rst'))
+    if len(rst_results):
+        try:
+            test_report = os.path.join(path, _TEMPLATE_RST['final'])
+            retval = subprocess.call('cat {} {} {} > {}'.format(_TEMPLATE_RST['head'], ' '.join(rst_results),
+                                                                _TEMPLATE_RST['foot'], test_report), shell=True)
+            if retval == 0 and os.path.isfile(test_report):
+                logging.info('Overall test report written to "%s"', test_report)
+            else:
+                logging.error('Generatrion of overall test report has failed.')
+        except subprocess.CalledProcessError:
+            logging.error('Generatrion of overall test report has failed.')
+
 class MockTestCase(unittest.TestCase):
     """Allow use of xmlrunner to generate Jenkins compatible output without
     using xmlrunner to actually run tests.
@@ -449,6 +474,9 @@ def main():
             suite.addTest(MockTestCase(str(ex), False, test.name))
             logger.info("Continuing with next test...")
 
+    # generate final rst report with results of all executed TCs
+    generate_final_report(results_path)
+
     if settings.getValue('XUNIT'):
         xmlrunner.XMLTestRunner(
             output=settings.getValue('XUNIT_DIR'), outsuffix="",