Warum schlägt unittest.mock fehl, wenn der Konstruktor der Produktionsklasse zusätzliche Argumente annimmt?

Question

Ich bin auf ein Problem gestoßen, von dem ich denke, dass es ein Fehler in den Bibliotheken ist, die ich verwende. Ich bin jedoch ziemlich neu in Python, Unittest und unittest.mock Bibliotheken, so dass dies nur ein Loch in meinem Verständnis sein kann.

Während Tests bis zu einem gewissen Produktionscode hinzugefügt ich in einen Fehler laufen, ich habe eine minimale Probe erzeugt, die das Problem reproduziert:

import unittest 
import mock 

class noCtorArg: 
    def __init__(self): 
     pass 
    def okFunc(self): 
     raise NotImplemented 


class withCtorArg: 
    def __init__(self,obj): 
     pass 
    def notOkFunc(self): 
     raise NotImplemented 
    def okWithArgFunc(self, anArgForMe): 
     raise NotImplemented 

class BasicTestSuite(unittest.TestCase): 
    """Basic test Cases.""" 

    # passes 
    def test_noCtorArg_okFunc(self): 
     mockSUT = mock.MagicMock(spec=noCtorArg) 
     mockSUT.okFunc() 
     mockSUT.assert_has_calls([mock.call.okFunc()]) 

    # passes 
    def test_withCtorArg_okWithArgFuncTest(self): 
     mockSUT = mock.MagicMock(spec=withCtorArg) 
     mockSUT.okWithArgFunc("testing") 
     mockSUT.assert_has_calls([mock.call.okWithArgFunc("testing")]) 

    # fails 
    def test_withCtorArg_doNotOkFuncTest(self): 
     mockSUT = mock.MagicMock(spec=withCtorArg) 
     mockSUT.notOkFunc() 
     mockSUT.assert_has_calls([mock.call.notOkFunc()]) 


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

Wie ich die Tests ausführen und die Ausgabe ist wie folgt:

E:\work>python -m unittest testCopyFuncWithMock 
.F. 
====================================================================== 
FAIL: test_withCtorArg_doNotOkFuncTest (testCopyFuncWithMock.BasicTestSuite) 
---------------------------------------------------------------------- 
Traceback (most recent call last): 
    File "testCopyFuncWithMock.py", line 38, in test_withCtorArg_doNotOkFuncTest 
    mockSUT.assert_has_calls([mock.call.notOkFunc()]) 
    File "C:\Python27\lib\site-packages\mock\mock.py", line 969, in assert_has_calls 
    ), cause) 
    File "C:\Python27\lib\site-packages\six.py", line 718, in raise_from 
    raise value 
AssertionError: Calls not found. 
Expected: [call.notOkFunc()] 
Actual: [call.notOkFunc()] 

---------------------------------------------------------------------- 
Ran 3 tests in 0.004s 

FAILED (failures=1) 

Ich benutze Python 2.7.11, mit Mock-Version 2.0.0 über Pip installiert.

Irgendwelche Vorschläge für was ich falsch mache? Oder sieht das wie ein Fehler in der Bibliothek aus?

Answer 1

Interessanterweise hat die Art, wie Sie die Assert ausführen, Ihr Problem maskiert.

Versuchen, statt dies:

mockSUT.assert_has_calls(calls=[mock.call.notOkFunc()]) 

dies zu tun:

mockSUT.assert_has_calls(calls=[mock.call.notOkFunc()], any_order=True) 

Sie finden die aktuelle Ausnahme sehen:

TypeError("'obj' parameter lacking default value") 

Dies liegt daran, Sie zu instanziieren versucht eine Instanz der Klasse withCtorArg, die den Parameter obj ohne Defau hat lt Wert. Wenn Sie versucht hatte, es tatsächlich direkt zu instanziiert, würde haben Sie gesehen:

TypeError: __init__() takes exactly 2 arguments (1 given) 

Aber da man die mock Bibliothek handhaben die Instanziierung eines Mock-Objekt lassen, geschieht der Fehler dort - und Sie erhalten die TypeError Ausnahme .

Ändern der jeweiligen Klasse:

class withCtorArg: 
    def __init__(self, obj = None): 
     pass 
    def notOkFunc(self): 
     pass 
    def okWithArgFunc(self, anArgForMe): 
     pass 

und das Hinzufügen einer Standard Keine Wert für obj löst das Problem.

Answer 2

Ich glaube nicht, dass ich definitiv erklären kann, warum das der Fall ist, ich vermute immer noch einen Fehler in der Mock-Bibliothek, da das Problem nur für einen Testfall ohne Argumente für die aufgerufene Funktion auftritt. Danke an advance512 für den Hinweis, dass der wahre Fehler versteckt war!

jedoch, um dieses Problem zu umgehen, ohne den Produktionscode zu modifizieren ich den folgenden Ansatz verwenden werde:

# passes 
@mock.patch ('mymodule.noCtorArg') 
def test_noCtorArg_okFunc(self, noCtorArgMock): 
    mockSUT = noCtorArg.return_value 
    mockSUT.okFunc() 
    mockSUT.assert_has_calls([mock.call.okFunc()]) 

# passes 
@mock.patch ('mymodule.withCtorArg') 
def test_withCtorArg_okWithArgFuncTest(self, withCtorArgMock): 
    mockSUT = withCtorArg.return_value 
    mockSUT.okWithArgFunc("testing") 
    mockSUT.assert_has_calls([mock.call.okWithArgFunc("testing")]) 

# now passes 
@mock.patch ('mymodule.withCtorArg') 
def test_withCtorArg_doNotOkFuncTest(self, withCtorArgMock): 
    mockSUT = withCtorArg.return_value 
    mockSUT.notOkFunc() 
    mockSUT.assert_has_calls([mock.call.notOkFunc()], any_order=True) 

Edit:

Ein Problem dabei ist, dass der Mock hat nicht spec eingestellt. Dies bedeutet, dass das SUT Methoden aufrufen kann, die in der ursprünglichen Klassendefinition nicht vorhanden sind.

Ein alternativer Ansatz ist die Klasse wickeln verspottet werden:

class withCtorArg: 
    def __init__(self,obj): 
     pass 
    def notOkFunc(self): 
     raise NotImplemented 
    def okWithArgFunc(self, anArgForMe): 
     raise NotImplemented 

class wrapped_withCtorArg(withCtorArg): 
    def __init__(self): 
     super(None) 

class BasicTestSuite(unittest.TestCase): 
    """Basic test Cases.""" 

    # now passes 
    def test_withCtorArg_doNotOkFuncTest(self): 
     mockSUT = mock.MagicMock(spec=wrapped_withCtorArg) 
     mockSUT.notOkFunc() 
     #mockSUT.doesntExist() #causes the test to fail. "Mock object has no attribute 'doesntExist'" 
     assert isinstance (mockSUT, withCtorArg) 
     mockSUT.assert_has_calls([mock.call.notOkFunc()], any_order=True)