9646c3c6b2d918ab36c91e10470a32bd161fc0ce
[third_party/subunit] / NEWS
1 ---------------------
2 subunit release notes
3 ---------------------
4
5 NEXT (In development)
6 ---------------------
7
8 BUG FIXES
9 ~~~~~~~~~
10
11 * make check was failing if subunit wasn't installed due to a missing include
12   path for the test program test_child.
13
14 0.0.4
15 -----
16
17 BUG FIXES
18 ~~~~~~~~~
19
20 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
21   boolean switch with no parameter.
22
23 * Building with autoconf 2.65 is now supported.
24
25 IMPROVEMENTS
26 ~~~~~~~~~~~~
27
28 * New filter `subunit-notify` that will show a notification window with test 
29   statistics when the test run finishes.
30
31
32 0.0.3
33 -----
34
35   CHANGES:
36   
37     * License change, by unanimous agreement of contributors to BSD/Apache
38       License Version 2.0. This makes Subunit compatible with more testing
39       frameworks.
40
41   IMPROVEMENTS:
42
43     * CPPUnit is now directly supported: subunit builds a cppunit listener
44       ``libcppunit-subunit``. 
45
46     * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
47       from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
48       serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
49       The ``ProtocolTestCase`` parser now calls outcomes using an extended
50       API that permits attaching arbitrary MIME resources such as text files
51       log entries and so on. This extended API is being developed with the
52       Python testing community, and is in flux. ``TestResult`` objects that
53       do not support the API will be detected and transparently downgraded
54       back to the regular Python unittest API.
55
56     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
57       viarable when installing.
58
59     * Multipart test outcomes are tentatively supported; the exact protocol
60       for them, both serialiser and object is not yet finalised. Testers and
61       early adopters are sought. As part of this and also in an attempt to
62       provider a more precise focus on the wire protocol and toolchain, 
63       Subunit now depends on testtools (http://launchpad.net/testtools)
64       release 0.9.0 or newer.
65
66     * subunit2junitxml supports a new option, --forward which causes it
67       to forward the raw subunit stream in a similar manner to tee. This
68       is used with the -o option to both write a xml report and get some
69       other subunit filter to process the stream.
70
71     * The C library now has ``subunit_test_skip``.
72
73   BUG FIXES:
74
75     * Install progress_model.py correctly.
76
77     * Non-gcc builds will no longer try to use gcc specific flags.
78       (Thanks trondn-norbye)
79
80   API CHANGES:
81
82   INTERNALS:
83
84 0.0.2
85 -----
86
87   CHANGES:
88
89   IMPROVEMENTS:
90
91     * A number of filters now support ``--no-passthrough`` to cause all
92       non-subunit content to be discarded. This is useful when precise control
93       over what is output is required - such as with subunit2junitxml.
94
95     * A small perl parser is now included, and a new ``subunit-diff`` tool
96       using that is included. (Jelmer Vernooij)
97
98     * Subunit streams can now include optional, incremental lookahead
99       information about progress. This allows reporters to make estimates
100       about completion, when such information is available. See the README
101       under ``progress`` for more details.
102
103     * ``subunit-filter`` now supports regex filtering via ``--with`` and
104       ``without`` options. (Martin Pool)
105
106     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
107       test stream.
108
109     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
110       test reporter to be used, which has a textual progress bar. This requires
111       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
112
113     * ``subunit2junitxml`` has been added. This filter converts a subunit
114       stream to a single JUnit style XML stream using the pyjunitxml
115       python library.
116
117     * The shell functions support skipping via ``subunit_skip_test`` now.
118
119   BUG FIXES:
120
121     * ``xfail`` outcomes are now passed to python TestResult's via
122       addExpectedFailure if it is present on the TestResult. Python 2.6 and
123       earlier which do not have this function will have ``xfail`` outcomes
124       passed through as success outcomes as earlier versions of subunit did.
125
126   API CHANGES:
127
128     * tags are no longer passed around in python via the ``TestCase.tags``
129       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
130       and like in the protocol, if called while a test is active only applies
131       to that test. (Robert Collins)
132
133     * ``TestResultFilter`` takes a new optional constructor parameter 
134       ``filter_predicate``.  (Martin Pool)
135
136     * When a progress: directive is encountered in a subunit stream, the
137       python bindings now call the ``progress(offset, whence)`` method on
138       ``TestResult``.
139
140     * When a time: directive is encountered in a subunit stream, the python
141       bindings now call the ``time(seconds)`` method on ``TestResult``.
142
143   INTERNALS:
144
145     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
146       users of subunit will want to wrap their ``TestProtocolClient`` objects
147       in this decorator to get test timing data for performance analysis.
148
149     * (python) ExecTestCase supports passing arguments to test scripts.
150
151     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
152       which can be used to call some code on every event, without having to
153       implement all the event methods.
154
155     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
156       causes a timestamp to be output to the stream.