3 # Pretty-format subunit output
4 # Copyright (C) 2008-2010 Jelmer Vernooij <jelmer@samba.org>
5 # Published under the GNU GPL, v3 or later
12 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../lib/subunit/python"))
13 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../lib/testtools"))
19 def format_time(delta):
20 minutes, seconds = divmod(delta.seconds, 60)
21 hours, minutes = divmod(minutes, 60)
26 ret += "%dm" % minutes
27 ret += "%ds" % seconds
31 class PlainFormatter(subunithelper.TestsuiteEnabledTestResult):
33 def __init__(self, summaryfile, verbose, immediate, statistics,
35 self.verbose = verbose
36 self.immediate = immediate
37 self.statistics = statistics
38 self.start_time = None
40 self.suitesfailed = []
43 self.summaryfile = summaryfile
46 self._progress_level = 0
47 self.totalsuites = totaltests
50 def progress(self, offset, whence):
51 if whence == subunit.PROGRESS_POP:
52 self._progress_level -= 1
53 elif whence == subunit.PROGRESS_PUSH:
54 self._progress_level += 1
55 elif whence == subunit.PROGRESS_SET:
56 if self._progress_level == 0:
57 self.totalsuites = offset
58 elif whence == subunit.PROGRESS_CUR:
59 raise NotImplementedError
62 if self.start_time is None:
66 def start_testsuite(self, name):
71 self.test_output[name] = ""
73 out = "[%d" % self.index
74 if self.totalsuites is not None:
75 out += "/%d" % self.totalsuites
76 if self.start_time is not None:
77 out += " in " + format_time(self.last_time - self.start_time)
79 out += ", %d errors" % (len(self.suitesfailed),)
82 sys.stdout.write(out + "\n")
84 sys.stdout.write(out + ": ")
86 def output_msg(self, output):
88 sys.stdout.write(output)
89 elif self.name is not None:
90 self.test_output[self.name] += output
92 sys.stdout.write(output)
94 def control_msg(self, output):
95 #$self->output_msg($output)
98 def end_testsuite(self, name, result, reason):
102 if not name in self.test_output:
103 print "no output for name[%s]" % name
105 if result in ("success", "xfail"):
108 self.output_msg("ERROR: Testsuite[%s]\n" % name)
109 if reason is not None:
110 self.output_msg("REASON: %s\n" % (reason,))
111 self.suitesfailed.append(name)
112 if self.immediate and not self.verbose and name in self.test_output:
113 out += self.test_output[name]
116 if not self.immediate:
120 out += " " + result.upper() + "\n"
122 sys.stdout.write(out)
124 def startTest(self, test):
127 def addSuccess(self, test, details=None):
128 self.end_test(test.id(), "success", False, details)
130 def addError(self, test, details=None):
131 self.end_test(test.id(), "error", True, details)
133 def addFailure(self, test, details=None):
134 self.end_test(test.id(), "failure", True, details)
136 def addSkip(self, test, details=None):
137 self.end_test(test.id(), "skip", False, details)
139 def addExpectedFail(self, test, details=None):
140 self.end_test(test.id(), "xfail", False, details)
142 def end_test(self, testname, result, unexpected, reason=None):
144 self.test_output[self.name] = ""
145 if not self.immediate:
150 'success': '.'}.get(result, "?(%s)" % result))
153 self.test_output[self.name] += "UNEXPECTED(%s): %s\n" % (result, testname)
154 if reason is not None:
155 self.test_output[self.name] += "REASON: %s\n" % (reason.strip(),)
157 if self.immediate and not self.verbose:
158 print self.test_output[self.name]
159 self.test_output[self.name] = ""
161 if not self.immediate:
165 'success': 'S'}.get(result, "?"))
168 f = open(self.summaryfile, 'w+')
170 if self.suitesfailed:
171 f.write("= Failed tests =\n")
173 for suite in self.suitesfailed:
174 f.write("== %s ==\n" % suite)
175 if suite in self.test_output:
176 f.write(self.test_output[suite]+"\n\n")
180 if not self.immediate and not self.verbose:
181 for suite in self.suitesfailed:
183 print "FAIL: %s" % suite
184 if suite in self.test_output:
185 print self.test_output[suite]
188 f.write("= Skipped tests =\n")
189 for reason in self.skips.keys():
190 f.write(reason + "\n")
191 for name in self.skips[reason]:
192 f.write("\t%s\n" % name)
196 print "\nA summary with detailed information can be found in:"
197 print " %s" % self.summaryfile
199 if not self.suitesfailed:
200 ok = (self.statistics['TESTS_EXPECTED_OK'] +
201 self.statistics['TESTS_EXPECTED_FAIL'])
202 print "\nALL OK (%d tests in %d testsuites)" % (ok, self.suites_ok)
204 print "\nFAILED (%d failures and %d errors in %d testsuites)" % (
205 self.statistics['TESTS_UNEXPECTED_FAIL'],
206 self.statistics['TESTS_ERROR'],
207 len(self.suitesfailed))
209 def skip_testsuite(self, name, reason="UNKNOWN"):
210 self.skips.setdefault(reason, []).append(name)
214 parser = optparse.OptionParser("format-subunit [options]")
215 parser.add_option("--verbose", action="store_true",
217 parser.add_option("--immediate", action="store_true",
218 help="Show failures immediately, don't wait until test run has finished")
219 parser.add_option("--prefix", type="string", default=".",
220 help="Prefix to write summary to")
222 opts, args = parser.parse_args()
226 'TESTS_UNEXPECTED_OK': 0,
227 'TESTS_EXPECTED_OK': 0,
228 'TESTS_UNEXPECTED_FAIL': 0,
229 'TESTS_EXPECTED_FAIL': 0,
234 def handle_sigint(sig, stack):
236 signal.signal(signal.SIGINT, handle_sigint)
238 msg_ops = PlainFormatter(os.path.join(opts.prefix, "summary"), opts.verbose,
239 opts.immediate, statistics)
241 expected_ret = subunithelper.parse_results(msg_ops, statistics, sys.stdin)
245 sys.exit(expected_ret)