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