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