blob: 2bafa8266b63ba59c07ef768d7a1ea86c6087f24 [file] [log] [blame]
Michael Foord345266a2012-03-14 12:24:34 -07001import copy
Petter Strandmark47d94242018-10-28 21:37:10 +01002import re
Michael Foord345266a2012-03-14 12:24:34 -07003import sys
Robert Collinsca647ef2015-07-24 03:48:20 +12004import tempfile
Michael Foord345266a2012-03-14 12:24:34 -07005
Serhiy Storchaka662db122019-08-08 08:42:54 +03006from test.support import ALWAYS_EQ
Michael Foord345266a2012-03-14 12:24:34 -07007import unittest
8from unittest.test.testmock.support import is_instance
9from unittest import mock
10from unittest.mock import (
11 call, DEFAULT, patch, sentinel,
12 MagicMock, Mock, NonCallableMock,
Lisa Roach77b3b772019-05-20 09:19:53 -070013 NonCallableMagicMock, AsyncMock, _Call, _CallList,
Michael Foord345266a2012-03-14 12:24:34 -070014 create_autospec
15)
16
17
18class Iter(object):
19 def __init__(self):
20 self.thing = iter(['this', 'is', 'an', 'iter'])
21
22 def __iter__(self):
23 return self
24
25 def next(self):
26 return next(self.thing)
27
28 __next__ = next
29
30
Antoine Pitrou5c64df72013-02-03 00:23:58 +010031class Something(object):
Chris Withersadbf1782019-05-01 23:04:04 +010032 def meth(self, a, b, c, d=None): pass
Antoine Pitrou5c64df72013-02-03 00:23:58 +010033
34 @classmethod
Chris Withersadbf1782019-05-01 23:04:04 +010035 def cmeth(cls, a, b, c, d=None): pass
Antoine Pitrou5c64df72013-02-03 00:23:58 +010036
37 @staticmethod
Chris Withersadbf1782019-05-01 23:04:04 +010038 def smeth(a, b, c, d=None): pass
Antoine Pitrou5c64df72013-02-03 00:23:58 +010039
Michael Foord345266a2012-03-14 12:24:34 -070040
Xtreak7397cda2019-07-22 13:08:22 +053041def something(a): pass
42
43
Michael Foord345266a2012-03-14 12:24:34 -070044class MockTest(unittest.TestCase):
45
46 def test_all(self):
47 # if __all__ is badly defined then import * will raise an error
48 # We have to exec it because you can't import * inside a method
49 # in Python 3
Michael Foord83a16852012-03-14 12:58:46 -070050 exec("from unittest.mock import *")
Michael Foord345266a2012-03-14 12:24:34 -070051
52
53 def test_constructor(self):
54 mock = Mock()
55
56 self.assertFalse(mock.called, "called not initialised correctly")
57 self.assertEqual(mock.call_count, 0,
58 "call_count not initialised correctly")
59 self.assertTrue(is_instance(mock.return_value, Mock),
60 "return_value not initialised correctly")
61
62 self.assertEqual(mock.call_args, None,
63 "call_args not initialised correctly")
64 self.assertEqual(mock.call_args_list, [],
65 "call_args_list not initialised correctly")
66 self.assertEqual(mock.method_calls, [],
67 "method_calls not initialised correctly")
68
69 # Can't use hasattr for this test as it always returns True on a mock
Serhiy Storchaka5665bc52013-11-17 00:12:21 +020070 self.assertNotIn('_items', mock.__dict__,
Michael Foord345266a2012-03-14 12:24:34 -070071 "default mock should not have '_items' attribute")
72
73 self.assertIsNone(mock._mock_parent,
74 "parent not initialised correctly")
75 self.assertIsNone(mock._mock_methods,
76 "methods not initialised correctly")
77 self.assertEqual(mock._mock_children, {},
78 "children not initialised incorrectly")
79
80
81 def test_return_value_in_constructor(self):
82 mock = Mock(return_value=None)
83 self.assertIsNone(mock.return_value,
84 "return value in constructor not honoured")
85
86
Chris Withersadbf1782019-05-01 23:04:04 +010087 def test_change_return_value_via_delegate(self):
88 def f(): pass
89 mock = create_autospec(f)
90 mock.mock.return_value = 1
91 self.assertEqual(mock(), 1)
92
93
94 def test_change_side_effect_via_delegate(self):
95 def f(): pass
96 mock = create_autospec(f)
97 mock.mock.side_effect = TypeError()
98 with self.assertRaises(TypeError):
99 mock()
100
101
Michael Foord345266a2012-03-14 12:24:34 -0700102 def test_repr(self):
103 mock = Mock(name='foo')
104 self.assertIn('foo', repr(mock))
105 self.assertIn("'%s'" % id(mock), repr(mock))
106
107 mocks = [(Mock(), 'mock'), (Mock(name='bar'), 'bar')]
108 for mock, name in mocks:
109 self.assertIn('%s.bar' % name, repr(mock.bar))
110 self.assertIn('%s.foo()' % name, repr(mock.foo()))
111 self.assertIn('%s.foo().bing' % name, repr(mock.foo().bing))
112 self.assertIn('%s()' % name, repr(mock()))
113 self.assertIn('%s()()' % name, repr(mock()()))
114 self.assertIn('%s()().foo.bar.baz().bing' % name,
115 repr(mock()().foo.bar.baz().bing))
116
117
118 def test_repr_with_spec(self):
119 class X(object):
120 pass
121
122 mock = Mock(spec=X)
123 self.assertIn(" spec='X' ", repr(mock))
124
125 mock = Mock(spec=X())
126 self.assertIn(" spec='X' ", repr(mock))
127
128 mock = Mock(spec_set=X)
129 self.assertIn(" spec_set='X' ", repr(mock))
130
131 mock = Mock(spec_set=X())
132 self.assertIn(" spec_set='X' ", repr(mock))
133
134 mock = Mock(spec=X, name='foo')
135 self.assertIn(" spec='X' ", repr(mock))
136 self.assertIn(" name='foo' ", repr(mock))
137
138 mock = Mock(name='foo')
139 self.assertNotIn("spec", repr(mock))
140
141 mock = Mock()
142 self.assertNotIn("spec", repr(mock))
143
144 mock = Mock(spec=['foo'])
145 self.assertNotIn("spec", repr(mock))
146
147
148 def test_side_effect(self):
149 mock = Mock()
150
151 def effect(*args, **kwargs):
152 raise SystemError('kablooie')
153
154 mock.side_effect = effect
155 self.assertRaises(SystemError, mock, 1, 2, fish=3)
156 mock.assert_called_with(1, 2, fish=3)
157
158 results = [1, 2, 3]
159 def effect():
160 return results.pop()
161 mock.side_effect = effect
162
163 self.assertEqual([mock(), mock(), mock()], [3, 2, 1],
164 "side effect not used correctly")
165
166 mock = Mock(side_effect=sentinel.SideEffect)
167 self.assertEqual(mock.side_effect, sentinel.SideEffect,
168 "side effect in constructor not used")
169
170 def side_effect():
171 return DEFAULT
172 mock = Mock(side_effect=side_effect, return_value=sentinel.RETURN)
173 self.assertEqual(mock(), sentinel.RETURN)
174
Michael Foord01bafdc2014-04-14 16:09:42 -0400175 def test_autospec_side_effect(self):
176 # Test for issue17826
177 results = [1, 2, 3]
178 def effect():
179 return results.pop()
Chris Withersadbf1782019-05-01 23:04:04 +0100180 def f(): pass
Michael Foord01bafdc2014-04-14 16:09:42 -0400181
182 mock = create_autospec(f)
183 mock.side_effect = [1, 2, 3]
184 self.assertEqual([mock(), mock(), mock()], [1, 2, 3],
185 "side effect not used correctly in create_autospec")
186 # Test where side effect is a callable
187 results = [1, 2, 3]
188 mock = create_autospec(f)
189 mock.side_effect = effect
190 self.assertEqual([mock(), mock(), mock()], [3, 2, 1],
191 "callable side effect not used correctly")
Michael Foord345266a2012-03-14 12:24:34 -0700192
Robert Collinsf58f88c2015-07-14 13:51:40 +1200193 def test_autospec_side_effect_exception(self):
194 # Test for issue 23661
Chris Withersadbf1782019-05-01 23:04:04 +0100195 def f(): pass
Robert Collinsf58f88c2015-07-14 13:51:40 +1200196
197 mock = create_autospec(f)
198 mock.side_effect = ValueError('Bazinga!')
199 self.assertRaisesRegex(ValueError, 'Bazinga!', mock)
200
Michael Foord345266a2012-03-14 12:24:34 -0700201
202 def test_reset_mock(self):
203 parent = Mock()
204 spec = ["something"]
205 mock = Mock(name="child", parent=parent, spec=spec)
206 mock(sentinel.Something, something=sentinel.SomethingElse)
207 something = mock.something
208 mock.something()
209 mock.side_effect = sentinel.SideEffect
210 return_value = mock.return_value
211 return_value()
212
213 mock.reset_mock()
214
215 self.assertEqual(mock._mock_name, "child",
216 "name incorrectly reset")
217 self.assertEqual(mock._mock_parent, parent,
218 "parent incorrectly reset")
219 self.assertEqual(mock._mock_methods, spec,
220 "methods incorrectly reset")
221
222 self.assertFalse(mock.called, "called not reset")
223 self.assertEqual(mock.call_count, 0, "call_count not reset")
224 self.assertEqual(mock.call_args, None, "call_args not reset")
225 self.assertEqual(mock.call_args_list, [], "call_args_list not reset")
226 self.assertEqual(mock.method_calls, [],
227 "method_calls not initialised correctly: %r != %r" %
228 (mock.method_calls, []))
229 self.assertEqual(mock.mock_calls, [])
230
231 self.assertEqual(mock.side_effect, sentinel.SideEffect,
232 "side_effect incorrectly reset")
233 self.assertEqual(mock.return_value, return_value,
234 "return_value incorrectly reset")
235 self.assertFalse(return_value.called, "return value mock not reset")
236 self.assertEqual(mock._mock_children, {'something': something},
237 "children reset incorrectly")
238 self.assertEqual(mock.something, something,
239 "children incorrectly cleared")
240 self.assertFalse(mock.something.called, "child not reset")
241
242
243 def test_reset_mock_recursion(self):
244 mock = Mock()
245 mock.return_value = mock
246
247 # used to cause recursion
248 mock.reset_mock()
249
Robert Collinsb37f43f2015-07-15 11:42:28 +1200250 def test_reset_mock_on_mock_open_issue_18622(self):
251 a = mock.mock_open()
252 a.reset_mock()
Michael Foord345266a2012-03-14 12:24:34 -0700253
254 def test_call(self):
255 mock = Mock()
256 self.assertTrue(is_instance(mock.return_value, Mock),
257 "Default return_value should be a Mock")
258
259 result = mock()
260 self.assertEqual(mock(), result,
261 "different result from consecutive calls")
262 mock.reset_mock()
263
264 ret_val = mock(sentinel.Arg)
265 self.assertTrue(mock.called, "called not set")
Min ho Kimc4cacc82019-07-31 08:16:13 +1000266 self.assertEqual(mock.call_count, 1, "call_count incorrect")
Michael Foord345266a2012-03-14 12:24:34 -0700267 self.assertEqual(mock.call_args, ((sentinel.Arg,), {}),
268 "call_args not set")
Kumar Akshayb0df45e2019-03-22 13:40:40 +0530269 self.assertEqual(mock.call_args.args, (sentinel.Arg,),
270 "call_args not set")
271 self.assertEqual(mock.call_args.kwargs, {},
272 "call_args not set")
Michael Foord345266a2012-03-14 12:24:34 -0700273 self.assertEqual(mock.call_args_list, [((sentinel.Arg,), {})],
274 "call_args_list not initialised correctly")
275
276 mock.return_value = sentinel.ReturnValue
277 ret_val = mock(sentinel.Arg, key=sentinel.KeyArg)
278 self.assertEqual(ret_val, sentinel.ReturnValue,
279 "incorrect return value")
280
281 self.assertEqual(mock.call_count, 2, "call_count incorrect")
282 self.assertEqual(mock.call_args,
283 ((sentinel.Arg,), {'key': sentinel.KeyArg}),
284 "call_args not set")
285 self.assertEqual(mock.call_args_list, [
286 ((sentinel.Arg,), {}),
287 ((sentinel.Arg,), {'key': sentinel.KeyArg})
288 ],
289 "call_args_list not set")
290
291
292 def test_call_args_comparison(self):
293 mock = Mock()
294 mock()
295 mock(sentinel.Arg)
296 mock(kw=sentinel.Kwarg)
297 mock(sentinel.Arg, kw=sentinel.Kwarg)
298 self.assertEqual(mock.call_args_list, [
299 (),
300 ((sentinel.Arg,),),
301 ({"kw": sentinel.Kwarg},),
302 ((sentinel.Arg,), {"kw": sentinel.Kwarg})
303 ])
304 self.assertEqual(mock.call_args,
305 ((sentinel.Arg,), {"kw": sentinel.Kwarg}))
Kumar Akshayb0df45e2019-03-22 13:40:40 +0530306 self.assertEqual(mock.call_args.args, (sentinel.Arg,))
307 self.assertEqual(mock.call_args.kwargs, {"kw": sentinel.Kwarg})
Michael Foord345266a2012-03-14 12:24:34 -0700308
Berker Peksag3fc536f2015-09-09 23:35:25 +0300309 # Comparing call_args to a long sequence should not raise
310 # an exception. See issue 24857.
311 self.assertFalse(mock.call_args == "a long sequence")
Michael Foord345266a2012-03-14 12:24:34 -0700312
Berker Peksagce913872016-03-28 00:30:02 +0300313
314 def test_calls_equal_with_any(self):
Berker Peksagce913872016-03-28 00:30:02 +0300315 # Check that equality and non-equality is consistent even when
316 # comparing with mock.ANY
Serhiy Storchaka362f0582017-01-21 23:12:58 +0200317 mm = mock.MagicMock()
318 self.assertTrue(mm == mm)
319 self.assertFalse(mm != mm)
320 self.assertFalse(mm == mock.MagicMock())
321 self.assertTrue(mm != mock.MagicMock())
322 self.assertTrue(mm == mock.ANY)
323 self.assertFalse(mm != mock.ANY)
324 self.assertTrue(mock.ANY == mm)
325 self.assertFalse(mock.ANY != mm)
Serhiy Storchaka662db122019-08-08 08:42:54 +0300326 self.assertTrue(mm == ALWAYS_EQ)
327 self.assertFalse(mm != ALWAYS_EQ)
Serhiy Storchaka362f0582017-01-21 23:12:58 +0200328
329 call1 = mock.call(mock.MagicMock())
330 call2 = mock.call(mock.ANY)
Berker Peksagce913872016-03-28 00:30:02 +0300331 self.assertTrue(call1 == call2)
332 self.assertFalse(call1 != call2)
Serhiy Storchaka362f0582017-01-21 23:12:58 +0200333 self.assertTrue(call2 == call1)
334 self.assertFalse(call2 != call1)
Berker Peksagce913872016-03-28 00:30:02 +0300335
Serhiy Storchaka662db122019-08-08 08:42:54 +0300336 self.assertTrue(call1 == ALWAYS_EQ)
337 self.assertFalse(call1 != ALWAYS_EQ)
338 self.assertFalse(call1 == 1)
339 self.assertTrue(call1 != 1)
340
Berker Peksagce913872016-03-28 00:30:02 +0300341
Michael Foord345266a2012-03-14 12:24:34 -0700342 def test_assert_called_with(self):
343 mock = Mock()
344 mock()
345
346 # Will raise an exception if it fails
347 mock.assert_called_with()
348 self.assertRaises(AssertionError, mock.assert_called_with, 1)
349
350 mock.reset_mock()
351 self.assertRaises(AssertionError, mock.assert_called_with)
352
353 mock(1, 2, 3, a='fish', b='nothing')
354 mock.assert_called_with(1, 2, 3, a='fish', b='nothing')
355
356
Berker Peksagce913872016-03-28 00:30:02 +0300357 def test_assert_called_with_any(self):
358 m = MagicMock()
359 m(MagicMock())
360 m.assert_called_with(mock.ANY)
361
362
Antoine Pitrou5c64df72013-02-03 00:23:58 +0100363 def test_assert_called_with_function_spec(self):
Chris Withersadbf1782019-05-01 23:04:04 +0100364 def f(a, b, c, d=None): pass
Antoine Pitrou5c64df72013-02-03 00:23:58 +0100365
366 mock = Mock(spec=f)
367
368 mock(1, b=2, c=3)
369 mock.assert_called_with(1, 2, 3)
370 mock.assert_called_with(a=1, b=2, c=3)
371 self.assertRaises(AssertionError, mock.assert_called_with,
372 1, b=3, c=2)
373 # Expected call doesn't match the spec's signature
374 with self.assertRaises(AssertionError) as cm:
375 mock.assert_called_with(e=8)
376 self.assertIsInstance(cm.exception.__cause__, TypeError)
377
378
379 def test_assert_called_with_method_spec(self):
380 def _check(mock):
381 mock(1, b=2, c=3)
382 mock.assert_called_with(1, 2, 3)
383 mock.assert_called_with(a=1, b=2, c=3)
384 self.assertRaises(AssertionError, mock.assert_called_with,
385 1, b=3, c=2)
386
387 mock = Mock(spec=Something().meth)
388 _check(mock)
389 mock = Mock(spec=Something.cmeth)
390 _check(mock)
391 mock = Mock(spec=Something().cmeth)
392 _check(mock)
393 mock = Mock(spec=Something.smeth)
394 _check(mock)
395 mock = Mock(spec=Something().smeth)
396 _check(mock)
397
398
Abraham Toriz Cruz5f5f11f2019-09-17 06:16:08 -0500399 def test_assert_called_exception_message(self):
400 msg = "Expected '{0}' to have been called"
401 with self.assertRaisesRegex(AssertionError, msg.format('mock')):
402 Mock().assert_called()
403 with self.assertRaisesRegex(AssertionError, msg.format('test_name')):
404 Mock(name="test_name").assert_called()
405
406
Michael Foord345266a2012-03-14 12:24:34 -0700407 def test_assert_called_once_with(self):
408 mock = Mock()
409 mock()
410
411 # Will raise an exception if it fails
412 mock.assert_called_once_with()
413
414 mock()
415 self.assertRaises(AssertionError, mock.assert_called_once_with)
416
417 mock.reset_mock()
418 self.assertRaises(AssertionError, mock.assert_called_once_with)
419
420 mock('foo', 'bar', baz=2)
421 mock.assert_called_once_with('foo', 'bar', baz=2)
422
423 mock.reset_mock()
424 mock('foo', 'bar', baz=2)
425 self.assertRaises(
426 AssertionError,
427 lambda: mock.assert_called_once_with('bob', 'bar', baz=2)
428 )
429
Petter Strandmark47d94242018-10-28 21:37:10 +0100430 def test_assert_called_once_with_call_list(self):
431 m = Mock()
432 m(1)
433 m(2)
434 self.assertRaisesRegex(AssertionError,
435 re.escape("Calls: [call(1), call(2)]"),
436 lambda: m.assert_called_once_with(2))
437
Michael Foord345266a2012-03-14 12:24:34 -0700438
Antoine Pitrou5c64df72013-02-03 00:23:58 +0100439 def test_assert_called_once_with_function_spec(self):
Chris Withersadbf1782019-05-01 23:04:04 +0100440 def f(a, b, c, d=None): pass
Antoine Pitrou5c64df72013-02-03 00:23:58 +0100441
442 mock = Mock(spec=f)
443
444 mock(1, b=2, c=3)
445 mock.assert_called_once_with(1, 2, 3)
446 mock.assert_called_once_with(a=1, b=2, c=3)
447 self.assertRaises(AssertionError, mock.assert_called_once_with,
448 1, b=3, c=2)
449 # Expected call doesn't match the spec's signature
450 with self.assertRaises(AssertionError) as cm:
451 mock.assert_called_once_with(e=8)
452 self.assertIsInstance(cm.exception.__cause__, TypeError)
453 # Mock called more than once => always fails
454 mock(4, 5, 6)
455 self.assertRaises(AssertionError, mock.assert_called_once_with,
456 1, 2, 3)
457 self.assertRaises(AssertionError, mock.assert_called_once_with,
458 4, 5, 6)
459
460
Michael Foord345266a2012-03-14 12:24:34 -0700461 def test_attribute_access_returns_mocks(self):
462 mock = Mock()
463 something = mock.something
464 self.assertTrue(is_instance(something, Mock), "attribute isn't a mock")
465 self.assertEqual(mock.something, something,
466 "different attributes returned for same name")
467
468 # Usage example
469 mock = Mock()
470 mock.something.return_value = 3
471
472 self.assertEqual(mock.something(), 3, "method returned wrong value")
473 self.assertTrue(mock.something.called,
474 "method didn't record being called")
475
476
477 def test_attributes_have_name_and_parent_set(self):
478 mock = Mock()
479 something = mock.something
480
481 self.assertEqual(something._mock_name, "something",
482 "attribute name not set correctly")
483 self.assertEqual(something._mock_parent, mock,
484 "attribute parent not set correctly")
485
486
487 def test_method_calls_recorded(self):
488 mock = Mock()
489 mock.something(3, fish=None)
490 mock.something_else.something(6, cake=sentinel.Cake)
491
492 self.assertEqual(mock.something_else.method_calls,
493 [("something", (6,), {'cake': sentinel.Cake})],
494 "method calls not recorded correctly")
495 self.assertEqual(mock.method_calls, [
496 ("something", (3,), {'fish': None}),
497 ("something_else.something", (6,), {'cake': sentinel.Cake})
498 ],
499 "method calls not recorded correctly")
500
501
502 def test_method_calls_compare_easily(self):
503 mock = Mock()
504 mock.something()
505 self.assertEqual(mock.method_calls, [('something',)])
506 self.assertEqual(mock.method_calls, [('something', (), {})])
507
508 mock = Mock()
509 mock.something('different')
510 self.assertEqual(mock.method_calls, [('something', ('different',))])
511 self.assertEqual(mock.method_calls,
512 [('something', ('different',), {})])
513
514 mock = Mock()
515 mock.something(x=1)
516 self.assertEqual(mock.method_calls, [('something', {'x': 1})])
517 self.assertEqual(mock.method_calls, [('something', (), {'x': 1})])
518
519 mock = Mock()
520 mock.something('different', some='more')
521 self.assertEqual(mock.method_calls, [
522 ('something', ('different',), {'some': 'more'})
523 ])
524
525
526 def test_only_allowed_methods_exist(self):
527 for spec in ['something'], ('something',):
528 for arg in 'spec', 'spec_set':
529 mock = Mock(**{arg: spec})
530
531 # this should be allowed
532 mock.something
533 self.assertRaisesRegex(
534 AttributeError,
535 "Mock object has no attribute 'something_else'",
536 getattr, mock, 'something_else'
537 )
538
539
540 def test_from_spec(self):
541 class Something(object):
542 x = 3
543 __something__ = None
Chris Withersadbf1782019-05-01 23:04:04 +0100544 def y(self): pass
Michael Foord345266a2012-03-14 12:24:34 -0700545
546 def test_attributes(mock):
547 # should work
548 mock.x
549 mock.y
550 mock.__something__
551 self.assertRaisesRegex(
552 AttributeError,
553 "Mock object has no attribute 'z'",
554 getattr, mock, 'z'
555 )
556 self.assertRaisesRegex(
557 AttributeError,
558 "Mock object has no attribute '__foobar__'",
559 getattr, mock, '__foobar__'
560 )
561
562 test_attributes(Mock(spec=Something))
563 test_attributes(Mock(spec=Something()))
564
565
566 def test_wraps_calls(self):
567 real = Mock()
568
569 mock = Mock(wraps=real)
570 self.assertEqual(mock(), real())
571
572 real.reset_mock()
573
574 mock(1, 2, fish=3)
575 real.assert_called_with(1, 2, fish=3)
576
577
Mario Corcherof05df0a2018-12-08 11:25:02 +0000578 def test_wraps_prevents_automatic_creation_of_mocks(self):
579 class Real(object):
580 pass
581
582 real = Real()
583 mock = Mock(wraps=real)
584
585 self.assertRaises(AttributeError, lambda: mock.new_attr())
586
587
Michael Foord345266a2012-03-14 12:24:34 -0700588 def test_wraps_call_with_nondefault_return_value(self):
589 real = Mock()
590
591 mock = Mock(wraps=real)
592 mock.return_value = 3
593
594 self.assertEqual(mock(), 3)
595 self.assertFalse(real.called)
596
597
598 def test_wraps_attributes(self):
599 class Real(object):
600 attribute = Mock()
601
602 real = Real()
603
604 mock = Mock(wraps=real)
605 self.assertEqual(mock.attribute(), real.attribute())
606 self.assertRaises(AttributeError, lambda: mock.fish)
607
608 self.assertNotEqual(mock.attribute, real.attribute)
609 result = mock.attribute.frog(1, 2, fish=3)
610 Real.attribute.frog.assert_called_with(1, 2, fish=3)
611 self.assertEqual(result, Real.attribute.frog())
612
613
Mario Corcherof05df0a2018-12-08 11:25:02 +0000614 def test_customize_wrapped_object_with_side_effect_iterable_with_default(self):
615 class Real(object):
616 def method(self):
617 return sentinel.ORIGINAL_VALUE
618
619 real = Real()
620 mock = Mock(wraps=real)
621 mock.method.side_effect = [sentinel.VALUE1, DEFAULT]
622
623 self.assertEqual(mock.method(), sentinel.VALUE1)
624 self.assertEqual(mock.method(), sentinel.ORIGINAL_VALUE)
625 self.assertRaises(StopIteration, mock.method)
626
627
628 def test_customize_wrapped_object_with_side_effect_iterable(self):
629 class Real(object):
Chris Withersadbf1782019-05-01 23:04:04 +0100630 def method(self): pass
Mario Corcherof05df0a2018-12-08 11:25:02 +0000631
632 real = Real()
633 mock = Mock(wraps=real)
634 mock.method.side_effect = [sentinel.VALUE1, sentinel.VALUE2]
635
636 self.assertEqual(mock.method(), sentinel.VALUE1)
637 self.assertEqual(mock.method(), sentinel.VALUE2)
638 self.assertRaises(StopIteration, mock.method)
639
640
641 def test_customize_wrapped_object_with_side_effect_exception(self):
642 class Real(object):
Chris Withersadbf1782019-05-01 23:04:04 +0100643 def method(self): pass
Mario Corcherof05df0a2018-12-08 11:25:02 +0000644
645 real = Real()
646 mock = Mock(wraps=real)
647 mock.method.side_effect = RuntimeError
648
649 self.assertRaises(RuntimeError, mock.method)
650
651
652 def test_customize_wrapped_object_with_side_effect_function(self):
653 class Real(object):
Chris Withersadbf1782019-05-01 23:04:04 +0100654 def method(self): pass
Mario Corcherof05df0a2018-12-08 11:25:02 +0000655 def side_effect():
656 return sentinel.VALUE
657
658 real = Real()
659 mock = Mock(wraps=real)
660 mock.method.side_effect = side_effect
661
662 self.assertEqual(mock.method(), sentinel.VALUE)
663
664
665 def test_customize_wrapped_object_with_return_value(self):
666 class Real(object):
Chris Withersadbf1782019-05-01 23:04:04 +0100667 def method(self): pass
Mario Corcherof05df0a2018-12-08 11:25:02 +0000668
669 real = Real()
670 mock = Mock(wraps=real)
671 mock.method.return_value = sentinel.VALUE
672
673 self.assertEqual(mock.method(), sentinel.VALUE)
674
675
676 def test_customize_wrapped_object_with_return_value_and_side_effect(self):
677 # side_effect should always take precedence over return_value.
678 class Real(object):
Chris Withersadbf1782019-05-01 23:04:04 +0100679 def method(self): pass
Mario Corcherof05df0a2018-12-08 11:25:02 +0000680
681 real = Real()
682 mock = Mock(wraps=real)
683 mock.method.side_effect = [sentinel.VALUE1, sentinel.VALUE2]
684 mock.method.return_value = sentinel.WRONG_VALUE
685
686 self.assertEqual(mock.method(), sentinel.VALUE1)
687 self.assertEqual(mock.method(), sentinel.VALUE2)
688 self.assertRaises(StopIteration, mock.method)
689
690
691 def test_customize_wrapped_object_with_return_value_and_side_effect2(self):
692 # side_effect can return DEFAULT to default to return_value
693 class Real(object):
Chris Withersadbf1782019-05-01 23:04:04 +0100694 def method(self): pass
Mario Corcherof05df0a2018-12-08 11:25:02 +0000695
696 real = Real()
697 mock = Mock(wraps=real)
698 mock.method.side_effect = lambda: DEFAULT
699 mock.method.return_value = sentinel.VALUE
700
701 self.assertEqual(mock.method(), sentinel.VALUE)
702
703
704 def test_customize_wrapped_object_with_return_value_and_side_effect_default(self):
705 class Real(object):
Chris Withersadbf1782019-05-01 23:04:04 +0100706 def method(self): pass
Mario Corcherof05df0a2018-12-08 11:25:02 +0000707
708 real = Real()
709 mock = Mock(wraps=real)
710 mock.method.side_effect = [sentinel.VALUE1, DEFAULT]
711 mock.method.return_value = sentinel.RETURN
712
713 self.assertEqual(mock.method(), sentinel.VALUE1)
714 self.assertEqual(mock.method(), sentinel.RETURN)
715 self.assertRaises(StopIteration, mock.method)
716
717
Michael Foord345266a2012-03-14 12:24:34 -0700718 def test_exceptional_side_effect(self):
719 mock = Mock(side_effect=AttributeError)
720 self.assertRaises(AttributeError, mock)
721
722 mock = Mock(side_effect=AttributeError('foo'))
723 self.assertRaises(AttributeError, mock)
724
725
726 def test_baseexceptional_side_effect(self):
727 mock = Mock(side_effect=KeyboardInterrupt)
728 self.assertRaises(KeyboardInterrupt, mock)
729
730 mock = Mock(side_effect=KeyboardInterrupt('foo'))
731 self.assertRaises(KeyboardInterrupt, mock)
732
733
734 def test_assert_called_with_message(self):
735 mock = Mock()
Susan Su2bdd5852019-02-13 18:22:29 -0800736 self.assertRaisesRegex(AssertionError, 'not called',
Michael Foord345266a2012-03-14 12:24:34 -0700737 mock.assert_called_with)
738
739
Michael Foord28d591c2012-09-28 16:15:22 +0100740 def test_assert_called_once_with_message(self):
741 mock = Mock(name='geoffrey')
742 self.assertRaisesRegex(AssertionError,
743 r"Expected 'geoffrey' to be called once\.",
744 mock.assert_called_once_with)
745
746
Michael Foord345266a2012-03-14 12:24:34 -0700747 def test__name__(self):
748 mock = Mock()
749 self.assertRaises(AttributeError, lambda: mock.__name__)
750
751 mock.__name__ = 'foo'
752 self.assertEqual(mock.__name__, 'foo')
753
754
755 def test_spec_list_subclass(self):
756 class Sub(list):
757 pass
758 mock = Mock(spec=Sub(['foo']))
759
760 mock.append(3)
761 mock.append.assert_called_with(3)
762 self.assertRaises(AttributeError, getattr, mock, 'foo')
763
764
765 def test_spec_class(self):
766 class X(object):
767 pass
768
769 mock = Mock(spec=X)
Serhiy Storchaka5665bc52013-11-17 00:12:21 +0200770 self.assertIsInstance(mock, X)
Michael Foord345266a2012-03-14 12:24:34 -0700771
772 mock = Mock(spec=X())
Serhiy Storchaka5665bc52013-11-17 00:12:21 +0200773 self.assertIsInstance(mock, X)
Michael Foord345266a2012-03-14 12:24:34 -0700774
775 self.assertIs(mock.__class__, X)
776 self.assertEqual(Mock().__class__.__name__, 'Mock')
777
778 mock = Mock(spec_set=X)
Serhiy Storchaka5665bc52013-11-17 00:12:21 +0200779 self.assertIsInstance(mock, X)
Michael Foord345266a2012-03-14 12:24:34 -0700780
781 mock = Mock(spec_set=X())
Serhiy Storchaka5665bc52013-11-17 00:12:21 +0200782 self.assertIsInstance(mock, X)
Michael Foord345266a2012-03-14 12:24:34 -0700783
784
Chris Withersadbf1782019-05-01 23:04:04 +0100785 def test_spec_class_no_object_base(self):
786 class X:
787 pass
788
789 mock = Mock(spec=X)
790 self.assertIsInstance(mock, X)
791
792 mock = Mock(spec=X())
793 self.assertIsInstance(mock, X)
794
795 self.assertIs(mock.__class__, X)
796 self.assertEqual(Mock().__class__.__name__, 'Mock')
797
798 mock = Mock(spec_set=X)
799 self.assertIsInstance(mock, X)
800
801 mock = Mock(spec_set=X())
802 self.assertIsInstance(mock, X)
803
804
Michael Foord345266a2012-03-14 12:24:34 -0700805 def test_setting_attribute_with_spec_set(self):
806 class X(object):
807 y = 3
808
809 mock = Mock(spec=X)
810 mock.x = 'foo'
811
812 mock = Mock(spec_set=X)
813 def set_attr():
814 mock.x = 'foo'
815
816 mock.y = 'foo'
817 self.assertRaises(AttributeError, set_attr)
818
819
820 def test_copy(self):
821 current = sys.getrecursionlimit()
822 self.addCleanup(sys.setrecursionlimit, current)
823
824 # can't use sys.maxint as this doesn't exist in Python 3
825 sys.setrecursionlimit(int(10e8))
826 # this segfaults without the fix in place
827 copy.copy(Mock())
828
829
830 def test_subclass_with_properties(self):
831 class SubClass(Mock):
832 def _get(self):
833 return 3
834 def _set(self, value):
835 raise NameError('strange error')
836 some_attribute = property(_get, _set)
837
838 s = SubClass(spec_set=SubClass)
839 self.assertEqual(s.some_attribute, 3)
840
841 def test():
842 s.some_attribute = 3
843 self.assertRaises(NameError, test)
844
845 def test():
846 s.foo = 'bar'
847 self.assertRaises(AttributeError, test)
848
849
850 def test_setting_call(self):
851 mock = Mock()
852 def __call__(self, a):
853 return self._mock_call(a)
854
855 type(mock).__call__ = __call__
856 mock('one')
857 mock.assert_called_with('one')
858
859 self.assertRaises(TypeError, mock, 'one', 'two')
860
861
862 def test_dir(self):
863 mock = Mock()
864 attrs = set(dir(mock))
865 type_attrs = set([m for m in dir(Mock) if not m.startswith('_')])
866
867 # all public attributes from the type are included
868 self.assertEqual(set(), type_attrs - attrs)
869
870 # creates these attributes
871 mock.a, mock.b
872 self.assertIn('a', dir(mock))
873 self.assertIn('b', dir(mock))
874
875 # instance attributes
876 mock.c = mock.d = None
877 self.assertIn('c', dir(mock))
878 self.assertIn('d', dir(mock))
879
880 # magic methods
881 mock.__iter__ = lambda s: iter([])
882 self.assertIn('__iter__', dir(mock))
883
884
885 def test_dir_from_spec(self):
886 mock = Mock(spec=unittest.TestCase)
887 testcase_attrs = set(dir(unittest.TestCase))
888 attrs = set(dir(mock))
889
890 # all attributes from the spec are included
891 self.assertEqual(set(), testcase_attrs - attrs)
892
893 # shadow a sys attribute
894 mock.version = 3
895 self.assertEqual(dir(mock).count('version'), 1)
896
897
898 def test_filter_dir(self):
899 patcher = patch.object(mock, 'FILTER_DIR', False)
900 patcher.start()
901 try:
902 attrs = set(dir(Mock()))
903 type_attrs = set(dir(Mock))
904
905 # ALL attributes from the type are included
906 self.assertEqual(set(), type_attrs - attrs)
907 finally:
908 patcher.stop()
909
910
Mario Corchero0df635c2019-04-30 19:56:36 +0100911 def test_dir_does_not_include_deleted_attributes(self):
912 mock = Mock()
913 mock.child.return_value = 1
914
915 self.assertIn('child', dir(mock))
916 del mock.child
917 self.assertNotIn('child', dir(mock))
918
919
Michael Foord345266a2012-03-14 12:24:34 -0700920 def test_configure_mock(self):
921 mock = Mock(foo='bar')
922 self.assertEqual(mock.foo, 'bar')
923
924 mock = MagicMock(foo='bar')
925 self.assertEqual(mock.foo, 'bar')
926
927 kwargs = {'side_effect': KeyError, 'foo.bar.return_value': 33,
928 'foo': MagicMock()}
929 mock = Mock(**kwargs)
930 self.assertRaises(KeyError, mock)
931 self.assertEqual(mock.foo.bar(), 33)
932 self.assertIsInstance(mock.foo, MagicMock)
933
934 mock = Mock()
935 mock.configure_mock(**kwargs)
936 self.assertRaises(KeyError, mock)
937 self.assertEqual(mock.foo.bar(), 33)
938 self.assertIsInstance(mock.foo, MagicMock)
939
940
941 def assertRaisesWithMsg(self, exception, message, func, *args, **kwargs):
942 # needed because assertRaisesRegex doesn't work easily with newlines
Chris Withersadbf1782019-05-01 23:04:04 +0100943 with self.assertRaises(exception) as context:
Michael Foord345266a2012-03-14 12:24:34 -0700944 func(*args, **kwargs)
Chris Withersadbf1782019-05-01 23:04:04 +0100945 msg = str(context.exception)
Michael Foord345266a2012-03-14 12:24:34 -0700946 self.assertEqual(msg, message)
947
948
949 def test_assert_called_with_failure_message(self):
950 mock = NonCallableMock()
951
Susan Su2bdd5852019-02-13 18:22:29 -0800952 actual = 'not called.'
Michael Foord345266a2012-03-14 12:24:34 -0700953 expected = "mock(1, '2', 3, bar='foo')"
Susan Su2bdd5852019-02-13 18:22:29 -0800954 message = 'expected call not found.\nExpected: %s\nActual: %s'
Michael Foord345266a2012-03-14 12:24:34 -0700955 self.assertRaisesWithMsg(
Susan Su2bdd5852019-02-13 18:22:29 -0800956 AssertionError, message % (expected, actual),
Michael Foord345266a2012-03-14 12:24:34 -0700957 mock.assert_called_with, 1, '2', 3, bar='foo'
958 )
959
960 mock.foo(1, '2', 3, foo='foo')
961
962
963 asserters = [
964 mock.foo.assert_called_with, mock.foo.assert_called_once_with
965 ]
966 for meth in asserters:
967 actual = "foo(1, '2', 3, foo='foo')"
968 expected = "foo(1, '2', 3, bar='foo')"
Susan Su2bdd5852019-02-13 18:22:29 -0800969 message = 'expected call not found.\nExpected: %s\nActual: %s'
Michael Foord345266a2012-03-14 12:24:34 -0700970 self.assertRaisesWithMsg(
971 AssertionError, message % (expected, actual),
972 meth, 1, '2', 3, bar='foo'
973 )
974
975 # just kwargs
976 for meth in asserters:
977 actual = "foo(1, '2', 3, foo='foo')"
978 expected = "foo(bar='foo')"
Susan Su2bdd5852019-02-13 18:22:29 -0800979 message = 'expected call not found.\nExpected: %s\nActual: %s'
Michael Foord345266a2012-03-14 12:24:34 -0700980 self.assertRaisesWithMsg(
981 AssertionError, message % (expected, actual),
982 meth, bar='foo'
983 )
984
985 # just args
986 for meth in asserters:
987 actual = "foo(1, '2', 3, foo='foo')"
988 expected = "foo(1, 2, 3)"
Susan Su2bdd5852019-02-13 18:22:29 -0800989 message = 'expected call not found.\nExpected: %s\nActual: %s'
Michael Foord345266a2012-03-14 12:24:34 -0700990 self.assertRaisesWithMsg(
991 AssertionError, message % (expected, actual),
992 meth, 1, 2, 3
993 )
994
995 # empty
996 for meth in asserters:
997 actual = "foo(1, '2', 3, foo='foo')"
998 expected = "foo()"
Susan Su2bdd5852019-02-13 18:22:29 -0800999 message = 'expected call not found.\nExpected: %s\nActual: %s'
Michael Foord345266a2012-03-14 12:24:34 -07001000 self.assertRaisesWithMsg(
1001 AssertionError, message % (expected, actual), meth
1002 )
1003
1004
1005 def test_mock_calls(self):
1006 mock = MagicMock()
1007
1008 # need to do this because MagicMock.mock_calls used to just return
1009 # a MagicMock which also returned a MagicMock when __eq__ was called
1010 self.assertIs(mock.mock_calls == [], True)
1011
1012 mock = MagicMock()
1013 mock()
1014 expected = [('', (), {})]
1015 self.assertEqual(mock.mock_calls, expected)
1016
1017 mock.foo()
1018 expected.append(call.foo())
1019 self.assertEqual(mock.mock_calls, expected)
1020 # intermediate mock_calls work too
1021 self.assertEqual(mock.foo.mock_calls, [('', (), {})])
1022
1023 mock = MagicMock()
1024 mock().foo(1, 2, 3, a=4, b=5)
1025 expected = [
1026 ('', (), {}), ('().foo', (1, 2, 3), dict(a=4, b=5))
1027 ]
1028 self.assertEqual(mock.mock_calls, expected)
1029 self.assertEqual(mock.return_value.foo.mock_calls,
1030 [('', (1, 2, 3), dict(a=4, b=5))])
1031 self.assertEqual(mock.return_value.mock_calls,
1032 [('foo', (1, 2, 3), dict(a=4, b=5))])
1033
1034 mock = MagicMock()
1035 mock().foo.bar().baz()
1036 expected = [
1037 ('', (), {}), ('().foo.bar', (), {}),
1038 ('().foo.bar().baz', (), {})
1039 ]
1040 self.assertEqual(mock.mock_calls, expected)
1041 self.assertEqual(mock().mock_calls,
1042 call.foo.bar().baz().call_list())
1043
1044 for kwargs in dict(), dict(name='bar'):
1045 mock = MagicMock(**kwargs)
1046 int(mock.foo)
1047 expected = [('foo.__int__', (), {})]
1048 self.assertEqual(mock.mock_calls, expected)
1049
1050 mock = MagicMock(**kwargs)
1051 mock.a()()
1052 expected = [('a', (), {}), ('a()', (), {})]
1053 self.assertEqual(mock.mock_calls, expected)
1054 self.assertEqual(mock.a().mock_calls, [call()])
1055
1056 mock = MagicMock(**kwargs)
1057 mock(1)(2)(3)
1058 self.assertEqual(mock.mock_calls, call(1)(2)(3).call_list())
1059 self.assertEqual(mock().mock_calls, call(2)(3).call_list())
1060 self.assertEqual(mock()().mock_calls, call(3).call_list())
1061
1062 mock = MagicMock(**kwargs)
1063 mock(1)(2)(3).a.b.c(4)
1064 self.assertEqual(mock.mock_calls,
1065 call(1)(2)(3).a.b.c(4).call_list())
1066 self.assertEqual(mock().mock_calls,
1067 call(2)(3).a.b.c(4).call_list())
1068 self.assertEqual(mock()().mock_calls,
1069 call(3).a.b.c(4).call_list())
1070
1071 mock = MagicMock(**kwargs)
1072 int(mock().foo.bar().baz())
1073 last_call = ('().foo.bar().baz().__int__', (), {})
1074 self.assertEqual(mock.mock_calls[-1], last_call)
1075 self.assertEqual(mock().mock_calls,
1076 call.foo.bar().baz().__int__().call_list())
1077 self.assertEqual(mock().foo.bar().mock_calls,
1078 call.baz().__int__().call_list())
1079 self.assertEqual(mock().foo.bar().baz.mock_calls,
1080 call().__int__().call_list())
1081
1082
Chris Withers8ca0fa92018-12-03 21:31:37 +00001083 def test_child_mock_call_equal(self):
1084 m = Mock()
1085 result = m()
1086 result.wibble()
1087 # parent looks like this:
1088 self.assertEqual(m.mock_calls, [call(), call().wibble()])
1089 # but child should look like this:
1090 self.assertEqual(result.mock_calls, [call.wibble()])
1091
1092
1093 def test_mock_call_not_equal_leaf(self):
1094 m = Mock()
1095 m.foo().something()
1096 self.assertNotEqual(m.mock_calls[1], call.foo().different())
1097 self.assertEqual(m.mock_calls[0], call.foo())
1098
1099
1100 def test_mock_call_not_equal_non_leaf(self):
1101 m = Mock()
1102 m.foo().bar()
1103 self.assertNotEqual(m.mock_calls[1], call.baz().bar())
1104 self.assertNotEqual(m.mock_calls[0], call.baz())
1105
1106
1107 def test_mock_call_not_equal_non_leaf_params_different(self):
1108 m = Mock()
1109 m.foo(x=1).bar()
1110 # This isn't ideal, but there's no way to fix it without breaking backwards compatibility:
1111 self.assertEqual(m.mock_calls[1], call.foo(x=2).bar())
1112
1113
1114 def test_mock_call_not_equal_non_leaf_attr(self):
1115 m = Mock()
1116 m.foo.bar()
1117 self.assertNotEqual(m.mock_calls[0], call.baz.bar())
1118
1119
1120 def test_mock_call_not_equal_non_leaf_call_versus_attr(self):
1121 m = Mock()
1122 m.foo.bar()
1123 self.assertNotEqual(m.mock_calls[0], call.foo().bar())
1124
1125
1126 def test_mock_call_repr(self):
1127 m = Mock()
1128 m.foo().bar().baz.bob()
1129 self.assertEqual(repr(m.mock_calls[0]), 'call.foo()')
1130 self.assertEqual(repr(m.mock_calls[1]), 'call.foo().bar()')
1131 self.assertEqual(repr(m.mock_calls[2]), 'call.foo().bar().baz.bob()')
1132
1133
Chris Withersadbf1782019-05-01 23:04:04 +01001134 def test_mock_call_repr_loop(self):
1135 m = Mock()
1136 m.foo = m
1137 repr(m.foo())
1138 self.assertRegex(repr(m.foo()), r"<Mock name='mock\(\)' id='\d+'>")
1139
1140
1141 def test_mock_calls_contains(self):
1142 m = Mock()
1143 self.assertFalse([call()] in m.mock_calls)
1144
1145
Michael Foord345266a2012-03-14 12:24:34 -07001146 def test_subclassing(self):
1147 class Subclass(Mock):
1148 pass
1149
1150 mock = Subclass()
1151 self.assertIsInstance(mock.foo, Subclass)
1152 self.assertIsInstance(mock(), Subclass)
1153
1154 class Subclass(Mock):
1155 def _get_child_mock(self, **kwargs):
1156 return Mock(**kwargs)
1157
1158 mock = Subclass()
1159 self.assertNotIsInstance(mock.foo, Subclass)
1160 self.assertNotIsInstance(mock(), Subclass)
1161
1162
1163 def test_arg_lists(self):
1164 mocks = [
1165 Mock(),
1166 MagicMock(),
1167 NonCallableMock(),
1168 NonCallableMagicMock()
1169 ]
1170
1171 def assert_attrs(mock):
1172 names = 'call_args_list', 'method_calls', 'mock_calls'
1173 for name in names:
1174 attr = getattr(mock, name)
1175 self.assertIsInstance(attr, _CallList)
1176 self.assertIsInstance(attr, list)
1177 self.assertEqual(attr, [])
1178
1179 for mock in mocks:
1180 assert_attrs(mock)
1181
1182 if callable(mock):
1183 mock()
1184 mock(1, 2)
1185 mock(a=3)
1186
1187 mock.reset_mock()
1188 assert_attrs(mock)
1189
1190 mock.foo()
1191 mock.foo.bar(1, a=3)
1192 mock.foo(1).bar().baz(3)
1193
1194 mock.reset_mock()
1195 assert_attrs(mock)
1196
1197
1198 def test_call_args_two_tuple(self):
1199 mock = Mock()
1200 mock(1, a=3)
1201 mock(2, b=4)
1202
1203 self.assertEqual(len(mock.call_args), 2)
Kumar Akshayb0df45e2019-03-22 13:40:40 +05301204 self.assertEqual(mock.call_args.args, (2,))
1205 self.assertEqual(mock.call_args.kwargs, dict(b=4))
Michael Foord345266a2012-03-14 12:24:34 -07001206
1207 expected_list = [((1,), dict(a=3)), ((2,), dict(b=4))]
1208 for expected, call_args in zip(expected_list, mock.call_args_list):
1209 self.assertEqual(len(call_args), 2)
1210 self.assertEqual(expected[0], call_args[0])
1211 self.assertEqual(expected[1], call_args[1])
1212
1213
1214 def test_side_effect_iterator(self):
1215 mock = Mock(side_effect=iter([1, 2, 3]))
1216 self.assertEqual([mock(), mock(), mock()], [1, 2, 3])
1217 self.assertRaises(StopIteration, mock)
1218
1219 mock = MagicMock(side_effect=['a', 'b', 'c'])
1220 self.assertEqual([mock(), mock(), mock()], ['a', 'b', 'c'])
1221 self.assertRaises(StopIteration, mock)
1222
1223 mock = Mock(side_effect='ghi')
1224 self.assertEqual([mock(), mock(), mock()], ['g', 'h', 'i'])
1225 self.assertRaises(StopIteration, mock)
1226
1227 class Foo(object):
1228 pass
1229 mock = MagicMock(side_effect=Foo)
1230 self.assertIsInstance(mock(), Foo)
1231
1232 mock = Mock(side_effect=Iter())
1233 self.assertEqual([mock(), mock(), mock(), mock()],
1234 ['this', 'is', 'an', 'iter'])
1235 self.assertRaises(StopIteration, mock)
1236
1237
Michael Foord2cd48732012-04-21 15:52:11 +01001238 def test_side_effect_iterator_exceptions(self):
1239 for Klass in Mock, MagicMock:
1240 iterable = (ValueError, 3, KeyError, 6)
1241 m = Klass(side_effect=iterable)
1242 self.assertRaises(ValueError, m)
1243 self.assertEqual(m(), 3)
1244 self.assertRaises(KeyError, m)
1245 self.assertEqual(m(), 6)
1246
1247
Michael Foord345266a2012-03-14 12:24:34 -07001248 def test_side_effect_setting_iterator(self):
1249 mock = Mock()
1250 mock.side_effect = iter([1, 2, 3])
1251 self.assertEqual([mock(), mock(), mock()], [1, 2, 3])
1252 self.assertRaises(StopIteration, mock)
1253 side_effect = mock.side_effect
1254 self.assertIsInstance(side_effect, type(iter([])))
1255
1256 mock.side_effect = ['a', 'b', 'c']
1257 self.assertEqual([mock(), mock(), mock()], ['a', 'b', 'c'])
1258 self.assertRaises(StopIteration, mock)
1259 side_effect = mock.side_effect
1260 self.assertIsInstance(side_effect, type(iter([])))
1261
1262 this_iter = Iter()
1263 mock.side_effect = this_iter
1264 self.assertEqual([mock(), mock(), mock(), mock()],
1265 ['this', 'is', 'an', 'iter'])
1266 self.assertRaises(StopIteration, mock)
1267 self.assertIs(mock.side_effect, this_iter)
1268
Andrew Svetlov8b2cd752013-04-07 16:42:24 +03001269 def test_side_effect_iterator_default(self):
1270 mock = Mock(return_value=2)
1271 mock.side_effect = iter([1, DEFAULT])
1272 self.assertEqual([mock(), mock()], [1, 2])
Michael Foord345266a2012-03-14 12:24:34 -07001273
1274 def test_assert_has_calls_any_order(self):
1275 mock = Mock()
1276 mock(1, 2)
1277 mock(a=3)
1278 mock(3, 4)
1279 mock(b=6)
1280 mock(b=6)
1281
1282 kalls = [
1283 call(1, 2), ({'a': 3},),
1284 ((3, 4),), ((), {'a': 3}),
1285 ('', (1, 2)), ('', {'a': 3}),
1286 ('', (1, 2), {}), ('', (), {'a': 3})
1287 ]
1288 for kall in kalls:
1289 mock.assert_has_calls([kall], any_order=True)
1290
1291 for kall in call(1, '2'), call(b=3), call(), 3, None, 'foo':
1292 self.assertRaises(
1293 AssertionError, mock.assert_has_calls,
1294 [kall], any_order=True
1295 )
1296
1297 kall_lists = [
1298 [call(1, 2), call(b=6)],
1299 [call(3, 4), call(1, 2)],
1300 [call(b=6), call(b=6)],
1301 ]
1302
1303 for kall_list in kall_lists:
1304 mock.assert_has_calls(kall_list, any_order=True)
1305
1306 kall_lists = [
1307 [call(b=6), call(b=6), call(b=6)],
1308 [call(1, 2), call(1, 2)],
1309 [call(3, 4), call(1, 2), call(5, 7)],
1310 [call(b=6), call(3, 4), call(b=6), call(1, 2), call(b=6)],
1311 ]
1312 for kall_list in kall_lists:
1313 self.assertRaises(
1314 AssertionError, mock.assert_has_calls,
1315 kall_list, any_order=True
1316 )
1317
1318 def test_assert_has_calls(self):
1319 kalls1 = [
1320 call(1, 2), ({'a': 3},),
1321 ((3, 4),), call(b=6),
1322 ('', (1,), {'b': 6}),
1323 ]
1324 kalls2 = [call.foo(), call.bar(1)]
1325 kalls2.extend(call.spam().baz(a=3).call_list())
1326 kalls2.extend(call.bam(set(), foo={}).fish([1]).call_list())
1327
1328 mocks = []
1329 for mock in Mock(), MagicMock():
1330 mock(1, 2)
1331 mock(a=3)
1332 mock(3, 4)
1333 mock(b=6)
1334 mock(1, b=6)
1335 mocks.append((mock, kalls1))
1336
1337 mock = Mock()
1338 mock.foo()
1339 mock.bar(1)
1340 mock.spam().baz(a=3)
1341 mock.bam(set(), foo={}).fish([1])
1342 mocks.append((mock, kalls2))
1343
1344 for mock, kalls in mocks:
1345 for i in range(len(kalls)):
1346 for step in 1, 2, 3:
1347 these = kalls[i:i+step]
1348 mock.assert_has_calls(these)
1349
1350 if len(these) > 1:
1351 self.assertRaises(
1352 AssertionError,
1353 mock.assert_has_calls,
1354 list(reversed(these))
1355 )
1356
1357
Xtreakc9612782019-08-29 11:39:01 +05301358 def test_assert_has_calls_nested_spec(self):
1359 class Something:
1360
1361 def __init__(self): pass
1362 def meth(self, a, b, c, d=None): pass
1363
1364 class Foo:
1365
1366 def __init__(self, a): pass
1367 def meth1(self, a, b): pass
1368
1369 mock_class = create_autospec(Something)
1370
1371 for m in [mock_class, mock_class()]:
1372 m.meth(1, 2, 3, d=1)
1373 m.assert_has_calls([call.meth(1, 2, 3, d=1)])
1374 m.assert_has_calls([call.meth(1, 2, 3, 1)])
1375
1376 mock_class.reset_mock()
1377
1378 for m in [mock_class, mock_class()]:
1379 self.assertRaises(AssertionError, m.assert_has_calls, [call.Foo()])
1380 m.Foo(1).meth1(1, 2)
1381 m.assert_has_calls([call.Foo(1), call.Foo(1).meth1(1, 2)])
1382 m.Foo.assert_has_calls([call(1), call().meth1(1, 2)])
1383
1384 mock_class.reset_mock()
1385
1386 invalid_calls = [call.meth(1),
1387 call.non_existent(1),
1388 call.Foo().non_existent(1),
1389 call.Foo().meth(1, 2, 3, 4)]
1390
1391 for kall in invalid_calls:
1392 self.assertRaises(AssertionError,
1393 mock_class.assert_has_calls,
1394 [kall]
1395 )
1396
1397
1398 def test_assert_has_calls_nested_without_spec(self):
1399 m = MagicMock()
1400 m().foo().bar().baz()
1401 m.one().two().three()
1402 calls = call.one().two().three().call_list()
1403 m.assert_has_calls(calls)
1404
1405
Antoine Pitrou5c64df72013-02-03 00:23:58 +01001406 def test_assert_has_calls_with_function_spec(self):
Chris Withersadbf1782019-05-01 23:04:04 +01001407 def f(a, b, c, d=None): pass
Antoine Pitrou5c64df72013-02-03 00:23:58 +01001408
1409 mock = Mock(spec=f)
1410
1411 mock(1, b=2, c=3)
1412 mock(4, 5, c=6, d=7)
1413 mock(10, 11, c=12)
1414 calls = [
1415 ('', (1, 2, 3), {}),
1416 ('', (4, 5, 6), {'d': 7}),
1417 ((10, 11, 12), {}),
1418 ]
1419 mock.assert_has_calls(calls)
1420 mock.assert_has_calls(calls, any_order=True)
1421 mock.assert_has_calls(calls[1:])
1422 mock.assert_has_calls(calls[1:], any_order=True)
1423 mock.assert_has_calls(calls[:-1])
1424 mock.assert_has_calls(calls[:-1], any_order=True)
1425 # Reversed order
1426 calls = list(reversed(calls))
1427 with self.assertRaises(AssertionError):
1428 mock.assert_has_calls(calls)
1429 mock.assert_has_calls(calls, any_order=True)
1430 with self.assertRaises(AssertionError):
1431 mock.assert_has_calls(calls[1:])
1432 mock.assert_has_calls(calls[1:], any_order=True)
1433 with self.assertRaises(AssertionError):
1434 mock.assert_has_calls(calls[:-1])
1435 mock.assert_has_calls(calls[:-1], any_order=True)
1436
1437
Michael Foord345266a2012-03-14 12:24:34 -07001438 def test_assert_any_call(self):
1439 mock = Mock()
1440 mock(1, 2)
1441 mock(a=3)
1442 mock(1, b=6)
1443
1444 mock.assert_any_call(1, 2)
1445 mock.assert_any_call(a=3)
1446 mock.assert_any_call(1, b=6)
1447
1448 self.assertRaises(
1449 AssertionError,
1450 mock.assert_any_call
1451 )
1452 self.assertRaises(
1453 AssertionError,
1454 mock.assert_any_call,
1455 1, 3
1456 )
1457 self.assertRaises(
1458 AssertionError,
1459 mock.assert_any_call,
1460 a=4
1461 )
1462
1463
Antoine Pitrou5c64df72013-02-03 00:23:58 +01001464 def test_assert_any_call_with_function_spec(self):
Chris Withersadbf1782019-05-01 23:04:04 +01001465 def f(a, b, c, d=None): pass
Antoine Pitrou5c64df72013-02-03 00:23:58 +01001466
1467 mock = Mock(spec=f)
1468
1469 mock(1, b=2, c=3)
1470 mock(4, 5, c=6, d=7)
1471 mock.assert_any_call(1, 2, 3)
1472 mock.assert_any_call(a=1, b=2, c=3)
1473 mock.assert_any_call(4, 5, 6, 7)
1474 mock.assert_any_call(a=4, b=5, c=6, d=7)
1475 self.assertRaises(AssertionError, mock.assert_any_call,
1476 1, b=3, c=2)
1477 # Expected call doesn't match the spec's signature
1478 with self.assertRaises(AssertionError) as cm:
1479 mock.assert_any_call(e=8)
1480 self.assertIsInstance(cm.exception.__cause__, TypeError)
1481
1482
Michael Foord345266a2012-03-14 12:24:34 -07001483 def test_mock_calls_create_autospec(self):
Chris Withersadbf1782019-05-01 23:04:04 +01001484 def f(a, b): pass
Michael Foord345266a2012-03-14 12:24:34 -07001485 obj = Iter()
1486 obj.f = f
1487
1488 funcs = [
1489 create_autospec(f),
1490 create_autospec(obj).f
1491 ]
1492 for func in funcs:
1493 func(1, 2)
1494 func(3, 4)
1495
1496 self.assertEqual(
1497 func.mock_calls, [call(1, 2), call(3, 4)]
1498 )
1499
Kushal Das484f8a82014-04-16 01:05:50 +05301500 #Issue21222
1501 def test_create_autospec_with_name(self):
1502 m = mock.create_autospec(object(), name='sweet_func')
1503 self.assertIn('sweet_func', repr(m))
Michael Foord345266a2012-03-14 12:24:34 -07001504
Xtreak9b218562019-04-22 08:00:23 +05301505 #Issue23078
1506 def test_create_autospec_classmethod_and_staticmethod(self):
1507 class TestClass:
1508 @classmethod
Chris Withersadbf1782019-05-01 23:04:04 +01001509 def class_method(cls): pass
Xtreak9b218562019-04-22 08:00:23 +05301510
1511 @staticmethod
Chris Withersadbf1782019-05-01 23:04:04 +01001512 def static_method(): pass
Xtreak9b218562019-04-22 08:00:23 +05301513 for method in ('class_method', 'static_method'):
1514 with self.subTest(method=method):
1515 mock_method = mock.create_autospec(getattr(TestClass, method))
1516 mock_method()
1517 mock_method.assert_called_once_with()
1518 self.assertRaises(TypeError, mock_method, 'extra_arg')
1519
Kushal Das8c145342014-04-16 23:32:21 +05301520 #Issue21238
1521 def test_mock_unsafe(self):
1522 m = Mock()
Zackery Spytzb9b08cd2019-05-08 11:32:24 -06001523 msg = "Attributes cannot start with 'assert' or 'assret'"
1524 with self.assertRaisesRegex(AttributeError, msg):
Kushal Das8c145342014-04-16 23:32:21 +05301525 m.assert_foo_call()
Zackery Spytzb9b08cd2019-05-08 11:32:24 -06001526 with self.assertRaisesRegex(AttributeError, msg):
Kushal Das8c145342014-04-16 23:32:21 +05301527 m.assret_foo_call()
1528 m = Mock(unsafe=True)
1529 m.assert_foo_call()
1530 m.assret_foo_call()
1531
Kushal Das8af9db32014-04-17 01:36:14 +05301532 #Issue21262
1533 def test_assert_not_called(self):
1534 m = Mock()
1535 m.hello.assert_not_called()
1536 m.hello()
1537 with self.assertRaises(AssertionError):
1538 m.hello.assert_not_called()
1539
Petter Strandmark47d94242018-10-28 21:37:10 +01001540 def test_assert_not_called_message(self):
1541 m = Mock()
1542 m(1, 2)
1543 self.assertRaisesRegex(AssertionError,
1544 re.escape("Calls: [call(1, 2)]"),
1545 m.assert_not_called)
1546
Victor Stinner2c2a4e62016-03-11 22:17:48 +01001547 def test_assert_called(self):
1548 m = Mock()
1549 with self.assertRaises(AssertionError):
1550 m.hello.assert_called()
1551 m.hello()
1552 m.hello.assert_called()
1553
1554 m.hello()
1555 m.hello.assert_called()
1556
1557 def test_assert_called_once(self):
1558 m = Mock()
1559 with self.assertRaises(AssertionError):
1560 m.hello.assert_called_once()
1561 m.hello()
1562 m.hello.assert_called_once()
1563
1564 m.hello()
1565 with self.assertRaises(AssertionError):
1566 m.hello.assert_called_once()
1567
Petter Strandmark47d94242018-10-28 21:37:10 +01001568 def test_assert_called_once_message(self):
1569 m = Mock()
1570 m(1, 2)
1571 m(3)
1572 self.assertRaisesRegex(AssertionError,
1573 re.escape("Calls: [call(1, 2), call(3)]"),
1574 m.assert_called_once)
1575
1576 def test_assert_called_once_message_not_called(self):
1577 m = Mock()
1578 with self.assertRaises(AssertionError) as e:
1579 m.assert_called_once()
1580 self.assertNotIn("Calls:", str(e.exception))
1581
Xtreak9d607062019-09-09 16:25:22 +05301582 #Issue37212 printout of keyword args now preserves the original order
1583 def test_ordered_call_signature(self):
Kushal Das047f14c2014-06-09 13:45:56 +05301584 m = Mock()
1585 m.hello(name='hello', daddy='hero')
Xtreak9d607062019-09-09 16:25:22 +05301586 text = "call(name='hello', daddy='hero')"
R David Murray130a5662014-06-11 17:09:43 -04001587 self.assertEqual(repr(m.hello.call_args), text)
Kushal Das8af9db32014-04-17 01:36:14 +05301588
Kushal Dasa37b9582014-09-16 18:33:37 +05301589 #Issue21270 overrides tuple methods for mock.call objects
1590 def test_override_tuple_methods(self):
1591 c = call.count()
1592 i = call.index(132,'hello')
1593 m = Mock()
1594 m.count()
1595 m.index(132,"hello")
1596 self.assertEqual(m.method_calls[0], c)
1597 self.assertEqual(m.method_calls[1], i)
1598
Kushal Das9cd39a12016-06-02 10:20:16 -07001599 def test_reset_return_sideeffect(self):
1600 m = Mock(return_value=10, side_effect=[2,3])
1601 m.reset_mock(return_value=True, side_effect=True)
1602 self.assertIsInstance(m.return_value, Mock)
1603 self.assertEqual(m.side_effect, None)
1604
1605 def test_reset_return(self):
1606 m = Mock(return_value=10, side_effect=[2,3])
1607 m.reset_mock(return_value=True)
1608 self.assertIsInstance(m.return_value, Mock)
1609 self.assertNotEqual(m.side_effect, None)
1610
1611 def test_reset_sideeffect(self):
1612 m = Mock(return_value=10, side_effect=[2,3])
1613 m.reset_mock(side_effect=True)
1614 self.assertEqual(m.return_value, 10)
1615 self.assertEqual(m.side_effect, None)
1616
Michael Foord345266a2012-03-14 12:24:34 -07001617 def test_mock_add_spec(self):
1618 class _One(object):
1619 one = 1
1620 class _Two(object):
1621 two = 2
1622 class Anything(object):
1623 one = two = three = 'four'
1624
1625 klasses = [
1626 Mock, MagicMock, NonCallableMock, NonCallableMagicMock
1627 ]
1628 for Klass in list(klasses):
1629 klasses.append(lambda K=Klass: K(spec=Anything))
1630 klasses.append(lambda K=Klass: K(spec_set=Anything))
1631
1632 for Klass in klasses:
1633 for kwargs in dict(), dict(spec_set=True):
1634 mock = Klass()
1635 #no error
1636 mock.one, mock.two, mock.three
1637
1638 for One, Two in [(_One, _Two), (['one'], ['two'])]:
1639 for kwargs in dict(), dict(spec_set=True):
1640 mock.mock_add_spec(One, **kwargs)
1641
1642 mock.one
1643 self.assertRaises(
1644 AttributeError, getattr, mock, 'two'
1645 )
1646 self.assertRaises(
1647 AttributeError, getattr, mock, 'three'
1648 )
1649 if 'spec_set' in kwargs:
1650 self.assertRaises(
1651 AttributeError, setattr, mock, 'three', None
1652 )
1653
1654 mock.mock_add_spec(Two, **kwargs)
1655 self.assertRaises(
1656 AttributeError, getattr, mock, 'one'
1657 )
1658 mock.two
1659 self.assertRaises(
1660 AttributeError, getattr, mock, 'three'
1661 )
1662 if 'spec_set' in kwargs:
1663 self.assertRaises(
1664 AttributeError, setattr, mock, 'three', None
1665 )
1666 # note that creating a mock, setting an instance attribute, and
1667 # *then* setting a spec doesn't work. Not the intended use case
1668
1669
1670 def test_mock_add_spec_magic_methods(self):
1671 for Klass in MagicMock, NonCallableMagicMock:
1672 mock = Klass()
1673 int(mock)
1674
1675 mock.mock_add_spec(object)
1676 self.assertRaises(TypeError, int, mock)
1677
1678 mock = Klass()
1679 mock['foo']
1680 mock.__int__.return_value =4
1681
1682 mock.mock_add_spec(int)
1683 self.assertEqual(int(mock), 4)
1684 self.assertRaises(TypeError, lambda: mock['foo'])
1685
1686
1687 def test_adding_child_mock(self):
Lisa Roach77b3b772019-05-20 09:19:53 -07001688 for Klass in (NonCallableMock, Mock, MagicMock, NonCallableMagicMock,
1689 AsyncMock):
Michael Foord345266a2012-03-14 12:24:34 -07001690 mock = Klass()
1691
1692 mock.foo = Mock()
1693 mock.foo()
1694
1695 self.assertEqual(mock.method_calls, [call.foo()])
1696 self.assertEqual(mock.mock_calls, [call.foo()])
1697
1698 mock = Klass()
1699 mock.bar = Mock(name='name')
1700 mock.bar()
1701 self.assertEqual(mock.method_calls, [])
1702 self.assertEqual(mock.mock_calls, [])
1703
1704 # mock with an existing _new_parent but no name
1705 mock = Klass()
1706 mock.baz = MagicMock()()
1707 mock.baz()
1708 self.assertEqual(mock.method_calls, [])
1709 self.assertEqual(mock.mock_calls, [])
1710
1711
1712 def test_adding_return_value_mock(self):
1713 for Klass in Mock, MagicMock:
1714 mock = Klass()
1715 mock.return_value = MagicMock()
1716
1717 mock()()
1718 self.assertEqual(mock.mock_calls, [call(), call()()])
1719
1720
1721 def test_manager_mock(self):
1722 class Foo(object):
1723 one = 'one'
1724 two = 'two'
1725 manager = Mock()
1726 p1 = patch.object(Foo, 'one')
1727 p2 = patch.object(Foo, 'two')
1728
1729 mock_one = p1.start()
1730 self.addCleanup(p1.stop)
1731 mock_two = p2.start()
1732 self.addCleanup(p2.stop)
1733
1734 manager.attach_mock(mock_one, 'one')
1735 manager.attach_mock(mock_two, 'two')
1736
1737 Foo.two()
1738 Foo.one()
1739
1740 self.assertEqual(manager.mock_calls, [call.two(), call.one()])
1741
1742
1743 def test_magic_methods_mock_calls(self):
1744 for Klass in Mock, MagicMock:
1745 m = Klass()
1746 m.__int__ = Mock(return_value=3)
1747 m.__float__ = MagicMock(return_value=3.0)
1748 int(m)
1749 float(m)
1750
1751 self.assertEqual(m.mock_calls, [call.__int__(), call.__float__()])
1752 self.assertEqual(m.method_calls, [])
1753
Robert Collins5329aaa2015-07-17 20:08:45 +12001754 def test_mock_open_reuse_issue_21750(self):
1755 mocked_open = mock.mock_open(read_data='data')
1756 f1 = mocked_open('a-name')
Robert Collinsca647ef2015-07-24 03:48:20 +12001757 f1_data = f1.read()
Robert Collins5329aaa2015-07-17 20:08:45 +12001758 f2 = mocked_open('another-name')
Robert Collinsca647ef2015-07-24 03:48:20 +12001759 f2_data = f2.read()
1760 self.assertEqual(f1_data, f2_data)
1761
Tony Flury20870232018-09-12 23:21:16 +01001762 def test_mock_open_dunder_iter_issue(self):
1763 # Test dunder_iter method generates the expected result and
1764 # consumes the iterator.
1765 mocked_open = mock.mock_open(read_data='Remarkable\nNorwegian Blue')
1766 f1 = mocked_open('a-name')
1767 lines = [line for line in f1]
1768 self.assertEqual(lines[0], 'Remarkable\n')
1769 self.assertEqual(lines[1], 'Norwegian Blue')
1770 self.assertEqual(list(f1), [])
1771
Damien Nadé394119a2019-05-23 12:03:25 +02001772 def test_mock_open_using_next(self):
1773 mocked_open = mock.mock_open(read_data='1st line\n2nd line\n3rd line')
1774 f1 = mocked_open('a-name')
1775 line1 = next(f1)
1776 line2 = f1.__next__()
1777 lines = [line for line in f1]
1778 self.assertEqual(line1, '1st line\n')
1779 self.assertEqual(line2, '2nd line\n')
1780 self.assertEqual(lines[0], '3rd line')
1781 self.assertEqual(list(f1), [])
1782 with self.assertRaises(StopIteration):
1783 next(f1)
1784
Robert Collinsca647ef2015-07-24 03:48:20 +12001785 def test_mock_open_write(self):
1786 # Test exception in file writing write()
1787 mock_namedtemp = mock.mock_open(mock.MagicMock(name='JLV'))
1788 with mock.patch('tempfile.NamedTemporaryFile', mock_namedtemp):
1789 mock_filehandle = mock_namedtemp.return_value
1790 mock_write = mock_filehandle.write
1791 mock_write.side_effect = OSError('Test 2 Error')
1792 def attempt():
1793 tempfile.NamedTemporaryFile().write('asd')
1794 self.assertRaises(OSError, attempt)
1795
1796 def test_mock_open_alter_readline(self):
1797 mopen = mock.mock_open(read_data='foo\nbarn')
1798 mopen.return_value.readline.side_effect = lambda *args:'abc'
1799 first = mopen().readline()
1800 second = mopen().readline()
1801 self.assertEqual('abc', first)
1802 self.assertEqual('abc', second)
Michael Foord345266a2012-03-14 12:24:34 -07001803
Robert Collins9549a3e2016-05-16 15:22:01 +12001804 def test_mock_open_after_eof(self):
1805 # read, readline and readlines should work after end of file.
1806 _open = mock.mock_open(read_data='foo')
1807 h = _open('bar')
1808 h.read()
1809 self.assertEqual('', h.read())
1810 self.assertEqual('', h.read())
1811 self.assertEqual('', h.readline())
1812 self.assertEqual('', h.readline())
1813 self.assertEqual([], h.readlines())
1814 self.assertEqual([], h.readlines())
1815
Michael Foord345266a2012-03-14 12:24:34 -07001816 def test_mock_parents(self):
1817 for Klass in Mock, MagicMock:
1818 m = Klass()
1819 original_repr = repr(m)
1820 m.return_value = m
1821 self.assertIs(m(), m)
1822 self.assertEqual(repr(m), original_repr)
1823
1824 m.reset_mock()
1825 self.assertIs(m(), m)
1826 self.assertEqual(repr(m), original_repr)
1827
1828 m = Klass()
1829 m.b = m.a
1830 self.assertIn("name='mock.a'", repr(m.b))
1831 self.assertIn("name='mock.a'", repr(m.a))
1832 m.reset_mock()
1833 self.assertIn("name='mock.a'", repr(m.b))
1834 self.assertIn("name='mock.a'", repr(m.a))
1835
1836 m = Klass()
1837 original_repr = repr(m)
1838 m.a = m()
1839 m.a.return_value = m
1840
1841 self.assertEqual(repr(m), original_repr)
1842 self.assertEqual(repr(m.a()), original_repr)
1843
1844
1845 def test_attach_mock(self):
1846 classes = Mock, MagicMock, NonCallableMagicMock, NonCallableMock
1847 for Klass in classes:
1848 for Klass2 in classes:
1849 m = Klass()
1850
1851 m2 = Klass2(name='foo')
1852 m.attach_mock(m2, 'bar')
1853
1854 self.assertIs(m.bar, m2)
1855 self.assertIn("name='mock.bar'", repr(m2))
1856
1857 m.bar.baz(1)
1858 self.assertEqual(m.mock_calls, [call.bar.baz(1)])
1859 self.assertEqual(m.method_calls, [call.bar.baz(1)])
1860
1861
1862 def test_attach_mock_return_value(self):
1863 classes = Mock, MagicMock, NonCallableMagicMock, NonCallableMock
1864 for Klass in Mock, MagicMock:
1865 for Klass2 in classes:
1866 m = Klass()
1867
1868 m2 = Klass2(name='foo')
1869 m.attach_mock(m2, 'return_value')
1870
1871 self.assertIs(m(), m2)
1872 self.assertIn("name='mock()'", repr(m2))
1873
1874 m2.foo()
1875 self.assertEqual(m.mock_calls, call().foo().call_list())
1876
1877
Xtreak7397cda2019-07-22 13:08:22 +05301878 def test_attach_mock_patch_autospec(self):
1879 parent = Mock()
1880
1881 with mock.patch(f'{__name__}.something', autospec=True) as mock_func:
1882 self.assertEqual(mock_func.mock._extract_mock_name(), 'something')
1883 parent.attach_mock(mock_func, 'child')
1884 parent.child(1)
1885 something(2)
1886 mock_func(3)
1887
1888 parent_calls = [call.child(1), call.child(2), call.child(3)]
1889 child_calls = [call(1), call(2), call(3)]
1890 self.assertEqual(parent.mock_calls, parent_calls)
1891 self.assertEqual(parent.child.mock_calls, child_calls)
1892 self.assertEqual(something.mock_calls, child_calls)
1893 self.assertEqual(mock_func.mock_calls, child_calls)
1894 self.assertIn('mock.child', repr(parent.child.mock))
1895 self.assertEqual(mock_func.mock._extract_mock_name(), 'mock.child')
1896
1897
Michael Foord345266a2012-03-14 12:24:34 -07001898 def test_attribute_deletion(self):
Michael Foord468ec342013-09-15 20:05:19 +12001899 for mock in (Mock(), MagicMock(), NonCallableMagicMock(),
1900 NonCallableMock()):
Michael Foord345266a2012-03-14 12:24:34 -07001901 self.assertTrue(hasattr(mock, 'm'))
1902
1903 del mock.m
1904 self.assertFalse(hasattr(mock, 'm'))
1905
1906 del mock.f
1907 self.assertFalse(hasattr(mock, 'f'))
1908 self.assertRaises(AttributeError, getattr, mock, 'f')
1909
1910
Pablo Galindo222d3032019-01-21 08:57:46 +00001911 def test_mock_does_not_raise_on_repeated_attribute_deletion(self):
1912 # bpo-20239: Assigning and deleting twice an attribute raises.
1913 for mock in (Mock(), MagicMock(), NonCallableMagicMock(),
1914 NonCallableMock()):
1915 mock.foo = 3
1916 self.assertTrue(hasattr(mock, 'foo'))
1917 self.assertEqual(mock.foo, 3)
1918
1919 del mock.foo
1920 self.assertFalse(hasattr(mock, 'foo'))
1921
1922 mock.foo = 4
1923 self.assertTrue(hasattr(mock, 'foo'))
1924 self.assertEqual(mock.foo, 4)
1925
1926 del mock.foo
1927 self.assertFalse(hasattr(mock, 'foo'))
1928
1929
1930 def test_mock_raises_when_deleting_nonexistent_attribute(self):
1931 for mock in (Mock(), MagicMock(), NonCallableMagicMock(),
1932 NonCallableMock()):
1933 del mock.foo
1934 with self.assertRaises(AttributeError):
1935 del mock.foo
1936
1937
Xtreakedeca922018-12-01 15:33:54 +05301938 def test_reset_mock_does_not_raise_on_attr_deletion(self):
1939 # bpo-31177: reset_mock should not raise AttributeError when attributes
1940 # were deleted in a mock instance
1941 mock = Mock()
1942 mock.child = True
1943 del mock.child
1944 mock.reset_mock()
1945 self.assertFalse(hasattr(mock, 'child'))
1946
1947
Michael Foord345266a2012-03-14 12:24:34 -07001948 def test_class_assignable(self):
1949 for mock in Mock(), MagicMock():
1950 self.assertNotIsInstance(mock, int)
1951
1952 mock.__class__ = int
1953 self.assertIsInstance(mock, int)
1954 mock.foo
1955
Andrew Dunaie63e6172018-12-04 11:08:45 +02001956 def test_name_attribute_of_call(self):
1957 # bpo-35357: _Call should not disclose any attributes whose names
1958 # may clash with popular ones (such as ".name")
1959 self.assertIsNotNone(call.name)
1960 self.assertEqual(type(call.name), _Call)
1961 self.assertEqual(type(call.name().name), _Call)
1962
1963 def test_parent_attribute_of_call(self):
1964 # bpo-35357: _Call should not disclose any attributes whose names
1965 # may clash with popular ones (such as ".parent")
1966 self.assertIsNotNone(call.parent)
1967 self.assertEqual(type(call.parent), _Call)
1968 self.assertEqual(type(call.parent().parent), _Call)
1969
Michael Foord345266a2012-03-14 12:24:34 -07001970
Xtreak9c3f2842019-02-26 03:16:34 +05301971 def test_parent_propagation_with_create_autospec(self):
1972
Chris Withersadbf1782019-05-01 23:04:04 +01001973 def foo(a, b): pass
Xtreak9c3f2842019-02-26 03:16:34 +05301974
1975 mock = Mock()
1976 mock.child = create_autospec(foo)
1977 mock.child(1, 2)
1978
1979 self.assertRaises(TypeError, mock.child, 1)
1980 self.assertEqual(mock.mock_calls, [call.child(1, 2)])
Xtreak7397cda2019-07-22 13:08:22 +05301981 self.assertIn('mock.child', repr(mock.child.mock))
1982
1983 def test_parent_propagation_with_autospec_attach_mock(self):
1984
1985 def foo(a, b): pass
1986
1987 parent = Mock()
1988 parent.attach_mock(create_autospec(foo, name='bar'), 'child')
1989 parent.child(1, 2)
1990
1991 self.assertRaises(TypeError, parent.child, 1)
1992 self.assertEqual(parent.child.mock_calls, [call.child(1, 2)])
1993 self.assertIn('mock.child', repr(parent.child.mock))
1994
Xtreak9c3f2842019-02-26 03:16:34 +05301995
Xtreak830b43d2019-04-14 00:42:33 +05301996 def test_isinstance_under_settrace(self):
1997 # bpo-36593 : __class__ is not set for a class that has __class__
1998 # property defined when it's used with sys.settrace(trace) set.
1999 # Delete the module to force reimport with tracing function set
2000 # restore the old reference later since there are other tests that are
2001 # dependent on unittest.mock.patch. In testpatch.PatchTest
2002 # test_patch_dict_test_prefix and test_patch_test_prefix not restoring
2003 # causes the objects patched to go out of sync
2004
2005 old_patch = unittest.mock.patch
2006
2007 # Directly using __setattr__ on unittest.mock causes current imported
2008 # reference to be updated. Use a lambda so that during cleanup the
2009 # re-imported new reference is updated.
2010 self.addCleanup(lambda patch: setattr(unittest.mock, 'patch', patch),
2011 old_patch)
2012
2013 with patch.dict('sys.modules'):
2014 del sys.modules['unittest.mock']
2015
Chris Withersadbf1782019-05-01 23:04:04 +01002016 # This trace will stop coverage being measured ;-)
2017 def trace(frame, event, arg): # pragma: no cover
Xtreak830b43d2019-04-14 00:42:33 +05302018 return trace
2019
Chris Withersadbf1782019-05-01 23:04:04 +01002020 self.addCleanup(sys.settrace, sys.gettrace())
Xtreak830b43d2019-04-14 00:42:33 +05302021 sys.settrace(trace)
Xtreak830b43d2019-04-14 00:42:33 +05302022
2023 from unittest.mock import (
2024 Mock, MagicMock, NonCallableMock, NonCallableMagicMock
2025 )
2026
2027 mocks = [
2028 Mock, MagicMock, NonCallableMock, NonCallableMagicMock
2029 ]
2030
2031 for mock in mocks:
2032 obj = mock(spec=Something)
2033 self.assertIsInstance(obj, Something)
2034
Xtreak9c3f2842019-02-26 03:16:34 +05302035
Michael Foord345266a2012-03-14 12:24:34 -07002036if __name__ == '__main__':
2037 unittest.main()