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