11 * Subunit v2 packets with both file content and route code were not being
12 parsed correctly - they would incorrectly emit a parser error, due to trying
13 to parse the route code length from the first byes of the file content.
14 (Robert Collins, 1172815)
19 v2 protocol draft included in this release. The v2 protocol trades off human
20 readability for a massive improvement in robustness, the ability to represent
21 concurrent tests in a single stream, cheaper parsing, and that provides
22 significantly better in-line debugging support and structured forwarding
23 of non-test data (such as stdout or stdin data).
25 This change includes two new filters (subunit-1to2 and subunit-2to1). Use
26 these filters to convert old streams to v2 and convert v2 streams to v1.
28 All the other filters now only parse and emit v2 streams. V2 is still in
29 draft format, so if you want to delay and wait for v2 to be finalised, you
30 should use subunit-2to1 before any serialisation steps take place.
31 With the ability to encapsulate multiple non-test streams, another significant
32 cange is that filters which emit subunit now encapsulate any non-subunit they
33 encounter, labelling it 'stdout'. This permits multiplexing such streams and
34 detangling the stdout streams from each input.
36 The subunit libraries (Python etc) have not changed their behaviour: they
37 still emit v1 from their existing API calls. New API's are being added
38 and applications should migrate once their language has those API's available.
43 * ``subunit.run`` now replaces sys.stdout to ensure that stdout is unbuffered
44 - without this pdb output is not reliably visible when stdout is a pipe
45 as it usually is. (Robert Collins)
47 * v2 protocol draft included in this release. (Python implementation only so
48 far). (Robert Collins)
50 * Two new Python classes -- ``StreamResultToBytes`` and
51 ``ByteStreamToStreamResult`` handle v2 generation and parsing.
60 * make_stream_binary is now public for reuse. (Robert Collins)
62 * NAME was not defined in the protocol BNF. (Robert Collins)
64 * UnsupportedOperation is available in the Python2.6 io library, so ask
65 forgiveness rather than permission for obtaining it. (Robert Collins)
67 * Streams with no fileno() attribute are now supported, but they are not
68 checked for being in binary mode: be sure to take care of that if using
69 the library yourself. (Robert Collins)
77 * All the source files are now included in the distribution tarball.
78 (Arfrever Frehtes Taifersar Arahesis, Robert Collins, #996275)
80 * ``python/subunit/tests/test_run.py`` and ``python/subunit/filters.py`` were
81 not included in the 0.0.8 tarball. (Robert Collins)
83 * Test ids which include non-ascii unicode characters are now supported.
84 (Robert Collins, #1029866)
86 * The ``failfast`` option to ``subunit.run`` will now work. The dependency on
87 testtools has been raised to 0.9.23 to permit this.
88 (Robert Collins, #1090582)
96 * Perl module now correctly outputs "failure" instead of "fail". (Stewart Smith)
98 * Shell functions now output timestamps. (Stewart Smith, Robert Collins)
100 * 'subunit2csv' script that converts subunit output to CSV format.
103 * ``TagCollapsingDecorator`` now correctly distinguishes between local and
104 global tags. (Jonathan Lange)
106 * ``TestResultFilter`` always forwards ``time:`` events.
107 (Benji York, Brad Crittenden)
112 * Add 'subunit --no-xfail', which will omit expected failures from the subunit
113 stream. (John Arbash Meinel, #623642)
115 * Add 'subunit -F/--only-genuine-failures' which sets all of '--no-skips',
116 '--no-xfail', '--no-passthrough, '--no-success', and gives you just the
117 failure stream. (John Arbash Meinel)
119 * Python2.6 support was broken by the fixup feature.
120 (Arfrever Frehtes Taifersar Arahesis, #987490)
122 * Python3 support regressed in trunk.
123 (Arfrever Frehtes Taifersar Arahesis, #987514)
125 * Python3 support was insufficiently robust in detecting unicode streams.
126 (Robert Collins, Arfrever Frehtes Taifersar Arahesis)
128 * Tag support has been implemented for TestProtocolClient.
129 (Robert Collins, #518016)
131 * Tags can now be filtered. (Jonathan Lange, #664171)
133 * Test suite works with latest testtools (but not older ones - formatting
134 changes only). (Robert Collins)
139 The Subunit Python test runner ``python -m subunit.run`` can now report the
140 test ids and also filter via a test id list file thanks to improvements in
141 ``testtools.run``. See the testtools manual, or testrepository - a major
142 user of such functionality.
144 Additionally the protocol now has a keyword uxsuccess for Unexpected Success
145 reporting. Older parsers will report tests with this status code as 'lost
151 * Add ``TimeCollapsingDecorator`` which collapses multiple sequential time()
152 calls into just the first and last. (Jonathan Lange)
154 * Add ``TagCollapsingDecorator`` which collapses many tags() calls into one
155 where possible. (Jonathan Lange, Robert Collins)
157 * Force flush of writes to stdout in c/tests/test_child.
158 (Jelmer Vernooij, #687611)
160 * Provisional Python 3.x support.
161 (Robert Collins, Tres Seaver, Martin[gz], #666819)
163 * ``subunit.chunked.Decoder`` Python class takes a new ``strict`` option,
164 which defaults to ``True``. When ``False``, the ``Decoder`` will accept
165 incorrect input that is still unambiguous. i.e. subunit will not barf if
166 a \r is missing from the input. (Martin Pool)
168 * ``subunit-filter`` preserves the relative ordering of ``time:`` statements,
169 so you can now use filtered streams to gather data about how long it takes
170 to run a test. (Jonathan Lange, #716554)
172 * ``subunit-ls`` now handles a stream with time: instructions that start
173 partway through the stream (which may lead to strange times) more gracefully.
174 (Robert Collins, #785954)
176 * ``subunit-ls`` should handle the new test outcomes in Python2.7 better.
177 (Robert Collins, #785953)
179 * ``TestResultFilter`` now collapses sequential calls to time().
180 (Jonathan Lange, #567150)
182 * ``TestResultDecorator.tags()`` now actually works, and is no longer a buggy
183 copy/paste of ``TestResultDecorator.time()``. (Jonathan Lange, #681828)
185 * ``TestResultFilter`` now supports a ``fixup_expected_failures``
186 argument. (Jelmer Vernooij, #755241)
188 * The ``subunit.run`` Python module supports ``-l`` and ``--load-list`` as
189 per ``testtools.run``. This required a dependency bump due to a small
190 API change in ``testtools``. (Robert Collins)
192 * The help for subunit-filter was confusing about the behaviour of ``-f`` /
193 ``--no-failure``. (Robert Collins, #703392)
195 * The Python2.7 / testtools addUnexpectedSuccess API is now supported. This
196 required adding a new status code to the protocol. (Robert Collins, #654474)
201 * testtools 0.9.11 or newer is new needed (due to the Python 3 support).
207 This release of subunit fixes a number of unicode related bugs. This depends on
208 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
209 is also an optional native setup.py file for use with easy_install and the
215 * Be consistent about delivering unicode content to testtools StringException
216 class which has become (appropriately) conservative. (Robert Collins)
218 * Fix incorrect reference to subunit_test_failf in c/README.
219 (Brad Hards, #524341)
221 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
222 is purely cosmetic as the parameters are passed down with no interpretation.
223 (Robert Collins, #537611)
225 * Old style tracebacks with no encoding info are now treated as UTF8 rather
226 than some-random-codec-like-ascii. (Robert Collins)
228 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
229 binary mode by calling into msvcrt; this avoids having their input or output
230 mangled by the default line ending translation on that platform.
231 (Robert Collins, Martin [gz], #579296)
236 * Subunit now has a setup.py for python deployments that are not using
237 distribution packages. (Tres Seaver, #538181)
239 * Subunit now supports test discovery by building on the testtools support for
240 it. You can take advantage of it with "python -m subunit.run discover [path]"
241 and see "python -m subunit.run discover --help" for more options.
243 * Subunit now uses the improved unicode support in testtools when outputting
244 non-details based test information; this should consistently UTF8 encode such
247 * The Python TestProtocolClient now flushes output on startTest and stopTest.
257 * make check was failing if subunit wasn't installed due to a missing include
258 path for the test program test_child.
260 * make distcheck was failing due to a missing $(top_srcdir) rune.
265 * New filter `subunit-notify` that will show a notification window with test
266 statistics when the test run finishes.
268 * subunit.run will now pipe its output to the command in the
269 SUBUNIT_FORMATTER environment variable, if set.
277 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
278 boolean switch with no parameter.
280 * Building with autoconf 2.65 is now supported.
288 * License change, by unanimous agreement of contributors to BSD/Apache
289 License Version 2.0. This makes Subunit compatible with more testing
294 * CPPUnit is now directly supported: subunit builds a cppunit listener
295 ``libcppunit-subunit``.
297 * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
298 from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
299 serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
300 The ``ProtocolTestCase`` parser now calls outcomes using an extended
301 API that permits attaching arbitrary MIME resources such as text files
302 log entries and so on. This extended API is being developed with the
303 Python testing community, and is in flux. ``TestResult`` objects that
304 do not support the API will be detected and transparently downgraded
305 back to the regular Python unittest API.
307 * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
308 viarable when installing.
310 * Multipart test outcomes are tentatively supported; the exact protocol
311 for them, both serialiser and object is not yet finalised. Testers and
312 early adopters are sought. As part of this and also in an attempt to
313 provider a more precise focus on the wire protocol and toolchain,
314 Subunit now depends on testtools (http://launchpad.net/testtools)
315 release 0.9.0 or newer.
317 * subunit2junitxml supports a new option, --forward which causes it
318 to forward the raw subunit stream in a similar manner to tee. This
319 is used with the -o option to both write a xml report and get some
320 other subunit filter to process the stream.
322 * The C library now has ``subunit_test_skip``.
326 * Install progress_model.py correctly.
328 * Non-gcc builds will no longer try to use gcc specific flags.
329 (Thanks trondn-norbye)
342 * A number of filters now support ``--no-passthrough`` to cause all
343 non-subunit content to be discarded. This is useful when precise control
344 over what is output is required - such as with subunit2junitxml.
346 * A small perl parser is now included, and a new ``subunit-diff`` tool
347 using that is included. (Jelmer Vernooij)
349 * Subunit streams can now include optional, incremental lookahead
350 information about progress. This allows reporters to make estimates
351 about completion, when such information is available. See the README
352 under ``progress`` for more details.
354 * ``subunit-filter`` now supports regex filtering via ``--with`` and
355 ``without`` options. (Martin Pool)
357 * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
360 * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
361 test reporter to be used, which has a textual progress bar. This requires
362 a recent bzrlib as a minor bugfix was required in bzrlib to support this.
364 * ``subunit2junitxml`` has been added. This filter converts a subunit
365 stream to a single JUnit style XML stream using the pyjunitxml
368 * The shell functions support skipping via ``subunit_skip_test`` now.
372 * ``xfail`` outcomes are now passed to python TestResult's via
373 addExpectedFailure if it is present on the TestResult. Python 2.6 and
374 earlier which do not have this function will have ``xfail`` outcomes
375 passed through as success outcomes as earlier versions of subunit did.
379 * tags are no longer passed around in python via the ``TestCase.tags``
380 attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
381 and like in the protocol, if called while a test is active only applies
382 to that test. (Robert Collins)
384 * ``TestResultFilter`` takes a new optional constructor parameter
385 ``filter_predicate``. (Martin Pool)
387 * When a progress: directive is encountered in a subunit stream, the
388 python bindings now call the ``progress(offset, whence)`` method on
391 * When a time: directive is encountered in a subunit stream, the python
392 bindings now call the ``time(seconds)`` method on ``TestResult``.
396 * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
397 users of subunit will want to wrap their ``TestProtocolClient`` objects
398 in this decorator to get test timing data for performance analysis.
400 * (python) ExecTestCase supports passing arguments to test scripts.
402 * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
403 which can be used to call some code on every event, without having to
404 implement all the event methods.
406 * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
407 causes a timestamp to be output to the stream.