Testtools

~~~~~

Improvements
------------

* Twisted support code uses ``inlineCallbacks`` rather than the deprecated
``deferredGenerator``. (Tristan Seligmann)

~~~~~

Improvements
------------

* ``TestResult`` objects that don't implement ``stop``/``shouldStop`` are now
handled sanely. (Jonathan Lange)

* New ``Always`` and ``Never`` matchers. (Tristan Seligmann, 947026)

* Fixed example in ``failed`` docstring. (Jonathan Lange, Github 208)

* Rather than explicitly raising a ``KeyboardInterrupt`` if we get no result
from a ``Deferred``, we tell the test result to stop running tests and
report the lack of result as a test error. This ought to make weird
concurrency interaction bugs easier to understand. (Jonathan Lange)

* Introduce the unique_text_generator generator function. Similar to the
getUniqueString() method, except it creates unique unicode text strings.
(Brant Knudson)

* Previously, when gathering details caused by a setUp() failure,
a traceback occurred if the fixture used the newer _setUp().
This had the side effect of not clearing up fixtures nor gathering details
properly. This is now fixed. (Julian Edwards, 1469759)

* New ``Warnings`` matcher, and ``WarningMessage`` and ``IsDeprecated``
functions for matching emitted warnings. (Jonathan Jacobs, Github 223)

~~~~~

Just a few tweaks to our Twisted support. Major version bump to indicate that
Python 2.6 & 3.2 are no longer supported.

Changes
-------

* ``AsynchronousDeferredRunTest`` now has ``suppress_twisted_logging`` and
``store_twisted_logs`` parameters that can be used to override the default
logging behaviour. (Jonathan Lange, 942785)

* New fixture ``CaptureTwistedLogs`` that can be used with
``AsynchronousDeferredRunTest`` to attach a detail containing everything
logged to Twisted during the test run. (Jonathan Lange, 1515362)

* Python 2.6 and 3.2 are no longer supported. If you want to use either of
these versions of Python, use testtools 1.9.0. (Jonathan Lange)

* Make ``fixtures`` a real dependency, not just a test dependency.
(Jonathan Lange)

~~~~~

Many new fixes in this branch, including lots of work around Twisted support.

This is the first release that explicitly supports Python 3.5 and the last
release that supports Python 2.6 or 3.2.

Thanks to all who contributed!

Improvements
------------

* Python 3.5 added to the list of supported platforms. (Jonathan Lange)

* ``MatchesListwise`` has more informative error when lengths don't match.
(Jonathan Lange)

* The short form of errors for failed binary comparisons will now put the
expected value on the _right_. This means that ``assertThat(2, Equals(3))``
will raise an error saying ``2 != 3``.
(Jonathan Lange, 1525227)

* Tests for ``assertRaisesRegexp``. (Julia Varlamova, Jonathan Lange)

* Tests that customize ``skipException`` no longer get tracebacks for skipped
tests. (Jonathan Lange, 1518101)

* A failing ``expectThat`` now fails tests run with
``AsynchronousDeferredRunTest``. (Jonathan Lange, 1532452)

* New ``testtools.twistedsupport`` package that collects all of our Twisted
support code in one place, including that currently available under
``testtools.deferredruntest``. (Jonathan Lange)

* New matchers for testing ``Deferred`` code: ``failed``, ``succeeded``, and
``has_no_result``. (Jonathan Lange, Tristan Seligmann, 1369134)

* ``TestCase`` objects can now be run twice. All internal state is reset
between runs. In particular, testtools tests can now be run with
``trial -u``. (Jonathan Lange, 1517879)

* Fixed bug where if an asynchronous ``Deferred`` test times out but the
``Deferred`` then fires, the entire test run would abort with
``KeyboardInterrupt``, failing the currently running test.
(Jonathan Lange, James Westby)


Changes
-------

* Add a new test dependency of testscenarios. (Robert Collins)

* Make ``fixtures`` a real dependency, not just a test dependency.
(Jonathan Lange)

* ``run_with_log_observers`` is deprecated.

* ``addCleanup`` can now only be called within a test run.
(Jonathan Lange)

* ``TestCase.skip`` deprecated. Use ``skipTest`` instead.
(Jonathan Lange, 988893)

* Getting ``expected`` or ``observed`` attributes from binary comparison
mismatches (e.g. ``Equals(2).match(3).expected``) is now deprecated.
(Jonathan Lange)

* Last release of testtools to support Python 3.2. (Jonathan Lange)

* Last release of testtools to support Python 2.6. (Jonathan Lange)

* Report on all duplicate test ids when sorting test suites that contain
duplicate ids. (Thomas Bechtold, Jonathan Lange, 1390082)

* Add ``readthedocs-requirements.txt`` so readthedocs.org can build the
Twisted API documentation. (Jonathan Lange)

~~~~~

Improvements
------------

* Documented more explicitly how to build and install testtools in the hacking
documentation. (Thomi Richards)

* ``deferredruntest`` now works with Twisted 15.1.0 and later.
(Colin Watson, 1488710)

~~~~~

Improvements
------------

* AsynchronousDeferredRunTest now correctly attaches the test log.
Previously it attached an empty file. (Colin Watson)