blob: 8bfb29391d95f504d8f7e96ac40cb1356e1d4f28 [file] [log] [blame]
Michael Foord345266a2012-03-14 12:24:34 -07001import unittest
2
3from unittest.mock import (
4 call, _Call, create_autospec, MagicMock,
5 Mock, ANY, _CallList, patch, PropertyMock
6)
7
8from datetime import datetime
9
10class SomeClass(object):
11 def one(self, a, b):
12 pass
13 def two(self):
14 pass
15 def three(self, a=None):
16 pass
17
18
19
20class AnyTest(unittest.TestCase):
21
22 def test_any(self):
23 self.assertEqual(ANY, object())
24
25 mock = Mock()
26 mock(ANY)
27 mock.assert_called_with(ANY)
28
29 mock = Mock()
30 mock(foo=ANY)
31 mock.assert_called_with(foo=ANY)
32
33 def test_repr(self):
34 self.assertEqual(repr(ANY), '<ANY>')
35 self.assertEqual(str(ANY), '<ANY>')
36
37
38 def test_any_and_datetime(self):
39 mock = Mock()
40 mock(datetime.now(), foo=datetime.now())
41
42 mock.assert_called_with(ANY, foo=ANY)
43
44
45 def test_any_mock_calls_comparison_order(self):
46 mock = Mock()
47 d = datetime.now()
48 class Foo(object):
49 def __eq__(self, other):
50 return False
51 def __ne__(self, other):
52 return True
53
54 for d in datetime.now(), Foo():
55 mock.reset_mock()
56
57 mock(d, foo=d, bar=d)
58 mock.method(d, zinga=d, alpha=d)
59 mock().method(a1=d, z99=d)
60
61 expected = [
62 call(ANY, foo=ANY, bar=ANY),
63 call.method(ANY, zinga=ANY, alpha=ANY),
64 call(), call().method(a1=ANY, z99=ANY)
65 ]
66 self.assertEqual(expected, mock.mock_calls)
67 self.assertEqual(mock.mock_calls, expected)
68
69
70
71class CallTest(unittest.TestCase):
72
73 def test_call_with_call(self):
74 kall = _Call()
75 self.assertEqual(kall, _Call())
76 self.assertEqual(kall, _Call(('',)))
77 self.assertEqual(kall, _Call(((),)))
78 self.assertEqual(kall, _Call(({},)))
79 self.assertEqual(kall, _Call(('', ())))
80 self.assertEqual(kall, _Call(('', {})))
81 self.assertEqual(kall, _Call(('', (), {})))
82 self.assertEqual(kall, _Call(('foo',)))
83 self.assertEqual(kall, _Call(('bar', ())))
84 self.assertEqual(kall, _Call(('baz', {})))
85 self.assertEqual(kall, _Call(('spam', (), {})))
86
87 kall = _Call(((1, 2, 3),))
88 self.assertEqual(kall, _Call(((1, 2, 3),)))
89 self.assertEqual(kall, _Call(('', (1, 2, 3))))
90 self.assertEqual(kall, _Call(((1, 2, 3), {})))
91 self.assertEqual(kall, _Call(('', (1, 2, 3), {})))
92
93 kall = _Call(((1, 2, 4),))
94 self.assertNotEqual(kall, _Call(('', (1, 2, 3))))
95 self.assertNotEqual(kall, _Call(('', (1, 2, 3), {})))
96
97 kall = _Call(('foo', (1, 2, 4),))
98 self.assertNotEqual(kall, _Call(('', (1, 2, 4))))
99 self.assertNotEqual(kall, _Call(('', (1, 2, 4), {})))
100 self.assertNotEqual(kall, _Call(('bar', (1, 2, 4))))
101 self.assertNotEqual(kall, _Call(('bar', (1, 2, 4), {})))
102
103 kall = _Call(({'a': 3},))
104 self.assertEqual(kall, _Call(('', (), {'a': 3})))
105 self.assertEqual(kall, _Call(('', {'a': 3})))
106 self.assertEqual(kall, _Call(((), {'a': 3})))
107 self.assertEqual(kall, _Call(({'a': 3},)))
108
109
110 def test_empty__Call(self):
111 args = _Call()
112
113 self.assertEqual(args, ())
114 self.assertEqual(args, ('foo',))
115 self.assertEqual(args, ((),))
116 self.assertEqual(args, ('foo', ()))
117 self.assertEqual(args, ('foo',(), {}))
118 self.assertEqual(args, ('foo', {}))
119 self.assertEqual(args, ({},))
120
121
122 def test_named_empty_call(self):
123 args = _Call(('foo', (), {}))
124
125 self.assertEqual(args, ('foo',))
126 self.assertEqual(args, ('foo', ()))
127 self.assertEqual(args, ('foo',(), {}))
128 self.assertEqual(args, ('foo', {}))
129
130 self.assertNotEqual(args, ((),))
131 self.assertNotEqual(args, ())
132 self.assertNotEqual(args, ({},))
133 self.assertNotEqual(args, ('bar',))
134 self.assertNotEqual(args, ('bar', ()))
135 self.assertNotEqual(args, ('bar', {}))
136
137
138 def test_call_with_args(self):
139 args = _Call(((1, 2, 3), {}))
140
141 self.assertEqual(args, ((1, 2, 3),))
142 self.assertEqual(args, ('foo', (1, 2, 3)))
143 self.assertEqual(args, ('foo', (1, 2, 3), {}))
144 self.assertEqual(args, ((1, 2, 3), {}))
145
146
147 def test_named_call_with_args(self):
148 args = _Call(('foo', (1, 2, 3), {}))
149
150 self.assertEqual(args, ('foo', (1, 2, 3)))
151 self.assertEqual(args, ('foo', (1, 2, 3), {}))
152
153 self.assertNotEqual(args, ((1, 2, 3),))
154 self.assertNotEqual(args, ((1, 2, 3), {}))
155
156
157 def test_call_with_kwargs(self):
158 args = _Call(((), dict(a=3, b=4)))
159
160 self.assertEqual(args, (dict(a=3, b=4),))
161 self.assertEqual(args, ('foo', dict(a=3, b=4)))
162 self.assertEqual(args, ('foo', (), dict(a=3, b=4)))
163 self.assertEqual(args, ((), dict(a=3, b=4)))
164
165
166 def test_named_call_with_kwargs(self):
167 args = _Call(('foo', (), dict(a=3, b=4)))
168
169 self.assertEqual(args, ('foo', dict(a=3, b=4)))
170 self.assertEqual(args, ('foo', (), dict(a=3, b=4)))
171
172 self.assertNotEqual(args, (dict(a=3, b=4),))
173 self.assertNotEqual(args, ((), dict(a=3, b=4)))
174
175
176 def test_call_with_args_call_empty_name(self):
177 args = _Call(((1, 2, 3), {}))
178 self.assertEqual(args, call(1, 2, 3))
179 self.assertEqual(call(1, 2, 3), args)
180 self.assertTrue(call(1, 2, 3) in [args])
181
182
183 def test_call_ne(self):
184 self.assertNotEqual(_Call(((1, 2, 3),)), call(1, 2))
185 self.assertFalse(_Call(((1, 2, 3),)) != call(1, 2, 3))
186 self.assertTrue(_Call(((1, 2), {})) != call(1, 2, 3))
187
188
189 def test_call_non_tuples(self):
190 kall = _Call(((1, 2, 3),))
191 for value in 1, None, self, int:
192 self.assertNotEqual(kall, value)
193 self.assertFalse(kall == value)
194
195
196 def test_repr(self):
197 self.assertEqual(repr(_Call()), 'call()')
198 self.assertEqual(repr(_Call(('foo',))), 'call.foo()')
199
200 self.assertEqual(repr(_Call(((1, 2, 3), {'a': 'b'}))),
201 "call(1, 2, 3, a='b')")
202 self.assertEqual(repr(_Call(('bar', (1, 2, 3), {'a': 'b'}))),
203 "call.bar(1, 2, 3, a='b')")
204
205 self.assertEqual(repr(call), 'call')
206 self.assertEqual(str(call), 'call')
207
208 self.assertEqual(repr(call()), 'call()')
209 self.assertEqual(repr(call(1)), 'call(1)')
210 self.assertEqual(repr(call(zz='thing')), "call(zz='thing')")
211
212 self.assertEqual(repr(call().foo), 'call().foo')
213 self.assertEqual(repr(call(1).foo.bar(a=3).bing),
214 'call().foo.bar().bing')
215 self.assertEqual(
216 repr(call().foo(1, 2, a=3)),
217 "call().foo(1, 2, a=3)"
218 )
219 self.assertEqual(repr(call()()), "call()()")
220 self.assertEqual(repr(call(1)(2)), "call()(2)")
221 self.assertEqual(
222 repr(call()().bar().baz.beep(1)),
223 "call()().bar().baz.beep(1)"
224 )
225
226
227 def test_call(self):
228 self.assertEqual(call(), ('', (), {}))
229 self.assertEqual(call('foo', 'bar', one=3, two=4),
230 ('', ('foo', 'bar'), {'one': 3, 'two': 4}))
231
232 mock = Mock()
233 mock(1, 2, 3)
234 mock(a=3, b=6)
235 self.assertEqual(mock.call_args_list,
236 [call(1, 2, 3), call(a=3, b=6)])
237
238 def test_attribute_call(self):
239 self.assertEqual(call.foo(1), ('foo', (1,), {}))
240 self.assertEqual(call.bar.baz(fish='eggs'),
241 ('bar.baz', (), {'fish': 'eggs'}))
242
243 mock = Mock()
244 mock.foo(1, 2 ,3)
245 mock.bar.baz(a=3, b=6)
246 self.assertEqual(mock.method_calls,
247 [call.foo(1, 2, 3), call.bar.baz(a=3, b=6)])
248
249
250 def test_extended_call(self):
251 result = call(1).foo(2).bar(3, a=4)
252 self.assertEqual(result, ('().foo().bar', (3,), dict(a=4)))
253
254 mock = MagicMock()
255 mock(1, 2, a=3, b=4)
256 self.assertEqual(mock.call_args, call(1, 2, a=3, b=4))
257 self.assertNotEqual(mock.call_args, call(1, 2, 3))
258
259 self.assertEqual(mock.call_args_list, [call(1, 2, a=3, b=4)])
260 self.assertEqual(mock.mock_calls, [call(1, 2, a=3, b=4)])
261
262 mock = MagicMock()
263 mock.foo(1).bar()().baz.beep(a=6)
264
265 last_call = call.foo(1).bar()().baz.beep(a=6)
266 self.assertEqual(mock.mock_calls[-1], last_call)
267 self.assertEqual(mock.mock_calls, last_call.call_list())
268
269
270 def test_call_list(self):
271 mock = MagicMock()
272 mock(1)
273 self.assertEqual(call(1).call_list(), mock.mock_calls)
274
275 mock = MagicMock()
276 mock(1).method(2)
277 self.assertEqual(call(1).method(2).call_list(),
278 mock.mock_calls)
279
280 mock = MagicMock()
281 mock(1).method(2)(3)
282 self.assertEqual(call(1).method(2)(3).call_list(),
283 mock.mock_calls)
284
285 mock = MagicMock()
286 int(mock(1).method(2)(3).foo.bar.baz(4)(5))
287 kall = call(1).method(2)(3).foo.bar.baz(4)(5).__int__()
288 self.assertEqual(kall.call_list(), mock.mock_calls)
289
290
291 def test_call_any(self):
292 self.assertEqual(call, ANY)
293
294 m = MagicMock()
295 int(m)
296 self.assertEqual(m.mock_calls, [ANY])
297 self.assertEqual([ANY], m.mock_calls)
298
299
300 def test_two_args_call(self):
301 args = _Call(((1, 2), {'a': 3}), two=True)
302 self.assertEqual(len(args), 2)
303 self.assertEqual(args[0], (1, 2))
304 self.assertEqual(args[1], {'a': 3})
305
306 other_args = _Call(((1, 2), {'a': 3}))
307 self.assertEqual(args, other_args)
308
309
310class SpecSignatureTest(unittest.TestCase):
311
312 def _check_someclass_mock(self, mock):
313 self.assertRaises(AttributeError, getattr, mock, 'foo')
314 mock.one(1, 2)
315 mock.one.assert_called_with(1, 2)
316 self.assertRaises(AssertionError,
317 mock.one.assert_called_with, 3, 4)
318 self.assertRaises(TypeError, mock.one, 1)
319
320 mock.two()
321 mock.two.assert_called_with()
322 self.assertRaises(AssertionError,
323 mock.two.assert_called_with, 3)
324 self.assertRaises(TypeError, mock.two, 1)
325
326 mock.three()
327 mock.three.assert_called_with()
328 self.assertRaises(AssertionError,
329 mock.three.assert_called_with, 3)
330 self.assertRaises(TypeError, mock.three, 3, 2)
331
332 mock.three(1)
333 mock.three.assert_called_with(1)
334
335 mock.three(a=1)
336 mock.three.assert_called_with(a=1)
337
338
339 def test_basic(self):
340 for spec in (SomeClass, SomeClass()):
341 mock = create_autospec(spec)
342 self._check_someclass_mock(mock)
343
344
345 def test_create_autospec_return_value(self):
346 def f():
347 pass
348 mock = create_autospec(f, return_value='foo')
349 self.assertEqual(mock(), 'foo')
350
351 class Foo(object):
352 pass
353
354 mock = create_autospec(Foo, return_value='foo')
355 self.assertEqual(mock(), 'foo')
356
357
Michael Foord75963642012-06-09 17:31:59 +0100358 def test_autospec_reset_mock(self):
359 m = create_autospec(int)
360 int(m)
361 m.reset_mock()
362 self.assertEqual(m.__int__.call_count, 0)
363
364
Michael Foord345266a2012-03-14 12:24:34 -0700365 def test_mocking_unbound_methods(self):
366 class Foo(object):
367 def foo(self, foo):
368 pass
369 p = patch.object(Foo, 'foo')
370 mock_foo = p.start()
371 Foo().foo(1)
372
373 mock_foo.assert_called_with(1)
374
375
376 def test_create_autospec_unbound_methods(self):
Michael Foord3af125a2012-04-21 18:22:28 +0100377 # see mock issue 128
Michael Foord345266a2012-03-14 12:24:34 -0700378 # this is expected to fail until the issue is fixed
379 return
380 class Foo(object):
381 def foo(self):
382 pass
383
384 klass = create_autospec(Foo)
385 instance = klass()
386 self.assertRaises(TypeError, instance.foo, 1)
387
388 # Note: no type checking on the "self" parameter
389 klass.foo(1)
390 klass.foo.assert_called_with(1)
391 self.assertRaises(TypeError, klass.foo)
392
393
394 def test_create_autospec_keyword_arguments(self):
395 class Foo(object):
396 a = 3
397 m = create_autospec(Foo, a='3')
398 self.assertEqual(m.a, '3')
399
400
Michael Foord3af125a2012-04-21 18:22:28 +0100401 def test_create_autospec_keyword_only_arguments(self):
402 def foo(a, *, b=None):
403 pass
404
405 m = create_autospec(foo)
406 m(1)
407 m.assert_called_with(1)
408 self.assertRaises(TypeError, m, 1, 2)
409
410 m(2, b=3)
411 m.assert_called_with(2, b=3)
412
413
Michael Foord345266a2012-03-14 12:24:34 -0700414 def test_function_as_instance_attribute(self):
415 obj = SomeClass()
416 def f(a):
417 pass
418 obj.f = f
419
420 mock = create_autospec(obj)
421 mock.f('bing')
422 mock.f.assert_called_with('bing')
423
424
425 def test_spec_as_list(self):
426 # because spec as a list of strings in the mock constructor means
427 # something very different we treat a list instance as the type.
428 mock = create_autospec([])
429 mock.append('foo')
430 mock.append.assert_called_with('foo')
431
432 self.assertRaises(AttributeError, getattr, mock, 'foo')
433
434 class Foo(object):
435 foo = []
436
437 mock = create_autospec(Foo)
438 mock.foo.append(3)
439 mock.foo.append.assert_called_with(3)
440 self.assertRaises(AttributeError, getattr, mock.foo, 'foo')
441
442
443 def test_attributes(self):
444 class Sub(SomeClass):
445 attr = SomeClass()
446
447 sub_mock = create_autospec(Sub)
448
449 for mock in (sub_mock, sub_mock.attr):
450 self._check_someclass_mock(mock)
451
452
453 def test_builtin_functions_types(self):
454 # we could replace builtin functions / methods with a function
455 # with *args / **kwargs signature. Using the builtin method type
456 # as a spec seems to work fairly well though.
457 class BuiltinSubclass(list):
458 def bar(self, arg):
459 pass
460 sorted = sorted
461 attr = {}
462
463 mock = create_autospec(BuiltinSubclass)
464 mock.append(3)
465 mock.append.assert_called_with(3)
466 self.assertRaises(AttributeError, getattr, mock.append, 'foo')
467
468 mock.bar('foo')
469 mock.bar.assert_called_with('foo')
470 self.assertRaises(TypeError, mock.bar, 'foo', 'bar')
471 self.assertRaises(AttributeError, getattr, mock.bar, 'foo')
472
473 mock.sorted([1, 2])
474 mock.sorted.assert_called_with([1, 2])
475 self.assertRaises(AttributeError, getattr, mock.sorted, 'foo')
476
477 mock.attr.pop(3)
478 mock.attr.pop.assert_called_with(3)
479 self.assertRaises(AttributeError, getattr, mock.attr, 'foo')
480
481
482 def test_method_calls(self):
483 class Sub(SomeClass):
484 attr = SomeClass()
485
486 mock = create_autospec(Sub)
487 mock.one(1, 2)
488 mock.two()
489 mock.three(3)
490
491 expected = [call.one(1, 2), call.two(), call.three(3)]
492 self.assertEqual(mock.method_calls, expected)
493
494 mock.attr.one(1, 2)
495 mock.attr.two()
496 mock.attr.three(3)
497
498 expected.extend(
499 [call.attr.one(1, 2), call.attr.two(), call.attr.three(3)]
500 )
501 self.assertEqual(mock.method_calls, expected)
502
503
504 def test_magic_methods(self):
505 class BuiltinSubclass(list):
506 attr = {}
507
508 mock = create_autospec(BuiltinSubclass)
509 self.assertEqual(list(mock), [])
510 self.assertRaises(TypeError, int, mock)
511 self.assertRaises(TypeError, int, mock.attr)
512 self.assertEqual(list(mock), [])
513
514 self.assertIsInstance(mock['foo'], MagicMock)
515 self.assertIsInstance(mock.attr['foo'], MagicMock)
516
517
518 def test_spec_set(self):
519 class Sub(SomeClass):
520 attr = SomeClass()
521
522 for spec in (Sub, Sub()):
523 mock = create_autospec(spec, spec_set=True)
524 self._check_someclass_mock(mock)
525
526 self.assertRaises(AttributeError, setattr, mock, 'foo', 'bar')
527 self.assertRaises(AttributeError, setattr, mock.attr, 'foo', 'bar')
528
529
530 def test_descriptors(self):
531 class Foo(object):
532 @classmethod
533 def f(cls, a, b):
534 pass
535 @staticmethod
536 def g(a, b):
537 pass
538
539 class Bar(Foo):
540 pass
541
542 class Baz(SomeClass, Bar):
543 pass
544
545 for spec in (Foo, Foo(), Bar, Bar(), Baz, Baz()):
546 mock = create_autospec(spec)
547 mock.f(1, 2)
548 mock.f.assert_called_once_with(1, 2)
549
550 mock.g(3, 4)
551 mock.g.assert_called_once_with(3, 4)
552
553
554 def test_recursive(self):
555 class A(object):
556 def a(self):
557 pass
558 foo = 'foo bar baz'
559 bar = foo
560
561 A.B = A
562 mock = create_autospec(A)
563
564 mock()
565 self.assertFalse(mock.B.called)
566
567 mock.a()
568 mock.B.a()
569 self.assertEqual(mock.method_calls, [call.a(), call.B.a()])
570
571 self.assertIs(A.foo, A.bar)
572 self.assertIsNot(mock.foo, mock.bar)
573 mock.foo.lower()
574 self.assertRaises(AssertionError, mock.bar.lower.assert_called_with)
575
576
577 def test_spec_inheritance_for_classes(self):
578 class Foo(object):
579 def a(self):
580 pass
581 class Bar(object):
582 def f(self):
583 pass
584
585 class_mock = create_autospec(Foo)
586
587 self.assertIsNot(class_mock, class_mock())
588
589 for this_mock in class_mock, class_mock():
590 this_mock.a()
591 this_mock.a.assert_called_with()
592 self.assertRaises(TypeError, this_mock.a, 'foo')
593 self.assertRaises(AttributeError, getattr, this_mock, 'b')
594
595 instance_mock = create_autospec(Foo())
596 instance_mock.a()
597 instance_mock.a.assert_called_with()
598 self.assertRaises(TypeError, instance_mock.a, 'foo')
599 self.assertRaises(AttributeError, getattr, instance_mock, 'b')
600
601 # The return value isn't isn't callable
602 self.assertRaises(TypeError, instance_mock)
603
604 instance_mock.Bar.f()
605 instance_mock.Bar.f.assert_called_with()
606 self.assertRaises(AttributeError, getattr, instance_mock.Bar, 'g')
607
608 instance_mock.Bar().f()
609 instance_mock.Bar().f.assert_called_with()
610 self.assertRaises(AttributeError, getattr, instance_mock.Bar(), 'g')
611
612
613 def test_inherit(self):
614 class Foo(object):
615 a = 3
616
617 Foo.Foo = Foo
618
619 # class
620 mock = create_autospec(Foo)
621 instance = mock()
622 self.assertRaises(AttributeError, getattr, instance, 'b')
623
624 attr_instance = mock.Foo()
625 self.assertRaises(AttributeError, getattr, attr_instance, 'b')
626
627 # instance
628 mock = create_autospec(Foo())
629 self.assertRaises(AttributeError, getattr, mock, 'b')
630 self.assertRaises(TypeError, mock)
631
632 # attribute instance
633 call_result = mock.Foo()
634 self.assertRaises(AttributeError, getattr, call_result, 'b')
635
636
637 def test_builtins(self):
638 # used to fail with infinite recursion
639 create_autospec(1)
640
641 create_autospec(int)
642 create_autospec('foo')
643 create_autospec(str)
644 create_autospec({})
645 create_autospec(dict)
646 create_autospec([])
647 create_autospec(list)
648 create_autospec(set())
649 create_autospec(set)
650 create_autospec(1.0)
651 create_autospec(float)
652 create_autospec(1j)
653 create_autospec(complex)
654 create_autospec(False)
655 create_autospec(True)
656
657
658 def test_function(self):
659 def f(a, b):
660 pass
661
662 mock = create_autospec(f)
663 self.assertRaises(TypeError, mock)
664 mock(1, 2)
665 mock.assert_called_with(1, 2)
666
667 f.f = f
668 mock = create_autospec(f)
669 self.assertRaises(TypeError, mock.f)
670 mock.f(3, 4)
671 mock.f.assert_called_with(3, 4)
672
673
Michael Foord656319e2012-04-13 17:39:16 +0100674 def test_skip_attributeerrors(self):
675 class Raiser(object):
676 def __get__(self, obj, type=None):
677 if obj is None:
678 raise AttributeError('Can only be accessed via an instance')
679
680 class RaiserClass(object):
681 raiser = Raiser()
682
683 @staticmethod
684 def existing(a, b):
685 return a + b
686
687 s = create_autospec(RaiserClass)
688 self.assertRaises(TypeError, lambda x: s.existing(1, 2, 3))
689 s.existing(1, 2)
690 self.assertRaises(AttributeError, lambda: s.nonexisting)
691
692 # check we can fetch the raiser attribute and it has no spec
693 obj = s.raiser
694 obj.foo, obj.bar
695
696
Michael Foord345266a2012-03-14 12:24:34 -0700697 def test_signature_class(self):
698 class Foo(object):
699 def __init__(self, a, b=3):
700 pass
701
702 mock = create_autospec(Foo)
703
704 self.assertRaises(TypeError, mock)
705 mock(1)
706 mock.assert_called_once_with(1)
707
708 mock(4, 5)
709 mock.assert_called_with(4, 5)
710
711
712 def test_class_with_no_init(self):
713 # this used to raise an exception
714 # due to trying to get a signature from object.__init__
715 class Foo(object):
716 pass
717 create_autospec(Foo)
718
719
720 def test_signature_callable(self):
721 class Callable(object):
722 def __init__(self):
723 pass
724 def __call__(self, a):
725 pass
726
727 mock = create_autospec(Callable)
728 mock()
729 mock.assert_called_once_with()
730 self.assertRaises(TypeError, mock, 'a')
731
732 instance = mock()
733 self.assertRaises(TypeError, instance)
734 instance(a='a')
735 instance.assert_called_once_with(a='a')
736 instance('a')
737 instance.assert_called_with('a')
738
739 mock = create_autospec(Callable())
740 mock(a='a')
741 mock.assert_called_once_with(a='a')
742 self.assertRaises(TypeError, mock)
743 mock('a')
744 mock.assert_called_with('a')
745
746
747 def test_signature_noncallable(self):
748 class NonCallable(object):
749 def __init__(self):
750 pass
751
752 mock = create_autospec(NonCallable)
753 instance = mock()
754 mock.assert_called_once_with()
755 self.assertRaises(TypeError, mock, 'a')
756 self.assertRaises(TypeError, instance)
757 self.assertRaises(TypeError, instance, 'a')
758
759 mock = create_autospec(NonCallable())
760 self.assertRaises(TypeError, mock)
761 self.assertRaises(TypeError, mock, 'a')
762
763
764 def test_create_autospec_none(self):
765 class Foo(object):
766 bar = None
767
768 mock = create_autospec(Foo)
769 none = mock.bar
770 self.assertNotIsInstance(none, type(None))
771
772 none.foo()
773 none.foo.assert_called_once_with()
774
775
776 def test_autospec_functions_with_self_in_odd_place(self):
777 class Foo(object):
778 def f(a, self):
779 pass
780
781 a = create_autospec(Foo)
782 a.f(self=10)
783 a.f.assert_called_with(self=10)
784
785
786 def test_autospec_property(self):
787 class Foo(object):
788 @property
789 def foo(self):
790 return 3
791
792 foo = create_autospec(Foo)
793 mock_property = foo.foo
794
795 # no spec on properties
796 self.assertTrue(isinstance(mock_property, MagicMock))
797 mock_property(1, 2, 3)
798 mock_property.abc(4, 5, 6)
799 mock_property.assert_called_once_with(1, 2, 3)
800 mock_property.abc.assert_called_once_with(4, 5, 6)
801
802
803 def test_autospec_slots(self):
804 class Foo(object):
805 __slots__ = ['a']
806
807 foo = create_autospec(Foo)
808 mock_slot = foo.a
809
810 # no spec on slots
811 mock_slot(1, 2, 3)
812 mock_slot.abc(4, 5, 6)
813 mock_slot.assert_called_once_with(1, 2, 3)
814 mock_slot.abc.assert_called_once_with(4, 5, 6)
815
816
817class TestCallList(unittest.TestCase):
818
819 def test_args_list_contains_call_list(self):
820 mock = Mock()
821 self.assertIsInstance(mock.call_args_list, _CallList)
822
823 mock(1, 2)
824 mock(a=3)
825 mock(3, 4)
826 mock(b=6)
827
828 for kall in call(1, 2), call(a=3), call(3, 4), call(b=6):
829 self.assertTrue(kall in mock.call_args_list)
830
831 calls = [call(a=3), call(3, 4)]
832 self.assertTrue(calls in mock.call_args_list)
833 calls = [call(1, 2), call(a=3)]
834 self.assertTrue(calls in mock.call_args_list)
835 calls = [call(3, 4), call(b=6)]
836 self.assertTrue(calls in mock.call_args_list)
837 calls = [call(3, 4)]
838 self.assertTrue(calls in mock.call_args_list)
839
840 self.assertFalse(call('fish') in mock.call_args_list)
841 self.assertFalse([call('fish')] in mock.call_args_list)
842
843
844 def test_call_list_str(self):
845 mock = Mock()
846 mock(1, 2)
847 mock.foo(a=3)
848 mock.foo.bar().baz('fish', cat='dog')
849
850 expected = (
851 "[call(1, 2),\n"
852 " call.foo(a=3),\n"
853 " call.foo.bar(),\n"
854 " call.foo.bar().baz('fish', cat='dog')]"
855 )
856 self.assertEqual(str(mock.mock_calls), expected)
857
858
859 def test_propertymock(self):
860 p = patch('%s.SomeClass.one' % __name__, new_callable=PropertyMock)
861 mock = p.start()
862 try:
863 SomeClass.one
864 mock.assert_called_once_with()
865
866 s = SomeClass()
867 s.one
868 mock.assert_called_with()
869 self.assertEqual(mock.mock_calls, [call(), call()])
870
871 s.one = 3
872 self.assertEqual(mock.mock_calls, [call(), call(), call(3)])
873 finally:
874 p.stop()
875
876
Michael Foordc2870622012-04-13 16:57:22 +0100877 def test_propertymock_returnvalue(self):
878 m = MagicMock()
879 p = PropertyMock()
880 type(m).foo = p
881
882 returned = m.foo
883 p.assert_called_once_with()
884 self.assertIsInstance(returned, MagicMock)
885 self.assertNotIsInstance(returned, PropertyMock)
886
887
Michael Foord345266a2012-03-14 12:24:34 -0700888if __name__ == '__main__':
889 unittest.main()