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