11 * Tests have been fixed with testtools 1.2.0 and above.
17 * With testtools 1.4.0 and above import errors are now
18 shown in detail by ``subunit.run``. (Robert Collins)
26 * Brown bag bugfix - 0.0.20's setup.py referenced cvs not csv.
27 (Robert Collins, #1361924)
35 * subunit2csv is now installed when using pip.
36 (Robert Collins, #1279669)
38 * testscenarios is now a test dependency, not an install dependency.
39 (Arfrever Frehtes Taifersar Arahesis, #1292757)
41 * The python-subunit tarball can now have setup run from the current
42 directory. (Robert Collins, #1361857)
50 * ``subunit.run`` in Python will now exit 0 as long as the test stream has
51 been generated correctly - this has always been the intent but API friction
52 with testtools had prevented it working.
61 * Fix compatibility with testtools 0.9.35 which dropped the 'all' compat
62 symbol. This breaks support for Python versions lower than 2.6.
63 (Robert Collins, #1274056)
71 * Add ``subunit-output`` tool that can generate a Subunit v2 bytestream from
72 arguments passed on the command line. (Thomi Richards, #1252084)
80 * Perl files should now honour perl system config.
81 (Benedikt Morbach, #1233198)
83 * Python 3.1 and 3.2 have an inconsistent memoryview implementation which
84 required a workaround for NUL byte detection. (Robert Collins, #1216246)
86 * The test suite was failing 6 tests due to testtools changing it's output
87 formatting of exceptions. (Robert Collins)
89 * V2 parser errors now set appropriate mime types for the encapsulated packet
90 data and the error message. (Robert Collins)
92 * When tests fail to import ``python subunit.run -l ...`` will now write a
93 subunit file attachment listing the failed imports and exit 2, rather than
94 listing the stub objects from the importer and exiting 0.
95 (Robert Collins, #1245672)
100 * Most filters will now accept a file path argument instead of only reading
101 from stdin. (Robert Collins, #409206)
109 * Clients of subunit did not expect memoryview objects in StreamResult events.
112 * Memoryview and struct were mutually incompatible in 2.7.3 and 3.2.
113 (Robert Collins, #1216163)
121 * Memoryview detection was broken and thus it's use was never really tested.
122 (Robert Collins, 1216101)
124 * TestProtocol2's tag tests were set sort order dependent.
125 (Robert Collins, #1025392)
127 * TestTestProtocols' test_tags_both was set sort order dependent.
128 (Robert Collins, #1025392)
130 * TestTestProtocols' test_*_details were dictionary sort order dependent.
131 (Robert Collins, #1025392)
133 * TestSubUnitTags's test_add_tag was also se sort order dependent.
134 (Robert Collins, #1025392)
142 * subunit should now build with automake 1.11 again. (Robert Collins)
144 * `subunit-stats` no longer outputs encapsulated stdout as subunit.
145 (Robert Collins, #1171987)
147 * The logic for `subunit.run` is now importable via python -
148 `subunit.run.main`. (Robert Collins, #606770)
153 * Removed GPL files that were (C) non Subunit Developers - they are
154 incompatible for binary distribution, which affects redistributors.
155 (Robert Collins, #1185591)
163 * Subunit v2 packets with both file content and route code were not being
164 parsed correctly - they would incorrectly emit a parser error, due to trying
165 to parse the route code length from the first byes of the file content.
166 (Robert Collins, 1172815)
171 v2 protocol draft included in this release. The v2 protocol trades off human
172 readability for a massive improvement in robustness, the ability to represent
173 concurrent tests in a single stream, cheaper parsing, and that provides
174 significantly better in-line debugging support and structured forwarding
175 of non-test data (such as stdout or stdin data).
177 This change includes two new filters (subunit-1to2 and subunit-2to1). Use
178 these filters to convert old streams to v2 and convert v2 streams to v1.
180 All the other filters now only parse and emit v2 streams. V2 is still in
181 draft format, so if you want to delay and wait for v2 to be finalised, you
182 should use subunit-2to1 before any serialisation steps take place.
183 With the ability to encapsulate multiple non-test streams, another significant
184 cange is that filters which emit subunit now encapsulate any non-subunit they
185 encounter, labelling it 'stdout'. This permits multiplexing such streams and
186 detangling the stdout streams from each input.
188 The subunit libraries (Python etc) have not changed their behaviour: they
189 still emit v1 from their existing API calls. New API's are being added
190 and applications should migrate once their language has those API's available.
195 * ``subunit.run`` now replaces sys.stdout to ensure that stdout is unbuffered
196 - without this pdb output is not reliably visible when stdout is a pipe
197 as it usually is. (Robert Collins)
199 * v2 protocol draft included in this release. (Python implementation only so
200 far). (Robert Collins)
202 * Two new Python classes -- ``StreamResultToBytes`` and
203 ``ByteStreamToStreamResult`` handle v2 generation and parsing.
212 * make_stream_binary is now public for reuse. (Robert Collins)
214 * NAME was not defined in the protocol BNF. (Robert Collins)
216 * UnsupportedOperation is available in the Python2.6 io library, so ask
217 forgiveness rather than permission for obtaining it. (Robert Collins)
219 * Streams with no fileno() attribute are now supported, but they are not
220 checked for being in binary mode: be sure to take care of that if using
221 the library yourself. (Robert Collins)
229 * All the source files are now included in the distribution tarball.
230 (Arfrever Frehtes Taifersar Arahesis, Robert Collins, #996275)
232 * ``python/subunit/tests/test_run.py`` and ``python/subunit/filters.py`` were
233 not included in the 0.0.8 tarball. (Robert Collins)
235 * Test ids which include non-ascii unicode characters are now supported.
236 (Robert Collins, #1029866)
238 * The ``failfast`` option to ``subunit.run`` will now work. The dependency on
239 testtools has been raised to 0.9.23 to permit this.
240 (Robert Collins, #1090582)
248 * Perl module now correctly outputs "failure" instead of "fail". (Stewart Smith)
250 * Shell functions now output timestamps. (Stewart Smith, Robert Collins)
252 * 'subunit2csv' script that converts subunit output to CSV format.
255 * ``TagCollapsingDecorator`` now correctly distinguishes between local and
256 global tags. (Jonathan Lange)
258 * ``TestResultFilter`` always forwards ``time:`` events.
259 (Benji York, Brad Crittenden)
264 * Add 'subunit --no-xfail', which will omit expected failures from the subunit
265 stream. (John Arbash Meinel, #623642)
267 * Add 'subunit -F/--only-genuine-failures' which sets all of '--no-skips',
268 '--no-xfail', '--no-passthrough, '--no-success', and gives you just the
269 failure stream. (John Arbash Meinel)
271 * Python2.6 support was broken by the fixup feature.
272 (Arfrever Frehtes Taifersar Arahesis, #987490)
274 * Python3 support regressed in trunk.
275 (Arfrever Frehtes Taifersar Arahesis, #987514)
277 * Python3 support was insufficiently robust in detecting unicode streams.
278 (Robert Collins, Arfrever Frehtes Taifersar Arahesis)
280 * Tag support has been implemented for TestProtocolClient.
281 (Robert Collins, #518016)
283 * Tags can now be filtered. (Jonathan Lange, #664171)
285 * Test suite works with latest testtools (but not older ones - formatting
286 changes only). (Robert Collins)
291 The Subunit Python test runner ``python -m subunit.run`` can now report the
292 test ids and also filter via a test id list file thanks to improvements in
293 ``testtools.run``. See the testtools manual, or testrepository - a major
294 user of such functionality.
296 Additionally the protocol now has a keyword uxsuccess for Unexpected Success
297 reporting. Older parsers will report tests with this status code as 'lost
303 * Add ``TimeCollapsingDecorator`` which collapses multiple sequential time()
304 calls into just the first and last. (Jonathan Lange)
306 * Add ``TagCollapsingDecorator`` which collapses many tags() calls into one
307 where possible. (Jonathan Lange, Robert Collins)
309 * Force flush of writes to stdout in c/tests/test_child.
310 (Jelmer Vernooij, #687611)
312 * Provisional Python 3.x support.
313 (Robert Collins, Tres Seaver, Martin[gz], #666819)
315 * ``subunit.chunked.Decoder`` Python class takes a new ``strict`` option,
316 which defaults to ``True``. When ``False``, the ``Decoder`` will accept
317 incorrect input that is still unambiguous. i.e. subunit will not barf if
318 a \r is missing from the input. (Martin Pool)
320 * ``subunit-filter`` preserves the relative ordering of ``time:`` statements,
321 so you can now use filtered streams to gather data about how long it takes
322 to run a test. (Jonathan Lange, #716554)
324 * ``subunit-ls`` now handles a stream with time: instructions that start
325 partway through the stream (which may lead to strange times) more gracefully.
326 (Robert Collins, #785954)
328 * ``subunit-ls`` should handle the new test outcomes in Python2.7 better.
329 (Robert Collins, #785953)
331 * ``TestResultFilter`` now collapses sequential calls to time().
332 (Jonathan Lange, #567150)
334 * ``TestResultDecorator.tags()`` now actually works, and is no longer a buggy
335 copy/paste of ``TestResultDecorator.time()``. (Jonathan Lange, #681828)
337 * ``TestResultFilter`` now supports a ``fixup_expected_failures``
338 argument. (Jelmer Vernooij, #755241)
340 * The ``subunit.run`` Python module supports ``-l`` and ``--load-list`` as
341 per ``testtools.run``. This required a dependency bump due to a small
342 API change in ``testtools``. (Robert Collins)
344 * The help for subunit-filter was confusing about the behaviour of ``-f`` /
345 ``--no-failure``. (Robert Collins, #703392)
347 * The Python2.7 / testtools addUnexpectedSuccess API is now supported. This
348 required adding a new status code to the protocol. (Robert Collins, #654474)
353 * testtools 0.9.11 or newer is new needed (due to the Python 3 support).
359 This release of subunit fixes a number of unicode related bugs. This depends on
360 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
361 is also an optional native setup.py file for use with easy_install and the
367 * Be consistent about delivering unicode content to testtools StringException
368 class which has become (appropriately) conservative. (Robert Collins)
370 * Fix incorrect reference to subunit_test_failf in c/README.
371 (Brad Hards, #524341)
373 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
374 is purely cosmetic as the parameters are passed down with no interpretation.
375 (Robert Collins, #537611)
377 * Old style tracebacks with no encoding info are now treated as UTF8 rather
378 than some-random-codec-like-ascii. (Robert Collins)
380 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
381 binary mode by calling into msvcrt; this avoids having their input or output
382 mangled by the default line ending translation on that platform.
383 (Robert Collins, Martin [gz], #579296)
388 * Subunit now has a setup.py for python deployments that are not using
389 distribution packages. (Tres Seaver, #538181)
391 * Subunit now supports test discovery by building on the testtools support for
392 it. You can take advantage of it with "python -m subunit.run discover [path]"
393 and see "python -m subunit.run discover --help" for more options.
395 * Subunit now uses the improved unicode support in testtools when outputting
396 non-details based test information; this should consistently UTF8 encode such
399 * The Python TestProtocolClient now flushes output on startTest and stopTest.
409 * make check was failing if subunit wasn't installed due to a missing include
410 path for the test program test_child.
412 * make distcheck was failing due to a missing $(top_srcdir) rune.
417 * New filter `subunit-notify` that will show a notification window with test
418 statistics when the test run finishes.
420 * subunit.run will now pipe its output to the command in the
421 SUBUNIT_FORMATTER environment variable, if set.
429 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
430 boolean switch with no parameter.
432 * Building with autoconf 2.65 is now supported.
440 * License change, by unanimous agreement of contributors to BSD/Apache
441 License Version 2.0. This makes Subunit compatible with more testing
446 * CPPUnit is now directly supported: subunit builds a cppunit listener
447 ``libcppunit-subunit``.
449 * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
450 from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
451 serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
452 The ``ProtocolTestCase`` parser now calls outcomes using an extended
453 API that permits attaching arbitrary MIME resources such as text files
454 log entries and so on. This extended API is being developed with the
455 Python testing community, and is in flux. ``TestResult`` objects that
456 do not support the API will be detected and transparently downgraded
457 back to the regular Python unittest API.
459 * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
460 viarable when installing.
462 * Multipart test outcomes are tentatively supported; the exact protocol
463 for them, both serialiser and object is not yet finalised. Testers and
464 early adopters are sought. As part of this and also in an attempt to
465 provider a more precise focus on the wire protocol and toolchain,
466 Subunit now depends on testtools (http://launchpad.net/testtools)
467 release 0.9.0 or newer.
469 * subunit2junitxml supports a new option, --forward which causes it
470 to forward the raw subunit stream in a similar manner to tee. This
471 is used with the -o option to both write a xml report and get some
472 other subunit filter to process the stream.
474 * The C library now has ``subunit_test_skip``.
478 * Install progress_model.py correctly.
480 * Non-gcc builds will no longer try to use gcc specific flags.
481 (Thanks trondn-norbye)
494 * A number of filters now support ``--no-passthrough`` to cause all
495 non-subunit content to be discarded. This is useful when precise control
496 over what is output is required - such as with subunit2junitxml.
498 * A small perl parser is now included, and a new ``subunit-diff`` tool
499 using that is included. (Jelmer Vernooij)
501 * Subunit streams can now include optional, incremental lookahead
502 information about progress. This allows reporters to make estimates
503 about completion, when such information is available. See the README
504 under ``progress`` for more details.
506 * ``subunit-filter`` now supports regex filtering via ``--with`` and
507 ``without`` options. (Martin Pool)
509 * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
512 * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
513 test reporter to be used, which has a textual progress bar. This requires
514 a recent bzrlib as a minor bugfix was required in bzrlib to support this.
516 * ``subunit2junitxml`` has been added. This filter converts a subunit
517 stream to a single JUnit style XML stream using the pyjunitxml
520 * The shell functions support skipping via ``subunit_skip_test`` now.
524 * ``xfail`` outcomes are now passed to python TestResult's via
525 addExpectedFailure if it is present on the TestResult. Python 2.6 and
526 earlier which do not have this function will have ``xfail`` outcomes
527 passed through as success outcomes as earlier versions of subunit did.
531 * tags are no longer passed around in python via the ``TestCase.tags``
532 attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
533 and like in the protocol, if called while a test is active only applies
534 to that test. (Robert Collins)
536 * ``TestResultFilter`` takes a new optional constructor parameter
537 ``filter_predicate``. (Martin Pool)
539 * When a progress: directive is encountered in a subunit stream, the
540 python bindings now call the ``progress(offset, whence)`` method on
543 * When a time: directive is encountered in a subunit stream, the python
544 bindings now call the ``time(seconds)`` method on ``TestResult``.
548 * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
549 users of subunit will want to wrap their ``TestProtocolClient`` objects
550 in this decorator to get test timing data for performance analysis.
552 * (python) ExecTestCase supports passing arguments to test scripts.
554 * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
555 which can be used to call some code on every event, without having to
556 implement all the event methods.
558 * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
559 causes a timestamp to be output to the stream.