Support unexpected success outcomes.
[third_party/subunit] / NEWS
1 ---------------------
2 subunit release notes
3 ---------------------
4
5 NEXT (In development)
6 ---------------------
7
8 The Subunit Python test runner ``python -m subunit.run`` can now report the
9 test ids and also filter via a test id list file thanks to improvements in
10 ``testtools.run``. See the testtools manual, or testrepository - a major
11 user of such functionality.
12
13 Additionally the protocol now has a keyword uxsuccess for Unexpected Success
14 reporting. Older parsers will report tests with this status code as 'lost
15 connection'.
16
17 IMPROVEMENTS
18 ~~~~~~~~~~~~
19
20 * Add ``TimeCollapsingDecorator`` which collapses multiple sequential time()
21   calls into just the first and last. (Jonathan Lange)
22
23 * Add ``TagCollapsingDecorator`` which collapses many tags() calls into one
24   where possible. (Jonathan Lange)
25
26 * Force flush of writes to stdout in c/tests/test_child.
27   (Jelmer Vernooij, #687611)
28
29 * Provisional Python 3.x support.
30   (Robert Collins, Tres Seaver, Martin[gz], #666819)
31
32 * ``subunit.chunked.Decoder`` Python class takes a new ``strict`` option,
33   which defaults to ``True``. When ``False``, the ``Decoder`` will accept
34   incorrect input that is still unambiguous. i.e. subunit will not barf if
35   a \r is missing from the input. (Martin Pool)
36
37 * ``subunit-filter`` preserves the relative ordering of ``time:`` statements,
38   so you can now use filtered streams to gather data about how long it takes
39   to run a test. (Jonathan Lange, #716554)
40
41 * ``TestResultFilter`` now collapses sequential calls to time().
42   (Jonathan Lange, #567150)
43
44 * ``TestResultDecorator.tags()`` now actually works, and is no longer a buggy
45   copy/paste of ``TestResultDecorator.time()``. (Jonathan Lange, #681828)
46
47 * ``TestResultFilter`` now supports a ``fixup_expected_failures``
48   argument. (Jelmer Vernooij, #755241)
49
50 * The ``subunit.run`` Python module supports ``-l`` and ``--load-list`` as
51   per ``testtools.run``. This required a dependency bump due to a small
52   API change in ``testtools``. (Robert Collins)
53
54 * The help for subunit-filter was confusing about the behaviour of ``-f`` /
55   ``--no-failure``. (Robert Collins, #703392)
56
57 * The Python2.7 / testtools addUnexpectedSuccess API is now supported. This
58   required adding a new status code to the protocol. (Robert Collins, #654474)
59
60 =======
61 CHANGES
62 ~~~~~~~
63
64 * Newer testtools is needed as part of the Python 3 support. (Robert Collins)
65
66 0.0.6
67 -----
68
69 This release of subunit fixes a number of unicode related bugs. This depends on
70 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
71 is also an optional native setup.py file for use with easy_install and the
72 like.
73
74 BUG FIXES
75 ~~~~~~~~~
76
77 * Be consistent about delivering unicode content to testtools StringException
78   class which has become (appropriately) conservative. (Robert Collins)
79
80 * Fix incorrect reference to subunit_test_failf in c/README.
81   (Brad Hards, #524341)
82
83 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
84   is purely cosmetic as the parameters are passed down with no interpretation.
85   (Robert Collins, #537611)
86
87 * Old style tracebacks with no encoding info are now treated as UTF8 rather
88   than some-random-codec-like-ascii. (Robert Collins)
89
90 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
91   binary mode by calling into msvcrt; this avoids having their input or output
92   mangled by the default line ending translation on that platform.
93   (Robert Collins, Martin [gz], #579296)
94
95 IMPROVEMENTS
96 ~~~~~~~~~~~~
97
98 * Subunit now has a setup.py for python deployments that are not using
99   distribution packages. (Tres Seaver, #538181)
100
101 * Subunit now supports test discovery by building on the testtools support for
102   it. You can take advantage of it with "python -m subunit.run discover [path]"
103   and see "python -m subunit.run discover --help" for more options.
104
105 * Subunit now uses the improved unicode support in testtools when outputting
106   non-details based test information; this should consistently UTF8 encode such
107   strings.
108
109 * The Python TestProtocolClient now flushes output on startTest and stopTest.
110   (Martin [gz]).
111
112
113 0.0.5
114 -----
115
116 BUG FIXES
117 ~~~~~~~~~
118
119 * make check was failing if subunit wasn't installed due to a missing include
120   path for the test program test_child.
121
122 * make distcheck was failing due to a missing $(top_srcdir) rune.
123
124 IMPROVEMENTS
125 ~~~~~~~~~~~~
126
127 * New filter `subunit-notify` that will show a notification window with test 
128   statistics when the test run finishes.
129
130 * subunit.run will now pipe its output to the command in the 
131   SUBUNIT_FORMATTER environment variable, if set.
132
133 0.0.4
134 -----
135
136 BUG FIXES
137 ~~~~~~~~~
138
139 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
140   boolean switch with no parameter.
141
142 * Building with autoconf 2.65 is now supported.
143
144
145 0.0.3
146 -----
147
148   CHANGES:
149   
150     * License change, by unanimous agreement of contributors to BSD/Apache
151       License Version 2.0. This makes Subunit compatible with more testing
152       frameworks.
153
154   IMPROVEMENTS:
155
156     * CPPUnit is now directly supported: subunit builds a cppunit listener
157       ``libcppunit-subunit``. 
158
159     * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
160       from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
161       serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
162       The ``ProtocolTestCase`` parser now calls outcomes using an extended
163       API that permits attaching arbitrary MIME resources such as text files
164       log entries and so on. This extended API is being developed with the
165       Python testing community, and is in flux. ``TestResult`` objects that
166       do not support the API will be detected and transparently downgraded
167       back to the regular Python unittest API.
168
169     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
170       viarable when installing.
171
172     * Multipart test outcomes are tentatively supported; the exact protocol
173       for them, both serialiser and object is not yet finalised. Testers and
174       early adopters are sought. As part of this and also in an attempt to
175       provider a more precise focus on the wire protocol and toolchain, 
176       Subunit now depends on testtools (http://launchpad.net/testtools)
177       release 0.9.0 or newer.
178
179     * subunit2junitxml supports a new option, --forward which causes it
180       to forward the raw subunit stream in a similar manner to tee. This
181       is used with the -o option to both write a xml report and get some
182       other subunit filter to process the stream.
183
184     * The C library now has ``subunit_test_skip``.
185
186   BUG FIXES:
187
188     * Install progress_model.py correctly.
189
190     * Non-gcc builds will no longer try to use gcc specific flags.
191       (Thanks trondn-norbye)
192
193   API CHANGES:
194
195   INTERNALS:
196
197 0.0.2
198 -----
199
200   CHANGES:
201
202   IMPROVEMENTS:
203
204     * A number of filters now support ``--no-passthrough`` to cause all
205       non-subunit content to be discarded. This is useful when precise control
206       over what is output is required - such as with subunit2junitxml.
207
208     * A small perl parser is now included, and a new ``subunit-diff`` tool
209       using that is included. (Jelmer Vernooij)
210
211     * Subunit streams can now include optional, incremental lookahead
212       information about progress. This allows reporters to make estimates
213       about completion, when such information is available. See the README
214       under ``progress`` for more details.
215
216     * ``subunit-filter`` now supports regex filtering via ``--with`` and
217       ``without`` options. (Martin Pool)
218
219     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
220       test stream.
221
222     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
223       test reporter to be used, which has a textual progress bar. This requires
224       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
225
226     * ``subunit2junitxml`` has been added. This filter converts a subunit
227       stream to a single JUnit style XML stream using the pyjunitxml
228       python library.
229
230     * The shell functions support skipping via ``subunit_skip_test`` now.
231
232   BUG FIXES:
233
234     * ``xfail`` outcomes are now passed to python TestResult's via
235       addExpectedFailure if it is present on the TestResult. Python 2.6 and
236       earlier which do not have this function will have ``xfail`` outcomes
237       passed through as success outcomes as earlier versions of subunit did.
238
239   API CHANGES:
240
241     * tags are no longer passed around in python via the ``TestCase.tags``
242       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
243       and like in the protocol, if called while a test is active only applies
244       to that test. (Robert Collins)
245
246     * ``TestResultFilter`` takes a new optional constructor parameter 
247       ``filter_predicate``.  (Martin Pool)
248
249     * When a progress: directive is encountered in a subunit stream, the
250       python bindings now call the ``progress(offset, whence)`` method on
251       ``TestResult``.
252
253     * When a time: directive is encountered in a subunit stream, the python
254       bindings now call the ``time(seconds)`` method on ``TestResult``.
255
256   INTERNALS:
257
258     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
259       users of subunit will want to wrap their ``TestProtocolClient`` objects
260       in this decorator to get test timing data for performance analysis.
261
262     * (python) ExecTestCase supports passing arguments to test scripts.
263
264     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
265       which can be used to call some code on every event, without having to
266       implement all the event methods.
267
268     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
269       causes a timestamp to be output to the stream.