git.samba.org - third_party/subunit/blob - NEWS

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