results.py revision 11482:2ca1efb451e4 
1#!/usr/bin/env python
2#
3# Copyright (c) 2016 ARM Limited
4# All rights reserved
5#
6# The license below extends only to copyright in the software and shall
7# not be construed as granting a license to any other intellectual
8# property including but not limited to intellectual property relating
9# to a hardware implementation of the functionality of the software
10# licensed hereunder.  You may use the software subject to the license
11# terms below provided that you ensure that this notice is replicated
12# unmodified and in its entirety in all distributions of the software,
13# modified or unmodified, in source code or in binary form.
14#
15# Redistribution and use in source and binary forms, with or without
16# modification, are permitted provided that the following conditions are
17# met: redistributions of source code must retain the above copyright
18# notice, this list of conditions and the following disclaimer;
19# redistributions in binary form must reproduce the above copyright
20# notice, this list of conditions and the following disclaimer in the
21# documentation and/or other materials provided with the distribution;
22# neither the name of the copyright holders nor the names of its
23# contributors may be used to endorse or promote products derived from
24# this software without specific prior written permission.
25#
26# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37#
38# Authors: Andreas Sandberg
39
40from abc import ABCMeta, abstractmethod
41import inspect
42import pickle
43import string
44import sys
45
46import xml.etree.cElementTree as ET
47
48class UnitResult(object):
49    """Results of a single test unit.
50
51    A test result can be one of:
52        - STATE_OK: Test ran successfully.
53        - STATE_SKIPPED: The test was skipped.
54        - STATE_ERROR: The test failed to run.
55        - STATE_FAILED: Test ran, but failed.
56
57    The difference between STATE_ERROR and STATE_FAILED is very
58    subtle. In a gem5 context, STATE_ERROR would mean that gem5 failed
59    to start or crashed, while STATE_FAILED would mean that a test
60    failed (e.g., statistics mismatch).
61
62    """
63
64    STATE_OK = 0
65    STATE_SKIPPED = 1
66    STATE_ERROR = 2
67    STATE_FAILURE = 3
68
69    state_names = {
70        STATE_OK : "OK",
71        STATE_SKIPPED : "SKIPPED",
72        STATE_ERROR : "ERROR",
73        STATE_FAILURE : "FAILURE",
74    }
75
76    def __init__(self, name, state, message="", stderr="", stdout="",
77                 runtime=0.0):
78        self.name = name
79        self.state = state
80        self.message = message
81        self.stdout = stdout
82        self.stderr = stderr
83        self.runtime = runtime
84
85    def skipped(self):
86        return self.state == UnitResult.STATE_SKIPPED
87
88    def success(self):
89        return self.state == UnitResult.STATE_OK
90
91    def state_name(self):
92        return UnitResult.state_names[self.state]
93
94    def __nonzero__(self):
95        return self.success() or self.skipped()
96
97    def __str__(self):
98        state_name = self.state_name()
99
100        status = "%s: %s" % (state_name, self.message) if self.message else \
101                 state_name
102
103        return "%s: %s" % (self.name, status)
104
105class TestResult(object):
106    """Results for from a single test consisting of one or more units."""
107
108    def __init__(self, name, results=[]):
109        self.name = name
110        self.results = results
111
112    def success(self):
113        return all([ r.success() for r in self.results])
114
115    def skipped(self):
116        return all([ r.skipped() for r in self.results])
117
118    def failed(self):
119        return any([ not r for r in self.results])
120
121    def runtime(self):
122        return sum([ r.runtime for r in self.results ])
123
124    def __nonzero__(self):
125        return all([r for r in self.results])
126
127class ResultFormatter(object):
128    __metaclass__ = ABCMeta
129
130    def __init__(self, fout=sys.stdout, verbose=False):
131        self.verbose = verbose
132        self.fout = fout
133
134    @abstractmethod
135    def dump_suites(self, suites):
136        pass
137
138class Pickle(ResultFormatter):
139    """Save test results as a binary using Python's pickle
140    functionality.
141
142    """
143
144    def __init__(self, **kwargs):
145        super(Pickle, self).__init__(**kwargs)
146
147    def dump_suites(self, suites):
148        pickle.dump(suites, self.fout, pickle.HIGHEST_PROTOCOL)
149
150class Text(ResultFormatter):
151    """Output test results as text."""
152
153    def __init__(self, **kwargs):
154        super(Text, self).__init__(**kwargs)
155
156    def dump_suites(self, suites):
157        fout = self.fout
158        for suite in suites:
159            print >> fout, "--- %s ---" % suite.name
160
161            for t in suite.results:
162                print >> fout, "*** %s" % t
163
164                if t and not self.verbose:
165                    continue
166
167                if t.message:
168                    print >> fout, t.message
169
170                if t.stderr:
171                    print >> fout, t.stderr
172                if t.stdout:
173                    print >> fout, t.stdout
174
175class TextSummary(ResultFormatter):
176    """Output test results as a text summary"""
177
178    def __init__(self, **kwargs):
179        super(TextSummary, self).__init__(**kwargs)
180
181    def dump_suites(self, suites):
182        fout = self.fout
183        for suite in suites:
184            status = "SKIPPED" if suite.skipped() else \
185                     ("OK" if suite else "FAILED")
186            print >> fout, "%s: %s" % (suite.name, status)
187
188class JUnit(ResultFormatter):
189    """Output test results as JUnit XML"""
190
191    def __init__(self, translate_names=True, **kwargs):
192        super(JUnit, self).__init__(**kwargs)
193
194        if translate_names:
195            self.name_table = string.maketrans(
196                "/.",
197                ".-",
198            )
199        else:
200            self.name_table = string.maketrans("", "")
201
202    def convert_unit(self, x_suite, test):
203        x_test = ET.SubElement(x_suite, "testcase",
204                               name=test.name,
205                               time="%f" % test.runtime)
206
207        x_state = None
208        if test.state == UnitResult.STATE_OK:
209            pass
210        elif test.state == UnitResult.STATE_SKIPPED:
211            x_state = ET.SubElement(x_test, "skipped")
212        elif test.state == UnitResult.STATE_FAILURE:
213            x_state = ET.SubElement(x_test, "failure")
214        elif test.state == UnitResult.STATE_ERROR:
215            x_state = ET.SubElement(x_test, "error")
216        else:
217            assert False, "Unknown test state"
218
219        if x_state is not None:
220            if test.message:
221                x_state.set("message", test.message)
222
223            msg = []
224            if test.stderr:
225                msg.append("*** Standard Errror: ***")
226                msg.append(test.stderr)
227            if test.stdout:
228                msg.append("*** Standard Out: ***")
229                msg.append(test.stdout)
230
231            x_state.text = "\n".join(msg)
232
233        return x_test
234
235    def convert_suite(self, x_suites, suite):
236        x_suite = ET.SubElement(x_suites, "testsuite",
237                                name=suite.name.translate(self.name_table),
238                                time="%f" % suite.runtime())
239        errors = 0
240        failures = 0
241        skipped = 0
242
243        for test in suite.results:
244            if test.state != UnitResult.STATE_OK:
245                if test.state == UnitResult.STATE_SKIPPED:
246                    skipped += 1
247                elif test.state == UnitResult.STATE_ERROR:
248                    errors += 1
249                elif test.state == UnitResult.STATE_FAILURE:
250                    failures += 1
251
252            x_test = self.convert_unit(x_suite, test)
253
254        x_suite.set("errors", str(errors))
255        x_suite.set("failures", str(failures))
256        x_suite.set("skipped", str(skipped))
257        x_suite.set("tests", str(len(suite.results)))
258
259        return x_suite
260
261    def convert_suites(self, suites):
262        x_root = ET.Element("testsuites")
263
264        for suite in suites:
265            self.convert_suite(x_root, suite)
266
267        return x_root
268
269    def dump_suites(self, suites):
270        et = ET.ElementTree(self.convert_suites(suites))
271        et.write(self.fout, encoding="UTF-8")
272