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