11 * Perl files should now honour perl system config.
12 (Benedikt Morbach, #1233198)
14 * Python 3.1 and 3.2 have an inconsistent memoryview implementation which
15 required a workaround for NUL byte detection. (Robert Collins, #1216246)
17 * The test suite was failing 6 tests due to testtools changing it's output
18 formatting of exceptions. (Robert Collins)
20 * V2 parser errors now set appropriate mime types for the encapsulated packet
21 data and the error message. (Robert Collins)
26 * Most filters will now accept a file path argument instead of only reading
27 from stdin. (Robert Collins, #409206)
35 * Clients of subunit did not expect memoryview objects in StreamResult events.
38 * Memoryview and struct were mutually incompatible in 2.7.3 and 3.2.
39 (Robert Collins, #1216163)
47 * Memoryview detection was broken and thus it's use was never really tested.
48 (Robert Collins, 1216101)
50 * TestProtocol2's tag tests were set sort order dependent.
51 (Robert Collins, #1025392)
53 * TestTestProtocols' test_tags_both was set sort order dependent.
54 (Robert Collins, #1025392)
56 * TestTestProtocols' test_*_details were dictionary sort order dependent.
57 (Robert Collins, #1025392)
59 * TestSubUnitTags's test_add_tag was also se sort order dependent.
60 (Robert Collins, #1025392)
68 * subunit should now build with automake 1.11 again. (Robert Collins)
70 * `subunit-stats` no longer outputs encapsulated stdout as subunit.
71 (Robert Collins, #1171987)
73 * The logic for `subunit.run` is now importable via python -
74 `subunit.run.main`. (Robert Collins, #606770)
79 * Removed GPL files that were (C) non Subunit Developers - they are
80 incompatible for binary distribution, which affects redistributors.
81 (Robert Collins, #1185591)
89 * Subunit v2 packets with both file content and route code were not being
90 parsed correctly - they would incorrectly emit a parser error, due to trying
91 to parse the route code length from the first byes of the file content.
92 (Robert Collins, 1172815)
97 v2 protocol draft included in this release. The v2 protocol trades off human
98 readability for a massive improvement in robustness, the ability to represent
99 concurrent tests in a single stream, cheaper parsing, and that provides
100 significantly better in-line debugging support and structured forwarding
101 of non-test data (such as stdout or stdin data).
103 This change includes two new filters (subunit-1to2 and subunit-2to1). Use
104 these filters to convert old streams to v2 and convert v2 streams to v1.
106 All the other filters now only parse and emit v2 streams. V2 is still in
107 draft format, so if you want to delay and wait for v2 to be finalised, you
108 should use subunit-2to1 before any serialisation steps take place.
109 With the ability to encapsulate multiple non-test streams, another significant
110 cange is that filters which emit subunit now encapsulate any non-subunit they
111 encounter, labelling it 'stdout'. This permits multiplexing such streams and
112 detangling the stdout streams from each input.
114 The subunit libraries (Python etc) have not changed their behaviour: they
115 still emit v1 from their existing API calls. New API's are being added
116 and applications should migrate once their language has those API's available.
121 * ``subunit.run`` now replaces sys.stdout to ensure that stdout is unbuffered
122 - without this pdb output is not reliably visible when stdout is a pipe
123 as it usually is. (Robert Collins)
125 * v2 protocol draft included in this release. (Python implementation only so
126 far). (Robert Collins)
128 * Two new Python classes -- ``StreamResultToBytes`` and
129 ``ByteStreamToStreamResult`` handle v2 generation and parsing.
138 * make_stream_binary is now public for reuse. (Robert Collins)
140 * NAME was not defined in the protocol BNF. (Robert Collins)
142 * UnsupportedOperation is available in the Python2.6 io library, so ask
143 forgiveness rather than permission for obtaining it. (Robert Collins)
145 * Streams with no fileno() attribute are now supported, but they are not
146 checked for being in binary mode: be sure to take care of that if using
147 the library yourself. (Robert Collins)
155 * All the source files are now included in the distribution tarball.
156 (Arfrever Frehtes Taifersar Arahesis, Robert Collins, #996275)
158 * ``python/subunit/tests/test_run.py`` and ``python/subunit/filters.py`` were
159 not included in the 0.0.8 tarball. (Robert Collins)
161 * Test ids which include non-ascii unicode characters are now supported.
162 (Robert Collins, #1029866)
164 * The ``failfast`` option to ``subunit.run`` will now work. The dependency on
165 testtools has been raised to 0.9.23 to permit this.
166 (Robert Collins, #1090582)
174 * Perl module now correctly outputs "failure" instead of "fail". (Stewart Smith)
176 * Shell functions now output timestamps. (Stewart Smith, Robert Collins)
178 * 'subunit2csv' script that converts subunit output to CSV format.
181 * ``TagCollapsingDecorator`` now correctly distinguishes between local and
182 global tags. (Jonathan Lange)
184 * ``TestResultFilter`` always forwards ``time:`` events.
185 (Benji York, Brad Crittenden)
190 * Add 'subunit --no-xfail', which will omit expected failures from the subunit
191 stream. (John Arbash Meinel, #623642)
193 * Add 'subunit -F/--only-genuine-failures' which sets all of '--no-skips',
194 '--no-xfail', '--no-passthrough, '--no-success', and gives you just the
195 failure stream. (John Arbash Meinel)
197 * Python2.6 support was broken by the fixup feature.
198 (Arfrever Frehtes Taifersar Arahesis, #987490)
200 * Python3 support regressed in trunk.
201 (Arfrever Frehtes Taifersar Arahesis, #987514)
203 * Python3 support was insufficiently robust in detecting unicode streams.
204 (Robert Collins, Arfrever Frehtes Taifersar Arahesis)
206 * Tag support has been implemented for TestProtocolClient.
207 (Robert Collins, #518016)
209 * Tags can now be filtered. (Jonathan Lange, #664171)
211 * Test suite works with latest testtools (but not older ones - formatting
212 changes only). (Robert Collins)
217 The Subunit Python test runner ``python -m subunit.run`` can now report the
218 test ids and also filter via a test id list file thanks to improvements in
219 ``testtools.run``. See the testtools manual, or testrepository - a major
220 user of such functionality.
222 Additionally the protocol now has a keyword uxsuccess for Unexpected Success
223 reporting. Older parsers will report tests with this status code as 'lost
229 * Add ``TimeCollapsingDecorator`` which collapses multiple sequential time()
230 calls into just the first and last. (Jonathan Lange)
232 * Add ``TagCollapsingDecorator`` which collapses many tags() calls into one
233 where possible. (Jonathan Lange, Robert Collins)
235 * Force flush of writes to stdout in c/tests/test_child.
236 (Jelmer Vernooij, #687611)
238 * Provisional Python 3.x support.
239 (Robert Collins, Tres Seaver, Martin[gz], #666819)
241 * ``subunit.chunked.Decoder`` Python class takes a new ``strict`` option,
242 which defaults to ``True``. When ``False``, the ``Decoder`` will accept
243 incorrect input that is still unambiguous. i.e. subunit will not barf if
244 a \r is missing from the input. (Martin Pool)
246 * ``subunit-filter`` preserves the relative ordering of ``time:`` statements,
247 so you can now use filtered streams to gather data about how long it takes
248 to run a test. (Jonathan Lange, #716554)
250 * ``subunit-ls`` now handles a stream with time: instructions that start
251 partway through the stream (which may lead to strange times) more gracefully.
252 (Robert Collins, #785954)
254 * ``subunit-ls`` should handle the new test outcomes in Python2.7 better.
255 (Robert Collins, #785953)
257 * ``TestResultFilter`` now collapses sequential calls to time().
258 (Jonathan Lange, #567150)
260 * ``TestResultDecorator.tags()`` now actually works, and is no longer a buggy
261 copy/paste of ``TestResultDecorator.time()``. (Jonathan Lange, #681828)
263 * ``TestResultFilter`` now supports a ``fixup_expected_failures``
264 argument. (Jelmer Vernooij, #755241)
266 * The ``subunit.run`` Python module supports ``-l`` and ``--load-list`` as
267 per ``testtools.run``. This required a dependency bump due to a small
268 API change in ``testtools``. (Robert Collins)
270 * The help for subunit-filter was confusing about the behaviour of ``-f`` /
271 ``--no-failure``. (Robert Collins, #703392)
273 * The Python2.7 / testtools addUnexpectedSuccess API is now supported. This
274 required adding a new status code to the protocol. (Robert Collins, #654474)
279 * testtools 0.9.11 or newer is new needed (due to the Python 3 support).
285 This release of subunit fixes a number of unicode related bugs. This depends on
286 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
287 is also an optional native setup.py file for use with easy_install and the
293 * Be consistent about delivering unicode content to testtools StringException
294 class which has become (appropriately) conservative. (Robert Collins)
296 * Fix incorrect reference to subunit_test_failf in c/README.
297 (Brad Hards, #524341)
299 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
300 is purely cosmetic as the parameters are passed down with no interpretation.
301 (Robert Collins, #537611)
303 * Old style tracebacks with no encoding info are now treated as UTF8 rather
304 than some-random-codec-like-ascii. (Robert Collins)
306 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
307 binary mode by calling into msvcrt; this avoids having their input or output
308 mangled by the default line ending translation on that platform.
309 (Robert Collins, Martin [gz], #579296)
314 * Subunit now has a setup.py for python deployments that are not using
315 distribution packages. (Tres Seaver, #538181)
317 * Subunit now supports test discovery by building on the testtools support for
318 it. You can take advantage of it with "python -m subunit.run discover [path]"
319 and see "python -m subunit.run discover --help" for more options.
321 * Subunit now uses the improved unicode support in testtools when outputting
322 non-details based test information; this should consistently UTF8 encode such
325 * The Python TestProtocolClient now flushes output on startTest and stopTest.
335 * make check was failing if subunit wasn't installed due to a missing include
336 path for the test program test_child.
338 * make distcheck was failing due to a missing $(top_srcdir) rune.
343 * New filter `subunit-notify` that will show a notification window with test
344 statistics when the test run finishes.
346 * subunit.run will now pipe its output to the command in the
347 SUBUNIT_FORMATTER environment variable, if set.
355 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
356 boolean switch with no parameter.
358 * Building with autoconf 2.65 is now supported.
366 * License change, by unanimous agreement of contributors to BSD/Apache
367 License Version 2.0. This makes Subunit compatible with more testing
372 * CPPUnit is now directly supported: subunit builds a cppunit listener
373 ``libcppunit-subunit``.
375 * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
376 from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
377 serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
378 The ``ProtocolTestCase`` parser now calls outcomes using an extended
379 API that permits attaching arbitrary MIME resources such as text files
380 log entries and so on. This extended API is being developed with the
381 Python testing community, and is in flux. ``TestResult`` objects that
382 do not support the API will be detected and transparently downgraded
383 back to the regular Python unittest API.
385 * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
386 viarable when installing.
388 * Multipart test outcomes are tentatively supported; the exact protocol
389 for them, both serialiser and object is not yet finalised. Testers and
390 early adopters are sought. As part of this and also in an attempt to
391 provider a more precise focus on the wire protocol and toolchain,
392 Subunit now depends on testtools (http://launchpad.net/testtools)
393 release 0.9.0 or newer.
395 * subunit2junitxml supports a new option, --forward which causes it
396 to forward the raw subunit stream in a similar manner to tee. This
397 is used with the -o option to both write a xml report and get some
398 other subunit filter to process the stream.
400 * The C library now has ``subunit_test_skip``.
404 * Install progress_model.py correctly.
406 * Non-gcc builds will no longer try to use gcc specific flags.
407 (Thanks trondn-norbye)
420 * A number of filters now support ``--no-passthrough`` to cause all
421 non-subunit content to be discarded. This is useful when precise control
422 over what is output is required - such as with subunit2junitxml.
424 * A small perl parser is now included, and a new ``subunit-diff`` tool
425 using that is included. (Jelmer Vernooij)
427 * Subunit streams can now include optional, incremental lookahead
428 information about progress. This allows reporters to make estimates
429 about completion, when such information is available. See the README
430 under ``progress`` for more details.
432 * ``subunit-filter`` now supports regex filtering via ``--with`` and
433 ``without`` options. (Martin Pool)
435 * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
438 * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
439 test reporter to be used, which has a textual progress bar. This requires
440 a recent bzrlib as a minor bugfix was required in bzrlib to support this.
442 * ``subunit2junitxml`` has been added. This filter converts a subunit
443 stream to a single JUnit style XML stream using the pyjunitxml
446 * The shell functions support skipping via ``subunit_skip_test`` now.
450 * ``xfail`` outcomes are now passed to python TestResult's via
451 addExpectedFailure if it is present on the TestResult. Python 2.6 and
452 earlier which do not have this function will have ``xfail`` outcomes
453 passed through as success outcomes as earlier versions of subunit did.
457 * tags are no longer passed around in python via the ``TestCase.tags``
458 attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
459 and like in the protocol, if called while a test is active only applies
460 to that test. (Robert Collins)
462 * ``TestResultFilter`` takes a new optional constructor parameter
463 ``filter_predicate``. (Martin Pool)
465 * When a progress: directive is encountered in a subunit stream, the
466 python bindings now call the ``progress(offset, whence)`` method on
469 * When a time: directive is encountered in a subunit stream, the python
470 bindings now call the ``time(seconds)`` method on ``TestResult``.
474 * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
475 users of subunit will want to wrap their ``TestProtocolClient`` objects
476 in this decorator to get test timing data for performance analysis.
478 * (python) ExecTestCase supports passing arguments to test scripts.
480 * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
481 which can be used to call some code on every event, without having to
482 implement all the event methods.
484 * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
485 causes a timestamp to be output to the stream.