aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/lib/resulttool/regression.py
blob: bee3fb011a888ba5ea645d44663979964ebd6fd3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# test result tool - regression analysis
#
# Copyright (c) 2019, Intel Corporation.
#
# This program is free software; you can redistribute it and/or modify it
# under the terms and conditions of the GNU General Public License,
# version 2, as published by the Free Software Foundation.
#
# This program is distributed in the hope it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details.
#
from resulttool.resultsutils import load_json_file, get_dict_value, pop_dict_element
import json

class ResultsRegressionSelector(object):

    def get_results_unique_configurations(self, logger, results):
        unique_configurations_map = {"oeselftest": ['TEST_TYPE', 'HOST_DISTRO', 'MACHINE'],
                                     "runtime": ['TEST_TYPE', 'IMAGE_BASENAME', 'MACHINE'],
                                     "sdk": ['TEST_TYPE', 'IMAGE_BASENAME', 'MACHINE', 'SDKMACHINE'],
                                     "sdkext": ['TEST_TYPE', 'IMAGE_BASENAME', 'MACHINE', 'SDKMACHINE']}
        results_unique_configs = {}
        for k in results:
            result = results[k]
            result_configs = get_dict_value(logger, result, 'configuration')
            result_test_type = get_dict_value(logger, result_configs, 'TEST_TYPE')
            unique_configuration_keys = get_dict_value(logger, unique_configurations_map, result_test_type)
            result_unique_config = {}
            for ck in unique_configuration_keys:
                config_value = get_dict_value(logger, result_configs, ck)
                if config_value:
                    result_unique_config[ck] = config_value
            results_unique_configs[k] = result_unique_config
        return results_unique_configs

    def get_regression_base_target_pair(self, logger, base_results, target_results):
        base_configs = self.get_results_unique_configurations(logger, base_results)
        logger.debug('Retrieved base configuration: config=%s' % base_configs)
        target_configs = self.get_results_unique_configurations(logger, target_results)
        logger.debug('Retrieved target configuration: config=%s' % target_configs)
        regression_pair = {}
        for bk in base_configs:
            base_config = base_configs[bk]
            for tk in target_configs:
                target_config = target_configs[tk]
                if base_config == target_config:
                    if bk in regression_pair:
                        regression_pair[bk].append(tk)
                    else:
                        regression_pair[bk] = [tk]
        return regression_pair

    def run_regression_with_regression_pairing(self, logger, regression_pair, base_results, target_results):
        regression = ResultsRegression()
        for base in regression_pair:
            for target in regression_pair[base]:
                print('Getting regression for base=%s target=%s' % (base, target))
                regression.run(logger, base_results[base], target_results[target])

class ResultsRegression(object):

    def print_regression_result(self, result):
        if result:
            print('============================Start Regression============================')
            print('Only print regression if base status not equal target')
            print('<test case> : <base status> -> <target status>')
            print('========================================================================')
            for k in result:
                print(k, ':', result[k]['base'], '->', result[k]['target'])
            print('==============================End Regression==============================')

    def get_regression_result(self, logger, base_result, target_result):
        base_result = get_dict_value(logger, base_result, 'result')
        target_result = get_dict_value(logger, target_result, 'result')
        result = {}
        if base_result and target_result:
            logger.debug('Getting regression result')
            for k in base_result:
                base_testcase = base_result[k]
                base_status = get_dict_value(logger, base_testcase, 'status')
                if base_status:
                    target_testcase = get_dict_value(logger, target_result, k)
                    target_status = get_dict_value(logger, target_testcase, 'status')
                    if base_status != target_status:
                        result[k] = {'base': base_status, 'target': target_status}
                else:
                    logger.error('Failed to retrieved base test case status: %s' % k)
        return result

    def run(self, logger, base_result, target_result):
        if base_result and target_result:
            result = self.get_regression_result(logger, base_result, target_result)
            logger.debug('Retrieved regression result =%s' % result)
            self.print_regression_result(result)
        else:
            logger.error('Input data objects must not be empty (base_result=%s, target_result=%s)' %
                         (base_result, target_result))

def get_results_from_directory(logger, source_dir):
    from resulttool.merge import ResultsMerge
    from resulttool.resultsutils import get_directory_files
    result_files = get_directory_files(source_dir, ['.git'], 'testresults.json')
    base_results = {}
    for file in result_files:
        merge = ResultsMerge()
        results = merge.get_test_results(logger, file, '')
        base_results = merge.merge_results(base_results, results)
    return base_results

