Add --forward option to subunit2junitxml.
[third_party/subunit] / NEWS
1 ---------------------
2 subunit release notes
3 ---------------------
4
5 0.0.3 (In development)
6 ----------------------
7
8   CHANGES:
9   
10     * License change, by unanimous agreement of contributors to BSD/Apache
11       License Version 2.0. This makes Subunit compatible with more testing
12       frameworks.
13
14   IMPROVEMENTS:
15
16     * CPPUnit is now directly supported: subunit builds a cppunit listener
17       ``libcppunit-subunit``. 
18
19     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
20       viarable when installing.
21
22     * subunit2junitxml supports a new option, --forward which causes it
23       to forward the raw subunit stream in a similar manner to tee. This
24       is used with the -o option to both write a xml report and get some
25       other subunit filter to process the stream.
26
27     * The C library now has ``subunit_test_skip``.
28
29   BUG FIXES:
30
31     * Install progress_model.py correctly.
32
33     * Non-gcc builds will no longer try to use gcc specific flags.
34       (Thanks trondn-norbye)
35
36   API CHANGES:
37
38   INTERNALS:
39
40 0.0.2
41 -----
42
43   CHANGES:
44
45   IMPROVEMENTS:
46
47     * A number of filters now support ``--no-passthrough`` to cause all
48       non-subunit content to be discarded. This is useful when precise control
49       over what is output is required - such as with subunit2junitxml.
50
51     * A small perl parser is now included, and a new ``subunit-diff`` tool
52       using that is included. (Jelmer Vernooij)
53
54     * Subunit streams can now include optional, incremental lookahead
55       information about progress. This allows reporters to make estimates
56       about completion, when such information is available. See the README
57       under ``progress`` for more details.
58
59     * ``subunit-filter`` now supports regex filtering via ``--with`` and
60       ``without`` options. (Martin Pool)
61
62     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
63       test stream.
64
65     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
66       test reporter to be used, which has a textual progress bar. This requires
67       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
68
69     * ``subunit2junitxml`` has been added. This filter converts a subunit
70       stream to a single JUnit style XML stream using the pyjunitxml
71       python library.
72
73     * The shell functions support skipping via ``subunit_skip_test`` now.
74
75   BUG FIXES:
76
77     * ``xfail`` outcomes are now passed to python TestResult's via
78       addExpectedFailure if it is present on the TestResult. Python 2.6 and
79       earlier which do not have this function will have ``xfail`` outcomes
80       passed through as success outcomes as earlier versions of subunit did.
81
82   API CHANGES:
83
84     * tags are no longer passed around in python via the ``TestCase.tags``
85       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
86       and like in the protocol, if called while a test is active only applies
87       to that test. (Robert Collins)
88
89     * ``TestResultFilter`` takes a new optional constructor parameter 
90       ``filter_predicate``.  (Martin Pool)
91
92     * When a progress: directive is encountered in a subunit stream, the
93       python bindings now call the ``progress(offset, whence)`` method on
94       ``TestResult``.
95
96     * When a time: directive is encountered in a subunit stream, the python
97       bindings now call the ``time(seconds)`` method on ``TestResult``.
98
99   INTERNALS:
100
101     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
102       users of subunit will want to wrap their ``TestProtocolClient`` objects
103       in this decorator to get test timing data for performance analysis.
104
105     * (python) ExecTestCase supports passing arguments to test scripts.
106
107     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
108       which can be used to call some code on every event, without having to
109       implement all the event methods.
110
111     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
112       causes a timestamp to be output to the stream.