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