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