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