4 Changes and improvements to testtools_, grouped by release.
13 Long overdue, we've adopted a backwards compatibility statement and recognized
14 that we have plenty of users depending on our behaviour - calling our version
15 1.0.0 is a recognition of that.
20 * Fix a long-standing bug where tearDown and cleanUps would not be called if the
21 test run was interrupted. This should fix leaking external resources from
23 (Robert Collins, #1364188)
25 * Fix a long-standing bug where calling sys.exit(0) from within a test would
26 cause the test suite to exit with 0, without reporting a failure of that
27 test. We still allow the test suite to be exited (since catching higher order
28 exceptions requires exceptional circumstances) but we now call a last-resort
29 handler on the TestCase, resulting in an error being reported for the test.
30 (Robert Collins, #1364188)
32 * Fix an issue where tests skipped with the ``skip``* family of decorators would
33 still have their ``setUp`` and ``tearDown`` functions called.
34 (Thomi Richards, #https://github.com/testing-cabal/testtools/issues/86)
36 * We have adopted a formal backwards compatibility statement (see hacking.rst)
42 Brown paper bag release - 0.9.38 was broken for some users,
43 _jython_aware_splitext was not defined entirely compatibly.
44 (Robert Collins, #https://github.com/testing-cabal/testtools/issues/100)
49 Bug fixes for test importing.
54 * Discovery import error detection wasn't implemented for python 2.6 (the
55 'discover' module). (Robert Collins)
57 * Discovery now executes load_tests (if present) in __init__ in all packages.
58 (Robert Collins, http://bugs.python.org/issue16662)
63 Minor improvements to correctness.
68 * ``stdout`` is now correctly honoured on ``run.TestProgram`` - before the
69 runner objects would be created with no stdout parameter. If construction
70 fails, the previous parameter list is attempted, permitting compatibility
71 with Runner classes that don't accept stdout as a parameter.
74 * The ``ExtendedToStreamDecorator`` now handles content objects with one less
75 packet - the last packet of the source content is sent with EOF set rather
76 than an empty packet with EOF set being sent after the last packet of the
77 source content. (Robert Collins)
82 Welcome to our long overdue 0.9.36 release, which improves compatibility with
83 Python3.4, adds assert_that, a function for using matchers without TestCase
84 objects, and finally will error if you try to use setUp or tearDown twice -
85 since that invariably leads to bad things of one sort or another happening.
90 * Error if ``setUp`` or ``tearDown`` are called twice.
91 (Robert Collins, #882884)
93 * Make testtools compatible with the ``unittest.expectedFailure`` decorator in
94 Python 3.4. (Thomi Richards)
100 * Introduce the assert_that function, which allows matchers to be used
101 independent of testtools.TestCase. (Daniel Watkins, #1243834)
110 * Removed a number of code paths where Python 2.4 and Python 2.5 were
111 explicitly handled. (Daniel Watkins)
116 * Added the ``testtools.TestCase.expectThat`` method, which implements
117 delayed assertions. (Thomi Richards)
119 * Docs are now built as part of the Travis-CI build, reducing the chance of
120 Read The Docs being broken accidentally. (Daniel Watkins, #1158773)
128 * Added ability for ``testtools.TestCase`` instances to force a test to
129 fail, even if no assertions failed. (Thomi Richards)
131 * Added ``testtools.content.StacktraceContent``, a content object that
132 automatically creates a ``StackLinesContent`` object containing the current
133 stack trace. (Thomi Richards)
135 * ``AnyMatch`` is now exported properly in ``testtools.matchers``.
136 (Robert Collins, Rob Kennedy, github #44)
138 * In Python 3.3, if there are duplicate test ids, tests.sort() will
139 fail and raise TypeError. Detect the duplicate test ids firstly in
140 sorted_tests() to ensure that all test ids are unique.
143 * ``json_content`` is now in the ``__all__`` attribute for
144 ``testtools.content``. (Robert Collins)
146 * Network tests now bind to 127.0.0.1 to avoid (even temporary) network
147 visible ports. (Benedikt Morbach, github #46)
149 * Test listing now explicitly indicates by printing 'Failed to import' and
150 exiting (2) when an import has failed rather than only signalling through the
151 test name. (Robert Collins, #1245672)
153 * ``test_compat.TestDetectEncoding.test_bom`` now works on Python 3.3 - the
154 corner case with euc_jp is no longer permitted in Python 3.3 so we can
155 skip it. (Martin [gz], #1251962)
163 * Added ``addDetailuniqueName`` method to ``testtools.TestCase`` class.
166 * Removed some unused code from ``testtools.content.TracebackContent``.
169 * Added ``testtools.StackLinesContent``: a content object for displaying
170 pre-processed stack lines. (Thomi Richards)
172 * ``StreamSummary`` was calculating testsRun incorrectly: ``exists`` status
173 tests were counted as run tests, but they are not.
174 (Robert Collins, #1203728)
179 Regular maintenance release. Special thanks to new contributor, Xiao Hanyu!
184 * ``testttols.compat._format_exc_info`` has been refactored into several
185 smaller functions. (Thomi Richards)
190 * Stacktrace filtering no longer hides unittest frames that are surrounded by
191 user frames. We will reenable this when we figure out a better algorithm for
192 retaining meaning. (Robert Collins, #1188420)
194 * The compatibility code for skipped tests with unittest2 was broken.
195 (Robert Collins, #1190951)
197 * Various documentation improvements (Clint Byrum, Xiao Hanyu).
205 * ``ExpectedException`` now accepts a msg parameter for describing an error,
206 much the same as assertEquals etc. (Robert Collins)
211 A new sort of TestResult, the StreamResult has been added, as a prototype for
212 a revised standard library test result API. Expect this API to change.
213 Although we will try to preserve compatibility for early adopters, it is
214 experimental and we might need to break it if it turns out to be unsuitable.
218 * ``assertRaises`` works properly for exception classes that have custom
221 * ``ConcurrentTestSuite`` was silently eating exceptions that propagate from
222 the test.run(result) method call. Ignoring them is fine in a normal test
223 runner, but when they happen in a different thread, the thread that called
224 suite.run() is not in the stack anymore, and the exceptions are lost. We now
225 create a synthetic test recording any such exception.
226 (Robert Collins, #1130429)
228 * Fixed SyntaxError raised in ``_compat2x.py`` when installing via Python 3.
231 * New class ``StreamResult`` which defines the API for the new result type.
234 * New support class ``ConcurrentStreamTestSuite`` for convenient construction
235 and utilisation of ``StreamToQueue`` objects. (Robert Collins)
237 * New support class ``CopyStreamResult`` which forwards events onto multiple
238 ``StreamResult`` objects (each of which receives all the events).
241 * New support class ``StreamSummary`` which summarises a ``StreamResult``
242 stream compatibly with ``TestResult`` code. (Robert Collins)
244 * New support class ``StreamTagger`` which adds or removes tags from
245 ``StreamResult`` events. (RobertCollins)
247 * New support class ``StreamToDict`` which converts a ``StreamResult`` to a
248 series of dicts describing a test. Useful for writing trivial stream
249 analysers. (Robert Collins)
251 * New support class ``TestControl`` which permits cancelling an in-progress
252 run. (Robert Collins)
254 * New support class ``StreamFailFast`` which calls a ``TestControl`` instance
255 to abort the test run when a failure is detected. (Robert Collins)
257 * New support class ``ExtendedToStreamDecorator`` which translates both regular
258 unittest TestResult API calls and the ExtendedTestResult API which testtools
259 has supported into the StreamResult API. ExtendedToStreamDecorator also
260 forwards calls made in the StreamResult API, permitting it to be used
261 anywhere a StreamResult is used. Key TestResult query methods like
262 wasSuccessful and shouldStop are synchronised with the StreamResult API
263 calls, but the detailed statistics like the list of errors are not - a
264 separate consumer will be created to support that.
267 * New support class ``StreamToExtendedDecorator`` which translates
268 ``StreamResult`` API calls into ``ExtendedTestResult`` (or any older
269 ``TestResult``) calls. This permits using un-migrated result objects with
270 new runners / tests. (Robert Collins)
272 * New support class ``StreamToQueue`` for sending messages to one
273 ``StreamResult`` from multiple threads. (Robert Collins)
275 * New support class ``TimestampingStreamResult`` which adds a timestamp to
276 events with no timestamp. (Robert Collins)
278 * New ``TestCase`` decorator ``DecorateTestCaseResult`` that adapts the
279 ``TestResult`` or ``StreamResult`` a case will be run with, for ensuring that
280 a particular result object is used even if the runner running the test doesn't
281 know to use it. (Robert Collins)
283 * New test support class ``testtools.testresult.doubles.StreamResult``, which
284 captures all the StreamResult events. (Robert Collins)
286 * ``PlaceHolder`` can now hold tags, and applies them before, and removes them
287 after, the test. (Robert Collins)
289 * ``PlaceHolder`` can now hold timestamps, and applies them before the test and
290 then before the outcome. (Robert Collins)
292 * ``StreamResultRouter`` added. This is useful for demultiplexing - e.g. for
293 partitioning analysis of events or sending feedback encapsulated in
294 StreamResult events back to their source. (Robert Collins)
296 * ``testtools.run.TestProgram`` now supports the ``TestRunner`` taking over
297 responsibility for formatting the output of ``--list-tests``.
300 * The error message for setUp and tearDown upcall errors was broken on Python
301 3.4. (Monty Taylor, Robert Collins, #1140688)
303 * The repr of object() on pypy includes the object id, which was breaking a
304 test that accidentally depended on the CPython repr for object().
310 A simple bug fix, and better error messages when you don't up-call.
315 * ``testtools.content_type.ContentType`` incorrectly used ',' rather than ';'
316 to separate parameters. (Robert Collins)
321 * ``testtools.compat.unicode_output_stream`` was wrapping a stream encoder
322 around ``io.StringIO`` and ``io.TextIOWrapper`` objects, which was incorrect.
325 * Report the name of the source file for setUp and tearDown upcall errors.
331 Testtools has moved VCS - https://github.com/testing-cabal/testtools/ is
332 the new home. Bug tracking is still on Launchpad, and releases are on Pypi.
334 We made this change to take advantage of the richer ecosystem of tools around
335 Git, and to lower the barrier for new contributors.
340 * New ``testtools.testcase.attr`` and ``testtools.testcase.WithAttributes``
341 helpers allow marking up test case methods with simple labels. This permits
342 filtering tests with more granularity than organising them into modules and
343 test classes. (Robert Collins)
351 * New matcher ``HasLength`` for matching the length of a collection.
354 * New matcher ``MatchesPredicateWithParams`` make it still easier to create
355 ad hoc matchers. (Robert Collins)
357 * We have a simpler release process in future - see doc/hacking.rst.
363 Brown paper bag fix: failed to document the need for setup to be able to use
364 extras. Compounded by pip not supporting setup_requires.
369 * setup.py now can generate egg_info even if extras is not available.
370 Also lists extras in setup_requires for easy_install.
371 (Robert Collins, #1102464)
379 * ``python -m testtools.run --load-list`` will now preserve any custom suites
380 (such as ``testtools.FixtureSuite`` or ``testresources.OptimisingTestSuite``)
381 rather than flattening them.
382 (Robert Collins, #827175)
384 * Testtools now depends on extras, a small library split out from it to contain
385 generally useful non-testing facilities. Since extras has been around for a
386 couple of testtools releases now, we're making this into a hard dependency of
387 testtools. (Robert Collins)
389 * Testtools now uses setuptools rather than distutils so that we can document
390 the extras dependency. (Robert Collins)
395 * Testtools will no longer override test code registered details called
396 'traceback' when reporting caught exceptions from test code.
397 (Robert Collins, #812793)
405 * ``testtools.run discover`` will now sort the tests it discovered. This is a
406 workaround for http://bugs.python.org/issue16709. Non-standard test suites
407 are preserved, and their ``sort_tests()`` method called (if they have such an
408 attribute). ``testtools.testsuite.sorted_tests(suite, True)`` can be used by
409 such suites to do a local sort. (Robert Collins, #1091512)
411 * ``ThreadsafeForwardingResult`` now defines a stub ``progress`` method, which
412 fixes ``testr run`` of streams containing progress markers (by discarding the
413 progress data). (Robert Collins, #1019165)
421 * ``run.TestToolsTestRunner`` now accepts the verbosity, buffer and failfast
422 arguments the upstream python TestProgram code wants to give it, making it
423 possible to support them in a compatible fashion. (Robert Collins)
428 * ``testtools.run`` now supports the ``-f`` or ``--failfast`` parameter.
429 Previously it was advertised in the help but ignored.
430 (Robert Collins, #1090582)
432 * ``AnyMatch`` added, a new matcher that matches when any item in a collection
433 matches the given matcher. (Jonathan Lange)
435 * Spelling corrections to documentation. (Vincent Ladeuil)
437 * ``TestProgram`` now has a sane default for its ``testRunner`` argument.
440 * The test suite passes on Python 3 again. (Robert Collins)
448 * ``content_from_file`` and ``content_from_stream`` now accept seek_offset and
449 seek_whence parameters allowing them to be used to grab less than the full
450 stream, or to be used with StringIO streams. (Robert Collins, #1088693)
458 * ``DirContains`` correctly exposed, after being accidentally hidden in the
459 great matcher re-organization of 0.9.17. (Jonathan Lange)
465 Three new matchers that'll rock your world.
470 * New, powerful matchers that match items in a dictionary:
472 - ``MatchesDict``, match every key in a dictionary with a key in a
473 dictionary of matchers. For when the set of expected keys is equal to the
474 set of observed keys.
476 - ``ContainsDict``, every key in a dictionary of matchers must be
477 found in a dictionary, and the values for those keys must match. For when
478 the set of expected keys is a subset of the set of observed keys.
480 - ``ContainedByDict``, every key in a dictionary must be found in
481 a dictionary of matchers. For when the set of expected keys is a superset
482 of the set of observed keys.
484 The names are a little confusing, sorry. We're still trying to figure out
485 how to present the concept in the simplest way possible.
491 How embarrassing! Three releases in two days.
493 We've worked out the kinks and have confirmation from our downstreams that
494 this is all good. Should be the last release for a little while. Please
495 ignore 0.9.18 and 0.9.17.
500 * Include the matcher tests in the release, allowing the tests to run and
501 pass from the release tarball. (Jonathan Lange)
503 * Fix cosmetic test failures in Python 3.3, introduced during release 0.9.17.
510 Due to an oversight, release 0.9.18 did not contain the new
511 ``testtools.matchers`` package and was thus completely broken. This release
512 corrects that, returning us all to normality.
517 This release brings better discover support and Python3.x improvements. There
518 are still some test failures on Python3.3 but they are cosmetic - the library
519 is as usable there as on any other Python 3 release.
524 * The ``testtools.matchers`` package has been split up. No change to the
525 public interface. (Jonathan Lange)
530 * ``python -m testtools.run discover . --list`` now works. (Robert Collins)
532 * Correctly handling of bytes vs text in JSON content type. (Martin [gz])
538 Some new matchers and a new content helper for JSON content.
540 This is the first release of testtools to drop support for Python 2.4 and 2.5.
541 If you need support for either of those versions, please use testtools 0.9.15.
546 * New content helper, ``json_content`` (Jonathan Lange)
550 * ``ContainsAll`` for asserting one thing is a subset of another
553 * ``SameMembers`` for asserting two iterators have the same members.
556 * Reraising of exceptions in Python 3 is more reliable. (Martin [gz])
562 This is the last release to support Python2.4 and 2.5. It brings in a slew of
563 improvements to test tagging and concurrency, making running large test suites
564 with partitioned workers more reliable and easier to reproduce exact test
565 ordering in a given worker. See our sister project ``testrepository`` for a
566 test runner that uses these features.
571 * ``PlaceHolder`` and ``ErrorHolder`` now support being given result details.
574 * ``ErrorHolder`` is now just a function - all the logic is in ``PlaceHolder``.
577 * ``TestResult`` and all other ``TestResult``-like objects in testtools
578 distinguish between global tags and test-local tags, as per the subunit
579 specification. (Jonathan Lange)
581 * This is the **last** release of testtools that supports Python 2.4 or 2.5.
582 These releases are no longer supported by the Python community and do not
583 receive security updates. If this affects you, you will need to either
584 stay on this release or perform your own backports.
585 (Jonathan Lange, Robert Collins)
587 * ``ThreadsafeForwardingResult`` now forwards global tags as test-local tags,
588 making reasoning about the correctness of the multiplexed stream simpler.
589 This preserves the semantic value (what tags apply to a given test) while
590 consuming less stream size (as no negative-tag statement is needed).
591 (Robert Collins, Gary Poster, #986434)
596 * API documentation corrections. (Raphaël Badin)
598 * ``ConcurrentTestSuite`` now takes an optional ``wrap_result`` parameter
599 that can be used to wrap the ``ThreadsafeForwardingResults`` created by
600 the suite. (Jonathan Lange)
602 * ``Tagger`` added. It's a new ``TestResult`` that tags all tests sent to
603 it with a particular set of tags. (Jonathan Lange)
605 * ``testresultdecorator`` brought over from subunit. (Jonathan Lange)
607 * All ``TestResult`` wrappers now correctly forward ``current_tags`` from
608 their wrapped results, meaning that ``current_tags`` can always be relied
609 upon to return the currently active tags on a test result.
611 * ``TestByTestResult``, a ``TestResult`` that calls a method once per test,
612 added. (Jonathan Lange)
614 * ``ThreadsafeForwardingResult`` correctly forwards ``tags()`` calls where
615 only one of ``new_tags`` or ``gone_tags`` are specified.
616 (Jonathan Lange, #980263)
618 * ``ThreadsafeForwardingResult`` no longer leaks local tags from one test
619 into all future tests run. (Jonathan Lange, #985613)
621 * ``ThreadsafeForwardingResult`` has many, many more tests. (Jonathan Lange)
627 Our sister project, `subunit <https://launchpad.net/subunit>`_, was using a
628 private API that was deleted in the 0.9.13 release. This release restores
629 that API in order to smooth out the upgrade path.
631 If you don't use subunit, then this release won't matter very much to you.
637 Plenty of new matchers and quite a few critical bug fixes (especially to do
638 with stack traces from failed assertions). A net win for all.
643 * ``MatchesAll`` now takes an ``first_only`` keyword argument that changes how
644 mismatches are displayed. If you were previously passing matchers to
645 ``MatchesAll`` with keyword arguments, then this change might affect your
646 test results. (Jonathan Lange)
651 * Actually hide all of the testtools stack for assertion failures. The
652 previous release promised clean stack, but now we actually provide it.
653 (Jonathan Lange, #854769)
655 * ``assertRaises`` now includes the ``repr`` of the callable that failed to raise
656 properly. (Jonathan Lange, #881052)
658 * Asynchronous tests no longer hang when run with trial.
659 (Jonathan Lange, #926189)
661 * ``Content`` objects now have an ``as_text`` method to convert their contents
662 to Unicode text. (Jonathan Lange)
664 * Failed equality assertions now line up. (Jonathan Lange, #879339)
666 * ``FullStackRunTest`` no longer aborts the test run if a test raises an
667 error. (Jonathan Lange)
669 * ``MatchesAll`` and ``MatchesListwise`` both take a ``first_only`` keyword
670 argument. If True, they will report only on the first mismatch they find,
671 and not continue looking for other possible mismatches.
674 * New helper, ``Nullary`` that turns callables with arguments into ones that
675 don't take arguments. (Jonathan Lange)
679 * ``DirContains`` matches the contents of a directory.
680 (Jonathan Lange, James Westby)
682 * ``DirExists`` matches if a directory exists.
683 (Jonathan Lange, James Westby)
685 * ``FileContains`` matches the contents of a file.
686 (Jonathan Lange, James Westby)
688 * ``FileExists`` matches if a file exists.
689 (Jonathan Lange, James Westby)
691 * ``HasPermissions`` matches the permissions of a file. (Jonathan Lange)
693 * ``MatchesPredicate`` matches if a predicate is true. (Jonathan Lange)
695 * ``PathExists`` matches if a path exists. (Jonathan Lange, James Westby)
697 * ``SamePath`` matches if two paths are the same. (Jonathan Lange)
699 * ``TarballContains`` matches the contents of a tarball. (Jonathan Lange)
701 * ``MultiTestResult`` supports the ``tags`` method.
702 (Graham Binns, Francesco Banconi, #914279)
704 * ``ThreadsafeForwardingResult`` supports the ``tags`` method.
705 (Graham Binns, Francesco Banconi, #914279)
707 * ``ThreadsafeForwardingResult`` no longer includes semaphore acquisition time
708 in the test duration (for implicitly timed test runs).
709 (Robert Collins, #914362)
714 This is a very big release. We've made huge improvements on three fronts:
715 1. Test failures are way nicer and easier to read
716 2. Matchers and ``assertThat`` are much more convenient to use
717 3. Correct handling of extended unicode characters
719 We've trimmed off the fat from the stack trace you get when tests fail, we've
720 cut out the bits of error messages that just didn't help, we've made it easier
721 to annotate mismatch failures, to compare complex objects and to match raised
724 Testing code was never this fun.
729 * ``AfterPreproccessing`` renamed to ``AfterPreprocessing``, which is a more
730 correct spelling. Old name preserved for backwards compatibility, but is
731 now deprecated. Please stop using it.
732 (Jonathan Lange, #813460)
734 * ``assertThat`` raises ``MismatchError`` instead of
735 ``TestCase.failureException``. ``MismatchError`` is a subclass of
736 ``AssertionError``, so in most cases this change will not matter. However,
737 if ``self.failureException`` has been set to a non-default value, then
738 mismatches will become test errors rather than test failures.
740 * ``gather_details`` takes two dicts, rather than two detailed objects.
741 (Jonathan Lange, #801027)
743 * ``MatchesRegex`` mismatch now says "<value> does not match /<regex>/" rather
744 than "<regex> did not match <value>". The regular expression contains fewer
745 backslashes too. (Jonathan Lange, #818079)
747 * Tests that run with ``AsynchronousDeferredRunTest`` now have the ``reactor``
748 attribute set to the running reactor. (Jonathan Lange, #720749)
753 * All public matchers are now in ``testtools.matchers.__all__``.
754 (Jonathan Lange, #784859)
756 * ``assertThat`` can actually display mismatches and matchers that contain
757 extended unicode characters. (Jonathan Lange, Martin [gz], #804127)
759 * ``assertThat`` output is much less verbose, displaying only what the mismatch
760 tells us to display. Old-style verbose output can be had by passing
761 ``verbose=True`` to assertThat. (Jonathan Lange, #675323, #593190)
763 * ``assertThat`` accepts a message which will be used to annotate the matcher.
764 This can be given as a third parameter or as a keyword parameter.
767 * Automated the Launchpad part of the release process.
768 (Jonathan Lange, #623486)
770 * Correctly display non-ASCII unicode output on terminals that claim to have a
771 unicode encoding. (Martin [gz], #804122)
773 * ``DocTestMatches`` correctly handles unicode output from examples, rather
774 than raising an error. (Martin [gz], #764170)
776 * ``ErrorHolder`` and ``PlaceHolder`` added to docs. (Jonathan Lange, #816597)
778 * ``ExpectedException`` now matches any exception of the given type by
779 default, and also allows specifying a ``Matcher`` rather than a mere regular
780 expression. (Jonathan Lange, #791889)
782 * ``FixtureSuite`` added, allows test suites to run with a given fixture.
785 * Hide testtools's own stack frames when displaying tracebacks, making it
786 easier for test authors to focus on their errors.
787 (Jonathan Lange, Martin [gz], #788974)
789 * Less boilerplate displayed in test failures and errors.
790 (Jonathan Lange, #660852)
792 * ``MatchesException`` now allows you to match exceptions against any matcher,
793 rather than just regular expressions. (Jonathan Lange, #791889)
795 * ``MatchesException`` now permits a tuple of types rather than a single type
796 (when using the type matching mode). (Robert Collins)
798 * ``MatchesStructure.byEquality`` added to make the common case of matching
799 many attributes by equality much easier. ``MatchesStructure.byMatcher``
800 added in case folk want to match by things other than equality.
803 * New convenience assertions, ``assertIsNone`` and ``assertIsNotNone``.
808 * ``AllMatch`` matches many values against a single matcher.
809 (Jonathan Lange, #615108)
811 * ``Contains``. (Robert Collins)
813 * ``GreaterThan``. (Christian Kampka)
815 * New helper, ``safe_hasattr`` added. (Jonathan Lange)
817 * ``reraise`` added to ``testtools.compat``. (Jonathan Lange)
823 This release brings consistent use of super for better compatibility with
824 multiple inheritance, fixed Python3 support, improvements in fixture and mather
825 outputs and a compat helper for testing libraries that deal with bytestrings.
830 * ``TestCase`` now uses super to call base ``unittest.TestCase`` constructor,
831 ``setUp`` and ``tearDown``. (Tim Cole, #771508)
833 * If, when calling ``useFixture`` an error occurs during fixture set up, we
834 still attempt to gather details from the fixture. (Gavin Panella)
840 * Additional compat helper for ``BytesIO`` for libraries that build on
841 testtools and are working on Python 3 porting. (Robert Collins)
843 * Corrected documentation for ``MatchesStructure`` in the test authors
844 document. (Jonathan Lange)
846 * ``LessThan`` error message now says something that is logically correct.
847 (Gavin Panella, #762008)
849 * Multiple details from a single fixture are now kept separate, rather than
850 being mooshed together. (Gavin Panella, #788182)
852 * Python 3 support now back in action. (Martin [gz], #688729)
854 * ``try_import`` and ``try_imports`` have a callback that is called whenever
855 they fail to import a module. (Martin Pool)
861 The last release of testtools could not be easy_installed. This is considered
862 severe enough for a re-release.
867 * Include ``doc/`` in the source distribution, making testtools installable
868 from PyPI again (Tres Seaver, #757439)
874 Many, many new matchers, vastly expanded documentation, stacks of bug fixes,
875 better unittest2 integration. If you've ever wanted to try out testtools but
876 been afraid to do so, this is the release to try.
882 * The timestamps generated by ``TestResult`` objects when no timing data has
883 been received are now datetime-with-timezone, which allows them to be
884 sensibly serialised and transported. (Robert Collins, #692297)
889 * ``AnnotatedMismatch`` now correctly returns details.
890 (Jonathan Lange, #724691)
892 * distutils integration for the testtools test runner. Can now use it for
893 'python setup.py test'. (Christian Kampka, #693773)
895 * ``EndsWith`` and ``KeysEqual`` now in testtools.matchers.__all__.
896 (Jonathan Lange, #692158)
898 * ``MatchesException`` extended to support a regular expression check against
899 the str() of a raised exception. (Jonathan Lange)
901 * ``MultiTestResult`` now forwards the ``time`` API. (Robert Collins, #692294)
903 * ``MultiTestResult`` now documented in the manual. (Jonathan Lange, #661116)
905 * New content helpers ``content_from_file``, ``content_from_stream`` and
906 ``attach_file`` make it easier to attach file-like objects to a
907 test. (Jonathan Lange, Robert Collins, #694126)
909 * New ``ExpectedException`` context manager to help write tests against things
910 that are expected to raise exceptions. (Aaron Bentley)
914 * ``MatchesListwise`` matches an iterable of matchers against an iterable
915 of values. (Michael Hudson-Doyle)
917 * ``MatchesRegex`` matches a string against a regular expression.
918 (Michael Hudson-Doyle)
920 * ``MatchesStructure`` matches attributes of an object against given
921 matchers. (Michael Hudson-Doyle)
923 * ``AfterPreproccessing`` matches values against a matcher after passing them
924 through a callable. (Michael Hudson-Doyle)
926 * ``MatchesSetwise`` matches an iterable of matchers against an iterable of
927 values, without regard to order. (Michael Hudson-Doyle)
929 * ``setup.py`` can now build a snapshot when Bazaar is installed but the tree
930 is not a Bazaar tree. (Jelmer Vernooij)
932 * Support for running tests using distutils (Christian Kampka, #726539)
934 * Vastly improved and extended documentation. (Jonathan Lange)
936 * Use unittest2 exception classes if available. (Jelmer Vernooij)
942 In this release we bring some very interesting improvements:
944 * new matchers for exceptions, sets, lists, dicts and more.
946 * experimental (works but the contract isn't supported) twisted reactor
949 * The built in runner can now list tests and filter tests (the -l and
950 --load-list options).
955 * addUnexpectedSuccess is translated to addFailure for test results that don't
956 know about addUnexpectedSuccess. Further, it fails the entire result for
957 all testtools TestResults (i.e. wasSuccessful() returns False after
958 addUnexpectedSuccess has been called). Note that when using a delegating
959 result such as ThreadsafeForwardingResult, MultiTestResult or
960 ExtendedToOriginalDecorator then the behaviour of addUnexpectedSuccess is
961 determined by the delegated to result(s).
962 (Jonathan Lange, Robert Collins, #654474, #683332)
964 * startTestRun will reset any errors on the result. That is, wasSuccessful()
965 will always return True immediately after startTestRun() is called. This
966 only applies to delegated test results (ThreadsafeForwardingResult,
967 MultiTestResult and ExtendedToOriginalDecorator) if the delegated to result
968 is a testtools test result - we cannot reliably reset the state of unknown
969 test result class instances. (Jonathan Lange, Robert Collins, #683332)
971 * Responsibility for running test cleanups has been moved to ``RunTest``.
972 This change does not affect public APIs and can be safely ignored by test
973 authors. (Jonathan Lange, #662647)
980 * ``EndsWith`` which complements the existing ``StartsWith`` matcher.
981 (Jonathan Lange, #669165)
983 * ``MatchesException`` matches an exception class and parameters. (Robert
986 * ``KeysEqual`` matches a dictionary with particular keys. (Jonathan Lange)
988 * ``assertIsInstance`` supports a custom error message to be supplied, which
989 is necessary when using ``assertDictEqual`` on Python 2.7 with a
990 ``testtools.TestCase`` base class. (Jelmer Vernooij)
992 * Experimental support for running tests that return Deferreds.
993 (Jonathan Lange, Martin [gz])
995 * Provide a per-test decorator, run_test_with, to specify which RunTest
996 object to use for a given test. (Jonathan Lange, #657780)
998 * Fix the runTest parameter of TestCase to actually work, rather than raising
999 a TypeError. (Jonathan Lange, #657760)
1001 * Non-release snapshots of testtools will now work with buildout.
1002 (Jonathan Lange, #613734)
1004 * Malformed SyntaxErrors no longer blow up the test suite. (Martin [gz])
1006 * ``MismatchesAll.describe`` no longer appends a trailing newline.
1007 (Michael Hudson-Doyle, #686790)
1009 * New helpers for conditionally importing modules, ``try_import`` and
1010 ``try_imports``. (Jonathan Lange)
1012 * ``Raises`` added to the ``testtools.matchers`` module - matches if the
1013 supplied callable raises, and delegates to an optional matcher for validation
1014 of the exception. (Robert Collins)
1016 * ``raises`` added to the ``testtools.matchers`` module - matches if the
1017 supplied callable raises and delegates to ``MatchesException`` to validate
1018 the exception. (Jonathan Lange)
1020 * Tests will now pass on Python 2.6.4 : an ``Exception`` change made only in
1021 2.6.4 and reverted in Python 2.6.5 was causing test failures on that version.
1022 (Martin [gz], #689858).
1024 * ``testtools.TestCase.useFixture`` has been added to glue with fixtures nicely.
1027 * ``testtools.run`` now supports ``-l`` to list tests rather than executing
1028 them. This is useful for integration with external test analysis/processing
1029 tools like subunit and testrepository. (Robert Collins)
1031 * ``testtools.run`` now supports ``--load-list``, which takes a file containing
1032 test ids, one per line, and intersects those ids with the tests found. This
1033 allows fine grained control of what tests are run even when the tests cannot
1034 be named as objects to import (e.g. due to test parameterisation via
1035 testscenarios). (Robert Collins)
1037 * Update documentation to say how to use testtools.run() on Python 2.4.
1038 (Jonathan Lange, #501174)
1040 * ``text_content`` conveniently converts a Python string to a Content object.
1041 (Jonathan Lange, James Westby)
1048 Lots of little cleanups in this release; many small improvements to make your
1049 testing life more pleasant.
1054 * Cleanups can raise ``testtools.MultipleExceptions`` if they have multiple
1055 exceptions to report. For instance, a cleanup which is itself responsible for
1056 running several different internal cleanup routines might use this.
1058 * Code duplication between assertEqual and the matcher Equals has been removed.
1060 * In normal circumstances, a TestCase will no longer share details with clones
1061 of itself. (Andrew Bennetts, bug #637725)
1063 * Less exception object cycles are generated (reduces peak memory use between
1064 garbage collection). (Martin [gz])
1066 * New matchers 'DoesNotStartWith' and 'StartsWith' contributed by Canonical
1067 from the Launchpad project. Written by James Westby.
1069 * Timestamps as produced by subunit protocol clients are now forwarded in the
1070 ThreadsafeForwardingResult so correct test durations can be reported.
1071 (Martin [gz], Robert Collins, #625594)
1073 * With unittest from Python 2.7 skipped tests will now show only the reason
1074 rather than a serialisation of all details. (Martin [gz], #625583)
1076 * The testtools release process is now a little better documented and a little
1077 smoother. (Jonathan Lange, #623483, #623487)
1083 Nothing major in this release, just enough small bits and pieces to make it
1084 useful enough to upgrade to.
1086 In particular, a serious bug in assertThat() has been fixed, it's easier to
1087 write Matchers, there's a TestCase.patch() method for those inevitable monkey
1088 patches and TestCase.assertEqual gives slightly nicer errors.
1093 * 'TestCase.assertEqual' now formats errors a little more nicely, in the
1096 * Added `PlaceHolder` and `ErrorHolder`, TestCase-like objects that can be
1097 used to add results to a `TestResult`.
1099 * 'Mismatch' now takes optional description and details parameters, so
1100 custom Matchers aren't compelled to make their own subclass.
1102 * jml added a built-in UTF8_TEXT ContentType to make it slightly easier to
1103 add details to test results. See bug #520044.
1105 * Fix a bug in our built-in matchers where assertThat would blow up if any
1106 of them failed. All built-in mismatch objects now provide get_details().
1108 * New 'Is' matcher, which lets you assert that a thing is identical to
1111 * New 'LessThan' matcher which lets you assert that a thing is less than
1114 * TestCase now has a 'patch()' method to make it easier to monkey-patching
1115 objects in tests. See the manual for more information. Fixes bug #310770.
1117 * MultiTestResult methods now pass back return values from the results it
1123 This release fixes some obscure traceback formatting issues that probably
1124 weren't affecting you but were certainly breaking our own test suite.
1129 * Jamu Kakar has updated classes in testtools.matchers and testtools.runtest
1130 to be new-style classes, fixing bug #611273.
1135 * Martin[gz] fixed traceback handling to handle cases where extract_tb returns
1136 a source line of None. Fixes bug #611307.
1138 * Martin[gz] fixed an unicode issue that was causing the tests to fail,
1139 closing bug #604187.
1141 * testtools now handles string exceptions (although why would you want to use
1142 them?) and formats their tracebacks correctly. Thanks to Martin[gz] for
1148 This release overhauls the traceback formatting layer to deal with Python 2
1149 line numbers and traceback objects often being local user encoded strings
1150 rather than unicode objects. Test discovery has also been added and Python 3.1
1151 is also supported. Finally, the Mismatch protocol has been extended to let
1152 Matchers collaborate with tests in supplying detailed data about failures.
1157 * testtools.utils has been renamed to testtools.compat. Importing
1158 testtools.utils will now generate a deprecation warning.
1163 * Add machinery for Python 2 to create unicode tracebacks like those used by
1164 Python 3. This means testtools no longer throws on encountering non-ascii
1165 filenames, source lines, or exception strings when displaying test results.
1166 Largely contributed by Martin[gz] with some tweaks from Robert Collins.
1168 * James Westby has supplied test discovery support using the Python 2.7
1169 TestRunner in testtools.run. This requires the 'discover' module. This
1172 * Python 3.1 is now supported, thanks to Martin[gz] for a partial patch.
1173 This fixes bug #592375.
1175 * TestCase.addCleanup has had its docstring corrected about when cleanups run.
1177 * TestCase.skip is now deprecated in favour of TestCase.skipTest, which is the
1178 Python2.7 spelling for skip. This closes bug #560436.
1180 * Tests work on IronPython patch from Martin[gz] applied.
1182 * Thanks to a patch from James Westby testtools.matchers.Mismatch can now
1183 supply a get_details method, which assertThat will query to provide
1184 additional attachments. This can be used to provide additional detail
1185 about the mismatch that doesn't suite being included in describe(). For
1186 instance, if the match process was complex, a log of the process could be
1187 included, permitting debugging.
1189 * testtools.testresults.real._StringException will now answer __str__ if its
1190 value is unicode by encoding with UTF8, and vice versa to answer __unicode__.
1191 This permits subunit decoded exceptions to contain unicode and still format
1197 More matchers, Python 2.4 support, faster test cloning by switching to copy
1198 rather than deepcopy and better output when exceptions occur in cleanups are
1199 the defining characteristics of this release.
1204 * New matcher "Annotate" that adds a simple string message to another matcher,
1205 much like the option 'message' parameter to standard library assertFoo
1208 * New matchers "Not" and "MatchesAll". "Not" will invert another matcher, and
1209 "MatchesAll" that needs a successful match for all of its arguments.
1211 * On Python 2.4, where types.FunctionType cannot be deepcopied, testtools will
1212 now monkeypatch copy._deepcopy_dispatch using the same trivial patch that
1213 added such support to Python 2.5. The monkey patch is triggered by the
1214 absence of FunctionType from the dispatch dict rather than a version check.
1217 * On windows the test 'test_now_datetime_now' should now work reliably.
1219 * TestCase.getUniqueInteger and TestCase.getUniqueString now have docstrings.
1221 * TestCase.getUniqueString now takes an optional prefix parameter, so you can
1222 now use it in circumstances that forbid strings with '.'s, and such like.
1224 * testtools.testcase.clone_test_with_new_id now uses copy.copy, rather than
1225 copy.deepcopy. Tests that need a deeper copy should use the copy protocol to
1226 control how they are copied. Bug #498869.
1228 * The backtrace test result output tests should now pass on windows and other
1229 systems where os.sep is not '/'.
1231 * When a cleanUp or tearDown exception occurs, it is now accumulated as a new
1232 traceback in the test details, rather than as a separate call to addError /
1233 addException. This makes testtools work better with most TestResult objects
1234 and fixes bug #335816.
1240 Python 3 support, more matchers and better consistency with Python 2.7 --
1241 you'd think that would be enough for a point release. Well, we here on the
1242 testtools project think that you deserve more.
1244 We've added a hook so that user code can be called just-in-time whenever there
1245 is an exception, and we've also factored out the "run" logic of test cases so
1246 that new outcomes can be added without fiddling with the actual flow of logic.
1248 It might sound like small potatoes, but it's changes like these that will
1249 bring about the end of test frameworks.
1255 * A failure in setUp and tearDown now report as failures not as errors.
1257 * Cleanups now run after tearDown to be consistent with Python 2.7's cleanup
1260 * ExtendedToOriginalDecorator now passes unrecognised attributes through
1261 to the decorated result object, permitting other extensions to the
1262 TestCase -> TestResult protocol to work.
1264 * It is now possible to trigger code just-in-time after an exception causes
1265 a test outcome such as failure or skip. See the testtools MANUAL or
1266 ``pydoc testtools.TestCase.addOnException``. (bug #469092)
1268 * New matcher Equals which performs a simple equality test.
1270 * New matcher MatchesAny which looks for a match of any of its arguments.
1272 * TestCase no longer breaks if a TestSkipped exception is raised with no
1275 * TestCase.run now clones test cases before they are run and runs the clone.
1276 This reduces memory footprint in large test runs - state accumulated on
1277 test objects during their setup and execution gets freed when test case
1278 has finished running unless the TestResult object keeps a reference.
1279 NOTE: As test cloning uses deepcopy, this can potentially interfere if
1280 a test suite has shared state (such as the testscenarios or testresources
1281 projects use). Use the __deepcopy__ hook to control the copying of such
1282 objects so that the shared references stay shared.
1284 * Testtools now accepts contributions without copyright assignment under some
1285 circumstances. See HACKING for details.
1287 * Testtools now provides a convenient way to run a test suite using the
1288 testtools result object: python -m testtools.run testspec [testspec...].
1290 * Testtools now works on Python 3, thanks to Benjamin Peterson.
1292 * Test execution now uses a separate class, testtools.RunTest to run single
1293 tests. This can be customised and extended in a more consistent fashion than
1294 the previous run method idiom. See pydoc for more information.
1296 * The test doubles that testtools itself uses are now available as part of
1297 the testtools API in testtols.testresult.doubles.
1299 * TracebackContent now sets utf8 as the charset encoding, rather than not
1300 setting one and encoding with the default encoder.
1302 * With python2.7 testtools.TestSkipped will be the unittest.case.SkipTest
1303 exception class making skips compatible with code that manually raises the
1304 standard library exception. (bug #490109)
1309 * TestCase.getUniqueInteger is now implemented using itertools.count. Thanks
1310 to Benjamin Peterson for the patch. (bug #490111)
1316 The new matcher API introduced in 0.9.0 had a small flaw where the matchee
1317 would be evaluated twice to get a description of the mismatch. This could lead
1318 to bugs if the act of matching caused side effects to occur in the matchee.
1319 Since having such side effects isn't desirable, we have changed the API now
1320 before it has become widespread.
1325 * Matcher API changed to avoid evaluating matchee twice. Please consult
1326 the API documentation.
1328 * TestCase.getUniqueString now uses the test id, not the test method name,
1329 which works nicer with parameterised tests.
1334 * Python2.4 is now supported again.
1340 This release of testtools is perhaps the most interesting and exciting one
1341 it's ever had. We've continued in bringing together the best practices of unit
1342 testing from across a raft of different Python projects, but we've also
1343 extended our mission to incorporating unit testing concepts from other
1344 languages and from our own research, led by Robert Collins.
1346 We now support skipping and expected failures. We'll make sure that you
1347 up-call setUp and tearDown, avoiding unexpected testing weirdnesses. We're
1348 now compatible with Python 2.5, 2.6 and 2.7 unittest library.
1350 All in all, if you are serious about unit testing and want to get the best
1351 thinking from the whole Python community, you should get this release.
1356 * A new TestResult API has been added for attaching details to test outcomes.
1357 This API is currently experimental, but is being prepared with the intent
1358 of becoming an upstream Python API. For more details see pydoc
1359 testtools.TestResult and the TestCase addDetail / getDetails methods.
1361 * assertThat has been added to TestCase. This new assertion supports
1362 a hamcrest-inspired matching protocol. See pydoc testtools.Matcher for
1363 details about writing matchers, and testtools.matchers for the included
1364 matchers. See http://code.google.com/p/hamcrest/.
1366 * Compatible with Python 2.6 and Python 2.7
1368 * Failing to upcall in setUp or tearDown will now cause a test failure.
1369 While the base methods do nothing, failing to upcall is usually a problem
1370 in deeper hierarchies, and checking that the root method is called is a
1371 simple way to catch this common bug.
1373 * New TestResult decorator ExtendedToOriginalDecorator which handles
1374 downgrading extended API calls like addSkip to older result objects that
1375 do not support them. This is used internally to make testtools simpler but
1376 can also be used to simplify other code built on or for use with testtools.
1378 * New TextTestResult supporting the extended APIs that testtools provides.
1380 * Nose will no longer find 'runTest' tests in classes derived from
1381 testtools.testcase.TestCase (bug #312257).
1383 * Supports the Python 2.7/3.1 addUnexpectedSuccess and addExpectedFailure
1384 TestResult methods, with a support function 'knownFailure' to let tests
1385 trigger these outcomes.
1387 * When using the skip feature with TestResult objects that do not support it
1388 a test success will now be reported. Previously an error was reported but
1389 production experience has shown that this is too disruptive for projects that
1390 are using skips: they cannot get a clean run on down-level result objects.
1393 .. _testtools: http://pypi.python.org/pypi/testtools
git.samba.org / third_party / testtools / blob