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