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