8d83b006a661679f595c067b9cf5a475f03dece0
[releng.git] / utils / test / result_collection_api / dashboard / dashboard_utils.py
1 #!/usr/bin/python
2 #
3 # Copyright (c) 2015 Orange
4 # morgan.richomme@orange.com
5 #
6 # This program and the accompanying materials
7 # are made available under the terms of the Apache License, Version 2.0
8 # which accompanies this distribution, and is available at
9 #
10 # http://www.apache.org/licenses/LICENSE-2.0
11 #
12 # This script is used to retieve data from test DB
13 # and format them into a json format adapted for a dashboard
14 #
15 # v0.1: basic example
16 #
17 import os
18 import re
19 from functest2Dashboard import format_functest_for_dashboard, \
20     check_functest_case_exist
21 from yardstick2Dashboard import format_yardstick_for_dashboard, \
22     check_yardstick_case_exist
23 from vsperf2Dashboard import format_vsperf_for_dashboard, \
24     check_vsperf_case_exist
25 from bottlenecks2Dashboard import format_bottlenecks_for_dashboard, \
26     check_bottlenecks_case_exist
27 from qtip2Dashboard import format_qtip_for_dashboard, \
28     check_qtip_case_exist
29
30 # any project test project wishing to provide dashboard ready values
31 # must include at least 2 methods
32 # - format_<Project>_for_dashboard
33 # - check_<Project>_case_exist
34
35
36 def check_dashboard_ready_project(test_project, path):
37     # Check that the first param corresponds to a project
38     # for whoch dashboard processing is available
39     subdirectories = os.listdir(path)
40     for testfile in subdirectories:
41         m = re.search('^(.*)(2Dashboard.py)$', testfile)
42         if m:
43             if (m.group(1) == test_project):
44                 return True
45     return False
46
47
48 def check_dashboard_ready_case(project, case):
49     cmd = "check_" + project + "_case_exist(case)"
50     return eval(cmd)
51
52
53 def get_dashboard_cases(path):
54     # Retrieve all the test cases that could provide
55     # Dashboard ready graphs
56     # look in the releng repo
57     # search all the project2Dashboard.py files
58     # we assume that dashboard processing of project <Project>
59     # is performed in the <Project>2Dashboard.py file
60     dashboard_test_cases = []
61     subdirectories = os.listdir(path)
62     for testfile in subdirectories:
63         m = re.search('^(.*)(2Dashboard.py)$', testfile)
64         if m:
65             dashboard_test_cases.append(m.group(1))
66
67     return dashboard_test_cases
68
69
70 def get_dashboard_result(project, case, results):
71     # get the dashboard ready results
72     # paramters are:
73     # project: project name
74     # results: array of raw results pre-filterded
75     # according to the parameters of the request
76     cmd = "format_" + project + "_for_dashboard(case,results)"
77     res = eval(cmd)
78     return res