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