lib/subunit/NEWS

   1 ---------------------
   2 subunit release notes
   3 ---------------------
   4
   5 NEXT (In development)
   6 ---------------------
   7
   8 0.0.6
   9 -----
  10
  11 This release of subunit fixes a number of unicode related bugs. This depends on
  12 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
  13 is also an optional native setup.py file for use with easy_install and the
  14 like.
  15
  16 BUG FIXES
  17 ~~~~~~~~~
  18
  19 * Be consistent about delivering unicode content to testtools StringException
  20   class which has become (appropriately) conservative. (Robert Collins)
  21
  22 * Fix incorrect reference to subunit_test_failf in c/README.
  23   (Brad Hards, #524341)
  24
  25 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
  26   is purely cosmetic as the parameters are passed down with no interpretation.
  27   (Robert Collins, #537611)
  28
  29 * Old style tracebacks with no encoding info are now treated as UTF8 rather
  30   than some-random-codec-like-ascii. (Robert Collins)
  31
  32 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
  33   binary mode by calling into msvcrt; this avoids having their input or output
  34   mangled by the default line ending translation on that platform.
  35   (Robert Collins, Martin [gz], #579296)
  36
  37 IMPROVEMENTS
  38 ~~~~~~~~~~~~
  39
  40 * Subunit now has a setup.py for python deployments that are not using
  41   distribution packages. (Tres Seaver, #538181)
  42
  43 * Subunit now supports test discovery by building on the testtools support for
  44   it. You can take advantage of it with "python -m subunit.run discover [path]"
  45   and see "python -m subunit.run discover --help" for more options.
  46
  47 * Subunit now uses the improved unicode support in testtools when outputting
  48   non-details based test information; this should consistently UTF8 encode such
  49   strings.
  50
  51 0.0.5
  52 -----
  53
  54 BUG FIXES
  55 ~~~~~~~~~
  56
  57 * make check was failing if subunit wasn't installed due to a missing include
  58   path for the test program test_child.
  59
  60 * make distcheck was failing due to a missing $(top_srcdir) rune.
  61
  62 IMPROVEMENTS
  63 ~~~~~~~~~~~~
  64
  65 * New filter `subunit-notify` that will show a notification window with test
  66   statistics when the test run finishes.
  67
  68 * subunit.run will now pipe its output to the command in the
  69   SUBUNIT_FORMATTER environment variable, if set.
  70
  71 0.0.4
  72 -----
  73
  74 BUG FIXES
  75 ~~~~~~~~~
  76
  77 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
  78   boolean switch with no parameter.
  79
  80 * Building with autoconf 2.65 is now supported.
  81
  82
  83 0.0.3
  84 -----
  85
  86   CHANGES:
  87
  88     * License change, by unanimous agreement of contributors to BSD/Apache
  89       License Version 2.0. This makes Subunit compatible with more testing
  90       frameworks.
  91
  92   IMPROVEMENTS:
  93
  94     * CPPUnit is now directly supported: subunit builds a cppunit listener
  95       ``libcppunit-subunit``.
  96
  97     * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
  98       from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
  99       serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
 100       The ``ProtocolTestCase`` parser now calls outcomes using an extended
 101       API that permits attaching arbitrary MIME resources such as text files
 102       log entries and so on. This extended API is being developed with the
 103       Python testing community, and is in flux. ``TestResult`` objects that
 104       do not support the API will be detected and transparently downgraded
 105       back to the regular Python unittest API.
 106
 107     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
 108       viarable when installing.
 109
 110     * Multipart test outcomes are tentatively supported; the exact protocol
 111       for them, both serialiser and object is not yet finalised. Testers and
 112       early adopters are sought. As part of this and also in an attempt to
 113       provider a more precise focus on the wire protocol and toolchain,
 114       Subunit now depends on testtools (http://launchpad.net/testtools)
 115       release 0.9.0 or newer.
 116
 117     * subunit2junitxml supports a new option, --forward which causes it
 118       to forward the raw subunit stream in a similar manner to tee. This
 119       is used with the -o option to both write a xml report and get some
 120       other subunit filter to process the stream.
 121
 122     * The C library now has ``subunit_test_skip``.
 123
 124   BUG FIXES:
 125
 126     * Install progress_model.py correctly.
 127
 128     * Non-gcc builds will no longer try to use gcc specific flags.
 129       (Thanks trondn-norbye)
 130
 131   API CHANGES:
 132
 133   INTERNALS:
 134
 135 0.0.2
 136 -----
 137
 138   CHANGES:
 139
 140   IMPROVEMENTS:
 141
 142     * A number of filters now support ``--no-passthrough`` to cause all
 143       non-subunit content to be discarded. This is useful when precise control
 144       over what is output is required - such as with subunit2junitxml.
 145
 146     * A small perl parser is now included, and a new ``subunit-diff`` tool
 147       using that is included. (Jelmer Vernooij)
 148
 149     * Subunit streams can now include optional, incremental lookahead
 150       information about progress. This allows reporters to make estimates
 151       about completion, when such information is available. See the README
 152       under ``progress`` for more details.
 153
 154     * ``subunit-filter`` now supports regex filtering via ``--with`` and
 155       ``without`` options. (Martin Pool)
 156
 157     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
 158       test stream.
 159
 160     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
 161       test reporter to be used, which has a textual progress bar. This requires
 162       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
 163
 164     * ``subunit2junitxml`` has been added. This filter converts a subunit
 165       stream to a single JUnit style XML stream using the pyjunitxml
 166       python library.
 167
 168     * The shell functions support skipping via ``subunit_skip_test`` now.
 169
 170   BUG FIXES:
 171
 172     * ``xfail`` outcomes are now passed to python TestResult's via
 173       addExpectedFailure if it is present on the TestResult. Python 2.6 and
 174       earlier which do not have this function will have ``xfail`` outcomes
 175       passed through as success outcomes as earlier versions of subunit did.
 176
 177   API CHANGES:
 178
 179     * tags are no longer passed around in python via the ``TestCase.tags``
 180       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
 181       and like in the protocol, if called while a test is active only applies
 182       to that test. (Robert Collins)
 183
 184     * ``TestResultFilter`` takes a new optional constructor parameter
 185       ``filter_predicate``.  (Martin Pool)
 186
 187     * When a progress: directive is encountered in a subunit stream, the
 188       python bindings now call the ``progress(offset, whence)`` method on
 189       ``TestResult``.
 190
 191     * When a time: directive is encountered in a subunit stream, the python
 192       bindings now call the ``time(seconds)`` method on ``TestResult``.
 193
 194   INTERNALS:
 195
 196     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
 197       users of subunit will want to wrap their ``TestProtocolClient`` objects
 198       in this decorator to get test timing data for performance analysis.
 199
 200     * (python) ExecTestCase supports passing arguments to test scripts.
 201
 202     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
 203       which can be used to call some code on every event, without having to
 204       implement all the event methods.
 205
 206     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
 207       causes a timestamp to be output to the stream.