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