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 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
  12   boolean switch with no parameter.
  13
  14 * Building with autoconf 2.65 is now supported.
  15
  16
  17 0.0.3
  18 -----
  19
  20   CHANGES:
  21
  22     * License change, by unanimous agreement of contributors to BSD/Apache
  23       License Version 2.0. This makes Subunit compatible with more testing
  24       frameworks.
  25
  26   IMPROVEMENTS:
  27
  28     * CPPUnit is now directly supported: subunit builds a cppunit listener
  29       ``libcppunit-subunit``.
  30
  31     * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
  32       from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
  33       serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
  34       The ``ProtocolTestCase`` parser now calls outcomes using an extended
  35       API that permits attaching arbitrary MIME resources such as text files
  36       log entries and so on. This extended API is being developed with the
  37       Python testing community, and is in flux. ``TestResult`` objects that
  38       do not support the API will be detected and transparently downgraded
  39       back to the regular Python unittest API.
  40
  41     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
  42       viarable when installing.
  43
  44     * Multipart test outcomes are tentatively supported; the exact protocol
  45       for them, both serialiser and object is not yet finalised. Testers and
  46       early adopters are sought. As part of this and also in an attempt to
  47       provider a more precise focus on the wire protocol and toolchain,
  48       Subunit now depends on testtools (http://launchpad.net/testtools)
  49       release 0.9.0 or newer.
  50
  51     * subunit2junitxml supports a new option, --forward which causes it
  52       to forward the raw subunit stream in a similar manner to tee. This
  53       is used with the -o option to both write a xml report and get some
  54       other subunit filter to process the stream.
  55
  56     * The C library now has ``subunit_test_skip``.
  57
  58   BUG FIXES:
  59
  60     * Install progress_model.py correctly.
  61
  62     * Non-gcc builds will no longer try to use gcc specific flags.
  63       (Thanks trondn-norbye)
  64
  65   API CHANGES:
  66
  67   INTERNALS:
  68
  69 0.0.2
  70 -----
  71
  72   CHANGES:
  73
  74   IMPROVEMENTS:
  75
  76     * A number of filters now support ``--no-passthrough`` to cause all
  77       non-subunit content to be discarded. This is useful when precise control
  78       over what is output is required - such as with subunit2junitxml.
  79
  80     * A small perl parser is now included, and a new ``subunit-diff`` tool
  81       using that is included. (Jelmer Vernooij)
  82
  83     * Subunit streams can now include optional, incremental lookahead
  84       information about progress. This allows reporters to make estimates
  85       about completion, when such information is available. See the README
  86       under ``progress`` for more details.
  87
  88     * ``subunit-filter`` now supports regex filtering via ``--with`` and
  89       ``without`` options. (Martin Pool)
  90
  91     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
  92       test stream.
  93
  94     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
  95       test reporter to be used, which has a textual progress bar. This requires
  96       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
  97
  98     * ``subunit2junitxml`` has been added. This filter converts a subunit
  99       stream to a single JUnit style XML stream using the pyjunitxml
 100       python library.
 101
 102     * The shell functions support skipping via ``subunit_skip_test`` now.
 103
 104   BUG FIXES:
 105
 106     * ``xfail`` outcomes are now passed to python TestResult's via
 107       addExpectedFailure if it is present on the TestResult. Python 2.6 and
 108       earlier which do not have this function will have ``xfail`` outcomes
 109       passed through as success outcomes as earlier versions of subunit did.
 110
 111   API CHANGES:
 112
 113     * tags are no longer passed around in python via the ``TestCase.tags``
 114       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
 115       and like in the protocol, if called while a test is active only applies
 116       to that test. (Robert Collins)
 117
 118     * ``TestResultFilter`` takes a new optional constructor parameter
 119       ``filter_predicate``.  (Martin Pool)
 120
 121     * When a progress: directive is encountered in a subunit stream, the
 122       python bindings now call the ``progress(offset, whence)`` method on
 123       ``TestResult``.
 124
 125     * When a time: directive is encountered in a subunit stream, the python
 126       bindings now call the ``time(seconds)`` method on ``TestResult``.
 127
 128   INTERNALS:
 129
 130     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
 131       users of subunit will want to wrap their ``TestProtocolClient`` objects
 132       in this decorator to get test timing data for performance analysis.
 133
 134     * (python) ExecTestCase supports passing arguments to test scripts.
 135
 136     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
 137       which can be used to call some code on every event, without having to
 138       implement all the event methods.
 139
 140     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
 141       causes a timestamp to be output to the stream.