* Memoryview detection was broken and thus it's use was never really tested.
[third_party/subunit] / NEWS
1 ---------------------
2 subunit release notes
3 ---------------------
4
5 NEXT (In development)
6 ---------------------
7
8 BUG FIXES
9 ~~~~~~~~~
10
11 * Memoryview detection was broken and thus it's use was never really tested.
12   (Robert Collins, 1216101)
13
14 * TestProtocol2's tag tests were set sort order dependent.
15   (Robert Collins, #1025392)
16
17 * TestTestProtocols' test_tags_both was set sort order dependent.
18   (Robert Collins, #1025392)
19
20 * TestTestProtocols' test_*_details were dictionary sort order dependent.
21   (Robert Collins, #1025392)
22
23 * TestSubUnitTags's test_add_tag was also se sort order dependent.
24   (Robert Collins, #1025392)
25
26 0.0.13
27 ------
28
29 IMPROVEMENTS
30 ~~~~~~~~~~~~
31
32 * subunit should now build with automake 1.11 again. (Robert Collins)
33
34 * `subunit-stats` no longer outputs encapsulated stdout as subunit.
35   (Robert Collins, #1171987)
36
37 * The logic for `subunit.run` is now importable via python -
38   `subunit.run.main`. (Robert Collins, #606770)
39
40 BUG FIXES
41 ~~~~~~~~~
42
43 * Removed GPL files that were (C) non Subunit Developers - they are
44   incompatible for binary distribution, which affects redistributors.
45   (Robert Collins, #1185591)
46
47 0.0.12
48 ------
49
50 BUG FIXES
51 ~~~~~~~~~
52
53 * Subunit v2 packets with both file content and route code were not being
54   parsed correctly - they would incorrectly emit a parser error, due to trying
55   to parse the route code length from the first byes of the file content.
56   (Robert Collins, 1172815)
57
58 0.0.11
59 ------
60
61 v2 protocol draft included in this release. The v2 protocol trades off human
62 readability for a massive improvement in robustness, the ability to represent
63 concurrent tests in a single stream, cheaper parsing, and that provides
64 significantly better in-line debugging support and structured forwarding
65 of non-test data (such as stdout or stdin data).
66
67 This change includes two new filters (subunit-1to2 and subunit-2to1). Use
68 these filters to convert old streams to v2 and convert v2 streams to v1.
69
70 All the other filters now only parse and emit v2 streams. V2 is still in
71 draft format, so if you want to delay and wait for v2 to be finalised, you
72 should use subunit-2to1 before any serialisation steps take place.
73 With the ability to encapsulate multiple non-test streams, another significant
74 cange is that filters which emit subunit now encapsulate any non-subunit they
75 encounter, labelling it 'stdout'. This permits multiplexing such streams and
76 detangling the stdout streams from each input.
77
78 The subunit libraries (Python etc) have not changed their behaviour: they
79 still emit v1 from their existing API calls. New API's are being added
80 and applications should migrate once their language has those API's available.
81
82 IMPROVEMENTS
83 ~~~~~~~~~~~~
84
85 * ``subunit.run`` now replaces sys.stdout to ensure that stdout is unbuffered
86   - without this pdb output is not reliably visible when stdout is a pipe
87   as it usually is. (Robert Collins)
88
89 * v2 protocol draft included in this release. (Python implementation only so
90   far). (Robert Collins)
91
92 * Two new Python classes -- ``StreamResultToBytes`` and
93   ``ByteStreamToStreamResult`` handle v2 generation and parsing.
94   (Robert Collins)
95
96 0.0.10
97 ------
98
99 BUG FIXES
100 ~~~~~~~~~
101
102 * make_stream_binary is now public for reuse. (Robert Collins)
103
104 * NAME was not defined in the protocol BNF. (Robert Collins)
105
106 * UnsupportedOperation is available in the Python2.6 io library, so ask
107   forgiveness rather than permission for obtaining it. (Robert Collins)
108
109 * Streams with no fileno() attribute are now supported, but they are not
110   checked for being in binary mode: be sure to take care of that if using
111   the library yourself. (Robert Collins)
112
113 0.0.9
114 -----
115
116 BUG FIXES
117 ~~~~~~~~~
118
119 * All the source files are now included in the distribution tarball.
120   (Arfrever Frehtes Taifersar Arahesis, Robert Collins, #996275)
121
122 * ``python/subunit/tests/test_run.py`` and ``python/subunit/filters.py`` were
123   not included in the 0.0.8 tarball. (Robert Collins)
124
125 * Test ids which include non-ascii unicode characters are now supported.
126   (Robert Collins, #1029866)
127
128 * The ``failfast`` option to ``subunit.run`` will now work. The dependency on
129   testtools has been raised to 0.9.23 to permit this.
130   (Robert Collins, #1090582)
131
132 0.0.8
133 -----
134
135 IMPROVEMENTS
136 ~~~~~~~~~~~~
137
138 * Perl module now correctly outputs "failure" instead of "fail".  (Stewart Smith)
139
140 * Shell functions now output timestamps. (Stewart Smith, Robert Collins)
141
142 * 'subunit2csv' script that converts subunit output to CSV format.
143   (Jonathan Lange)
144
145 * ``TagCollapsingDecorator`` now correctly distinguishes between local and
146   global tags.  (Jonathan Lange)
147
148 * ``TestResultFilter`` always forwards ``time:`` events.
149   (Benji York, Brad Crittenden)
150
151 BUG FIXES
152 ~~~~~~~~~
153
154 * Add 'subunit --no-xfail', which will omit expected failures from the subunit
155   stream. (John Arbash Meinel, #623642)
156
157 * Add 'subunit -F/--only-genuine-failures' which sets all of '--no-skips',
158   '--no-xfail', '--no-passthrough, '--no-success', and gives you just the
159   failure stream. (John Arbash Meinel)
160
161 * Python2.6 support was broken by the fixup feature.
162   (Arfrever Frehtes Taifersar Arahesis, #987490)
163
164 * Python3 support regressed in trunk.
165   (Arfrever Frehtes Taifersar Arahesis, #987514)
166
167 * Python3 support was insufficiently robust in detecting unicode streams.
168   (Robert Collins, Arfrever Frehtes Taifersar Arahesis)
169
170 * Tag support has been implemented for TestProtocolClient.
171   (Robert Collins, #518016)
172
173 * Tags can now be filtered. (Jonathan Lange, #664171)
174
175 * Test suite works with latest testtools (but not older ones - formatting
176   changes only). (Robert Collins)
177
178 0.0.7
179 -----
180
181 The Subunit Python test runner ``python -m subunit.run`` can now report the
182 test ids and also filter via a test id list file thanks to improvements in
183 ``testtools.run``. See the testtools manual, or testrepository - a major
184 user of such functionality.
185
186 Additionally the protocol now has a keyword uxsuccess for Unexpected Success
187 reporting. Older parsers will report tests with this status code as 'lost
188 connection'.
189
190 IMPROVEMENTS
191 ~~~~~~~~~~~~
192
193 * Add ``TimeCollapsingDecorator`` which collapses multiple sequential time()
194   calls into just the first and last. (Jonathan Lange)
195
196 * Add ``TagCollapsingDecorator`` which collapses many tags() calls into one
197   where possible. (Jonathan Lange, Robert Collins)
198
199 * Force flush of writes to stdout in c/tests/test_child.
200   (Jelmer Vernooij, #687611)
201
202 * Provisional Python 3.x support.
203   (Robert Collins, Tres Seaver, Martin[gz], #666819)
204
205 * ``subunit.chunked.Decoder`` Python class takes a new ``strict`` option,
206   which defaults to ``True``. When ``False``, the ``Decoder`` will accept
207   incorrect input that is still unambiguous. i.e. subunit will not barf if
208   a \r is missing from the input. (Martin Pool)
209
210 * ``subunit-filter`` preserves the relative ordering of ``time:`` statements,
211   so you can now use filtered streams to gather data about how long it takes
212   to run a test. (Jonathan Lange, #716554)
213
214 * ``subunit-ls`` now handles a stream with time: instructions that start
215   partway through the stream (which may lead to strange times) more gracefully.
216   (Robert Collins, #785954)
217
218 * ``subunit-ls`` should handle the new test outcomes in Python2.7 better.
219   (Robert Collins, #785953)
220
221 * ``TestResultFilter`` now collapses sequential calls to time().
222   (Jonathan Lange, #567150)
223
224 * ``TestResultDecorator.tags()`` now actually works, and is no longer a buggy
225   copy/paste of ``TestResultDecorator.time()``. (Jonathan Lange, #681828)
226
227 * ``TestResultFilter`` now supports a ``fixup_expected_failures``
228   argument. (Jelmer Vernooij, #755241)
229
230 * The ``subunit.run`` Python module supports ``-l`` and ``--load-list`` as
231   per ``testtools.run``. This required a dependency bump due to a small
232   API change in ``testtools``. (Robert Collins)
233
234 * The help for subunit-filter was confusing about the behaviour of ``-f`` /
235   ``--no-failure``. (Robert Collins, #703392)
236
237 * The Python2.7 / testtools addUnexpectedSuccess API is now supported. This
238   required adding a new status code to the protocol. (Robert Collins, #654474)
239
240 CHANGES
241 ~~~~~~~
242
243 * testtools 0.9.11 or newer is new needed (due to the Python 3 support).
244   (Robert Collins)
245
246 0.0.6
247 -----
248
249 This release of subunit fixes a number of unicode related bugs. This depends on
250 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
251 is also an optional native setup.py file for use with easy_install and the
252 like.
253
254 BUG FIXES
255 ~~~~~~~~~
256
257 * Be consistent about delivering unicode content to testtools StringException
258   class which has become (appropriately) conservative. (Robert Collins)
259
260 * Fix incorrect reference to subunit_test_failf in c/README.
261   (Brad Hards, #524341)
262
263 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
264   is purely cosmetic as the parameters are passed down with no interpretation.
265   (Robert Collins, #537611)
266
267 * Old style tracebacks with no encoding info are now treated as UTF8 rather
268   than some-random-codec-like-ascii. (Robert Collins)
269
270 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
271   binary mode by calling into msvcrt; this avoids having their input or output
272   mangled by the default line ending translation on that platform.
273   (Robert Collins, Martin [gz], #579296)
274
275 IMPROVEMENTS
276 ~~~~~~~~~~~~
277
278 * Subunit now has a setup.py for python deployments that are not using
279   distribution packages. (Tres Seaver, #538181)
280
281 * Subunit now supports test discovery by building on the testtools support for
282   it. You can take advantage of it with "python -m subunit.run discover [path]"
283   and see "python -m subunit.run discover --help" for more options.
284
285 * Subunit now uses the improved unicode support in testtools when outputting
286   non-details based test information; this should consistently UTF8 encode such
287   strings.
288
289 * The Python TestProtocolClient now flushes output on startTest and stopTest.
290   (Martin [gz]).
291
292
293 0.0.5
294 -----
295
296 BUG FIXES
297 ~~~~~~~~~
298
299 * make check was failing if subunit wasn't installed due to a missing include
300   path for the test program test_child.
301
302 * make distcheck was failing due to a missing $(top_srcdir) rune.
303
304 IMPROVEMENTS
305 ~~~~~~~~~~~~
306
307 * New filter `subunit-notify` that will show a notification window with test 
308   statistics when the test run finishes.
309
310 * subunit.run will now pipe its output to the command in the 
311   SUBUNIT_FORMATTER environment variable, if set.
312
313 0.0.4
314 -----
315
316 BUG FIXES
317 ~~~~~~~~~
318
319 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
320   boolean switch with no parameter.
321
322 * Building with autoconf 2.65 is now supported.
323
324
325 0.0.3
326 -----
327
328   CHANGES:
329   
330     * License change, by unanimous agreement of contributors to BSD/Apache
331       License Version 2.0. This makes Subunit compatible with more testing
332       frameworks.
333
334   IMPROVEMENTS:
335
336     * CPPUnit is now directly supported: subunit builds a cppunit listener
337       ``libcppunit-subunit``. 
338
339     * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
340       from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
341       serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
342       The ``ProtocolTestCase`` parser now calls outcomes using an extended
343       API that permits attaching arbitrary MIME resources such as text files
344       log entries and so on. This extended API is being developed with the
345       Python testing community, and is in flux. ``TestResult`` objects that
346       do not support the API will be detected and transparently downgraded
347       back to the regular Python unittest API.
348
349     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
350       viarable when installing.
351
352     * Multipart test outcomes are tentatively supported; the exact protocol
353       for them, both serialiser and object is not yet finalised. Testers and
354       early adopters are sought. As part of this and also in an attempt to
355       provider a more precise focus on the wire protocol and toolchain, 
356       Subunit now depends on testtools (http://launchpad.net/testtools)
357       release 0.9.0 or newer.
358
359     * subunit2junitxml supports a new option, --forward which causes it
360       to forward the raw subunit stream in a similar manner to tee. This
361       is used with the -o option to both write a xml report and get some
362       other subunit filter to process the stream.
363
364     * The C library now has ``subunit_test_skip``.
365
366   BUG FIXES:
367
368     * Install progress_model.py correctly.
369
370     * Non-gcc builds will no longer try to use gcc specific flags.
371       (Thanks trondn-norbye)
372
373   API CHANGES:
374
375   INTERNALS:
376
377 0.0.2
378 -----
379
380   CHANGES:
381
382   IMPROVEMENTS:
383
384     * A number of filters now support ``--no-passthrough`` to cause all
385       non-subunit content to be discarded. This is useful when precise control
386       over what is output is required - such as with subunit2junitxml.
387
388     * A small perl parser is now included, and a new ``subunit-diff`` tool
389       using that is included. (Jelmer Vernooij)
390
391     * Subunit streams can now include optional, incremental lookahead
392       information about progress. This allows reporters to make estimates
393       about completion, when such information is available. See the README
394       under ``progress`` for more details.
395
396     * ``subunit-filter`` now supports regex filtering via ``--with`` and
397       ``without`` options. (Martin Pool)
398
399     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
400       test stream.
401
402     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
403       test reporter to be used, which has a textual progress bar. This requires
404       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
405
406     * ``subunit2junitxml`` has been added. This filter converts a subunit
407       stream to a single JUnit style XML stream using the pyjunitxml
408       python library.
409
410     * The shell functions support skipping via ``subunit_skip_test`` now.
411
412   BUG FIXES:
413
414     * ``xfail`` outcomes are now passed to python TestResult's via
415       addExpectedFailure if it is present on the TestResult. Python 2.6 and
416       earlier which do not have this function will have ``xfail`` outcomes
417       passed through as success outcomes as earlier versions of subunit did.
418
419   API CHANGES:
420
421     * tags are no longer passed around in python via the ``TestCase.tags``
422       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
423       and like in the protocol, if called while a test is active only applies
424       to that test. (Robert Collins)
425
426     * ``TestResultFilter`` takes a new optional constructor parameter 
427       ``filter_predicate``.  (Martin Pool)
428
429     * When a progress: directive is encountered in a subunit stream, the
430       python bindings now call the ``progress(offset, whence)`` method on
431       ``TestResult``.
432
433     * When a time: directive is encountered in a subunit stream, the python
434       bindings now call the ``time(seconds)`` method on ``TestResult``.
435
436   INTERNALS:
437
438     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
439       users of subunit will want to wrap their ``TestProtocolClient`` objects
440       in this decorator to get test timing data for performance analysis.
441
442     * (python) ExecTestCase supports passing arguments to test scripts.
443
444     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
445       which can be used to call some code on every event, without having to
446       implement all the event methods.
447
448     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
449       causes a timestamp to be output to the stream.