4 Changes and improvements to testtools_, grouped by release.
12 * ``AfterPreproccessing`` renamed to ``AfterPreprocessing``, which is a more
13 correct spelling. Old name preserved for backwards compatibility, but is
14 now deprecated. Please stop using it.
15 (Jonathan Lange, #813460)
17 * ``gather_details`` takes two dicts, rather than two detailed objects.
18 (Jonathan Lange, #801027)
20 * ``MatchesRegex`` mismatch now says "<value> does not match /<regex>/" rather
21 than "<regex> did not match <value>". The regular expression contains fewer
22 backslashes too. (Jonathan Lange, #818079)
24 * Tests that run with ``AsynchronousDeferredRunTest`` now have the ``reactor``
25 attribute set to the running reactor. (Jonathan Lange, #720749)
30 * All public matchers are now in ``testtools.matchers.__all__``.
31 (Jonathan Lange, #784859)
33 * assertThat output is much less verbose, displaying only what the mismatch
34 tells us to display. Old-style verbose output can be had by passing
35 ``verbose=True`` to assertThat. (Jonathan Lange, #675323, #593190)
37 * assertThat accepts a message which will be used to annotate the matcher. This
38 can be given as a third parameter or as a keyword parameter. (Robert Collins)
40 * Automated the Launchpad part of the release process.
41 (Jonathan Lange, #623486)
43 * Correctly display non-ASCII unicode output on terminals that claim to have a
44 unicode encoding. (Martin [gz], #804122)
46 * ``DocTestMatches`` correctly handles unicode output from examples, rather
47 than raising an error. (Martin [gz], #764170)
49 * ``ErrorHolder`` and ``PlaceHolder`` added to docs. (Jonathan Lange, #816597)
51 * ``ExpectedException`` now matches any exception of the given type by
52 default, and also allows specifying a ``Matcher`` rather than a mere regular
53 expression. (Jonathan Lange, #791889)
55 * ``FixtureSuite`` added, allows test suites to run with a given fixture.
58 * Hide testtools's own stack frames when displaying tracebacks, making it
59 easier for test authors to focus on their errors.
60 (Jonathan Lange, Martin [gz], #788974)
62 * Less boilerplate displayed in test failures and errors.
63 (Jonathan Lange, #660852)
65 * ``MatchesException`` now allows you to match exceptions against any matcher,
66 rather than just regular expressions. (Jonathan Lange, #791889)
68 * ``MatchesException`` now permits a tuple of types rather than a single type
69 (when using the type matching mode). (Robert Collins)
71 * ``MatchesStructure.byEquality`` added to make the common case of matching
72 many attributes by equality much easier. ``MatchesStructure.byMatcher``
73 added in case folk want to match by things other than equality.
76 * New convenience assertions, ``assertIsNone`` and ``assertIsNotNone``.
81 * ``AllMatch`` matches many values against a single matcher.
82 (Jonathan Lange, #615108)
84 * ``Contains``. (Robert Collins)
86 * ``GreaterThan``. (Christian Kampka)
88 * New helper, ``safe_hasattr`` added. (Jonathan Lange)
90 * ``reraise`` added to ``testtools.compat``. (Jonathan Lange)
96 This release brings consistent use of super for better compatibility with
97 multiple inheritance, fixed Python3 support, improvements in fixture and mather
98 outputs and a compat helper for testing libraries that deal with bytestrings.
103 * ``TestCase`` now uses super to call base ``unittest.TestCase`` constructor,
104 ``setUp`` and ``tearDown``. (Tim Cole, #771508)
106 * If, when calling ``useFixture`` an error occurs during fixture set up, we
107 still attempt to gather details from the fixture. (Gavin Panella)
113 * Additional compat helper for ``BytesIO`` for libraries that build on
114 testtools and are working on Python 3 porting. (Robert Collins)
116 * Corrected documentation for ``MatchesStructure`` in the test authors
117 document. (Jonathan Lange)
119 * ``LessThan`` error message now says something that is logically correct.
120 (Gavin Panella, #762008)
122 * Multiple details from a single fixture are now kept separate, rather than
123 being mooshed together. (Gavin Panella, #788182)
125 * Python 3 support now back in action. (Martin [gz], #688729)
127 * ``try_import`` and ``try_imports`` have a callback that is called whenever
128 they fail to import a module. (Martin Pool)
134 The last release of testtools could not be easy_installed. This is considered
135 severe enough for a re-release.
140 * Include ``doc/`` in the source distribution, making testtools installable
141 from PyPI again (Tres Seaver, #757439)
147 Many, many new matchers, vastly expanded documentation, stacks of bug fixes,
148 better unittest2 integration. If you've ever wanted to try out testtools but
149 been afraid to do so, this is the release to try.
155 * The timestamps generated by ``TestResult`` objects when no timing data has
156 been received are now datetime-with-timezone, which allows them to be
157 sensibly serialised and transported. (Robert Collins, #692297)
162 * ``AnnotatedMismatch`` now correctly returns details.
163 (Jonathan Lange, #724691)
165 * distutils integration for the testtools test runner. Can now use it for
166 'python setup.py test'. (Christian Kampka, #693773)
168 * ``EndsWith`` and ``KeysEqual`` now in testtools.matchers.__all__.
169 (Jonathan Lange, #692158)
171 * ``MatchesException`` extended to support a regular expression check against
172 the str() of a raised exception. (Jonathan Lange)
174 * ``MultiTestResult`` now forwards the ``time`` API. (Robert Collins, #692294)
176 * ``MultiTestResult`` now documented in the manual. (Jonathan Lange, #661116)
178 * New content helpers ``content_from_file``, ``content_from_stream`` and
179 ``attach_file`` make it easier to attach file-like objects to a
180 test. (Jonathan Lange, Robert Collins, #694126)
182 * New ``ExpectedException`` context manager to help write tests against things
183 that are expected to raise exceptions. (Aaron Bentley)
187 * ``MatchesListwise`` matches an iterable of matchers against an iterable
188 of values. (Michael Hudson-Doyle)
190 * ``MatchesRegex`` matches a string against a regular expression.
191 (Michael Hudson-Doyle)
193 * ``MatchesStructure`` matches attributes of an object against given
194 matchers. (Michael Hudson-Doyle)
196 * ``AfterPreproccessing`` matches values against a matcher after passing them
197 through a callable. (Michael Hudson-Doyle)
199 * ``MatchesSetwise`` matches an iterable of matchers against an iterable of
200 values, without regard to order. (Michael Hudson-Doyle)
202 * ``setup.py`` can now build a snapshot when Bazaar is installed but the tree
203 is not a Bazaar tree. (Jelmer Vernooij)
205 * Support for running tests using distutils (Christian Kampka, #726539)
207 * Vastly improved and extended documentation. (Jonathan Lange)
209 * Use unittest2 exception classes if available. (Jelmer Vernooij)
215 In this release we bring some very interesting improvements:
217 * new matchers for exceptions, sets, lists, dicts and more.
219 * experimental (works but the contract isn't supported) twisted reactor
222 * The built in runner can now list tests and filter tests (the -l and
223 --load-list options).
228 * addUnexpectedSuccess is translated to addFailure for test results that don't
229 know about addUnexpectedSuccess. Further, it fails the entire result for
230 all testtools TestResults (i.e. wasSuccessful() returns False after
231 addUnexpectedSuccess has been called). Note that when using a delegating
232 result such as ThreadsafeForwardingResult, MultiTestResult or
233 ExtendedToOriginalDecorator then the behaviour of addUnexpectedSuccess is
234 determined by the delegated to result(s).
235 (Jonathan Lange, Robert Collins, #654474, #683332)
237 * startTestRun will reset any errors on the result. That is, wasSuccessful()
238 will always return True immediately after startTestRun() is called. This
239 only applies to delegated test results (ThreadsafeForwardingResult,
240 MultiTestResult and ExtendedToOriginalDecorator) if the delegated to result
241 is a testtools test result - we cannot reliably reset the state of unknown
242 test result class instances. (Jonathan Lange, Robert Collins, #683332)
244 * Responsibility for running test cleanups has been moved to ``RunTest``.
245 This change does not affect public APIs and can be safely ignored by test
246 authors. (Jonathan Lange, #662647)
253 * ``EndsWith`` which complements the existing ``StartsWith`` matcher.
254 (Jonathan Lange, #669165)
256 * ``MatchesException`` matches an exception class and parameters. (Robert
259 * ``KeysEqual`` matches a dictionary with particular keys. (Jonathan Lange)
261 * ``assertIsInstance`` supports a custom error message to be supplied, which
262 is necessary when using ``assertDictEqual`` on Python 2.7 with a
263 ``testtools.TestCase`` base class. (Jelmer Vernooij)
265 * Experimental support for running tests that return Deferreds.
266 (Jonathan Lange, Martin [gz])
268 * Provide a per-test decorator, run_test_with, to specify which RunTest
269 object to use for a given test. (Jonathan Lange, #657780)
271 * Fix the runTest parameter of TestCase to actually work, rather than raising
272 a TypeError. (Jonathan Lange, #657760)
274 * Non-release snapshots of testtools will now work with buildout.
275 (Jonathan Lange, #613734)
277 * Malformed SyntaxErrors no longer blow up the test suite. (Martin [gz])
279 * ``MismatchesAll.describe`` no longer appends a trailing newline.
280 (Michael Hudson-Doyle, #686790)
282 * New helpers for conditionally importing modules, ``try_import`` and
283 ``try_imports``. (Jonathan Lange)
285 * ``Raises`` added to the ``testtools.matchers`` module - matches if the
286 supplied callable raises, and delegates to an optional matcher for validation
287 of the exception. (Robert Collins)
289 * ``raises`` added to the ``testtools.matchers`` module - matches if the
290 supplied callable raises and delegates to ``MatchesException`` to validate
291 the exception. (Jonathan Lange)
293 * Tests will now pass on Python 2.6.4 : an ``Exception`` change made only in
294 2.6.4 and reverted in Python 2.6.5 was causing test failures on that version.
295 (Martin [gz], #689858).
297 * ``testtools.TestCase.useFixture`` has been added to glue with fixtures nicely.
300 * ``testtools.run`` now supports ``-l`` to list tests rather than executing
301 them. This is useful for integration with external test analysis/processing
302 tools like subunit and testrepository. (Robert Collins)
304 * ``testtools.run`` now supports ``--load-list``, which takes a file containing
305 test ids, one per line, and intersects those ids with the tests found. This
306 allows fine grained control of what tests are run even when the tests cannot
307 be named as objects to import (e.g. due to test parameterisation via
308 testscenarios). (Robert Collins)
310 * Update documentation to say how to use testtools.run() on Python 2.4.
311 (Jonathan Lange, #501174)
313 * ``text_content`` conveniently converts a Python string to a Content object.
314 (Jonathan Lange, James Westby)
321 Lots of little cleanups in this release; many small improvements to make your
322 testing life more pleasant.
327 * Cleanups can raise ``testtools.MultipleExceptions`` if they have multiple
328 exceptions to report. For instance, a cleanup which is itself responsible for
329 running several different internal cleanup routines might use this.
331 * Code duplication between assertEqual and the matcher Equals has been removed.
333 * In normal circumstances, a TestCase will no longer share details with clones
334 of itself. (Andrew Bennetts, bug #637725)
336 * Less exception object cycles are generated (reduces peak memory use between
337 garbage collection). (Martin [gz])
339 * New matchers 'DoesNotStartWith' and 'StartsWith' contributed by Canonical
340 from the Launchpad project. Written by James Westby.
342 * Timestamps as produced by subunit protocol clients are now forwarded in the
343 ThreadsafeForwardingResult so correct test durations can be reported.
344 (Martin [gz], Robert Collins, #625594)
346 * With unittest from Python 2.7 skipped tests will now show only the reason
347 rather than a serialisation of all details. (Martin [gz], #625583)
349 * The testtools release process is now a little better documented and a little
350 smoother. (Jonathan Lange, #623483, #623487)
356 Nothing major in this release, just enough small bits and pieces to make it
357 useful enough to upgrade to.
359 In particular, a serious bug in assertThat() has been fixed, it's easier to
360 write Matchers, there's a TestCase.patch() method for those inevitable monkey
361 patches and TestCase.assertEqual gives slightly nicer errors.
366 * 'TestCase.assertEqual' now formats errors a little more nicely, in the
369 * Added `PlaceHolder` and `ErrorHolder`, TestCase-like objects that can be
370 used to add results to a `TestResult`.
372 * 'Mismatch' now takes optional description and details parameters, so
373 custom Matchers aren't compelled to make their own subclass.
375 * jml added a built-in UTF8_TEXT ContentType to make it slightly easier to
376 add details to test results. See bug #520044.
378 * Fix a bug in our built-in matchers where assertThat would blow up if any
379 of them failed. All built-in mismatch objects now provide get_details().
381 * New 'Is' matcher, which lets you assert that a thing is identical to
384 * New 'LessThan' matcher which lets you assert that a thing is less than
387 * TestCase now has a 'patch()' method to make it easier to monkey-patching
388 objects in tests. See the manual for more information. Fixes bug #310770.
390 * MultiTestResult methods now pass back return values from the results it
396 This release fixes some obscure traceback formatting issues that probably
397 weren't affecting you but were certainly breaking our own test suite.
402 * Jamu Kakar has updated classes in testtools.matchers and testtools.runtest
403 to be new-style classes, fixing bug #611273.
408 * Martin[gz] fixed traceback handling to handle cases where extract_tb returns
409 a source line of None. Fixes bug #611307.
411 * Martin[gz] fixed an unicode issue that was causing the tests to fail,
414 * testtools now handles string exceptions (although why would you want to use
415 them?) and formats their tracebacks correctly. Thanks to Martin[gz] for
421 This release overhauls the traceback formatting layer to deal with Python 2
422 line numbers and traceback objects often being local user encoded strings
423 rather than unicode objects. Test discovery has also been added and Python 3.1
424 is also supported. Finally, the Mismatch protocol has been extended to let
425 Matchers collaborate with tests in supplying detailed data about failures.
430 * testtools.utils has been renamed to testtools.compat. Importing
431 testtools.utils will now generate a deprecation warning.
436 * Add machinery for Python 2 to create unicode tracebacks like those used by
437 Python 3. This means testtools no longer throws on encountering non-ascii
438 filenames, source lines, or exception strings when displaying test results.
439 Largely contributed by Martin[gz] with some tweaks from Robert Collins.
441 * James Westby has supplied test discovery support using the Python 2.7
442 TestRunner in testtools.run. This requires the 'discover' module. This
445 * Python 3.1 is now supported, thanks to Martin[gz] for a partial patch.
446 This fixes bug #592375.
448 * TestCase.addCleanup has had its docstring corrected about when cleanups run.
450 * TestCase.skip is now deprecated in favour of TestCase.skipTest, which is the
451 Python2.7 spelling for skip. This closes bug #560436.
453 * Tests work on IronPython patch from Martin[gz] applied.
455 * Thanks to a patch from James Westby testtools.matchers.Mismatch can now
456 supply a get_details method, which assertThat will query to provide
457 additional attachments. This can be used to provide additional detail
458 about the mismatch that doesn't suite being included in describe(). For
459 instance, if the match process was complex, a log of the process could be
460 included, permitting debugging.
462 * testtools.testresults.real._StringException will now answer __str__ if its
463 value is unicode by encoding with UTF8, and vice versa to answer __unicode__.
464 This permits subunit decoded exceptions to contain unicode and still format
470 More matchers, Python 2.4 support, faster test cloning by switching to copy
471 rather than deepcopy and better output when exceptions occur in cleanups are
472 the defining characteristics of this release.
477 * New matcher "Annotate" that adds a simple string message to another matcher,
478 much like the option 'message' parameter to standard library assertFoo
481 * New matchers "Not" and "MatchesAll". "Not" will invert another matcher, and
482 "MatchesAll" that needs a successful match for all of its arguments.
484 * On Python 2.4, where types.FunctionType cannot be deepcopied, testtools will
485 now monkeypatch copy._deepcopy_dispatch using the same trivial patch that
486 added such support to Python 2.5. The monkey patch is triggered by the
487 absence of FunctionType from the dispatch dict rather than a version check.
490 * On windows the test 'test_now_datetime_now' should now work reliably.
492 * TestCase.getUniqueInteger and TestCase.getUniqueString now have docstrings.
494 * TestCase.getUniqueString now takes an optional prefix parameter, so you can
495 now use it in circumstances that forbid strings with '.'s, and such like.
497 * testtools.testcase.clone_test_with_new_id now uses copy.copy, rather than
498 copy.deepcopy. Tests that need a deeper copy should use the copy protocol to
499 control how they are copied. Bug #498869.
501 * The backtrace test result output tests should now pass on windows and other
502 systems where os.sep is not '/'.
504 * When a cleanUp or tearDown exception occurs, it is now accumulated as a new
505 traceback in the test details, rather than as a separate call to addError /
506 addException. This makes testtools work better with most TestResult objects
507 and fixes bug #335816.
513 Python 3 support, more matchers and better consistency with Python 2.7 --
514 you'd think that would be enough for a point release. Well, we here on the
515 testtools project think that you deserve more.
517 We've added a hook so that user code can be called just-in-time whenever there
518 is an exception, and we've also factored out the "run" logic of test cases so
519 that new outcomes can be added without fiddling with the actual flow of logic.
521 It might sound like small potatoes, but it's changes like these that will
522 bring about the end of test frameworks.
528 * A failure in setUp and tearDown now report as failures not as errors.
530 * Cleanups now run after tearDown to be consistent with Python 2.7's cleanup
533 * ExtendedToOriginalDecorator now passes unrecognised attributes through
534 to the decorated result object, permitting other extensions to the
535 TestCase -> TestResult protocol to work.
537 * It is now possible to trigger code just-in-time after an exception causes
538 a test outcome such as failure or skip. See the testtools MANUAL or
539 ``pydoc testtools.TestCase.addOnException``. (bug #469092)
541 * New matcher Equals which performs a simple equality test.
543 * New matcher MatchesAny which looks for a match of any of its arguments.
545 * TestCase no longer breaks if a TestSkipped exception is raised with no
548 * TestCase.run now clones test cases before they are run and runs the clone.
549 This reduces memory footprint in large test runs - state accumulated on
550 test objects during their setup and execution gets freed when test case
551 has finished running unless the TestResult object keeps a reference.
552 NOTE: As test cloning uses deepcopy, this can potentially interfere if
553 a test suite has shared state (such as the testscenarios or testresources
554 projects use). Use the __deepcopy__ hook to control the copying of such
555 objects so that the shared references stay shared.
557 * Testtools now accepts contributions without copyright assignment under some
558 circumstances. See HACKING for details.
560 * Testtools now provides a convenient way to run a test suite using the
561 testtools result object: python -m testtools.run testspec [testspec...].
563 * Testtools now works on Python 3, thanks to Benjamin Peterson.
565 * Test execution now uses a separate class, testtools.RunTest to run single
566 tests. This can be customised and extended in a more consistent fashion than
567 the previous run method idiom. See pydoc for more information.
569 * The test doubles that testtools itself uses are now available as part of
570 the testtools API in testtols.testresult.doubles.
572 * TracebackContent now sets utf8 as the charset encoding, rather than not
573 setting one and encoding with the default encoder.
575 * With python2.7 testtools.TestSkipped will be the unittest.case.SkipTest
576 exception class making skips compatible with code that manually raises the
577 standard library exception. (bug #490109)
582 * TestCase.getUniqueInteger is now implemented using itertools.count. Thanks
583 to Benjamin Peterson for the patch. (bug #490111)
589 The new matcher API introduced in 0.9.0 had a small flaw where the matchee
590 would be evaluated twice to get a description of the mismatch. This could lead
591 to bugs if the act of matching caused side effects to occur in the matchee.
592 Since having such side effects isn't desirable, we have changed the API now
593 before it has become widespread.
598 * Matcher API changed to avoid evaluating matchee twice. Please consult
599 the API documentation.
601 * TestCase.getUniqueString now uses the test id, not the test method name,
602 which works nicer with parameterised tests.
607 * Python2.4 is now supported again.
613 This release of testtools is perhaps the most interesting and exciting one
614 it's ever had. We've continued in bringing together the best practices of unit
615 testing from across a raft of different Python projects, but we've also
616 extended our mission to incorporating unit testing concepts from other
617 languages and from our own research, led by Robert Collins.
619 We now support skipping and expected failures. We'll make sure that you
620 up-call setUp and tearDown, avoiding unexpected testing weirdnesses. We're
621 now compatible with Python 2.5, 2.6 and 2.7 unittest library.
623 All in all, if you are serious about unit testing and want to get the best
624 thinking from the whole Python community, you should get this release.
629 * A new TestResult API has been added for attaching details to test outcomes.
630 This API is currently experimental, but is being prepared with the intent
631 of becoming an upstream Python API. For more details see pydoc
632 testtools.TestResult and the TestCase addDetail / getDetails methods.
634 * assertThat has been added to TestCase. This new assertion supports
635 a hamcrest-inspired matching protocol. See pydoc testtools.Matcher for
636 details about writing matchers, and testtools.matchers for the included
637 matchers. See http://code.google.com/p/hamcrest/.
639 * Compatible with Python 2.6 and Python 2.7
641 * Failing to upcall in setUp or tearDown will now cause a test failure.
642 While the base methods do nothing, failing to upcall is usually a problem
643 in deeper hierarchies, and checking that the root method is called is a
644 simple way to catch this common bug.
646 * New TestResult decorator ExtendedToOriginalDecorator which handles
647 downgrading extended API calls like addSkip to older result objects that
648 do not support them. This is used internally to make testtools simpler but
649 can also be used to simplify other code built on or for use with testtools.
651 * New TextTestResult supporting the extended APIs that testtools provides.
653 * Nose will no longer find 'runTest' tests in classes derived from
654 testtools.testcase.TestCase (bug #312257).
656 * Supports the Python 2.7/3.1 addUnexpectedSuccess and addExpectedFailure
657 TestResult methods, with a support function 'knownFailure' to let tests
658 trigger these outcomes.
660 * When using the skip feature with TestResult objects that do not support it
661 a test success will now be reported. Previously an error was reported but
662 production experience has shown that this is too disruptive for projects that
663 are using skips: they cannot get a clean run on down-level result objects.
666 .. _testtools: http://pypi.python.org/pypi/testtools