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