lib/subunit/NEWS

   1 ---------------------
   2 subunit release notes
   3 ---------------------
   4
   5 NEXT (In development)
   6 ---------------------
   7
   8 BUG FIXES
   9 ~~~~~~~~~
  10
  11 * ``python/subunit/tests/test_run.py`` and ``python/subunit/filters.py`` were
  12   not included in the 0.0.8 tarball. (Robert Collins)
  13
  14 0.0.8
  15 -----
  16
  17 IMPROVEMENTS
  18 ~~~~~~~~~~~~
  19
  20 * Perl module now correctly outputs "failure" instead of "fail".  (Stewart Smith)
  21
  22 * Shell functions now output timestamps. (Stewart Smith, Robert Collins)
  23
  24 * 'subunit2csv' script that converts subunit output to CSV format.
  25   (Jonathan Lange)
  26
  27 * ``TagCollapsingDecorator`` now correctly distinguishes between local and
  28   global tags.  (Jonathan Lange)
  29
  30 * ``TestResultFilter`` always forwards ``time:`` events.
  31   (Benji York, Brad Crittenden)
  32
  33 BUG FIXES
  34 ~~~~~~~~~
  35
  36 * Add 'subunit --no-xfail', which will omit expected failures from the subunit
  37   stream. (John Arbash Meinel, #623642)
  38
  39 * Add 'subunit -F/--only-genuine-failures' which sets all of '--no-skips',
  40   '--no-xfail', '--no-passthrough, '--no-success', and gives you just the
  41   failure stream. (John Arbash Meinel)
  42
  43 * Python2.6 support was broken by the fixup feature.
  44   (Arfrever Frehtes Taifersar Arahesis, #987490)
  45
  46 * Python3 support regressed in trunk.
  47   (Arfrever Frehtes Taifersar Arahesis, #987514)
  48
  49 * Python3 support was insufficiently robust in detecting unicode streams.
  50   (Robert Collins, Arfrever Frehtes Taifersar Arahesis)
  51
  52 * Tag support has been implemented for TestProtocolClient.
  53   (Robert Collins, #518016)
  54
  55 * Tags can now be filtered. (Jonathan Lange, #664171)
  56
  57 * Test suite works with latest testtools (but not older ones - formatting
  58   changes only). (Robert Collins)
  59
  60 0.0.7
  61 -----
  62
  63 The Subunit Python test runner ``python -m subunit.run`` can now report the
  64 test ids and also filter via a test id list file thanks to improvements in
  65 ``testtools.run``. See the testtools manual, or testrepository - a major
  66 user of such functionality.
  67
  68 Additionally the protocol now has a keyword uxsuccess for Unexpected Success
  69 reporting. Older parsers will report tests with this status code as 'lost
  70 connection'.
  71
  72 IMPROVEMENTS
  73 ~~~~~~~~~~~~
  74
  75 * Add ``TimeCollapsingDecorator`` which collapses multiple sequential time()
  76   calls into just the first and last. (Jonathan Lange)
  77
  78 * Add ``TagCollapsingDecorator`` which collapses many tags() calls into one
  79   where possible. (Jonathan Lange, Robert Collins)
  80
  81 * Force flush of writes to stdout in c/tests/test_child.
  82   (Jelmer Vernooij, #687611)
  83
  84 * Provisional Python 3.x support.
  85   (Robert Collins, Tres Seaver, Martin[gz], #666819)
  86
  87 * ``subunit.chunked.Decoder`` Python class takes a new ``strict`` option,
  88   which defaults to ``True``. When ``False``, the ``Decoder`` will accept
  89   incorrect input that is still unambiguous. i.e. subunit will not barf if
  90   a \r is missing from the input. (Martin Pool)
  91
  92 * ``subunit-filter`` preserves the relative ordering of ``time:`` statements,
  93   so you can now use filtered streams to gather data about how long it takes
  94   to run a test. (Jonathan Lange, #716554)
  95
  96 * ``subunit-ls`` now handles a stream with time: instructions that start
  97   partway through the stream (which may lead to strange times) more gracefully.
  98   (Robert Collins, #785954)
  99
 100 * ``subunit-ls`` should handle the new test outcomes in Python2.7 better.
 101   (Robert Collins, #785953)
 102
 103 * ``TestResultFilter`` now collapses sequential calls to time().
 104   (Jonathan Lange, #567150)
 105
 106 * ``TestResultDecorator.tags()`` now actually works, and is no longer a buggy
 107   copy/paste of ``TestResultDecorator.time()``. (Jonathan Lange, #681828)
 108
 109 * ``TestResultFilter`` now supports a ``fixup_expected_failures``
 110   argument. (Jelmer Vernooij, #755241)
 111
 112 * The ``subunit.run`` Python module supports ``-l`` and ``--load-list`` as
 113   per ``testtools.run``. This required a dependency bump due to a small
 114   API change in ``testtools``. (Robert Collins)
 115
 116 * The help for subunit-filter was confusing about the behaviour of ``-f`` /
 117   ``--no-failure``. (Robert Collins, #703392)
 118
 119 * The Python2.7 / testtools addUnexpectedSuccess API is now supported. This
 120   required adding a new status code to the protocol. (Robert Collins, #654474)
 121
 122 CHANGES
 123 ~~~~~~~
 124
 125 * testtools 0.9.11 or newer is new needed (due to the Python 3 support).
 126   (Robert Collins)
 127
 128 0.0.6
 129 -----
 130
 131 This release of subunit fixes a number of unicode related bugs. This depends on
 132 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
 133 is also an optional native setup.py file for use with easy_install and the
 134 like.
 135
 136 BUG FIXES
 137 ~~~~~~~~~
 138
 139 * Be consistent about delivering unicode content to testtools StringException
 140   class which has become (appropriately) conservative. (Robert Collins)
 141
 142 * Fix incorrect reference to subunit_test_failf in c/README.
 143   (Brad Hards, #524341)
 144
 145 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
 146   is purely cosmetic as the parameters are passed down with no interpretation.
 147   (Robert Collins, #537611)
 148
 149 * Old style tracebacks with no encoding info are now treated as UTF8 rather
 150   than some-random-codec-like-ascii. (Robert Collins)
 151
 152 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
 153   binary mode by calling into msvcrt; this avoids having their input or output
 154   mangled by the default line ending translation on that platform.
 155   (Robert Collins, Martin [gz], #579296)
 156
 157 IMPROVEMENTS
 158 ~~~~~~~~~~~~
 159
 160 * Subunit now has a setup.py for python deployments that are not using
 161   distribution packages. (Tres Seaver, #538181)
 162
 163 * Subunit now supports test discovery by building on the testtools support for
 164   it. You can take advantage of it with "python -m subunit.run discover [path]"
 165   and see "python -m subunit.run discover --help" for more options.
 166
 167 * Subunit now uses the improved unicode support in testtools when outputting
 168   non-details based test information; this should consistently UTF8 encode such
 169   strings.
 170
 171 * The Python TestProtocolClient now flushes output on startTest and stopTest.
 172   (Martin [gz]).
 173
 174
 175 0.0.5
 176 -----
 177
 178 BUG FIXES
 179 ~~~~~~~~~
 180
 181 * make check was failing if subunit wasn't installed due to a missing include
 182   path for the test program test_child.
 183
 184 * make distcheck was failing due to a missing $(top_srcdir) rune.
 185
 186 IMPROVEMENTS
 187 ~~~~~~~~~~~~
 188
 189 * New filter `subunit-notify` that will show a notification window with test
 190   statistics when the test run finishes.
 191
 192 * subunit.run will now pipe its output to the command in the
 193   SUBUNIT_FORMATTER environment variable, if set.
 194
 195 0.0.4
 196 -----
 197
 198 BUG FIXES
 199 ~~~~~~~~~
 200
 201 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
 202   boolean switch with no parameter.
 203
 204 * Building with autoconf 2.65 is now supported.
 205
 206
 207 0.0.3
 208 -----
 209
 210   CHANGES:
 211
 212     * License change, by unanimous agreement of contributors to BSD/Apache
 213       License Version 2.0. This makes Subunit compatible with more testing
 214       frameworks.
 215
 216   IMPROVEMENTS:
 217
 218     * CPPUnit is now directly supported: subunit builds a cppunit listener
 219       ``libcppunit-subunit``.
 220
 221     * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
 222       from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
 223       serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
 224       The ``ProtocolTestCase`` parser now calls outcomes using an extended
 225       API that permits attaching arbitrary MIME resources such as text files
 226       log entries and so on. This extended API is being developed with the
 227       Python testing community, and is in flux. ``TestResult`` objects that
 228       do not support the API will be detected and transparently downgraded
 229       back to the regular Python unittest API.
 230
 231     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
 232       viarable when installing.
 233
 234     * Multipart test outcomes are tentatively supported; the exact protocol
 235       for them, both serialiser and object is not yet finalised. Testers and
 236       early adopters are sought. As part of this and also in an attempt to
 237       provider a more precise focus on the wire protocol and toolchain,
 238       Subunit now depends on testtools (http://launchpad.net/testtools)
 239       release 0.9.0 or newer.
 240
 241     * subunit2junitxml supports a new option, --forward which causes it
 242       to forward the raw subunit stream in a similar manner to tee. This
 243       is used with the -o option to both write a xml report and get some
 244       other subunit filter to process the stream.
 245
 246     * The C library now has ``subunit_test_skip``.
 247
 248   BUG FIXES:
 249
 250     * Install progress_model.py correctly.
 251
 252     * Non-gcc builds will no longer try to use gcc specific flags.
 253       (Thanks trondn-norbye)
 254
 255   API CHANGES:
 256
 257   INTERNALS:
 258
 259 0.0.2
 260 -----
 261
 262   CHANGES:
 263
 264   IMPROVEMENTS:
 265
 266     * A number of filters now support ``--no-passthrough`` to cause all
 267       non-subunit content to be discarded. This is useful when precise control
 268       over what is output is required - such as with subunit2junitxml.
 269
 270     * A small perl parser is now included, and a new ``subunit-diff`` tool
 271       using that is included. (Jelmer Vernooij)
 272
 273     * Subunit streams can now include optional, incremental lookahead
 274       information about progress. This allows reporters to make estimates
 275       about completion, when such information is available. See the README
 276       under ``progress`` for more details.
 277
 278     * ``subunit-filter`` now supports regex filtering via ``--with`` and
 279       ``without`` options. (Martin Pool)
 280
 281     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
 282       test stream.
 283
 284     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
 285       test reporter to be used, which has a textual progress bar. This requires
 286       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
 287
 288     * ``subunit2junitxml`` has been added. This filter converts a subunit
 289       stream to a single JUnit style XML stream using the pyjunitxml
 290       python library.
 291
 292     * The shell functions support skipping via ``subunit_skip_test`` now.
 293
 294   BUG FIXES:
 295
 296     * ``xfail`` outcomes are now passed to python TestResult's via
 297       addExpectedFailure if it is present on the TestResult. Python 2.6 and
 298       earlier which do not have this function will have ``xfail`` outcomes
 299       passed through as success outcomes as earlier versions of subunit did.
 300
 301   API CHANGES:
 302
 303     * tags are no longer passed around in python via the ``TestCase.tags``
 304       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
 305       and like in the protocol, if called while a test is active only applies
 306       to that test. (Robert Collins)
 307
 308     * ``TestResultFilter`` takes a new optional constructor parameter
 309       ``filter_predicate``.  (Martin Pool)
 310
 311     * When a progress: directive is encountered in a subunit stream, the
 312       python bindings now call the ``progress(offset, whence)`` method on
 313       ``TestResult``.
 314
 315     * When a time: directive is encountered in a subunit stream, the python
 316       bindings now call the ``time(seconds)`` method on ``TestResult``.
 317
 318   INTERNALS:
 319
 320     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
 321       users of subunit will want to wrap their ``TestProtocolClient`` objects
 322       in this decorator to get test timing data for performance analysis.
 323
 324     * (python) ExecTestCase supports passing arguments to test scripts.
 325
 326     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
 327       which can be used to call some code on every event, without having to
 328       implement all the event methods.
 329
 330     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
 331       causes a timestamp to be output to the stream.