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