def remove_testcases_to_optimize_regression_runtime(logger, results):
    test_case_removal = ['ptestresult.rawlogs', 'ptestresult.sections']
    for r in test_case_removal:
        for k in results:
            result = get_dict_value(logger, results[k], 'result')
            pop_dict_element(logger, result, r)

def regression_file(args, logger):
    base_results = load_json_file(args.base_result_file)
    print('Successfully loaded base test results from: %s' % args.base_result_file)
    target_results = load_json_file(args.target_result_file)
    print('Successfully loaded target test results from: %s' % args.target_result_file)
    remove_testcases_to_optimize_regression_runtime(logger, base_results)
    remove_testcases_to_optimize_regression_runtime(logger, target_results)
    if args.base_result_id and args.target_result_id:
        base_result = get_dict_value(logger, base_results, base_result_id)
        print('Getting base test result with result_id=%s' % base_result_id)
        target_result = get_dict_value(logger, target_results, target_result_id)
        print('Getting target test result with result_id=%s' % target_result_id)
        regression = ResultsRegression()
        regression.run(logger, base_result, target_result)
    else:
        regression = ResultsRegressionSelector()
        regression_pair = regression.get_regression_base_target_pair(logger, base_results, target_results)
        logger.debug('Retrieved regression pair=%s' % regression_pair)
        regression.run_regression_with_regression_pairing(logger, regression_pair, base_results, target_results)
    return 0

def regression_directory(args, logger):
    base_results = get_results_from_directory(logger, args.base_result_directory)
    target_results = get_results_from_directory(logger, args.target_result_directory)
    remove_testcases_to_optimize_regression_runtime(logger, base_results)
    remove_testcases_to_optimize_regression_runtime(logger, target_results)
    regression = ResultsRegressionSelector()
    regression_pair = regression.get_regression_base_target_pair(logger, base_results, target_results)
    logger.debug('Retrieved regression pair=%s' % regression_pair)
    regression.run_regression_with_regression_pairing(logger, regression_pair, base_results, target_results)
    return 0

def regression_git(args, logger):
    from resulttool.resultsutils import checkout_git_dir
    base_results = {}
    target_results = {}
    if checkout_git_dir(args.source_dir, args.base_git_branch):
        base_results = get_results_from_directory(logger, args.source_dir)
    if checkout_git_dir(args.source_dir, args.target_git_branch):
        target_results = get_results_from_directory(logger, args.source_dir)
    if base_results and target_results:
        remove_testcases_to_optimize_regression_runtime(logger, base_results)
        remove_testcases_to_optimize_regression_runtime(logger, target_results)
        regression = ResultsRegressionSelector()
        regression_pair = regression.get_regression_base_target_pair(logger, base_results, target_results)
        logger.debug('Retrieved regression pair=%s' % regression_pair)
        regression.run_regression_with_regression_pairing(logger, regression_pair, base_results, target_results)
    return 0

def register_commands(subparsers):
    """Register subcommands from this plugin"""
    parser_build = subparsers.add_parser('regression-file', help='regression file analysis',
                                         description='regression analysis comparing base result set to target '
                                                     'result set',
                                         group='analysis')
    parser_build.set_defaults(func=regression_file)
    parser_build.add_argument('base_result_file',
                              help='base result file provide the base result set')
    parser_build.add_argument('target_result_file',
                              help='target result file provide the target result set for comparison with base result')
    parser_build.add_argument('-b', '--base-result-id', default='',
                              help='(optional) default select regression based on configurations unless base result '
                                   'id was provided')
    parser_build.add_argument('-t', '--target-result-id', default='',
                              help='(optional) default select regression based on configurations unless target result '
                                   'id was provided')

    parser_build = subparsers.add_parser('regression-dir', help='regression directory analysis',
                                         description='regression analysis comparing base result set to target '
                                                     'result set',
                                         group='analysis')
    parser_build.set_defaults(func=regression_directory)
    parser_build.add_argument('base_result_directory',
                              help='base result directory provide the files for base result set')
    parser_build.add_argument('target_result_directory',
                              help='target result file provide the files for target result set for comparison with '
                                   'base result')

    parser_build = subparsers.add_parser('regression-git', help='regression git analysis',
                                         description='regression analysis comparing base result set to target '
                                                     'result set',
                                         group='analysis')
    parser_build.set_defaults(func=regression_git)
    parser_build.add_argument('source_dir',
                              help='source directory that contain the git repository with test result files')
    parser_build.add_argument('base_git_branch',
                              help='base git branch that provide the files for base result set')
    parser_build.add_argument('target_git_branch',
                              help='target git branch that provide the files for target result set for comparison with '
                                   'base result')