Magic mock assert_called_once vs assert_called_once_with weird behaviour

asgarro picture asgarro · Feb 17, 2017 · Viewed 22.1k times · Source

I am noticing a weird behavior with assert_called_once and assert_called_once_with in python. This is my real simple test:

File module/a.py

from .b import B

class A(object):
    def __init__(self):
        self.b = B("hi")

    def call_b_hello(self):
        print(self.b.hello())

File module/b.py

class B(object):
    def __init__(self, string):
        print("created B")
        self.string = string;

    def hello(self):
        return self.string

These are my tests:

import unittest
from mock import patch
from module.a import A    

class MCVETests(unittest.TestCase):
    @patch('module.a.B')   
    def testAcallBwithMockPassCorrect(self, b1):
        a = A()
        b1.assert_called_once_with("hi")
        a.call_b_hello()
        a.b.hello.assert_called_once()

    @patch('module.a.B')
    def testAcallBwithMockPassCorrectWith(self, b1):
        a = A()
        b1.assert_called_once_with("hi")
        a.call_b_hello()
        a.b.hello.assert_called_once_with()

    @patch('module.a.B')
    def testAcallBwithMockFailCorrectWith(self, b1):
        a = A()
        b1.assert_called_once_with("hi")
        a.b.hello.assert_called_once_with()

    @patch('module.a.B')
    def testAcallBwithMockPassWrong(self, b1):
        a = A()
        b1.assert_called_once_with("hi")
        a.b.hello.assert_called_once()

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

My problem as stated in the name of the function is:

  • Test 1 passes correctly
  • Test 2 passes correctly
  • Test 3 fails correctly (I've removed the call to b)
  • Test 4 passes I am not sure why.

Am I doing something wrong? I am not sure but reading the documentation docs python:

assert_called_once(*args, **kwargs)

Assert that the mock was called exactly once.

Answer

Curt picture Curt · Jul 17, 2019

This is old, but for others landing here...

For python < 3.6, assert_called_once isn't a thing and so you're actually making a mocked function call which doesn't error

Please see: http://engineroom.trackmaven.com/blog/mocking-mistakes/

You can check the call count instead.