Merge progress model overhaul adding nest progress data.
[third_party/subunit] / NEWS
1 ---------------------
2 subunit release notes
3 ---------------------
4
5
6 0.0.2 (IN DEVELOPMENT)
7 ----------------------
8
9   CHANGES:
10
11   IMPROVEMENTS:
12
13     * A number of filters now support ``--no-passthrough`` to cause all
14       non-subunit content to be discarded. This is useful when precise control
15       over what is output is required - such as with subunit2junitxml.
16
17     * Subunit streams can now include optional, incremental lookahead
18       information about progress. This allows reporters to make estimates
19       about completion, when such information is available. See the README
20       under ``progress`` for more details.
21
22     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
23       test stream.
24
25     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
26       test reporter to be used, which has a textual progress bar. This requires
27       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
28
29     * ``subunit2junitxml`` has been added. This filter converts a subunit
30       stream to a single JUnit style XML stream using the pyjunitxml
31       python library.
32
33   BUG FIXES:
34
35     * ``xfail`` outcomes are now passed to python TestResult's via
36       addExpectedFailure if it is present on the TestResult. Python 2.6 and
37       earlier which do not have this function will have ``xfail`` outcomes
38       passed through as success outcomes as earlier versions of subunit did.
39
40   API CHANGES:
41
42     * When a progress: directive is encountered in a subunit stream, the
43       python bindings now call the ``progress(offset, whence)`` method on
44       ``TestResult``.
45
46     * When a time: directive is encountered in a subunit stream, the python
47       bindings now call the ``time(seconds)`` method on ``TestResult``.
48
49   INTERNALS:
50
51     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
52       users of subunit will want to wrap their ``TestProtocolClient`` objects
53       in this decorator to get test timing data for performance analysis.
54
55     * (python) ExecTestCase supports passing arguments to test scripts.
56
57     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
58       which can be used to call some code on every event, without having to
59       implement all the event methods.
60
61     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
62       causes a timestamp to be output to the stream.