* Add ``subunit-output`` tool that can generate a Subunit v2 bytestream from
[third_party/subunit] / NEWS
1 ---------------------
2 subunit release notes
3 ---------------------
4
5 NEXT (In development)
6 ---------------------
7
8 IMPROVMENTS
9 ~~~~~~~~~~~
10
11 * Add ``subunit-output`` tool that can generate a Subunit v2 bytestream from
12   arguments passed on the command line. (Thomi Richards, #1252084)
13
14 0.0.16
15 ------
16
17 BUG FIXES
18 ~~~~~~~~~
19
20 * Perl files should now honour perl system config.
21   (Benedikt Morbach, #1233198)
22
23 * Python 3.1 and 3.2 have an inconsistent memoryview implementation which
24   required a workaround for NUL byte detection. (Robert Collins, #1216246)
25
26 * The test suite was failing 6 tests due to testtools changing it's output
27   formatting of exceptions. (Robert Collins)
28
29 * V2 parser errors now set appropriate mime types for the encapsulated packet
30   data and the error message. (Robert Collins)
31
32 * When tests fail to import ``python subunit.run -l ...`` will now write a 
33   subunit file attachment listing the failed imports and exit 2, rather than
34   listing the stub objects from the importer and exiting 0.
35   (Robert Collins, #1245672)
36
37 IMPROVEMENTS
38 ~~~~~~~~~~~~
39
40 * Most filters will now accept a file path argument instead of only reading
41   from stdin. (Robert Collins, #409206)
42
43 0.0.15
44 ------
45
46 BUG FIXES
47 ~~~~~~~~~
48
49 * Clients of subunit did not expect memoryview objects in StreamResult events.
50   (Robert Collins)
51
52 * Memoryview and struct were mutually incompatible in 2.7.3 and 3.2.
53   (Robert Collins, #1216163)
54
55 0.0.14
56 ------
57
58 BUG FIXES
59 ~~~~~~~~~
60
61 * Memoryview detection was broken and thus it's use was never really tested.
62   (Robert Collins, 1216101)
63
64 * TestProtocol2's tag tests were set sort order dependent.
65   (Robert Collins, #1025392)
66
67 * TestTestProtocols' test_tags_both was set sort order dependent.
68   (Robert Collins, #1025392)
69
70 * TestTestProtocols' test_*_details were dictionary sort order dependent.
71   (Robert Collins, #1025392)
72
73 * TestSubUnitTags's test_add_tag was also se sort order dependent.
74   (Robert Collins, #1025392)
75
76 0.0.13
77 ------
78
79 IMPROVEMENTS
80 ~~~~~~~~~~~~
81
82 * subunit should now build with automake 1.11 again. (Robert Collins)
83
84 * `subunit-stats` no longer outputs encapsulated stdout as subunit.
85   (Robert Collins, #1171987)
86
87 * The logic for `subunit.run` is now importable via python -
88   `subunit.run.main`. (Robert Collins, #606770)
89
90 BUG FIXES
91 ~~~~~~~~~
92
93 * Removed GPL files that were (C) non Subunit Developers - they are
94   incompatible for binary distribution, which affects redistributors.
95   (Robert Collins, #1185591)
96
97 0.0.12
98 ------
99
100 BUG FIXES
101 ~~~~~~~~~
102
103 * Subunit v2 packets with both file content and route code were not being
104   parsed correctly - they would incorrectly emit a parser error, due to trying
105   to parse the route code length from the first byes of the file content.
106   (Robert Collins, 1172815)
107
108 0.0.11
109 ------
110
111 v2 protocol draft included in this release. The v2 protocol trades off human
112 readability for a massive improvement in robustness, the ability to represent
113 concurrent tests in a single stream, cheaper parsing, and that provides
114 significantly better in-line debugging support and structured forwarding
115 of non-test data (such as stdout or stdin data).
116
117 This change includes two new filters (subunit-1to2 and subunit-2to1). Use
118 these filters to convert old streams to v2 and convert v2 streams to v1.
119
120 All the other filters now only parse and emit v2 streams. V2 is still in
121 draft format, so if you want to delay and wait for v2 to be finalised, you
122 should use subunit-2to1 before any serialisation steps take place.
123 With the ability to encapsulate multiple non-test streams, another significant
124 cange is that filters which emit subunit now encapsulate any non-subunit they
125 encounter, labelling it 'stdout'. This permits multiplexing such streams and
126 detangling the stdout streams from each input.
127
128 The subunit libraries (Python etc) have not changed their behaviour: they
129 still emit v1 from their existing API calls. New API's are being added
130 and applications should migrate once their language has those API's available.
131
132 IMPROVEMENTS
133 ~~~~~~~~~~~~
134
135 * ``subunit.run`` now replaces sys.stdout to ensure that stdout is unbuffered
136   - without this pdb output is not reliably visible when stdout is a pipe
137   as it usually is. (Robert Collins)
138
139 * v2 protocol draft included in this release. (Python implementation only so
140   far). (Robert Collins)
141
142 * Two new Python classes -- ``StreamResultToBytes`` and
143   ``ByteStreamToStreamResult`` handle v2 generation and parsing.
144   (Robert Collins)
145
146 0.0.10
147 ------
148
149 BUG FIXES
150 ~~~~~~~~~
151
152 * make_stream_binary is now public for reuse. (Robert Collins)
153
154 * NAME was not defined in the protocol BNF. (Robert Collins)
155
156 * UnsupportedOperation is available in the Python2.6 io library, so ask
157   forgiveness rather than permission for obtaining it. (Robert Collins)
158
159 * Streams with no fileno() attribute are now supported, but they are not
160   checked for being in binary mode: be sure to take care of that if using
161   the library yourself. (Robert Collins)
162
163 0.0.9
164 -----
165
166 BUG FIXES
167 ~~~~~~~~~
168
169 * All the source files are now included in the distribution tarball.
170   (Arfrever Frehtes Taifersar Arahesis, Robert Collins, #996275)
171
172 * ``python/subunit/tests/test_run.py`` and ``python/subunit/filters.py`` were
173   not included in the 0.0.8 tarball. (Robert Collins)
174
175 * Test ids which include non-ascii unicode characters are now supported.
176   (Robert Collins, #1029866)
177
178 * The ``failfast`` option to ``subunit.run`` will now work. The dependency on
179   testtools has been raised to 0.9.23 to permit this.
180   (Robert Collins, #1090582)
181
182 0.0.8
183 -----
184
185 IMPROVEMENTS
186 ~~~~~~~~~~~~
187
188 * Perl module now correctly outputs "failure" instead of "fail".  (Stewart Smith)
189
190 * Shell functions now output timestamps. (Stewart Smith, Robert Collins)
191
192 * 'subunit2csv' script that converts subunit output to CSV format.
193   (Jonathan Lange)
194
195 * ``TagCollapsingDecorator`` now correctly distinguishes between local and
196   global tags.  (Jonathan Lange)
197
198 * ``TestResultFilter`` always forwards ``time:`` events.
199   (Benji York, Brad Crittenden)
200
201 BUG FIXES
202 ~~~~~~~~~
203
204 * Add 'subunit --no-xfail', which will omit expected failures from the subunit
205   stream. (John Arbash Meinel, #623642)
206
207 * Add 'subunit -F/--only-genuine-failures' which sets all of '--no-skips',
208   '--no-xfail', '--no-passthrough, '--no-success', and gives you just the
209   failure stream. (John Arbash Meinel)
210
211 * Python2.6 support was broken by the fixup feature.
212   (Arfrever Frehtes Taifersar Arahesis, #987490)
213
214 * Python3 support regressed in trunk.
215   (Arfrever Frehtes Taifersar Arahesis, #987514)
216
217 * Python3 support was insufficiently robust in detecting unicode streams.
218   (Robert Collins, Arfrever Frehtes Taifersar Arahesis)
219
220 * Tag support has been implemented for TestProtocolClient.
221   (Robert Collins, #518016)
222
223 * Tags can now be filtered. (Jonathan Lange, #664171)
224
225 * Test suite works with latest testtools (but not older ones - formatting
226   changes only). (Robert Collins)
227
228 0.0.7
229 -----
230
231 The Subunit Python test runner ``python -m subunit.run`` can now report the
232 test ids and also filter via a test id list file thanks to improvements in
233 ``testtools.run``. See the testtools manual, or testrepository - a major
234 user of such functionality.
235
236 Additionally the protocol now has a keyword uxsuccess for Unexpected Success
237 reporting. Older parsers will report tests with this status code as 'lost
238 connection'.
239
240 IMPROVEMENTS
241 ~~~~~~~~~~~~
242
243 * Add ``TimeCollapsingDecorator`` which collapses multiple sequential time()
244   calls into just the first and last. (Jonathan Lange)
245
246 * Add ``TagCollapsingDecorator`` which collapses many tags() calls into one
247   where possible. (Jonathan Lange, Robert Collins)
248
249 * Force flush of writes to stdout in c/tests/test_child.
250   (Jelmer Vernooij, #687611)
251
252 * Provisional Python 3.x support.
253   (Robert Collins, Tres Seaver, Martin[gz], #666819)
254
255 * ``subunit.chunked.Decoder`` Python class takes a new ``strict`` option,
256   which defaults to ``True``. When ``False``, the ``Decoder`` will accept
257   incorrect input that is still unambiguous. i.e. subunit will not barf if
258   a \r is missing from the input. (Martin Pool)
259
260 * ``subunit-filter`` preserves the relative ordering of ``time:`` statements,
261   so you can now use filtered streams to gather data about how long it takes
262   to run a test. (Jonathan Lange, #716554)
263
264 * ``subunit-ls`` now handles a stream with time: instructions that start
265   partway through the stream (which may lead to strange times) more gracefully.
266   (Robert Collins, #785954)
267
268 * ``subunit-ls`` should handle the new test outcomes in Python2.7 better.
269   (Robert Collins, #785953)
270
271 * ``TestResultFilter`` now collapses sequential calls to time().
272   (Jonathan Lange, #567150)
273
274 * ``TestResultDecorator.tags()`` now actually works, and is no longer a buggy
275   copy/paste of ``TestResultDecorator.time()``. (Jonathan Lange, #681828)
276
277 * ``TestResultFilter`` now supports a ``fixup_expected_failures``
278   argument. (Jelmer Vernooij, #755241)
279
280 * The ``subunit.run`` Python module supports ``-l`` and ``--load-list`` as
281   per ``testtools.run``. This required a dependency bump due to a small
282   API change in ``testtools``. (Robert Collins)
283
284 * The help for subunit-filter was confusing about the behaviour of ``-f`` /
285   ``--no-failure``. (Robert Collins, #703392)
286
287 * The Python2.7 / testtools addUnexpectedSuccess API is now supported. This
288   required adding a new status code to the protocol. (Robert Collins, #654474)
289
290 CHANGES
291 ~~~~~~~
292
293 * testtools 0.9.11 or newer is new needed (due to the Python 3 support).
294   (Robert Collins)
295
296 0.0.6
297 -----
298
299 This release of subunit fixes a number of unicode related bugs. This depends on
300 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
301 is also an optional native setup.py file for use with easy_install and the
302 like.
303
304 BUG FIXES
305 ~~~~~~~~~
306
307 * Be consistent about delivering unicode content to testtools StringException
308   class which has become (appropriately) conservative. (Robert Collins)
309
310 * Fix incorrect reference to subunit_test_failf in c/README.
311   (Brad Hards, #524341)
312
313 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
314   is purely cosmetic as the parameters are passed down with no interpretation.
315   (Robert Collins, #537611)
316
317 * Old style tracebacks with no encoding info are now treated as UTF8 rather
318   than some-random-codec-like-ascii. (Robert Collins)
319
320 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
321   binary mode by calling into msvcrt; this avoids having their input or output
322   mangled by the default line ending translation on that platform.
323   (Robert Collins, Martin [gz], #579296)
324
325 IMPROVEMENTS
326 ~~~~~~~~~~~~
327
328 * Subunit now has a setup.py for python deployments that are not using
329   distribution packages. (Tres Seaver, #538181)
330
331 * Subunit now supports test discovery by building on the testtools support for
332   it. You can take advantage of it with "python -m subunit.run discover [path]"
333   and see "python -m subunit.run discover --help" for more options.
334
335 * Subunit now uses the improved unicode support in testtools when outputting
336   non-details based test information; this should consistently UTF8 encode such
337   strings.
338
339 * The Python TestProtocolClient now flushes output on startTest and stopTest.
340   (Martin [gz]).
341
342
343 0.0.5
344 -----
345
346 BUG FIXES
347 ~~~~~~~~~
348
349 * make check was failing if subunit wasn't installed due to a missing include
350   path for the test program test_child.
351
352 * make distcheck was failing due to a missing $(top_srcdir) rune.
353
354 IMPROVEMENTS
355 ~~~~~~~~~~~~
356
357 * New filter `subunit-notify` that will show a notification window with test 
358   statistics when the test run finishes.
359
360 * subunit.run will now pipe its output to the command in the 
361   SUBUNIT_FORMATTER environment variable, if set.
362
363 0.0.4
364 -----
365
366 BUG FIXES
367 ~~~~~~~~~
368
369 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
370   boolean switch with no parameter.
371
372 * Building with autoconf 2.65 is now supported.
373
374
375 0.0.3
376 -----
377
378   CHANGES:
379   
380     * License change, by unanimous agreement of contributors to BSD/Apache
381       License Version 2.0. This makes Subunit compatible with more testing
382       frameworks.
383
384   IMPROVEMENTS:
385
386     * CPPUnit is now directly supported: subunit builds a cppunit listener
387       ``libcppunit-subunit``. 
388
389     * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
390       from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
391       serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
392       The ``ProtocolTestCase`` parser now calls outcomes using an extended
393       API that permits attaching arbitrary MIME resources such as text files
394       log entries and so on. This extended API is being developed with the
395       Python testing community, and is in flux. ``TestResult`` objects that
396       do not support the API will be detected and transparently downgraded
397       back to the regular Python unittest API.
398
399     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
400       viarable when installing.
401
402     * Multipart test outcomes are tentatively supported; the exact protocol
403       for them, both serialiser and object is not yet finalised. Testers and
404       early adopters are sought. As part of this and also in an attempt to
405       provider a more precise focus on the wire protocol and toolchain, 
406       Subunit now depends on testtools (http://launchpad.net/testtools)
407       release 0.9.0 or newer.
408
409     * subunit2junitxml supports a new option, --forward which causes it
410       to forward the raw subunit stream in a similar manner to tee. This
411       is used with the -o option to both write a xml report and get some
412       other subunit filter to process the stream.
413
414     * The C library now has ``subunit_test_skip``.
415
416   BUG FIXES:
417
418     * Install progress_model.py correctly.
419
420     * Non-gcc builds will no longer try to use gcc specific flags.
421       (Thanks trondn-norbye)
422
423   API CHANGES:
424
425   INTERNALS:
426
427 0.0.2
428 -----
429
430   CHANGES:
431
432   IMPROVEMENTS:
433
434     * A number of filters now support ``--no-passthrough`` to cause all
435       non-subunit content to be discarded. This is useful when precise control
436       over what is output is required - such as with subunit2junitxml.
437
438     * A small perl parser is now included, and a new ``subunit-diff`` tool
439       using that is included. (Jelmer Vernooij)
440
441     * Subunit streams can now include optional, incremental lookahead
442       information about progress. This allows reporters to make estimates
443       about completion, when such information is available. See the README
444       under ``progress`` for more details.
445
446     * ``subunit-filter`` now supports regex filtering via ``--with`` and
447       ``without`` options. (Martin Pool)
448
449     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
450       test stream.
451
452     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
453       test reporter to be used, which has a textual progress bar. This requires
454       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
455
456     * ``subunit2junitxml`` has been added. This filter converts a subunit
457       stream to a single JUnit style XML stream using the pyjunitxml
458       python library.
459
460     * The shell functions support skipping via ``subunit_skip_test`` now.
461
462   BUG FIXES:
463
464     * ``xfail`` outcomes are now passed to python TestResult's via
465       addExpectedFailure if it is present on the TestResult. Python 2.6 and
466       earlier which do not have this function will have ``xfail`` outcomes
467       passed through as success outcomes as earlier versions of subunit did.
468
469   API CHANGES:
470
471     * tags are no longer passed around in python via the ``TestCase.tags``
472       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
473       and like in the protocol, if called while a test is active only applies
474       to that test. (Robert Collins)
475
476     * ``TestResultFilter`` takes a new optional constructor parameter 
477       ``filter_predicate``.  (Martin Pool)
478
479     * When a progress: directive is encountered in a subunit stream, the
480       python bindings now call the ``progress(offset, whence)`` method on
481       ``TestResult``.
482
483     * When a time: directive is encountered in a subunit stream, the python
484       bindings now call the ``time(seconds)`` method on ``TestResult``.
485
486   INTERNALS:
487
488     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
489       users of subunit will want to wrap their ``TestProtocolClient`` objects
490       in this decorator to get test timing data for performance analysis.
491
492     * (python) ExecTestCase supports passing arguments to test scripts.
493
494     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
495       which can be used to call some code on every event, without having to
496       implement all the event methods.
497
498     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
499       causes a timestamp to be output to the stream.