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