modernize tests

[warner]

I'd like to clean up our unit tests.. there are a lot of archaic idioms that have crept in (partly because I'm not up-to-date on modern practices, partly because the tests were initially written before those practices were established). Here are some things that come to mind:

• switch from trial's TestCase? to testtools' TestCase? (probably via a base class in one of our common modules)
• replace JUnit-style assertions (assertEqual(...)) with "hamcrest" style assertions (assertThat(x, Equals(y)))
• switch to inlineCallbacks to flatten the control-flow nest of helper functions

[warner]

#2465 is where we removed "mock" about 8 months ago (mostly because it wanted a modern setuptools, but we had zetuptoolz, a reason that has gone away).

[meejah]

It also might be fruitful to look at changing at least some of the *MixIn? "helper" classes to be 'just' helper *methods* instead.

By which I mean that if a test-suite wants a particular helper, instead of inheriting from the MixIn? and using self.{various state} idioms, it might be better to have a "create_whatever_helper" and assign it to self.whatever in the setUp of any test-suites that need them.

For example, to use the "no network" test helper, you currently:

• subclass GridTestMixin
• make sure you called its setUp properly
• call self.set_up_grid at some point (but after the above)
• access the grid state via self.g and friends (which are set in set_up_grid) or any of the dozen methods added to self by the mix-in

Instead, it might be more-clear to take the functionality of set_up_grid and make it a bare method that creates you some helper object off of which hang any interesting helper methods for the test. Something like:

• change class GridTestMixin into class NoNetworkGrid
• turn set_up_grid into a bare factory method that creates, initializes and returns a NoNetworkGrid (could be async if needed)
• ...keep all the other state + helper functions it already has

Then, to use this a test-suite would:

• do something like self.grid = create_no_network_grid() in its setUp
• access + change grid state via self.grid.*

[warner]

Glyph also pointed me at newer assertion methods, like:

• f = self.failureResultOf(d, *expectedExceptionTypes): passes iff the Deferred has already errbacked, with one of the given types
• res = self.successResultOf(d): passes iff the Deferred has already callbacked
• self.assertNoResult(d): passes iff the Deferred has not been fired yet

The general pattern is to avoid waiting for Deferreds as much as possible. You call the method that returns a Deferred (with mocks in place for everything it might wait upon), then you manually trigger those mocks. Before, during, and after the triggers, you keep inspecting the Deferred to make sure it's in the right state.

[warner]

Oh, and for reference, the signature of assertFailure (when using inlineCallbacks) is:

• e = yield self.assertFailure(d, *expectedFailures): wait for d to errback, require that it errbacked with one of the given exception types, and yield the exception. Fail if d is callbacked instead of being errbacked.

[Brian Warner <warner@…>]

In 84a1064/trunk:

setup.py: depend on 'mock' when using [test] extra

I think this is useful enough that we should have it available when
running tests.

refs ticket:2777