3 # Pretty-format subunit output
4 # Copyright (C) 2008-2010 Jelmer Vernooij <jelmer@samba.org>
5 # Published under the GNU GPL, v3 or later
14 class PlainFormatter(object):
16 def __init__(self, summaryfile, verbose, immediate, statistics,
18 self.verbose = verbose
19 self.immediate = immediate
20 self.statistics = statistics
21 self.start_time = None
23 self.suitesfailed = []
26 self.summaryfile = summaryfile
29 self._progress_level = 0
30 self.totalsuites = totaltests
32 def progress(self, offset, whence):
33 if whence == subunit.PROGRESS_POP:
34 self._progress_level -= 1
35 elif whence == subunit.PROGRESS_PUSH:
36 self._progress_level += 1
37 elif whence == subunit.PROGRESS_SET:
38 if self._progress_level == 0:
39 self.totalsuites = offset
40 elif whence == subunit.PROGRESS_CUR:
41 raise NotImplementedError
43 def report_time(self, time):
44 if self.start_time is None:
45 self.start_time = time
48 def start_testsuite(self, name):
51 testsuite_start_time = self.last_time
53 duration = testsuite_start_time - self.start_time
56 self.test_output[name] = ""
58 out = "[%d" % self.index
59 if self.totalsuites is not None:
60 out += "/%d" % self.totalsuites
61 out += " in %ds" % duration
63 out += ", %d errors" % (len(self.suitesfailed),)
66 sys.stdout.write(out + "\n")
68 sys.stdout.write(out + ": ")
70 def output_msg(self, output):
72 sys.stdout.write(output)
73 elif self.name is not None:
74 self.test_output[self.name] += output
76 sys.stdout.write(output)
78 def control_msg(self, output):
79 #$self->output_msg($output)
82 def end_testsuite(self, name, result, reason):
86 if not name in self.test_output:
87 print "no output for name[%s]" % name
89 if result in ("success", "xfail"):
92 self.output_msg("ERROR: Testsuite[%s]\nREASON: %s\n" % (name, reason or ''))
93 self.suitesfailed.append(name)
94 if self.immediate and not self.verbose:
95 out += self.test_output[name]
98 if not self.immediate:
102 out += " " + result.upper() + "\n"
104 sys.stdout.write(out)
106 def start_test(self, testname):
109 def end_test(self, testname, result, unexpected, reason):
111 self.test_output[self.name] = ""
112 if not self.immediate:
117 'success': '.'}.get(result, "?(%s)" % result))
122 reason = reason.strip()
124 self.test_output[self.name] += "UNEXPECTED(%s): %s\nREASON: %s\n" % (result, testname, reason)
126 if self.immediate and not self.verbose:
127 print self.test_output[self.name]
128 self.test_output[self.name] = ""
130 if not self.immediate:
134 'success': 'S'}.get(result, "?"))
137 f = open(self.summaryfile, 'w+')
139 if self.suitesfailed:
140 f.write("= Failed tests =\n")
142 for suite in self.suitesfailed:
143 f.write("== %s ==\n" % suite)
144 f.write(self.test_output[suite]+"\n\n")
148 if not self.immediate and not self.verbose:
149 for suite in self.suitesfailed:
151 print "FAIL: %s" % suite
152 print self.test_output[suite]
155 f.write("= Skipped tests =\n")
156 for reason in self.skips.keys():
157 f.write(reason + "\n")
158 for name in self.skips[reason]:
159 f.write("\t%s\n" % name)
163 print "\nA summary with detailed information can be found in:"
164 print " %s" % self.summaryfile
166 if not self.suitesfailed:
167 ok = (self.statistics['TESTS_EXPECTED_OK'] +
168 self.statistics['TESTS_EXPECTED_FAIL'])
169 print "\nALL OK (%d tests in %d testsuites)" % (ok, self.suites_ok)
171 print "\nFAILED (%d failures and %d errors in %d testsuites)" % (
172 self.statistics['TESTS_UNEXPECTED_FAIL'],
173 self.statistics['TESTS_ERROR'],
174 len(self.suitesfailed))
176 def skip_testsuite(self, name, reason="UNKNOWN"):
177 self.skips.setdefault(reason, []).append(name)
181 parser = optparse.OptionParser("format-subunit [options]")
182 parser.add_option("--verbose", action="store_true",
184 parser.add_option("--immediate", action="store_true",
185 help="Show failures immediately, don't wait until test run has finished")
186 parser.add_option("--prefix", type="string", default=".",
187 help="Prefix to write summary to")
189 opts, args = parser.parse_args()
193 'TESTS_UNEXPECTED_OK': 0,
194 'TESTS_EXPECTED_OK': 0,
195 'TESTS_UNEXPECTED_FAIL': 0,
196 'TESTS_EXPECTED_FAIL': 0,
201 def handle_sigint(sig, stack):
203 signal.signal(signal.SIGINT, handle_sigint)
205 msg_ops = PlainFormatter(os.path.join(opts.prefix, "summary"), opts.verbose,
206 opts.immediate, statistics)
208 expected_ret = subunithelper.parse_results(msg_ops, statistics, sys.stdin)
212 sys.exit(expected_ret)