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