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