Search code examples
pythonpython-3.xpython-3.6python-unittestpython-mock

How to pass the arguments to the new_callable from mock.patch?


I've got the code and the test files:

code.py

class Code:

    def do_something_inside(self, a, b, c):
        return a-b-c

    def do_something(self, b, c):
        self.do_something_inside(30, b, c)

test.py

import unittest
import unittest.mock as mock
from code import Code

class TestStringMethods(unittest.TestCase):
    def setUp(self):
        self.code = Code()

    def do_something_inside_stub(self, a, b, c):
        return a+b+c

    @mock.patch('code.Code.do_something_inside', new_callable=do_something_inside_stub)
    def test_add(self):
        self.assertEquals(self.code.do_something(10, 5), 45)

if __name__ == '__main__':
    unittest.main()

I want to mock the do_something_inside method using do_something_inside_stub, but the execution failed:

E
======================================================================
ERROR: test_add (__main__.TestStringMethods)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3.6/unittest/mock.py", line 1171, in patched
    arg = patching.__enter__()
  File "/usr/lib/python3.6/unittest/mock.py", line 1293, in __enter__
    new = Klass(**_kwargs)
TypeError: do_something_inside_stub() missing 4 required positional arguments: 'self', 'a', 'b', and 'c'

----------------------------------------------------------------------
Ran 1 test in 0.001s

FAILED (errors=1)

I don't know how to pass the arguments to the new_callable from mock.patch.


Solution

  • new_callable requires a class inherited from Mock, whose object will be created for this mock. The functionality you are looking for is side_effect. Ref: https://docs.python.org/3/library/unittest.mock.html#the-mock-class

    Use the following code:

    @mock.patch('code.Code.do_something_inside', side_effect=do_something_inside_stub)
    def test_add(self, do_something_inside_mock):
        do_something_inside_mock.assert_called