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