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 * Python 3.1 and 3.2 have an inconsistent memoryview implementation which
  12   required a workaround for NUL byte detection. (Robert Collins, #1216246)
  13
  14 * V2 parser errors now set appropriate mime types for the encapsulated packet
  15   data and the error message. (Robert Collins)
  16
  17 IMPROVEMENTS
  18 ~~~~~~~~~~~~
  19
  20 * Most filters will now accept a file path argument instead of only reading
  21   from stdin. (Robert Collins, #409206)
  22
  23 * Add ``subunit-output`` tool that can generate a Subunit v2 bytestream from
  24   arguments passed on the command line. (Thomi Richards, #1252084)
  25
  26 0.0.15
  27 ------
  28
  29 BUG FIXES
  30 ~~~~~~~~~
  31
  32 * Clients of subunit did not expect memoryview objects in StreamResult events.
  33   (Robert Collins)
  34
  35 * Memoryview and struct were mutually incompatible in 2.7.3 and 3.2.
  36   (Robert Collins, #1216163)
  37
  38 0.0.14
  39 ------
  40
  41 BUG FIXES
  42 ~~~~~~~~~
  43
  44 * Memoryview detection was broken and thus it's use was never really tested.
  45   (Robert Collins, 1216101)
  46
  47 * TestProtocol2's tag tests were set sort order dependent.
  48   (Robert Collins, #1025392)
  49
  50 * TestTestProtocols' test_tags_both was set sort order dependent.
  51   (Robert Collins, #1025392)
  52
  53 * TestTestProtocols' test_*_details were dictionary sort order dependent.
  54   (Robert Collins, #1025392)
  55
  56 * TestSubUnitTags's test_add_tag was also se sort order dependent.
  57   (Robert Collins, #1025392)
  58
  59 0.0.13
  60 ------
  61
  62 IMPROVEMENTS
  63 ~~~~~~~~~~~~
  64
  65 * subunit should now build with automake 1.11 again. (Robert Collins)
  66
  67 * `subunit-stats` no longer outputs encapsulated stdout as subunit.
  68   (Robert Collins, #1171987)
  69
  70 * The logic for `subunit.run` is now importable via python -
  71   `subunit.run.main`. (Robert Collins, #606770)
  72
  73 BUG FIXES
  74 ~~~~~~~~~
  75
  76 * Removed GPL files that were (C) non Subunit Developers - they are
  77   incompatible for binary distribution, which affects redistributors.
  78   (Robert Collins, #1185591)
  79
  80 0.0.12
  81 ------
  82
  83 BUG FIXES
  84 ~~~~~~~~~
  85
  86 * Subunit v2 packets with both file content and route code were not being
  87   parsed correctly - they would incorrectly emit a parser error, due to trying
  88   to parse the route code length from the first byes of the file content.
  89   (Robert Collins, 1172815)
  90
  91 0.0.11
  92 ------
  93
  94 v2 protocol draft included in this release. The v2 protocol trades off human
  95 readability for a massive improvement in robustness, the ability to represent
  96 concurrent tests in a single stream, cheaper parsing, and that provides
  97 significantly better in-line debugging support and structured forwarding
  98 of non-test data (such as stdout or stdin data).
  99
 100 This change includes two new filters (subunit-1to2 and subunit-2to1). Use
 101 these filters to convert old streams to v2 and convert v2 streams to v1.
 102
 103 All the other filters now only parse and emit v2 streams. V2 is still in
 104 draft format, so if you want to delay and wait for v2 to be finalised, you
 105 should use subunit-2to1 before any serialisation steps take place.
 106 With the ability to encapsulate multiple non-test streams, another significant
 107 cange is that filters which emit subunit now encapsulate any non-subunit they
 108 encounter, labelling it 'stdout'. This permits multiplexing such streams and
 109 detangling the stdout streams from each input.
 110
 111 The subunit libraries (Python etc) have not changed their behaviour: they
 112 still emit v1 from their existing API calls. New API's are being added
 113 and applications should migrate once their language has those API's available.
 114
 115 IMPROVEMENTS
 116 ~~~~~~~~~~~~
 117
 118 * ``subunit.run`` now replaces sys.stdout to ensure that stdout is unbuffered
 119   - without this pdb output is not reliably visible when stdout is a pipe
 120   as it usually is. (Robert Collins)
 121
 122 * v2 protocol draft included in this release. (Python implementation only so
 123   far). (Robert Collins)
 124
 125 * Two new Python classes -- ``StreamResultToBytes`` and
 126   ``ByteStreamToStreamResult`` handle v2 generation and parsing.
 127   (Robert Collins)
 128
 129 0.0.10
 130 ------
 131
 132 BUG FIXES
 133 ~~~~~~~~~
 134
 135 * make_stream_binary is now public for reuse. (Robert Collins)
 136
 137 * NAME was not defined in the protocol BNF. (Robert Collins)
 138
 139 * UnsupportedOperation is available in the Python2.6 io library, so ask
 140   forgiveness rather than permission for obtaining it. (Robert Collins)
 141
 142 * Streams with no fileno() attribute are now supported, but they are not
 143   checked for being in binary mode: be sure to take care of that if using
 144   the library yourself. (Robert Collins)
 145
 146 0.0.9
 147 -----
 148
 149 BUG FIXES
 150 ~~~~~~~~~
 151
 152 * All the source files are now included in the distribution tarball.
 153   (Arfrever Frehtes Taifersar Arahesis, Robert Collins, #996275)
 154
 155 * ``python/subunit/tests/test_run.py`` and ``python/subunit/filters.py`` were
 156   not included in the 0.0.8 tarball. (Robert Collins)
 157
 158 * Test ids which include non-ascii unicode characters are now supported.
 159   (Robert Collins, #1029866)
 160
 161 * The ``failfast`` option to ``subunit.run`` will now work. The dependency on
 162   testtools has been raised to 0.9.23 to permit this.
 163   (Robert Collins, #1090582)
 164
 165 0.0.8
 166 -----
 167
 168 IMPROVEMENTS
 169 ~~~~~~~~~~~~
 170
 171 * Perl module now correctly outputs "failure" instead of "fail".  (Stewart Smith)
 172
 173 * Shell functions now output timestamps. (Stewart Smith, Robert Collins)
 174
 175 * 'subunit2csv' script that converts subunit output to CSV format.
 176   (Jonathan Lange)
 177
 178 * ``TagCollapsingDecorator`` now correctly distinguishes between local and
 179   global tags.  (Jonathan Lange)
 180
 181 * ``TestResultFilter`` always forwards ``time:`` events.
 182   (Benji York, Brad Crittenden)
 183
 184 BUG FIXES
 185 ~~~~~~~~~
 186
 187 * Add 'subunit --no-xfail', which will omit expected failures from the subunit
 188   stream. (John Arbash Meinel, #623642)
 189
 190 * Add 'subunit -F/--only-genuine-failures' which sets all of '--no-skips',
 191   '--no-xfail', '--no-passthrough, '--no-success', and gives you just the
 192   failure stream. (John Arbash Meinel)
 193
 194 * Python2.6 support was broken by the fixup feature.
 195   (Arfrever Frehtes Taifersar Arahesis, #987490)
 196
 197 * Python3 support regressed in trunk.
 198   (Arfrever Frehtes Taifersar Arahesis, #987514)
 199
 200 * Python3 support was insufficiently robust in detecting unicode streams.
 201   (Robert Collins, Arfrever Frehtes Taifersar Arahesis)
 202
 203 * Tag support has been implemented for TestProtocolClient.
 204   (Robert Collins, #518016)
 205
 206 * Tags can now be filtered. (Jonathan Lange, #664171)
 207
 208 * Test suite works with latest testtools (but not older ones - formatting
 209   changes only). (Robert Collins)
 210
 211 0.0.7
 212 -----
 213
 214 The Subunit Python test runner ``python -m subunit.run`` can now report the
 215 test ids and also filter via a test id list file thanks to improvements in
 216 ``testtools.run``. See the testtools manual, or testrepository - a major
 217 user of such functionality.
 218
 219 Additionally the protocol now has a keyword uxsuccess for Unexpected Success
 220 reporting. Older parsers will report tests with this status code as 'lost
 221 connection'.
 222
 223 IMPROVEMENTS
 224 ~~~~~~~~~~~~
 225
 226 * Add ``TimeCollapsingDecorator`` which collapses multiple sequential time()
 227   calls into just the first and last. (Jonathan Lange)
 228
 229 * Add ``TagCollapsingDecorator`` which collapses many tags() calls into one
 230   where possible. (Jonathan Lange, Robert Collins)
 231
 232 * Force flush of writes to stdout in c/tests/test_child.
 233   (Jelmer Vernooij, #687611)
 234
 235 * Provisional Python 3.x support.
 236   (Robert Collins, Tres Seaver, Martin[gz], #666819)
 237
 238 * ``subunit.chunked.Decoder`` Python class takes a new ``strict`` option,
 239   which defaults to ``True``. When ``False``, the ``Decoder`` will accept
 240   incorrect input that is still unambiguous. i.e. subunit will not barf if
 241   a \r is missing from the input. (Martin Pool)
 242
 243 * ``subunit-filter`` preserves the relative ordering of ``time:`` statements,
 244   so you can now use filtered streams to gather data about how long it takes
 245   to run a test. (Jonathan Lange, #716554)
 246
 247 * ``subunit-ls`` now handles a stream with time: instructions that start
 248   partway through the stream (which may lead to strange times) more gracefully.
 249   (Robert Collins, #785954)
 250
 251 * ``subunit-ls`` should handle the new test outcomes in Python2.7 better.
 252   (Robert Collins, #785953)
 253
 254 * ``TestResultFilter`` now collapses sequential calls to time().
 255   (Jonathan Lange, #567150)
 256
 257 * ``TestResultDecorator.tags()`` now actually works, and is no longer a buggy
 258   copy/paste of ``TestResultDecorator.time()``. (Jonathan Lange, #681828)
 259
 260 * ``TestResultFilter`` now supports a ``fixup_expected_failures``
 261   argument. (Jelmer Vernooij, #755241)
 262
 263 * The ``subunit.run`` Python module supports ``-l`` and ``--load-list`` as
 264   per ``testtools.run``. This required a dependency bump due to a small
 265   API change in ``testtools``. (Robert Collins)
 266
 267 * The help for subunit-filter was confusing about the behaviour of ``-f`` /
 268   ``--no-failure``. (Robert Collins, #703392)
 269
 270 * The Python2.7 / testtools addUnexpectedSuccess API is now supported. This
 271   required adding a new status code to the protocol. (Robert Collins, #654474)
 272
 273 CHANGES
 274 ~~~~~~~
 275
 276 * testtools 0.9.11 or newer is new needed (due to the Python 3 support).
 277   (Robert Collins)
 278
 279 0.0.6
 280 -----
 281
 282 This release of subunit fixes a number of unicode related bugs. This depends on
 283 testtools 0.9.4 and will not function without it. Thanks to Tres Seaver there
 284 is also an optional native setup.py file for use with easy_install and the
 285 like.
 286
 287 BUG FIXES
 288 ~~~~~~~~~
 289
 290 * Be consistent about delivering unicode content to testtools StringException
 291   class which has become (appropriately) conservative. (Robert Collins)
 292
 293 * Fix incorrect reference to subunit_test_failf in c/README.
 294   (Brad Hards, #524341)
 295
 296 * Fix incorrect ordering of tags method parameters in TestResultDecorator. This
 297   is purely cosmetic as the parameters are passed down with no interpretation.
 298   (Robert Collins, #537611)
 299
 300 * Old style tracebacks with no encoding info are now treated as UTF8 rather
 301   than some-random-codec-like-ascii. (Robert Collins)
 302
 303 * On windows, ProtocolTestCase and TestProtocolClient will set their streams to
 304   binary mode by calling into msvcrt; this avoids having their input or output
 305   mangled by the default line ending translation on that platform.
 306   (Robert Collins, Martin [gz], #579296)
 307
 308 IMPROVEMENTS
 309 ~~~~~~~~~~~~
 310
 311 * Subunit now has a setup.py for python deployments that are not using
 312   distribution packages. (Tres Seaver, #538181)
 313
 314 * Subunit now supports test discovery by building on the testtools support for
 315   it. You can take advantage of it with "python -m subunit.run discover [path]"
 316   and see "python -m subunit.run discover --help" for more options.
 317
 318 * Subunit now uses the improved unicode support in testtools when outputting
 319   non-details based test information; this should consistently UTF8 encode such
 320   strings.
 321
 322 * The Python TestProtocolClient now flushes output on startTest and stopTest.
 323   (Martin [gz]).
 324
 325
 326 0.0.5
 327 -----
 328
 329 BUG FIXES
 330 ~~~~~~~~~
 331
 332 * make check was failing if subunit wasn't installed due to a missing include
 333   path for the test program test_child.
 334
 335 * make distcheck was failing due to a missing $(top_srcdir) rune.
 336
 337 IMPROVEMENTS
 338 ~~~~~~~~~~~~
 339
 340 * New filter `subunit-notify` that will show a notification window with test
 341   statistics when the test run finishes.
 342
 343 * subunit.run will now pipe its output to the command in the
 344   SUBUNIT_FORMATTER environment variable, if set.
 345
 346 0.0.4
 347 -----
 348
 349 BUG FIXES
 350 ~~~~~~~~~
 351
 352 * subunit2junitxml -f required a value, this is now fixed and -f acts as a
 353   boolean switch with no parameter.
 354
 355 * Building with autoconf 2.65 is now supported.
 356
 357
 358 0.0.3
 359 -----
 360
 361   CHANGES:
 362
 363     * License change, by unanimous agreement of contributors to BSD/Apache
 364       License Version 2.0. This makes Subunit compatible with more testing
 365       frameworks.
 366
 367   IMPROVEMENTS:
 368
 369     * CPPUnit is now directly supported: subunit builds a cppunit listener
 370       ``libcppunit-subunit``.
 371
 372     * In the python API ``addExpectedFailure`` and ``addUnexpectedSuccess``
 373       from python 2.7/3.1 are now supported. ``addExpectedFailure`` is
 374       serialised as ``xfail``, and ``addUnexpectedSuccess`` as ``success``.
 375       The ``ProtocolTestCase`` parser now calls outcomes using an extended
 376       API that permits attaching arbitrary MIME resources such as text files
 377       log entries and so on. This extended API is being developed with the
 378       Python testing community, and is in flux. ``TestResult`` objects that
 379       do not support the API will be detected and transparently downgraded
 380       back to the regular Python unittest API.
 381
 382     * INSTALLDIRS can be set to control the perl MakeMaker 'INSTALLDIRS'
 383       viarable when installing.
 384
 385     * Multipart test outcomes are tentatively supported; the exact protocol
 386       for them, both serialiser and object is not yet finalised. Testers and
 387       early adopters are sought. As part of this and also in an attempt to
 388       provider a more precise focus on the wire protocol and toolchain,
 389       Subunit now depends on testtools (http://launchpad.net/testtools)
 390       release 0.9.0 or newer.
 391
 392     * subunit2junitxml supports a new option, --forward which causes it
 393       to forward the raw subunit stream in a similar manner to tee. This
 394       is used with the -o option to both write a xml report and get some
 395       other subunit filter to process the stream.
 396
 397     * The C library now has ``subunit_test_skip``.
 398
 399   BUG FIXES:
 400
 401     * Install progress_model.py correctly.
 402
 403     * Non-gcc builds will no longer try to use gcc specific flags.
 404       (Thanks trondn-norbye)
 405
 406   API CHANGES:
 407
 408   INTERNALS:
 409
 410 0.0.2
 411 -----
 412
 413   CHANGES:
 414
 415   IMPROVEMENTS:
 416
 417     * A number of filters now support ``--no-passthrough`` to cause all
 418       non-subunit content to be discarded. This is useful when precise control
 419       over what is output is required - such as with subunit2junitxml.
 420
 421     * A small perl parser is now included, and a new ``subunit-diff`` tool
 422       using that is included. (Jelmer Vernooij)
 423
 424     * Subunit streams can now include optional, incremental lookahead
 425       information about progress. This allows reporters to make estimates
 426       about completion, when such information is available. See the README
 427       under ``progress`` for more details.
 428
 429     * ``subunit-filter`` now supports regex filtering via ``--with`` and
 430       ``without`` options. (Martin Pool)
 431
 432     * ``subunit2gtk`` has been added, a filter that shows a GTK summary of a
 433       test stream.
 434
 435     * ``subunit2pyunit`` has a --progress flag which will cause the bzrlib
 436       test reporter to be used, which has a textual progress bar. This requires
 437       a recent bzrlib as a minor bugfix was required in bzrlib to support this.
 438
 439     * ``subunit2junitxml`` has been added. This filter converts a subunit
 440       stream to a single JUnit style XML stream using the pyjunitxml
 441       python library.
 442
 443     * The shell functions support skipping via ``subunit_skip_test`` now.
 444
 445   BUG FIXES:
 446
 447     * ``xfail`` outcomes are now passed to python TestResult's via
 448       addExpectedFailure if it is present on the TestResult. Python 2.6 and
 449       earlier which do not have this function will have ``xfail`` outcomes
 450       passed through as success outcomes as earlier versions of subunit did.
 451
 452   API CHANGES:
 453
 454     * tags are no longer passed around in python via the ``TestCase.tags``
 455       attribute. Instead ``TestResult.tags(new_tags, gone_tags)`` is called,
 456       and like in the protocol, if called while a test is active only applies
 457       to that test. (Robert Collins)
 458
 459     * ``TestResultFilter`` takes a new optional constructor parameter
 460       ``filter_predicate``.  (Martin Pool)
 461
 462     * When a progress: directive is encountered in a subunit stream, the
 463       python bindings now call the ``progress(offset, whence)`` method on
 464       ``TestResult``.
 465
 466     * When a time: directive is encountered in a subunit stream, the python
 467       bindings now call the ``time(seconds)`` method on ``TestResult``.
 468
 469   INTERNALS:
 470
 471     * (python) Added ``subunit.test_results.AutoTimingTestResultDecorator``. Most
 472       users of subunit will want to wrap their ``TestProtocolClient`` objects
 473       in this decorator to get test timing data for performance analysis.
 474
 475     * (python) ExecTestCase supports passing arguments to test scripts.
 476
 477     * (python) New helper ``subunit.test_results.HookedTestResultDecorator``
 478       which can be used to call some code on every event, without having to
 479       implement all the event methods.
 480
 481     * (python) ``TestProtocolClient.time(a_datetime)`` has been added which
 482       causes a timestamp to be output to the stream.