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