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