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

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