use a mock decorator for test methods that return Deferreds #1301

New Issue

tahoe-lafs · 2011-01-10T19:40:24Z

davidsarah commented

2011-01-10 19:40:24 +00:00

Using the @mock.patch decorator for Trial test methods that return Deferreds does not work, because the patch will be undone when the method returns synchronously, not when the Deferred chain completes.

We should add a decorator that can be used instead to source:src/allmydata/test/common_util.py. Something like:

def trialPatch(*patch_args, **patch_kwargs):
    patcher = mock.patch(*patch_args, **patch_kwargs)
    def decorator(f):
        def inner(*test_args, **test_kwargs):
            mock = patcher.__enter__()
            def cleanup(res):
                patcher.__exit__()
                return res
            test_args += (mock,)
            d = f(*test_args, **test_kwargs)
            d.addBoth(cleanup)
            return d
        return inner
    return decorator

This would require mock 0.6, I think. Thanks to ducki2p and voidspace for this code.

Using the @mock.patch decorator for Trial test methods that return Deferreds does not work, because the patch will be undone when the method returns synchronously, not when the Deferred chain completes. We should add a decorator that can be used instead to source:src/allmydata/test/common_util.py. Something like: ``` def trialPatch(*patch_args, **patch_kwargs): patcher = mock.patch(*patch_args, **patch_kwargs) def decorator(f): def inner(*test_args, **test_kwargs): mock = patcher.__enter__() def cleanup(res): patcher.__exit__() return res test_args += (mock,) d = f(*test_args, **test_kwargs) d.addBoth(cleanup) return d return inner return decorator ``` This would require mock 0.6, I think. Thanks to ducki2p and voidspace for this code.

tahoe-lafs added the

labels 2011-01-10 19:40:24 +00:00

tahoe-lafs added this to the undecided milestone 2011-01-10 19:40:24 +00:00

zooko commented

2011-06-17 06:19:13 +00:00

Please see #1395 for a working implementation of this and a discussion of whether we should actually maintain it in Tahoe-LAFS source tree or not.

davidsarah commented

2011-07-24 22:19:12 +00:00

The test added in #1149 could also benefit from this.

davidsarah commented

2011-08-09 03:57:17 +00:00

Is this useful? http://twistedmatrix.com/documents/10.1.0/api/twisted.trial.unittest.TestCase.html#patch

It's not as sophisticated as the mock library, but it might suffice for the cases we currently need, until we can depend on a version of mock that automatically handles deferreds.

Is this useful? <http://twistedmatrix.com/documents/10.1.0/api/twisted.trial.unittest.TestCase.html#patch> It's not as sophisticated as the `mock` library, but it might suffice for the cases we currently need, until we can depend on a version of `mock` that automatically handles deferreds.

zooko commented

2011-09-04 04:23:21 +00:00

Replying to davidsarah:

Is this useful? http://twistedmatrix.com/documents/10.1.0/api/twisted.trial.unittest.TestCase.html#patch

It's not as sophisticated as the mock library, but it might suffice for the cases we currently need, until we can depend on a version of mock that automatically handles deferreds.

Yeah, that looks potentially perfect. :-)

Replying to [davidsarah](/tahoe-lafs/trac-2024-07-25/issues/1301#issuecomment-81896): > Is this useful? <http://twistedmatrix.com/documents/10.1.0/api/twisted.trial.unittest.TestCase.html#patch> > > It's not as sophisticated as the `mock` library, but it might suffice for the cases we currently need, until we can depend on a version of `mock` that automatically handles deferreds. Yeah, that looks potentially perfect. :-)

zooko commented

2013-08-21 15:34:51 +00:00

Everyone who finds this ticket, please use the Twisted "patch" utility: http://twistedmatrix.com/documents/10.1.0/api/twisted.trial.unittest.TestCase.html#patch for your unit tests.

Everyone who finds this ticket, please use the Twisted "patch" utility: <http://twistedmatrix.com/documents/10.1.0/api/twisted.trial.unittest.TestCase.html#patch> for your unit tests.

zooko added the

somebody else's problem

label 2013-08-21 15:34:51 +00:00

zooko closed this issue

2013-08-21 15:34:51 +00:00

Sign in to join this conversation.