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