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