4 Changes and improvements to testtools_, grouped by release.
13 This is a very big release. We've made huge improvements on three fronts:
14 1. Test failures are way nicer and easier to read
15 2. Matchers and ``assertThat`` are much more convenient to use
16 3. Correct handling of extended unicode characters
18 We've trimmed off the fat from the stack trace you get when tests fail, we've
19 cut out the bits of error messages that just didn't help, we've made it easier
20 to annotate mismatch failures, to compare complex objects and to match raised
23 Testing code was never this fun.
28 * ``AfterPreproccessing`` renamed to ``AfterPreprocessing``, which is a more
29 correct spelling. Old name preserved for backwards compatibility, but is
30 now deprecated. Please stop using it.
31 (Jonathan Lange, #813460)
33 * ``assertThat`` raises ``MismatchError`` instead of
34 ``TestCase.failureException``. ``MismatchError`` is a subclass of
35 ``AssertionError``, so in most cases this change will not matter. However,
36 if ``self.failureException`` has been set to a non-default value, then
37 mismatches will become test errors rather than test failures.
39 * ``gather_details`` takes two dicts, rather than two detailed objects.
40 (Jonathan Lange, #801027)
42 * ``MatchesRegex`` mismatch now says "<value> does not match /<regex>/" rather
43 than "<regex> did not match <value>". The regular expression contains fewer
44 backslashes too. (Jonathan Lange, #818079)
46 * Tests that run with ``AsynchronousDeferredRunTest`` now have the ``reactor``
47 attribute set to the running reactor. (Jonathan Lange, #720749)
52 * All public matchers are now in ``testtools.matchers.__all__``.
53 (Jonathan Lange, #784859)
55 * ``assertThat`` can actually display mismatches and matchers that contain
56 extended unicode characters. (Jonathan Lange, Martin [gz], #804127)
58 * ``assertThat`` output is much less verbose, displaying only what the mismatch
59 tells us to display. Old-style verbose output can be had by passing
60 ``verbose=True`` to assertThat. (Jonathan Lange, #675323, #593190)
62 * ``assertThat`` accepts a message which will be used to annotate the matcher.
63 This can be given as a third parameter or as a keyword parameter.
66 * Automated the Launchpad part of the release process.
67 (Jonathan Lange, #623486)
69 * Correctly display non-ASCII unicode output on terminals that claim to have a
70 unicode encoding. (Martin [gz], #804122)
72 * ``DocTestMatches`` correctly handles unicode output from examples, rather
73 than raising an error. (Martin [gz], #764170)
75 * ``ErrorHolder`` and ``PlaceHolder`` added to docs. (Jonathan Lange, #816597)
77 * ``ExpectedException`` now matches any exception of the given type by
78 default, and also allows specifying a ``Matcher`` rather than a mere regular
79 expression. (Jonathan Lange, #791889)
81 * ``FixtureSuite`` added, allows test suites to run with a given fixture.
84 * Hide testtools's own stack frames when displaying tracebacks, making it
85 easier for test authors to focus on their errors.
86 (Jonathan Lange, Martin [gz], #788974)
88 * Less boilerplate displayed in test failures and errors.
89 (Jonathan Lange, #660852)
91 * ``MatchesException`` now allows you to match exceptions against any matcher,
92 rather than just regular expressions. (Jonathan Lange, #791889)
94 * ``MatchesException`` now permits a tuple of types rather than a single type
95 (when using the type matching mode). (Robert Collins)
97 * ``MatchesStructure.byEquality`` added to make the common case of matching
98 many attributes by equality much easier. ``MatchesStructure.byMatcher``
99 added in case folk want to match by things other than equality.
102 * New convenience assertions, ``assertIsNone`` and ``assertIsNotNone``.
107 * ``AllMatch`` matches many values against a single matcher.
108 (Jonathan Lange, #615108)
110 * ``Contains``. (Robert Collins)
112 * ``GreaterThan``. (Christian Kampka)
114 * New helper, ``safe_hasattr`` added. (Jonathan Lange)
116 * ``reraise`` added to ``testtools.compat``. (Jonathan Lange)
122 This release brings consistent use of super for better compatibility with
123 multiple inheritance, fixed Python3 support, improvements in fixture and mather
124 outputs and a compat helper for testing libraries that deal with bytestrings.
129 * ``TestCase`` now uses super to call base ``unittest.TestCase`` constructor,
130 ``setUp`` and ``tearDown``. (Tim Cole, #771508)
132 * If, when calling ``useFixture`` an error occurs during fixture set up, we
133 still attempt to gather details from the fixture. (Gavin Panella)
139 * Additional compat helper for ``BytesIO`` for libraries that build on
140 testtools and are working on Python 3 porting. (Robert Collins)
142 * Corrected documentation for ``MatchesStructure`` in the test authors
143 document. (Jonathan Lange)
145 * ``LessThan`` error message now says something that is logically correct.
146 (Gavin Panella, #762008)
148 * Multiple details from a single fixture are now kept separate, rather than
149 being mooshed together. (Gavin Panella, #788182)
151 * Python 3 support now back in action. (Martin [gz], #688729)
153 * ``try_import`` and ``try_imports`` have a callback that is called whenever
154 they fail to import a module. (Martin Pool)
160 The last release of testtools could not be easy_installed. This is considered
161 severe enough for a re-release.
166 * Include ``doc/`` in the source distribution, making testtools installable
167 from PyPI again (Tres Seaver, #757439)
173 Many, many new matchers, vastly expanded documentation, stacks of bug fixes,
174 better unittest2 integration. If you've ever wanted to try out testtools but
175 been afraid to do so, this is the release to try.
181 * The timestamps generated by ``TestResult`` objects when no timing data has
182 been received are now datetime-with-timezone, which allows them to be
183 sensibly serialised and transported. (Robert Collins, #692297)
188 * ``AnnotatedMismatch`` now correctly returns details.
189 (Jonathan Lange, #724691)
191 * distutils integration for the testtools test runner. Can now use it for
192 'python setup.py test'. (Christian Kampka, #693773)
194 * ``EndsWith`` and ``KeysEqual`` now in testtools.matchers.__all__.
195 (Jonathan Lange, #692158)
197 * ``MatchesException`` extended to support a regular expression check against
198 the str() of a raised exception. (Jonathan Lange)
200 * ``MultiTestResult`` now forwards the ``time`` API. (Robert Collins, #692294)
202 * ``MultiTestResult`` now documented in the manual. (Jonathan Lange, #661116)
204 * New content helpers ``content_from_file``, ``content_from_stream`` and
205 ``attach_file`` make it easier to attach file-like objects to a
206 test. (Jonathan Lange, Robert Collins, #694126)
208 * New ``ExpectedException`` context manager to help write tests against things
209 that are expected to raise exceptions. (Aaron Bentley)
213 * ``MatchesListwise`` matches an iterable of matchers against an iterable
214 of values. (Michael Hudson-Doyle)
216 * ``MatchesRegex`` matches a string against a regular expression.
217 (Michael Hudson-Doyle)
219 * ``MatchesStructure`` matches attributes of an object against given
220 matchers. (Michael Hudson-Doyle)
222 * ``AfterPreproccessing`` matches values against a matcher after passing them
223 through a callable. (Michael Hudson-Doyle)
225 * ``MatchesSetwise`` matches an iterable of matchers against an iterable of
226 values, without regard to order. (Michael Hudson-Doyle)
228 * ``setup.py`` can now build a snapshot when Bazaar is installed but the tree
229 is not a Bazaar tree. (Jelmer Vernooij)
231 * Support for running tests using distutils (Christian Kampka, #726539)
233 * Vastly improved and extended documentation. (Jonathan Lange)
235 * Use unittest2 exception classes if available. (Jelmer Vernooij)
241 In this release we bring some very interesting improvements:
243 * new matchers for exceptions, sets, lists, dicts and more.
245 * experimental (works but the contract isn't supported) twisted reactor
248 * The built in runner can now list tests and filter tests (the -l and
249 --load-list options).
254 * addUnexpectedSuccess is translated to addFailure for test results that don't
255 know about addUnexpectedSuccess. Further, it fails the entire result for
256 all testtools TestResults (i.e. wasSuccessful() returns False after
257 addUnexpectedSuccess has been called). Note that when using a delegating
258 result such as ThreadsafeForwardingResult, MultiTestResult or
259 ExtendedToOriginalDecorator then the behaviour of addUnexpectedSuccess is
260 determined by the delegated to result(s).
261 (Jonathan Lange, Robert Collins, #654474, #683332)
263 * startTestRun will reset any errors on the result. That is, wasSuccessful()
264 will always return True immediately after startTestRun() is called. This
265 only applies to delegated test results (ThreadsafeForwardingResult,
266 MultiTestResult and ExtendedToOriginalDecorator) if the delegated to result
267 is a testtools test result - we cannot reliably reset the state of unknown
268 test result class instances. (Jonathan Lange, Robert Collins, #683332)
270 * Responsibility for running test cleanups has been moved to ``RunTest``.
271 This change does not affect public APIs and can be safely ignored by test
272 authors. (Jonathan Lange, #662647)
279 * ``EndsWith`` which complements the existing ``StartsWith`` matcher.
280 (Jonathan Lange, #669165)
282 * ``MatchesException`` matches an exception class and parameters. (Robert
285 * ``KeysEqual`` matches a dictionary with particular keys. (Jonathan Lange)
287 * ``assertIsInstance`` supports a custom error message to be supplied, which
288 is necessary when using ``assertDictEqual`` on Python 2.7 with a
289 ``testtools.TestCase`` base class. (Jelmer Vernooij)
291 * Experimental support for running tests that return Deferreds.
292 (Jonathan Lange, Martin [gz])
294 * Provide a per-test decorator, run_test_with, to specify which RunTest
295 object to use for a given test. (Jonathan Lange, #657780)
297 * Fix the runTest parameter of TestCase to actually work, rather than raising
298 a TypeError. (Jonathan Lange, #657760)
300 * Non-release snapshots of testtools will now work with buildout.
301 (Jonathan Lange, #613734)
303 * Malformed SyntaxErrors no longer blow up the test suite. (Martin [gz])
305 * ``MismatchesAll.describe`` no longer appends a trailing newline.
306 (Michael Hudson-Doyle, #686790)
308 * New helpers for conditionally importing modules, ``try_import`` and
309 ``try_imports``. (Jonathan Lange)
311 * ``Raises`` added to the ``testtools.matchers`` module - matches if the
312 supplied callable raises, and delegates to an optional matcher for validation
313 of the exception. (Robert Collins)
315 * ``raises`` added to the ``testtools.matchers`` module - matches if the
316 supplied callable raises and delegates to ``MatchesException`` to validate
317 the exception. (Jonathan Lange)
319 * Tests will now pass on Python 2.6.4 : an ``Exception`` change made only in
320 2.6.4 and reverted in Python 2.6.5 was causing test failures on that version.
321 (Martin [gz], #689858).
323 * ``testtools.TestCase.useFixture`` has been added to glue with fixtures nicely.
326 * ``testtools.run`` now supports ``-l`` to list tests rather than executing
327 them. This is useful for integration with external test analysis/processing
328 tools like subunit and testrepository. (Robert Collins)
330 * ``testtools.run`` now supports ``--load-list``, which takes a file containing
331 test ids, one per line, and intersects those ids with the tests found. This
332 allows fine grained control of what tests are run even when the tests cannot
333 be named as objects to import (e.g. due to test parameterisation via
334 testscenarios). (Robert Collins)
336 * Update documentation to say how to use testtools.run() on Python 2.4.
337 (Jonathan Lange, #501174)
339 * ``text_content`` conveniently converts a Python string to a Content object.
340 (Jonathan Lange, James Westby)
347 Lots of little cleanups in this release; many small improvements to make your
348 testing life more pleasant.
353 * Cleanups can raise ``testtools.MultipleExceptions`` if they have multiple
354 exceptions to report. For instance, a cleanup which is itself responsible for
355 running several different internal cleanup routines might use this.
357 * Code duplication between assertEqual and the matcher Equals has been removed.
359 * In normal circumstances, a TestCase will no longer share details with clones
360 of itself. (Andrew Bennetts, bug #637725)
362 * Less exception object cycles are generated (reduces peak memory use between
363 garbage collection). (Martin [gz])
365 * New matchers 'DoesNotStartWith' and 'StartsWith' contributed by Canonical
366 from the Launchpad project. Written by James Westby.
368 * Timestamps as produced by subunit protocol clients are now forwarded in the
369 ThreadsafeForwardingResult so correct test durations can be reported.
370 (Martin [gz], Robert Collins, #625594)
372 * With unittest from Python 2.7 skipped tests will now show only the reason
373 rather than a serialisation of all details. (Martin [gz], #625583)
375 * The testtools release process is now a little better documented and a little
376 smoother. (Jonathan Lange, #623483, #623487)
382 Nothing major in this release, just enough small bits and pieces to make it
383 useful enough to upgrade to.
385 In particular, a serious bug in assertThat() has been fixed, it's easier to
386 write Matchers, there's a TestCase.patch() method for those inevitable monkey
387 patches and TestCase.assertEqual gives slightly nicer errors.
392 * 'TestCase.assertEqual' now formats errors a little more nicely, in the
395 * Added `PlaceHolder` and `ErrorHolder`, TestCase-like objects that can be
396 used to add results to a `TestResult`.
398 * 'Mismatch' now takes optional description and details parameters, so
399 custom Matchers aren't compelled to make their own subclass.
401 * jml added a built-in UTF8_TEXT ContentType to make it slightly easier to
402 add details to test results. See bug #520044.
404 * Fix a bug in our built-in matchers where assertThat would blow up if any
405 of them failed. All built-in mismatch objects now provide get_details().
407 * New 'Is' matcher, which lets you assert that a thing is identical to
410 * New 'LessThan' matcher which lets you assert that a thing is less than
413 * TestCase now has a 'patch()' method to make it easier to monkey-patching
414 objects in tests. See the manual for more information. Fixes bug #310770.
416 * MultiTestResult methods now pass back return values from the results it
422 This release fixes some obscure traceback formatting issues that probably
423 weren't affecting you but were certainly breaking our own test suite.
428 * Jamu Kakar has updated classes in testtools.matchers and testtools.runtest
429 to be new-style classes, fixing bug #611273.
434 * Martin[gz] fixed traceback handling to handle cases where extract_tb returns
435 a source line of None. Fixes bug #611307.
437 * Martin[gz] fixed an unicode issue that was causing the tests to fail,
440 * testtools now handles string exceptions (although why would you want to use
441 them?) and formats their tracebacks correctly. Thanks to Martin[gz] for
447 This release overhauls the traceback formatting layer to deal with Python 2
448 line numbers and traceback objects often being local user encoded strings
449 rather than unicode objects. Test discovery has also been added and Python 3.1
450 is also supported. Finally, the Mismatch protocol has been extended to let
451 Matchers collaborate with tests in supplying detailed data about failures.
456 * testtools.utils has been renamed to testtools.compat. Importing
457 testtools.utils will now generate a deprecation warning.
462 * Add machinery for Python 2 to create unicode tracebacks like those used by
463 Python 3. This means testtools no longer throws on encountering non-ascii
464 filenames, source lines, or exception strings when displaying test results.
465 Largely contributed by Martin[gz] with some tweaks from Robert Collins.
467 * James Westby has supplied test discovery support using the Python 2.7
468 TestRunner in testtools.run. This requires the 'discover' module. This
471 * Python 3.1 is now supported, thanks to Martin[gz] for a partial patch.
472 This fixes bug #592375.
474 * TestCase.addCleanup has had its docstring corrected about when cleanups run.
476 * TestCase.skip is now deprecated in favour of TestCase.skipTest, which is the
477 Python2.7 spelling for skip. This closes bug #560436.
479 * Tests work on IronPython patch from Martin[gz] applied.
481 * Thanks to a patch from James Westby testtools.matchers.Mismatch can now
482 supply a get_details method, which assertThat will query to provide
483 additional attachments. This can be used to provide additional detail
484 about the mismatch that doesn't suite being included in describe(). For
485 instance, if the match process was complex, a log of the process could be
486 included, permitting debugging.
488 * testtools.testresults.real._StringException will now answer __str__ if its
489 value is unicode by encoding with UTF8, and vice versa to answer __unicode__.
490 This permits subunit decoded exceptions to contain unicode and still format
496 More matchers, Python 2.4 support, faster test cloning by switching to copy
497 rather than deepcopy and better output when exceptions occur in cleanups are
498 the defining characteristics of this release.
503 * New matcher "Annotate" that adds a simple string message to another matcher,
504 much like the option 'message' parameter to standard library assertFoo
507 * New matchers "Not" and "MatchesAll". "Not" will invert another matcher, and
508 "MatchesAll" that needs a successful match for all of its arguments.
510 * On Python 2.4, where types.FunctionType cannot be deepcopied, testtools will
511 now monkeypatch copy._deepcopy_dispatch using the same trivial patch that
512 added such support to Python 2.5. The monkey patch is triggered by the
513 absence of FunctionType from the dispatch dict rather than a version check.
516 * On windows the test 'test_now_datetime_now' should now work reliably.
518 * TestCase.getUniqueInteger and TestCase.getUniqueString now have docstrings.
520 * TestCase.getUniqueString now takes an optional prefix parameter, so you can
521 now use it in circumstances that forbid strings with '.'s, and such like.
523 * testtools.testcase.clone_test_with_new_id now uses copy.copy, rather than
524 copy.deepcopy. Tests that need a deeper copy should use the copy protocol to
525 control how they are copied. Bug #498869.
527 * The backtrace test result output tests should now pass on windows and other
528 systems where os.sep is not '/'.
530 * When a cleanUp or tearDown exception occurs, it is now accumulated as a new
531 traceback in the test details, rather than as a separate call to addError /
532 addException. This makes testtools work better with most TestResult objects
533 and fixes bug #335816.
539 Python 3 support, more matchers and better consistency with Python 2.7 --
540 you'd think that would be enough for a point release. Well, we here on the
541 testtools project think that you deserve more.
543 We've added a hook so that user code can be called just-in-time whenever there
544 is an exception, and we've also factored out the "run" logic of test cases so
545 that new outcomes can be added without fiddling with the actual flow of logic.
547 It might sound like small potatoes, but it's changes like these that will
548 bring about the end of test frameworks.
554 * A failure in setUp and tearDown now report as failures not as errors.
556 * Cleanups now run after tearDown to be consistent with Python 2.7's cleanup
559 * ExtendedToOriginalDecorator now passes unrecognised attributes through
560 to the decorated result object, permitting other extensions to the
561 TestCase -> TestResult protocol to work.
563 * It is now possible to trigger code just-in-time after an exception causes
564 a test outcome such as failure or skip. See the testtools MANUAL or
565 ``pydoc testtools.TestCase.addOnException``. (bug #469092)
567 * New matcher Equals which performs a simple equality test.
569 * New matcher MatchesAny which looks for a match of any of its arguments.
571 * TestCase no longer breaks if a TestSkipped exception is raised with no
574 * TestCase.run now clones test cases before they are run and runs the clone.
575 This reduces memory footprint in large test runs - state accumulated on
576 test objects during their setup and execution gets freed when test case
577 has finished running unless the TestResult object keeps a reference.
578 NOTE: As test cloning uses deepcopy, this can potentially interfere if
579 a test suite has shared state (such as the testscenarios or testresources
580 projects use). Use the __deepcopy__ hook to control the copying of such
581 objects so that the shared references stay shared.
583 * Testtools now accepts contributions without copyright assignment under some
584 circumstances. See HACKING for details.
586 * Testtools now provides a convenient way to run a test suite using the
587 testtools result object: python -m testtools.run testspec [testspec...].
589 * Testtools now works on Python 3, thanks to Benjamin Peterson.
591 * Test execution now uses a separate class, testtools.RunTest to run single
592 tests. This can be customised and extended in a more consistent fashion than
593 the previous run method idiom. See pydoc for more information.
595 * The test doubles that testtools itself uses are now available as part of
596 the testtools API in testtols.testresult.doubles.
598 * TracebackContent now sets utf8 as the charset encoding, rather than not
599 setting one and encoding with the default encoder.
601 * With python2.7 testtools.TestSkipped will be the unittest.case.SkipTest
602 exception class making skips compatible with code that manually raises the
603 standard library exception. (bug #490109)
608 * TestCase.getUniqueInteger is now implemented using itertools.count. Thanks
609 to Benjamin Peterson for the patch. (bug #490111)
615 The new matcher API introduced in 0.9.0 had a small flaw where the matchee
616 would be evaluated twice to get a description of the mismatch. This could lead
617 to bugs if the act of matching caused side effects to occur in the matchee.
618 Since having such side effects isn't desirable, we have changed the API now
619 before it has become widespread.
624 * Matcher API changed to avoid evaluating matchee twice. Please consult
625 the API documentation.
627 * TestCase.getUniqueString now uses the test id, not the test method name,
628 which works nicer with parameterised tests.
633 * Python2.4 is now supported again.
639 This release of testtools is perhaps the most interesting and exciting one
640 it's ever had. We've continued in bringing together the best practices of unit
641 testing from across a raft of different Python projects, but we've also
642 extended our mission to incorporating unit testing concepts from other
643 languages and from our own research, led by Robert Collins.
645 We now support skipping and expected failures. We'll make sure that you
646 up-call setUp and tearDown, avoiding unexpected testing weirdnesses. We're
647 now compatible with Python 2.5, 2.6 and 2.7 unittest library.
649 All in all, if you are serious about unit testing and want to get the best
650 thinking from the whole Python community, you should get this release.
655 * A new TestResult API has been added for attaching details to test outcomes.
656 This API is currently experimental, but is being prepared with the intent
657 of becoming an upstream Python API. For more details see pydoc
658 testtools.TestResult and the TestCase addDetail / getDetails methods.
660 * assertThat has been added to TestCase. This new assertion supports
661 a hamcrest-inspired matching protocol. See pydoc testtools.Matcher for
662 details about writing matchers, and testtools.matchers for the included
663 matchers. See http://code.google.com/p/hamcrest/.
665 * Compatible with Python 2.6 and Python 2.7
667 * Failing to upcall in setUp or tearDown will now cause a test failure.
668 While the base methods do nothing, failing to upcall is usually a problem
669 in deeper hierarchies, and checking that the root method is called is a
670 simple way to catch this common bug.
672 * New TestResult decorator ExtendedToOriginalDecorator which handles
673 downgrading extended API calls like addSkip to older result objects that
674 do not support them. This is used internally to make testtools simpler but
675 can also be used to simplify other code built on or for use with testtools.
677 * New TextTestResult supporting the extended APIs that testtools provides.
679 * Nose will no longer find 'runTest' tests in classes derived from
680 testtools.testcase.TestCase (bug #312257).
682 * Supports the Python 2.7/3.1 addUnexpectedSuccess and addExpectedFailure
683 TestResult methods, with a support function 'knownFailure' to let tests
684 trigger these outcomes.
686 * When using the skip feature with TestResult objects that do not support it
687 a test success will now be reported. Previously an error was reported but
688 production experience has shown that this is too disruptive for projects that
689 are using skips: they cannot get a clean run on down-level result objects.
692 .. _testtools: http://pypi.python.org/pypi/testtools