1 # Copyright (c) 2016, Matt Layman
4 from unittest
import TextTestResult
, TextTestRunner
5 from unittest
.runner
import _WritelnDecorator
8 from tap
import formatter
10 from tap
.tracker
import Tracker
13 class TAPTestResult(TextTestResult
):
17 def __init__(self
, stream
, descriptions
, verbosity
):
18 super(TAPTestResult
, self
).__init
__(stream
, descriptions
, verbosity
)
20 def stopTestRun(self
):
21 """Once the test run is complete, generate each of the TAP files."""
22 super(TAPTestResult
, self
).stopTestRun()
23 self
.tracker
.generate_tap_reports()
25 def addError(self
, test
, err
):
26 super(TAPTestResult
, self
).addError(test
, err
)
27 diagnostics
= formatter
.format_exception(err
)
28 self
.tracker
.add_not_ok(
29 self
._cls
_name
(test
), self
._description
(test
),
30 diagnostics
=diagnostics
)
32 def addFailure(self
, test
, err
):
33 super(TAPTestResult
, self
).addFailure(test
, err
)
34 diagnostics
= formatter
.format_exception(err
)
35 self
.tracker
.add_not_ok(
36 self
._cls
_name
(test
), self
._description
(test
),
37 diagnostics
=diagnostics
)
39 def addSuccess(self
, test
):
40 super(TAPTestResult
, self
).addSuccess(test
)
41 self
.tracker
.add_ok(self
._cls
_name
(test
), self
._description
(test
))
43 def addSkip(self
, test
, reason
):
44 super(TAPTestResult
, self
).addSkip(test
, reason
)
45 self
.tracker
.add_skip(
46 self
._cls
_name
(test
), self
._description
(test
), reason
)
48 def addExpectedFailure(self
, test
, err
):
49 super(TAPTestResult
, self
).addExpectedFailure(test
, err
)
50 diagnostics
= formatter
.format_exception(err
)
51 self
.tracker
.add_not_ok(
52 self
._cls
_name
(test
), self
._description
(test
),
53 _('(expected failure)'), diagnostics
=diagnostics
)
55 def addUnexpectedSuccess(self
, test
):
56 super(TAPTestResult
, self
).addUnexpectedSuccess(test
)
57 self
.tracker
.add_ok(self
._cls
_name
(test
), self
._description
(test
),
58 _('(unexpected success)'))
60 def _cls_name(self
, test
):
61 return test
.__class
__.__name
__
63 def _description(self
, test
):
66 return self
.FORMAT
.format(
67 method_name
=str(test
),
68 short_description
=test
.shortDescription() or '')
71 'Bad format string: {format}\n'
72 'Replacement options are: {{short_description}} and '
73 '{{method_name}}').format(format
=self
.FORMAT
))
75 return test
.shortDescription() or str(test
)
78 # TODO: 2016-7-30 mblayman - Since the 2.6 signature is no longer relevant,
79 # check the possibility of removing the module level scope.
81 # Module level state stinks, but this is the only way to keep compatibility
82 # with Python 2.6. The best place for the tracker is as an instance variable
83 # on the runner, but __init__ is so different that it is not easy to create
84 # a runner that satisfies every supported Python version.
88 class TAPTestRunner(TextTestRunner
):
89 """A test runner that will behave exactly like TextTestRunner and will
90 additionally generate TAP files for each test case"""
92 resultclass
= TAPTestResult
94 def set_stream(self
, streaming
):
95 """Set the streaming boolean option to stream TAP directly to stdout.
97 The test runner default output will be suppressed in favor of TAP.
99 self
.stream
= _WritelnDecorator(open(os
.devnull
, 'w'))
100 _tracker
.streaming
= streaming
101 _tracker
.stream
= sys
.stdout
103 def _makeResult(self
):
104 result
= self
.resultclass(
105 self
.stream
, self
.descriptions
, self
.verbosity
)
106 result
.tracker
= _tracker
110 def set_outdir(cls
, outdir
):
111 """Set the output directory so that TAP files are written to the
112 specified outdir location.
114 # Blame the lack of unittest extensibility for this hacky method.
115 _tracker
.outdir
= outdir
118 def set_combined(cls
, combined
):
119 """Set the tracker to use a single output file."""
120 _tracker
.combined
= combined
123 def set_header(cls
, header
):
124 """Set the header display flag."""
125 _tracker
.header
= header
128 def set_format(cls
, fmt
):
129 """Set the format of each test line.
131 The format string can use:
132 * {method_name}: The test method name
133 * {short_description}: The test's docstring short description
135 TAPTestResult
.FORMAT
= fmt
This page took 0.047978 seconds and 4 git commands to generate.