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