add dashboard method to test result collection API

+ add new fields in pod section

JIRA: RELENG-45

Change-Id: I8e833207b7014d7fd07769af415a4892b9e9d924
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>

3 files changed, 192 insertions, 0 deletions

diff --git a/utils/test/result_collection_api/dashboard/__init__.py b/utils/test/result_collection_api/dashboard/__init__.py
new file mode 100644
index 000000000..05c0c9392
--- /dev/null
+++ b/utils/test/result_collection_api/dashboard/__init__.py
@@ -0,0 +1,8 @@
+##############################################################################
+# Copyright (c) 2015 Orange
+# guyrodrigue.koffi@orange.com / koffirodrigue@gmail.com
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
diff --git a/utils/test/result_collection_api/dashboard/dashboard_utils.py b/utils/test/result_collection_api/dashboard/dashboard_utils.py
new file mode 100644
index 000000000..06c90acf5
--- /dev/null
+++ b/utils/test/result_collection_api/dashboard/dashboard_utils.py
@@ -0,0 +1,70 @@
+#!/usr/bin/python
+#
+# Copyright (c) 2015 Orange
+# morgan.richomme@orange.com
+#
+# This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# This script is used to retieve data from test DB
+# and format them into a json format adapted for a dashboard
+#
+# v0.1: basic example
+#
+import os
+import re
+from functest2Dashboard import format_functest_for_dashboard, \
+    check_functest_case_exist
+
+# any project test project wishing to provide dashboard ready values
+# must include at least 2 methods
+# - format_<Project>_for_dashboard
+# - check_<Project>_case_exist
+
+
+def check_dashboard_ready_project(test_project, path):
+    # Check that the first param corresponds to a project
+    # for whoch dashboard processing is available
+    subdirectories = os.listdir(path)
+    for testfile in subdirectories:
+        m = re.search('^(.*)(2Dashboard.py)$', testfile)
+        if m:
+            if (m.group(1) == test_project):
+                return True
+    return False
+
+
+def check_dashboard_ready_case(project, case):
+    cmd = "check_" + project + "_case_exist(case)"
+    return eval(cmd)
+
+
+def get_dashboard_cases(path):
+    # Retrieve all the test cases that could provide
+    # Dashboard ready graphs
+    # look in the releng repo
+    # search all the project2Dashboard.py files
+    # we assume that dashboard processing of project <Project>
+    # is performed in the <Project>2Dashboard.py file
+    dashboard_test_cases = []
+    subdirectories = os.listdir(path)
+    for testfile in subdirectories:
+        m = re.search('^(.*)(2Dashboard.py)$', testfile)
+        if m:
+            dashboard_test_cases.append(m.group(1))
+
+    return dashboard_test_cases
+
+
+def get_dashboard_result(project, case, results):
+    # get the dashboard ready results
+    # paramters are:
+    # project: project name
+    # results: array of raw results pre-filterded
+    # according to the parameters of the request
+    cmd = "format_" + project + "_for_dashboard(case,results)"
+    res = eval(cmd)
+    return res
diff --git a/utils/test/result_collection_api/dashboard/functest2Dashboard.py b/utils/test/result_collection_api/dashboard/functest2Dashboard.py
new file mode 100644
index 000000000..427de76a5
--- /dev/null
+++ b/utils/test/result_collection_api/dashboard/functest2Dashboard.py
@@ -0,0 +1,114 @@
+#!/usr/bin/python
+#
+# Copyright (c) 2015 Orange
+# morgan.richomme@orange.com
+#
+# This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# This script is used to build dashboard ready json results
+# It may be used for all the test case of the Functest project
+# a new method format_<Test_case>_for_dashboard(results)
+# v0.1: basic example with methods for odl, Tempest, Rally and vPing
+#
+
+
+def get_functest_cases():
+    """
+    get the list of the supported test cases
+    TODO: update the list when adding a new test case for the dashboard
+    """
+    return ["vPing", "Tempest", "odl", "Rally"]
+
+
+def format_functest_for_dashboard(case, results):
+    """
+    generic method calling the method corresponding to the test case
+    check that the testcase is properly declared first
+    then build the call to the specific method
+    """
+    if check_functest_case_exist(case):
+        cmd = "format_" + case + "_for_dashboard(results)"
+        res = eval(cmd)
+    else:
+        res = []
+        print "Test cases not declared"
+    return res
+
+
+def check_functest_case_exist(case):
+    """
+    check if the testcase exists
+    if the test case is not defined or not declared in the list
+    return False
+    """
+    functest_cases = get_functest_cases()
+
+    if (case is None or case not in functest_cases):
+        return False
+    else:
+        return True
+
+
+def format_Tempest_for_dashboard(results):
+    """
+    Post processing for the Tempest test case
+    """
+    test_data = [{'description': 'Tempest results for Dashboard'}]
+    return test_data
+
+
+def format_odl_for_dashboard(results):
+    """
+    Post processing for the odl test case
+    """
+    test_data = [{'description': 'odl results for Dashboard'}]
+    return test_data
+
+
+def format_Rally_for_dashboard(results):
+    """
+    Post processing for the Rally test case
+    """
+    test_data = [{'description': 'Rally results for Dashboard'}]
+    return test_data
+
+
+def format_vPing_for_dashboard(results):
+    """
+    Post processing for the vPing test case
+    """
+    test_data = [{'description': 'vPing results for Dashboard'}]
+
+    # Graph 1: Test_Duration = f(time)
+    # ********************************
+    new_element = []
+    for data in results:
+        new_element.append({'x': data['creation_date'],
+                            'y': data['details']['duration']})
+
+    test_data.append({'name': "vPing duration",
+                      'info': {'type': "graph",
+                               'xlabel': 'time',
+                               'ylabel': 'duration (s)'},
+                      'data_set': new_element})
+
+    # Graph 2: bar
+    # ************
+    nbTest = 0
+    nbTestOk = 0
+
+    for data in results:
+        nbTest += 1
+        if data['details']['status'] == "OK":
+            nbTestOk += 1
+
+    test_data.append({'name': "vPing status",
+                      'info': {"type": "bar"},
+                      'data_set': [{'Nb tests': nbTest,
+                                    'Nb Success': nbTestOk}]})
+
+    return test_data