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