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