2 # subunit: extensions to Python unittest to get test results from subprocesses.
3 # Copyright (C) 2009 Robert Collins <robertc@robertcollins.net>
5 # Licensed under either the Apache License, Version 2.0 or the BSD 3-clause
6 # license at the users choice. A copy of both licenses are available in the
7 # project source as Apache-2.0 and BSD. You may not use this file except in
8 # compliance with one of these two licences.
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under these licenses is distributed on an "AS IS" BASIS, WITHOUT
12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 # license you chose for the specific language governing permissions and
14 # limitations under that license.
17 """TestResult helper classes used to by subunit."""
25 # NOT a TestResult, because we are implementing the interface, not inheriting
27 class TestResultDecorator(object):
28 """General pass-through decorator.
30 This provides a base that other TestResults can inherit from to
31 gain basic forwarding functionality. It also takes care of
32 handling the case where the target doesn't support newer methods
33 or features by degrading them.
36 def __init__(self, decorated):
37 """Create a TestResultDecorator forwarding to decorated."""
38 # Make every decorator degrade gracefully.
39 self.decorated = testtools.ExtendedToOriginalDecorator(decorated)
41 def startTest(self, test):
42 return self.decorated.startTest(test)
44 def startTestRun(self):
45 return self.decorated.startTestRun()
47 def stopTest(self, test):
48 return self.decorated.stopTest(test)
50 def stopTestRun(self):
51 return self.decorated.stopTestRun()
53 def addError(self, test, err=None, details=None):
54 return self.decorated.addError(test, err, details=details)
56 def addFailure(self, test, err=None, details=None):
57 return self.decorated.addFailure(test, err, details=details)
59 def addSuccess(self, test, details=None):
60 return self.decorated.addSuccess(test, details=details)
62 def addSkip(self, test, reason=None, details=None):
63 return self.decorated.addSkip(test, reason, details=details)
65 def addExpectedFailure(self, test, err=None, details=None):
66 return self.decorated.addExpectedFailure(test, err, details=details)
68 def addUnexpectedSuccess(self, test, details=None):
69 return self.decorated.addUnexpectedSuccess(test, details=details)
71 def progress(self, offset, whence):
72 return self.decorated.progress(offset, whence)
74 def wasSuccessful(self):
75 return self.decorated.wasSuccessful()
79 return self.decorated.shouldStop
82 return self.decorated.stop()
84 def tags(self, new_tags, gone_tags):
85 return self.decorated.time(new_tags, gone_tags)
87 def time(self, a_datetime):
88 return self.decorated.time(a_datetime)
91 class HookedTestResultDecorator(TestResultDecorator):
92 """A TestResult which calls a hook on every event."""
94 def __init__(self, decorated):
95 self.super = super(HookedTestResultDecorator, self)
96 self.super.__init__(decorated)
98 def startTest(self, test):
100 return self.super.startTest(test)
102 def startTestRun(self):
104 return self.super.startTestRun()
106 def stopTest(self, test):
108 return self.super.stopTest(test)
110 def stopTestRun(self):
112 return self.super.stopTestRun()
114 def addError(self, test, err=None, details=None):
116 return self.super.addError(test, err, details=details)
118 def addFailure(self, test, err=None, details=None):
120 return self.super.addFailure(test, err, details=details)
122 def addSuccess(self, test, details=None):
124 return self.super.addSuccess(test, details=details)
126 def addSkip(self, test, reason=None, details=None):
128 return self.super.addSkip(test, reason, details=details)
130 def addExpectedFailure(self, test, err=None, details=None):
132 return self.super.addExpectedFailure(test, err, details=details)
134 def addUnexpectedSuccess(self, test, details=None):
136 return self.super.addUnexpectedSuccess(test, details=details)
138 def progress(self, offset, whence):
140 return self.super.progress(offset, whence)
142 def wasSuccessful(self):
144 return self.super.wasSuccessful()
147 def shouldStop(self):
149 return self.super.shouldStop
153 return self.super.stop()
155 def time(self, a_datetime):
157 return self.super.time(a_datetime)
160 class AutoTimingTestResultDecorator(HookedTestResultDecorator):
161 """Decorate a TestResult to add time events to a test run.
163 By default this will cause a time event before every test event,
164 but if explicit time data is being provided by the test run, then
165 this decorator will turn itself off to prevent causing confusion.
168 def __init__(self, decorated):
170 super(AutoTimingTestResultDecorator, self).__init__(decorated)
172 def _before_event(self):
176 time = datetime.datetime.utcnow().replace(tzinfo=iso8601.Utc())
177 self.decorated.time(time)
179 def progress(self, offset, whence):
180 return self.decorated.progress(offset, whence)
183 def shouldStop(self):
184 return self.decorated.shouldStop
186 def time(self, a_datetime):
187 """Provide a timestamp for the current test activity.
189 :param a_datetime: If None, automatically add timestamps before every
190 event (this is the default behaviour if time() is not called at
191 all). If not None, pass the provided time onto the decorated
192 result object and disable automatic timestamps.
194 self._time = a_datetime
195 return self.decorated.time(a_datetime)
198 class TestResultFilter(TestResultDecorator):
199 """A pyunit TestResult interface implementation which filters tests.
201 Tests that pass the filter are handed on to another TestResult instance
202 for further processing/reporting. To obtain the filtered results,
203 the other instance must be interrogated.
205 :ivar result: The result that tests are passed to after filtering.
206 :ivar filter_predicate: The callback run to decide whether to pass
210 def __init__(self, result, filter_error=False, filter_failure=False,
211 filter_success=True, filter_skip=False,
212 filter_predicate=None):
213 """Create a FilterResult object filtering to result.
215 :param filter_error: Filter out errors.
216 :param filter_failure: Filter out failures.
217 :param filter_success: Filter out successful tests.
218 :param filter_skip: Filter out skipped tests.
219 :param filter_predicate: A callable taking (test, outcome, err,
220 details) and returning True if the result should be passed
221 through. err and details may be none if no error or extra
222 metadata is available. outcome is the name of the outcome such
223 as 'success' or 'failure'.
225 TestResultDecorator.__init__(self, result)
226 self._filter_error = filter_error
227 self._filter_failure = filter_failure
228 self._filter_success = filter_success
229 self._filter_skip = filter_skip
230 if filter_predicate is None:
231 filter_predicate = lambda test, outcome, err, details: True
232 self.filter_predicate = filter_predicate
233 # The current test (for filtering tags)
234 self._current_test = None
235 # Has the current test been filtered (for outputting test tags)
236 self._current_test_filtered = None
237 # The (new, gone) tags for the current test.
238 self._current_test_tags = None
240 def addError(self, test, err=None, details=None):
241 if (not self._filter_error and
242 self.filter_predicate(test, 'error', err, details)):
243 self.decorated.startTest(test)
244 self.decorated.addError(test, err, details=details)
248 def addFailure(self, test, err=None, details=None):
249 if (not self._filter_failure and
250 self.filter_predicate(test, 'failure', err, details)):
251 self.decorated.startTest(test)
252 self.decorated.addFailure(test, err, details=details)
256 def addSkip(self, test, reason=None, details=None):
257 if (not self._filter_skip and
258 self.filter_predicate(test, 'skip', reason, details)):
259 self.decorated.startTest(test)
260 self.decorated.addSkip(test, reason, details=details)
264 def addSuccess(self, test, details=None):
265 if (not self._filter_success and
266 self.filter_predicate(test, 'success', None, details)):
267 self.decorated.startTest(test)
268 self.decorated.addSuccess(test, details=details)
272 def addExpectedFailure(self, test, err=None, details=None):
273 if self.filter_predicate(test, 'expectedfailure', err, details):
274 self.decorated.startTest(test)
275 return self.decorated.addExpectedFailure(test, err,
280 def addUnexpectedSuccess(self, test, details=None):
281 self.decorated.startTest(test)
282 return self.decorated.addUnexpectedSuccess(test, details=details)
285 self._current_test_filtered = True
287 def startTest(self, test):
290 Not directly passed to the client, but used for handling of tags
293 self._current_test = test
294 self._current_test_filtered = False
295 self._current_test_tags = set(), set()
297 def stopTest(self, test):
300 Not directly passed to the client, but used for handling of tags
303 if not self._current_test_filtered:
304 # Tags to output for this test.
305 if self._current_test_tags[0] or self._current_test_tags[1]:
306 self.decorated.tags(*self._current_test_tags)
307 self.decorated.stopTest(test)
308 self._current_test = None
309 self._current_test_filtered = None
310 self._current_test_tags = None
312 def tags(self, new_tags, gone_tags):
313 """Handle tag instructions.
315 Adds and removes tags as appropriate. If a test is currently running,
316 tags are not affected for subsequent tests.
318 :param new_tags: Tags to add,
319 :param gone_tags: Tags to remove.
321 if self._current_test is not None:
322 # gather the tags until the test stops.
323 self._current_test_tags[0].update(new_tags)
324 self._current_test_tags[0].difference_update(gone_tags)
325 self._current_test_tags[1].update(gone_tags)
326 self._current_test_tags[1].difference_update(new_tags)
327 return self.decorated.tags(new_tags, gone_tags)
329 def id_to_orig_id(self, id):
330 if id.startswith("subunit.RemotedTestCase."):
331 return id[len("subunit.RemotedTestCase."):]
335 class TestIdPrintingResult(testtools.TestResult):
337 def __init__(self, stream, show_times=False):
338 """Create a FilterResult object outputting to stream."""
339 testtools.TestResult.__init__(self)
340 self._stream = stream
341 self.failed_tests = 0
343 self.show_times = show_times
345 self._test_duration = 0
347 def addError(self, test, err):
348 self.failed_tests += 1
351 def addFailure(self, test, err):
352 self.failed_tests += 1
355 def addSuccess(self, test):
358 def reportTest(self, test, duration):
360 seconds = duration.seconds
361 seconds += duration.days * 3600 * 24
362 seconds += duration.microseconds / 1000000.0
363 self._stream.write(test.id() + ' %0.3f\n' % seconds)
365 self._stream.write(test.id() + '\n')
367 def startTest(self, test):
368 self._start_time = self._time()
370 def stopTest(self, test):
371 test_duration = self._time() - self._start_time
372 self.reportTest(self._test, test_duration)
374 def time(self, time):
380 def wasSuccessful(self):
381 "Tells whether or not this result was a success"
382 return self.failed_tests == 0