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