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