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