testpatch.py 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953
  1. # Copyright (C) 2007-2012 Michael Foord & the mock team
  2. # E-mail: fuzzyman AT voidspace DOT org DOT uk
  3. # http://www.voidspace.org.uk/python/mock/
  4. import os
  5. import sys
  6. from collections import OrderedDict
  7. import unittest
  8. from unittest.test.testmock import support
  9. from unittest.test.testmock.support import SomeClass, is_instance
  10. from test.test_importlib.util import uncache
  11. from unittest.mock import (
  12. NonCallableMock, CallableMixin, sentinel,
  13. MagicMock, Mock, NonCallableMagicMock, patch, _patch,
  14. DEFAULT, call, _get_target
  15. )
  16. builtin_string = 'builtins'
  17. PTModule = sys.modules[__name__]
  18. MODNAME = '%s.PTModule' % __name__
  19. def _get_proxy(obj, get_only=True):
  20. class Proxy(object):
  21. def __getattr__(self, name):
  22. return getattr(obj, name)
  23. if not get_only:
  24. def __setattr__(self, name, value):
  25. setattr(obj, name, value)
  26. def __delattr__(self, name):
  27. delattr(obj, name)
  28. Proxy.__setattr__ = __setattr__
  29. Proxy.__delattr__ = __delattr__
  30. return Proxy()
  31. # for use in the test
  32. something = sentinel.Something
  33. something_else = sentinel.SomethingElse
  34. class Foo(object):
  35. def __init__(self, a): pass
  36. def f(self, a): pass
  37. def g(self): pass
  38. foo = 'bar'
  39. @staticmethod
  40. def static_method(): pass
  41. @classmethod
  42. def class_method(cls): pass
  43. class Bar(object):
  44. def a(self): pass
  45. foo_name = '%s.Foo' % __name__
  46. def function(a, b=Foo): pass
  47. class Container(object):
  48. def __init__(self):
  49. self.values = {}
  50. def __getitem__(self, name):
  51. return self.values[name]
  52. def __setitem__(self, name, value):
  53. self.values[name] = value
  54. def __delitem__(self, name):
  55. del self.values[name]
  56. def __iter__(self):
  57. return iter(self.values)
  58. class PatchTest(unittest.TestCase):
  59. def assertNotCallable(self, obj, magic=True):
  60. MockClass = NonCallableMagicMock
  61. if not magic:
  62. MockClass = NonCallableMock
  63. self.assertRaises(TypeError, obj)
  64. self.assertTrue(is_instance(obj, MockClass))
  65. self.assertFalse(is_instance(obj, CallableMixin))
  66. def test_single_patchobject(self):
  67. class Something(object):
  68. attribute = sentinel.Original
  69. @patch.object(Something, 'attribute', sentinel.Patched)
  70. def test():
  71. self.assertEqual(Something.attribute, sentinel.Patched, "unpatched")
  72. test()
  73. self.assertEqual(Something.attribute, sentinel.Original,
  74. "patch not restored")
  75. def test_patchobject_with_string_as_target(self):
  76. msg = "'Something' must be the actual object to be patched, not a str"
  77. with self.assertRaisesRegex(TypeError, msg):
  78. patch.object('Something', 'do_something')
  79. def test_patchobject_with_none(self):
  80. class Something(object):
  81. attribute = sentinel.Original
  82. @patch.object(Something, 'attribute', None)
  83. def test():
  84. self.assertIsNone(Something.attribute, "unpatched")
  85. test()
  86. self.assertEqual(Something.attribute, sentinel.Original,
  87. "patch not restored")
  88. def test_multiple_patchobject(self):
  89. class Something(object):
  90. attribute = sentinel.Original
  91. next_attribute = sentinel.Original2
  92. @patch.object(Something, 'attribute', sentinel.Patched)
  93. @patch.object(Something, 'next_attribute', sentinel.Patched2)
  94. def test():
  95. self.assertEqual(Something.attribute, sentinel.Patched,
  96. "unpatched")
  97. self.assertEqual(Something.next_attribute, sentinel.Patched2,
  98. "unpatched")
  99. test()
  100. self.assertEqual(Something.attribute, sentinel.Original,
  101. "patch not restored")
  102. self.assertEqual(Something.next_attribute, sentinel.Original2,
  103. "patch not restored")
  104. def test_object_lookup_is_quite_lazy(self):
  105. global something
  106. original = something
  107. @patch('%s.something' % __name__, sentinel.Something2)
  108. def test():
  109. pass
  110. try:
  111. something = sentinel.replacement_value
  112. test()
  113. self.assertEqual(something, sentinel.replacement_value)
  114. finally:
  115. something = original
  116. def test_patch(self):
  117. @patch('%s.something' % __name__, sentinel.Something2)
  118. def test():
  119. self.assertEqual(PTModule.something, sentinel.Something2,
  120. "unpatched")
  121. test()
  122. self.assertEqual(PTModule.something, sentinel.Something,
  123. "patch not restored")
  124. @patch('%s.something' % __name__, sentinel.Something2)
  125. @patch('%s.something_else' % __name__, sentinel.SomethingElse)
  126. def test():
  127. self.assertEqual(PTModule.something, sentinel.Something2,
  128. "unpatched")
  129. self.assertEqual(PTModule.something_else, sentinel.SomethingElse,
  130. "unpatched")
  131. self.assertEqual(PTModule.something, sentinel.Something,
  132. "patch not restored")
  133. self.assertEqual(PTModule.something_else, sentinel.SomethingElse,
  134. "patch not restored")
  135. # Test the patching and restoring works a second time
  136. test()
  137. self.assertEqual(PTModule.something, sentinel.Something,
  138. "patch not restored")
  139. self.assertEqual(PTModule.something_else, sentinel.SomethingElse,
  140. "patch not restored")
  141. mock = Mock()
  142. mock.return_value = sentinel.Handle
  143. @patch('%s.open' % builtin_string, mock)
  144. def test():
  145. self.assertEqual(open('filename', 'r'), sentinel.Handle,
  146. "open not patched")
  147. test()
  148. test()
  149. self.assertNotEqual(open, mock, "patch not restored")
  150. def test_patch_class_attribute(self):
  151. @patch('%s.SomeClass.class_attribute' % __name__,
  152. sentinel.ClassAttribute)
  153. def test():
  154. self.assertEqual(PTModule.SomeClass.class_attribute,
  155. sentinel.ClassAttribute, "unpatched")
  156. test()
  157. self.assertIsNone(PTModule.SomeClass.class_attribute,
  158. "patch not restored")
  159. def test_patchobject_with_default_mock(self):
  160. class Test(object):
  161. something = sentinel.Original
  162. something2 = sentinel.Original2
  163. @patch.object(Test, 'something')
  164. def test(mock):
  165. self.assertEqual(mock, Test.something,
  166. "Mock not passed into test function")
  167. self.assertIsInstance(mock, MagicMock,
  168. "patch with two arguments did not create a mock")
  169. test()
  170. @patch.object(Test, 'something')
  171. @patch.object(Test, 'something2')
  172. def test(this1, this2, mock1, mock2):
  173. self.assertEqual(this1, sentinel.this1,
  174. "Patched function didn't receive initial argument")
  175. self.assertEqual(this2, sentinel.this2,
  176. "Patched function didn't receive second argument")
  177. self.assertEqual(mock1, Test.something2,
  178. "Mock not passed into test function")
  179. self.assertEqual(mock2, Test.something,
  180. "Second Mock not passed into test function")
  181. self.assertIsInstance(mock2, MagicMock,
  182. "patch with two arguments did not create a mock")
  183. self.assertIsInstance(mock2, MagicMock,
  184. "patch with two arguments did not create a mock")
  185. # A hack to test that new mocks are passed the second time
  186. self.assertNotEqual(outerMock1, mock1, "unexpected value for mock1")
  187. self.assertNotEqual(outerMock2, mock2, "unexpected value for mock1")
  188. return mock1, mock2
  189. outerMock1 = outerMock2 = None
  190. outerMock1, outerMock2 = test(sentinel.this1, sentinel.this2)
  191. # Test that executing a second time creates new mocks
  192. test(sentinel.this1, sentinel.this2)
  193. def test_patch_with_spec(self):
  194. @patch('%s.SomeClass' % __name__, spec=SomeClass)
  195. def test(MockSomeClass):
  196. self.assertEqual(SomeClass, MockSomeClass)
  197. self.assertTrue(is_instance(SomeClass.wibble, MagicMock))
  198. self.assertRaises(AttributeError, lambda: SomeClass.not_wibble)
  199. test()
  200. def test_patchobject_with_spec(self):
  201. @patch.object(SomeClass, 'class_attribute', spec=SomeClass)
  202. def test(MockAttribute):
  203. self.assertEqual(SomeClass.class_attribute, MockAttribute)
  204. self.assertTrue(is_instance(SomeClass.class_attribute.wibble,
  205. MagicMock))
  206. self.assertRaises(AttributeError,
  207. lambda: SomeClass.class_attribute.not_wibble)
  208. test()
  209. def test_patch_with_spec_as_list(self):
  210. @patch('%s.SomeClass' % __name__, spec=['wibble'])
  211. def test(MockSomeClass):
  212. self.assertEqual(SomeClass, MockSomeClass)
  213. self.assertTrue(is_instance(SomeClass.wibble, MagicMock))
  214. self.assertRaises(AttributeError, lambda: SomeClass.not_wibble)
  215. test()
  216. def test_patchobject_with_spec_as_list(self):
  217. @patch.object(SomeClass, 'class_attribute', spec=['wibble'])
  218. def test(MockAttribute):
  219. self.assertEqual(SomeClass.class_attribute, MockAttribute)
  220. self.assertTrue(is_instance(SomeClass.class_attribute.wibble,
  221. MagicMock))
  222. self.assertRaises(AttributeError,
  223. lambda: SomeClass.class_attribute.not_wibble)
  224. test()
  225. def test_nested_patch_with_spec_as_list(self):
  226. # regression test for nested decorators
  227. @patch('%s.open' % builtin_string)
  228. @patch('%s.SomeClass' % __name__, spec=['wibble'])
  229. def test(MockSomeClass, MockOpen):
  230. self.assertEqual(SomeClass, MockSomeClass)
  231. self.assertTrue(is_instance(SomeClass.wibble, MagicMock))
  232. self.assertRaises(AttributeError, lambda: SomeClass.not_wibble)
  233. test()
  234. def test_patch_with_spec_as_boolean(self):
  235. @patch('%s.SomeClass' % __name__, spec=True)
  236. def test(MockSomeClass):
  237. self.assertEqual(SomeClass, MockSomeClass)
  238. # Should not raise attribute error
  239. MockSomeClass.wibble
  240. self.assertRaises(AttributeError, lambda: MockSomeClass.not_wibble)
  241. test()
  242. def test_patch_object_with_spec_as_boolean(self):
  243. @patch.object(PTModule, 'SomeClass', spec=True)
  244. def test(MockSomeClass):
  245. self.assertEqual(SomeClass, MockSomeClass)
  246. # Should not raise attribute error
  247. MockSomeClass.wibble
  248. self.assertRaises(AttributeError, lambda: MockSomeClass.not_wibble)
  249. test()
  250. def test_patch_class_acts_with_spec_is_inherited(self):
  251. @patch('%s.SomeClass' % __name__, spec=True)
  252. def test(MockSomeClass):
  253. self.assertTrue(is_instance(MockSomeClass, MagicMock))
  254. instance = MockSomeClass()
  255. self.assertNotCallable(instance)
  256. # Should not raise attribute error
  257. instance.wibble
  258. self.assertRaises(AttributeError, lambda: instance.not_wibble)
  259. test()
  260. def test_patch_with_create_mocks_non_existent_attributes(self):
  261. @patch('%s.frooble' % builtin_string, sentinel.Frooble, create=True)
  262. def test():
  263. self.assertEqual(frooble, sentinel.Frooble)
  264. test()
  265. self.assertRaises(NameError, lambda: frooble)
  266. def test_patchobject_with_create_mocks_non_existent_attributes(self):
  267. @patch.object(SomeClass, 'frooble', sentinel.Frooble, create=True)
  268. def test():
  269. self.assertEqual(SomeClass.frooble, sentinel.Frooble)
  270. test()
  271. self.assertFalse(hasattr(SomeClass, 'frooble'))
  272. def test_patch_wont_create_by_default(self):
  273. with self.assertRaises(AttributeError):
  274. @patch('%s.frooble' % builtin_string, sentinel.Frooble)
  275. def test(): pass
  276. test()
  277. self.assertRaises(NameError, lambda: frooble)
  278. def test_patchobject_wont_create_by_default(self):
  279. with self.assertRaises(AttributeError):
  280. @patch.object(SomeClass, 'ord', sentinel.Frooble)
  281. def test(): pass
  282. test()
  283. self.assertFalse(hasattr(SomeClass, 'ord'))
  284. def test_patch_builtins_without_create(self):
  285. @patch(__name__+'.ord')
  286. def test_ord(mock_ord):
  287. mock_ord.return_value = 101
  288. return ord('c')
  289. @patch(__name__+'.open')
  290. def test_open(mock_open):
  291. m = mock_open.return_value
  292. m.read.return_value = 'abcd'
  293. fobj = open('doesnotexists.txt')
  294. data = fobj.read()
  295. fobj.close()
  296. return data
  297. self.assertEqual(test_ord(), 101)
  298. self.assertEqual(test_open(), 'abcd')
  299. def test_patch_with_static_methods(self):
  300. class Foo(object):
  301. @staticmethod
  302. def woot():
  303. return sentinel.Static
  304. @patch.object(Foo, 'woot', staticmethod(lambda: sentinel.Patched))
  305. def anonymous():
  306. self.assertEqual(Foo.woot(), sentinel.Patched)
  307. anonymous()
  308. self.assertEqual(Foo.woot(), sentinel.Static)
  309. def test_patch_local(self):
  310. foo = sentinel.Foo
  311. @patch.object(sentinel, 'Foo', 'Foo')
  312. def anonymous():
  313. self.assertEqual(sentinel.Foo, 'Foo')
  314. anonymous()
  315. self.assertEqual(sentinel.Foo, foo)
  316. def test_patch_slots(self):
  317. class Foo(object):
  318. __slots__ = ('Foo',)
  319. foo = Foo()
  320. foo.Foo = sentinel.Foo
  321. @patch.object(foo, 'Foo', 'Foo')
  322. def anonymous():
  323. self.assertEqual(foo.Foo, 'Foo')
  324. anonymous()
  325. self.assertEqual(foo.Foo, sentinel.Foo)
  326. def test_patchobject_class_decorator(self):
  327. class Something(object):
  328. attribute = sentinel.Original
  329. class Foo(object):
  330. def test_method(other_self):
  331. self.assertEqual(Something.attribute, sentinel.Patched,
  332. "unpatched")
  333. def not_test_method(other_self):
  334. self.assertEqual(Something.attribute, sentinel.Original,
  335. "non-test method patched")
  336. Foo = patch.object(Something, 'attribute', sentinel.Patched)(Foo)
  337. f = Foo()
  338. f.test_method()
  339. f.not_test_method()
  340. self.assertEqual(Something.attribute, sentinel.Original,
  341. "patch not restored")
  342. def test_patch_class_decorator(self):
  343. class Something(object):
  344. attribute = sentinel.Original
  345. class Foo(object):
  346. test_class_attr = 'whatever'
  347. def test_method(other_self, mock_something):
  348. self.assertEqual(PTModule.something, mock_something,
  349. "unpatched")
  350. def not_test_method(other_self):
  351. self.assertEqual(PTModule.something, sentinel.Something,
  352. "non-test method patched")
  353. Foo = patch('%s.something' % __name__)(Foo)
  354. f = Foo()
  355. f.test_method()
  356. f.not_test_method()
  357. self.assertEqual(Something.attribute, sentinel.Original,
  358. "patch not restored")
  359. self.assertEqual(PTModule.something, sentinel.Something,
  360. "patch not restored")
  361. def test_patchobject_twice(self):
  362. class Something(object):
  363. attribute = sentinel.Original
  364. next_attribute = sentinel.Original2
  365. @patch.object(Something, 'attribute', sentinel.Patched)
  366. @patch.object(Something, 'attribute', sentinel.Patched)
  367. def test():
  368. self.assertEqual(Something.attribute, sentinel.Patched, "unpatched")
  369. test()
  370. self.assertEqual(Something.attribute, sentinel.Original,
  371. "patch not restored")
  372. def test_patch_dict(self):
  373. foo = {'initial': object(), 'other': 'something'}
  374. original = foo.copy()
  375. @patch.dict(foo)
  376. def test():
  377. foo['a'] = 3
  378. del foo['initial']
  379. foo['other'] = 'something else'
  380. test()
  381. self.assertEqual(foo, original)
  382. @patch.dict(foo, {'a': 'b'})
  383. def test():
  384. self.assertEqual(len(foo), 3)
  385. self.assertEqual(foo['a'], 'b')
  386. test()
  387. self.assertEqual(foo, original)
  388. @patch.dict(foo, [('a', 'b')])
  389. def test():
  390. self.assertEqual(len(foo), 3)
  391. self.assertEqual(foo['a'], 'b')
  392. test()
  393. self.assertEqual(foo, original)
  394. def test_patch_dict_with_container_object(self):
  395. foo = Container()
  396. foo['initial'] = object()
  397. foo['other'] = 'something'
  398. original = foo.values.copy()
  399. @patch.dict(foo)
  400. def test():
  401. foo['a'] = 3
  402. del foo['initial']
  403. foo['other'] = 'something else'
  404. test()
  405. self.assertEqual(foo.values, original)
  406. @patch.dict(foo, {'a': 'b'})
  407. def test():
  408. self.assertEqual(len(foo.values), 3)
  409. self.assertEqual(foo['a'], 'b')
  410. test()
  411. self.assertEqual(foo.values, original)
  412. def test_patch_dict_with_clear(self):
  413. foo = {'initial': object(), 'other': 'something'}
  414. original = foo.copy()
  415. @patch.dict(foo, clear=True)
  416. def test():
  417. self.assertEqual(foo, {})
  418. foo['a'] = 3
  419. foo['other'] = 'something else'
  420. test()
  421. self.assertEqual(foo, original)
  422. @patch.dict(foo, {'a': 'b'}, clear=True)
  423. def test():
  424. self.assertEqual(foo, {'a': 'b'})
  425. test()
  426. self.assertEqual(foo, original)
  427. @patch.dict(foo, [('a', 'b')], clear=True)
  428. def test():
  429. self.assertEqual(foo, {'a': 'b'})
  430. test()
  431. self.assertEqual(foo, original)
  432. def test_patch_dict_with_container_object_and_clear(self):
  433. foo = Container()
  434. foo['initial'] = object()
  435. foo['other'] = 'something'
  436. original = foo.values.copy()
  437. @patch.dict(foo, clear=True)
  438. def test():
  439. self.assertEqual(foo.values, {})
  440. foo['a'] = 3
  441. foo['other'] = 'something else'
  442. test()
  443. self.assertEqual(foo.values, original)
  444. @patch.dict(foo, {'a': 'b'}, clear=True)
  445. def test():
  446. self.assertEqual(foo.values, {'a': 'b'})
  447. test()
  448. self.assertEqual(foo.values, original)
  449. def test_patch_dict_as_context_manager(self):
  450. foo = {'a': 'b'}
  451. with patch.dict(foo, a='c') as patched:
  452. self.assertEqual(patched, {'a': 'c'})
  453. self.assertEqual(foo, {'a': 'b'})
  454. def test_name_preserved(self):
  455. foo = {}
  456. @patch('%s.SomeClass' % __name__, object())
  457. @patch('%s.SomeClass' % __name__, object(), autospec=True)
  458. @patch.object(SomeClass, object())
  459. @patch.dict(foo)
  460. def some_name(): pass
  461. self.assertEqual(some_name.__name__, 'some_name')
  462. def test_patch_with_exception(self):
  463. foo = {}
  464. @patch.dict(foo, {'a': 'b'})
  465. def test():
  466. raise NameError('Konrad')
  467. with self.assertRaises(NameError):
  468. test()
  469. self.assertEqual(foo, {})
  470. def test_patch_dict_with_string(self):
  471. @patch.dict('os.environ', {'konrad_delong': 'some value'})
  472. def test():
  473. self.assertIn('konrad_delong', os.environ)
  474. test()
  475. def test_patch_dict_decorator_resolution(self):
  476. # bpo-35512: Ensure that patch with a string target resolves to
  477. # the new dictionary during function call
  478. original = support.target.copy()
  479. @patch.dict('unittest.test.testmock.support.target', {'bar': 'BAR'})
  480. def test():
  481. self.assertEqual(support.target, {'foo': 'BAZ', 'bar': 'BAR'})
  482. try:
  483. support.target = {'foo': 'BAZ'}
  484. test()
  485. self.assertEqual(support.target, {'foo': 'BAZ'})
  486. finally:
  487. support.target = original
  488. def test_patch_spec_set(self):
  489. @patch('%s.SomeClass' % __name__, spec=SomeClass, spec_set=True)
  490. def test(MockClass):
  491. MockClass.z = 'foo'
  492. self.assertRaises(AttributeError, test)
  493. @patch.object(support, 'SomeClass', spec=SomeClass, spec_set=True)
  494. def test(MockClass):
  495. MockClass.z = 'foo'
  496. self.assertRaises(AttributeError, test)
  497. @patch('%s.SomeClass' % __name__, spec_set=True)
  498. def test(MockClass):
  499. MockClass.z = 'foo'
  500. self.assertRaises(AttributeError, test)
  501. @patch.object(support, 'SomeClass', spec_set=True)
  502. def test(MockClass):
  503. MockClass.z = 'foo'
  504. self.assertRaises(AttributeError, test)
  505. def test_spec_set_inherit(self):
  506. @patch('%s.SomeClass' % __name__, spec_set=True)
  507. def test(MockClass):
  508. instance = MockClass()
  509. instance.z = 'foo'
  510. self.assertRaises(AttributeError, test)
  511. def test_patch_start_stop(self):
  512. original = something
  513. patcher = patch('%s.something' % __name__)
  514. self.assertIs(something, original)
  515. mock = patcher.start()
  516. try:
  517. self.assertIsNot(mock, original)
  518. self.assertIs(something, mock)
  519. finally:
  520. patcher.stop()
  521. self.assertIs(something, original)
  522. def test_stop_without_start(self):
  523. # bpo-36366: calling stop without start will return None.
  524. patcher = patch(foo_name, 'bar', 3)
  525. self.assertIsNone(patcher.stop())
  526. def test_stop_idempotent(self):
  527. # bpo-36366: calling stop on an already stopped patch will return None.
  528. patcher = patch(foo_name, 'bar', 3)
  529. patcher.start()
  530. patcher.stop()
  531. self.assertIsNone(patcher.stop())
  532. def test_patchobject_start_stop(self):
  533. original = something
  534. patcher = patch.object(PTModule, 'something', 'foo')
  535. self.assertIs(something, original)
  536. replaced = patcher.start()
  537. try:
  538. self.assertEqual(replaced, 'foo')
  539. self.assertIs(something, replaced)
  540. finally:
  541. patcher.stop()
  542. self.assertIs(something, original)
  543. def test_patch_dict_start_stop(self):
  544. d = {'foo': 'bar'}
  545. original = d.copy()
  546. patcher = patch.dict(d, [('spam', 'eggs')], clear=True)
  547. self.assertEqual(d, original)
  548. patcher.start()
  549. try:
  550. self.assertEqual(d, {'spam': 'eggs'})
  551. finally:
  552. patcher.stop()
  553. self.assertEqual(d, original)
  554. def test_patch_dict_stop_without_start(self):
  555. d = {'foo': 'bar'}
  556. original = d.copy()
  557. patcher = patch.dict(d, [('spam', 'eggs')], clear=True)
  558. self.assertFalse(patcher.stop())
  559. self.assertEqual(d, original)
  560. def test_patch_dict_class_decorator(self):
  561. this = self
  562. d = {'spam': 'eggs'}
  563. original = d.copy()
  564. class Test(object):
  565. def test_first(self):
  566. this.assertEqual(d, {'foo': 'bar'})
  567. def test_second(self):
  568. this.assertEqual(d, {'foo': 'bar'})
  569. Test = patch.dict(d, {'foo': 'bar'}, clear=True)(Test)
  570. self.assertEqual(d, original)
  571. test = Test()
  572. test.test_first()
  573. self.assertEqual(d, original)
  574. test.test_second()
  575. self.assertEqual(d, original)
  576. test = Test()
  577. test.test_first()
  578. self.assertEqual(d, original)
  579. test.test_second()
  580. self.assertEqual(d, original)
  581. def test_get_only_proxy(self):
  582. class Something(object):
  583. foo = 'foo'
  584. class SomethingElse:
  585. foo = 'foo'
  586. for thing in Something, SomethingElse, Something(), SomethingElse:
  587. proxy = _get_proxy(thing)
  588. @patch.object(proxy, 'foo', 'bar')
  589. def test():
  590. self.assertEqual(proxy.foo, 'bar')
  591. test()
  592. self.assertEqual(proxy.foo, 'foo')
  593. self.assertEqual(thing.foo, 'foo')
  594. self.assertNotIn('foo', proxy.__dict__)
  595. def test_get_set_delete_proxy(self):
  596. class Something(object):
  597. foo = 'foo'
  598. class SomethingElse:
  599. foo = 'foo'
  600. for thing in Something, SomethingElse, Something(), SomethingElse:
  601. proxy = _get_proxy(Something, get_only=False)
  602. @patch.object(proxy, 'foo', 'bar')
  603. def test():
  604. self.assertEqual(proxy.foo, 'bar')
  605. test()
  606. self.assertEqual(proxy.foo, 'foo')
  607. self.assertEqual(thing.foo, 'foo')
  608. self.assertNotIn('foo', proxy.__dict__)
  609. def test_patch_keyword_args(self):
  610. kwargs = {'side_effect': KeyError, 'foo.bar.return_value': 33,
  611. 'foo': MagicMock()}
  612. patcher = patch(foo_name, **kwargs)
  613. mock = patcher.start()
  614. patcher.stop()
  615. self.assertRaises(KeyError, mock)
  616. self.assertEqual(mock.foo.bar(), 33)
  617. self.assertIsInstance(mock.foo, MagicMock)
  618. def test_patch_object_keyword_args(self):
  619. kwargs = {'side_effect': KeyError, 'foo.bar.return_value': 33,
  620. 'foo': MagicMock()}
  621. patcher = patch.object(Foo, 'f', **kwargs)
  622. mock = patcher.start()
  623. patcher.stop()
  624. self.assertRaises(KeyError, mock)
  625. self.assertEqual(mock.foo.bar(), 33)
  626. self.assertIsInstance(mock.foo, MagicMock)
  627. def test_patch_dict_keyword_args(self):
  628. original = {'foo': 'bar'}
  629. copy = original.copy()
  630. patcher = patch.dict(original, foo=3, bar=4, baz=5)
  631. patcher.start()
  632. try:
  633. self.assertEqual(original, dict(foo=3, bar=4, baz=5))
  634. finally:
  635. patcher.stop()
  636. self.assertEqual(original, copy)
  637. def test_autospec(self):
  638. class Boo(object):
  639. def __init__(self, a): pass
  640. def f(self, a): pass
  641. def g(self): pass
  642. foo = 'bar'
  643. class Bar(object):
  644. def a(self): pass
  645. def _test(mock):
  646. mock(1)
  647. mock.assert_called_with(1)
  648. self.assertRaises(TypeError, mock)
  649. def _test2(mock):
  650. mock.f(1)
  651. mock.f.assert_called_with(1)
  652. self.assertRaises(TypeError, mock.f)
  653. mock.g()
  654. mock.g.assert_called_with()
  655. self.assertRaises(TypeError, mock.g, 1)
  656. self.assertRaises(AttributeError, getattr, mock, 'h')
  657. mock.foo.lower()
  658. mock.foo.lower.assert_called_with()
  659. self.assertRaises(AttributeError, getattr, mock.foo, 'bar')
  660. mock.Bar()
  661. mock.Bar.assert_called_with()
  662. mock.Bar.a()
  663. mock.Bar.a.assert_called_with()
  664. self.assertRaises(TypeError, mock.Bar.a, 1)
  665. mock.Bar().a()
  666. mock.Bar().a.assert_called_with()
  667. self.assertRaises(TypeError, mock.Bar().a, 1)
  668. self.assertRaises(AttributeError, getattr, mock.Bar, 'b')
  669. self.assertRaises(AttributeError, getattr, mock.Bar(), 'b')
  670. def function(mock):
  671. _test(mock)
  672. _test2(mock)
  673. _test2(mock(1))
  674. self.assertIs(mock, Foo)
  675. return mock
  676. test = patch(foo_name, autospec=True)(function)
  677. mock = test()
  678. self.assertIsNot(Foo, mock)
  679. # test patching a second time works
  680. test()
  681. module = sys.modules[__name__]
  682. test = patch.object(module, 'Foo', autospec=True)(function)
  683. mock = test()
  684. self.assertIsNot(Foo, mock)
  685. # test patching a second time works
  686. test()
  687. def test_autospec_function(self):
  688. @patch('%s.function' % __name__, autospec=True)
  689. def test(mock):
  690. function.assert_not_called()
  691. self.assertRaises(AssertionError, function.assert_called)
  692. self.assertRaises(AssertionError, function.assert_called_once)
  693. function(1)
  694. self.assertRaises(AssertionError, function.assert_not_called)
  695. function.assert_called_with(1)
  696. function.assert_called()
  697. function.assert_called_once()
  698. function(2, 3)
  699. function.assert_called_with(2, 3)
  700. self.assertRaises(TypeError, function)
  701. self.assertRaises(AttributeError, getattr, function, 'foo')
  702. test()
  703. def test_autospec_keywords(self):
  704. @patch('%s.function' % __name__, autospec=True,
  705. return_value=3)
  706. def test(mock_function):
  707. #self.assertEqual(function.abc, 'foo')
  708. return function(1, 2)
  709. result = test()
  710. self.assertEqual(result, 3)
  711. def test_autospec_staticmethod(self):
  712. with patch('%s.Foo.static_method' % __name__, autospec=True) as method:
  713. Foo.static_method()
  714. method.assert_called_once_with()
  715. def test_autospec_classmethod(self):
  716. with patch('%s.Foo.class_method' % __name__, autospec=True) as method:
  717. Foo.class_method()
  718. method.assert_called_once_with()
  719. def test_autospec_with_new(self):
  720. patcher = patch('%s.function' % __name__, new=3, autospec=True)
  721. self.assertRaises(TypeError, patcher.start)
  722. module = sys.modules[__name__]
  723. patcher = patch.object(module, 'function', new=3, autospec=True)
  724. self.assertRaises(TypeError, patcher.start)
  725. def test_autospec_with_object(self):
  726. class Bar(Foo):
  727. extra = []
  728. patcher = patch(foo_name, autospec=Bar)
  729. mock = patcher.start()
  730. try:
  731. self.assertIsInstance(mock, Bar)
  732. self.assertIsInstance(mock.extra, list)
  733. finally:
  734. patcher.stop()
  735. def test_autospec_inherits(self):
  736. FooClass = Foo
  737. patcher = patch(foo_name, autospec=True)
  738. mock = patcher.start()
  739. try:
  740. self.assertIsInstance(mock, FooClass)
  741. self.assertIsInstance(mock(3), FooClass)
  742. finally:
  743. patcher.stop()
  744. def test_autospec_name(self):
  745. patcher = patch(foo_name, autospec=True)
  746. mock = patcher.start()
  747. try:
  748. self.assertIn(" name='Foo'", repr(mock))
  749. self.assertIn(" name='Foo.f'", repr(mock.f))
  750. self.assertIn(" name='Foo()'", repr(mock(None)))
  751. self.assertIn(" name='Foo().f'", repr(mock(None).f))
  752. finally:
  753. patcher.stop()
  754. def test_tracebacks(self):
  755. @patch.object(Foo, 'f', object())
  756. def test():
  757. raise AssertionError
  758. try:
  759. test()
  760. except:
  761. err = sys.exc_info()
  762. result = unittest.TextTestResult(None, None, 0)
  763. traceback = result._exc_info_to_string(err, self)
  764. self.assertIn('raise AssertionError', traceback)
  765. def test_new_callable_patch(self):
  766. patcher = patch(foo_name, new_callable=NonCallableMagicMock)
  767. m1 = patcher.start()
  768. patcher.stop()
  769. m2 = patcher.start()
  770. patcher.stop()
  771. self.assertIsNot(m1, m2)
  772. for mock in m1, m2:
  773. self.assertNotCallable(m1)
  774. def test_new_callable_patch_object(self):
  775. patcher = patch.object(Foo, 'f', new_callable=NonCallableMagicMock)
  776. m1 = patcher.start()
  777. patcher.stop()
  778. m2 = patcher.start()
  779. patcher.stop()
  780. self.assertIsNot(m1, m2)
  781. for mock in m1, m2:
  782. self.assertNotCallable(m1)
  783. def test_new_callable_keyword_arguments(self):
  784. class Bar(object):
  785. kwargs = None
  786. def __init__(self, **kwargs):
  787. Bar.kwargs = kwargs
  788. patcher = patch(foo_name, new_callable=Bar, arg1=1, arg2=2)
  789. m = patcher.start()
  790. try:
  791. self.assertIs(type(m), Bar)
  792. self.assertEqual(Bar.kwargs, dict(arg1=1, arg2=2))
  793. finally:
  794. patcher.stop()
  795. def test_new_callable_spec(self):
  796. class Bar(object):
  797. kwargs = None
  798. def __init__(self, **kwargs):
  799. Bar.kwargs = kwargs
  800. patcher = patch(foo_name, new_callable=Bar, spec=Bar)
  801. patcher.start()
  802. try:
  803. self.assertEqual(Bar.kwargs, dict(spec=Bar))
  804. finally:
  805. patcher.stop()
  806. patcher = patch(foo_name, new_callable=Bar, spec_set=Bar)
  807. patcher.start()
  808. try:
  809. self.assertEqual(Bar.kwargs, dict(spec_set=Bar))
  810. finally:
  811. patcher.stop()
  812. def test_new_callable_create(self):
  813. non_existent_attr = '%s.weeeee' % foo_name
  814. p = patch(non_existent_attr, new_callable=NonCallableMock)
  815. self.assertRaises(AttributeError, p.start)
  816. p = patch(non_existent_attr, new_callable=NonCallableMock,
  817. create=True)
  818. m = p.start()
  819. try:
  820. self.assertNotCallable(m, magic=False)
  821. finally:
  822. p.stop()
  823. def test_new_callable_incompatible_with_new(self):
  824. self.assertRaises(
  825. ValueError, patch, foo_name, new=object(), new_callable=MagicMock
  826. )
  827. self.assertRaises(
  828. ValueError, patch.object, Foo, 'f', new=object(),
  829. new_callable=MagicMock
  830. )
  831. def test_new_callable_incompatible_with_autospec(self):
  832. self.assertRaises(
  833. ValueError, patch, foo_name, new_callable=MagicMock,
  834. autospec=True
  835. )
  836. self.assertRaises(
  837. ValueError, patch.object, Foo, 'f', new_callable=MagicMock,
  838. autospec=True
  839. )
  840. def test_new_callable_inherit_for_mocks(self):
  841. class MockSub(Mock):
  842. pass
  843. MockClasses = (
  844. NonCallableMock, NonCallableMagicMock, MagicMock, Mock, MockSub
  845. )
  846. for Klass in MockClasses:
  847. for arg in 'spec', 'spec_set':
  848. kwargs = {arg: True}
  849. p = patch(foo_name, new_callable=Klass, **kwargs)
  850. m = p.start()
  851. try:
  852. instance = m.return_value
  853. self.assertRaises(AttributeError, getattr, instance, 'x')
  854. finally:
  855. p.stop()
  856. def test_new_callable_inherit_non_mock(self):
  857. class NotAMock(object):
  858. def __init__(self, spec):
  859. self.spec = spec
  860. p = patch(foo_name, new_callable=NotAMock, spec=True)
  861. m = p.start()
  862. try:
  863. self.assertTrue(is_instance(m, NotAMock))
  864. self.assertRaises(AttributeError, getattr, m, 'return_value')
  865. finally:
  866. p.stop()
  867. self.assertEqual(m.spec, Foo)
  868. def test_new_callable_class_decorating(self):
  869. test = self
  870. original = Foo
  871. class SomeTest(object):
  872. def _test(self, mock_foo):
  873. test.assertIsNot(Foo, original)
  874. test.assertIs(Foo, mock_foo)
  875. test.assertIsInstance(Foo, SomeClass)
  876. def test_two(self, mock_foo):
  877. self._test(mock_foo)
  878. def test_one(self, mock_foo):
  879. self._test(mock_foo)
  880. SomeTest = patch(foo_name, new_callable=SomeClass)(SomeTest)
  881. SomeTest().test_one()
  882. SomeTest().test_two()
  883. self.assertIs(Foo, original)
  884. def test_patch_multiple(self):
  885. original_foo = Foo
  886. original_f = Foo.f
  887. original_g = Foo.g
  888. patcher1 = patch.multiple(foo_name, f=1, g=2)
  889. patcher2 = patch.multiple(Foo, f=1, g=2)
  890. for patcher in patcher1, patcher2:
  891. patcher.start()
  892. try:
  893. self.assertIs(Foo, original_foo)
  894. self.assertEqual(Foo.f, 1)
  895. self.assertEqual(Foo.g, 2)
  896. finally:
  897. patcher.stop()
  898. self.assertIs(Foo, original_foo)
  899. self.assertEqual(Foo.f, original_f)
  900. self.assertEqual(Foo.g, original_g)
  901. @patch.multiple(foo_name, f=3, g=4)
  902. def test():
  903. self.assertIs(Foo, original_foo)
  904. self.assertEqual(Foo.f, 3)
  905. self.assertEqual(Foo.g, 4)
  906. test()
  907. def test_patch_multiple_no_kwargs(self):
  908. self.assertRaises(ValueError, patch.multiple, foo_name)
  909. self.assertRaises(ValueError, patch.multiple, Foo)
  910. def test_patch_multiple_create_mocks(self):
  911. original_foo = Foo
  912. original_f = Foo.f
  913. original_g = Foo.g
  914. @patch.multiple(foo_name, f=DEFAULT, g=3, foo=DEFAULT)
  915. def test(f, foo):
  916. self.assertIs(Foo, original_foo)
  917. self.assertIs(Foo.f, f)
  918. self.assertEqual(Foo.g, 3)
  919. self.assertIs(Foo.foo, foo)
  920. self.assertTrue(is_instance(f, MagicMock))
  921. self.assertTrue(is_instance(foo, MagicMock))
  922. test()
  923. self.assertEqual(Foo.f, original_f)
  924. self.assertEqual(Foo.g, original_g)
  925. def test_patch_multiple_create_mocks_different_order(self):
  926. original_f = Foo.f
  927. original_g = Foo.g
  928. patcher = patch.object(Foo, 'f', 3)
  929. patcher.attribute_name = 'f'
  930. other = patch.object(Foo, 'g', DEFAULT)
  931. other.attribute_name = 'g'
  932. patcher.additional_patchers = [other]
  933. @patcher
  934. def test(g):
  935. self.assertIs(Foo.g, g)
  936. self.assertEqual(Foo.f, 3)
  937. test()
  938. self.assertEqual(Foo.f, original_f)
  939. self.assertEqual(Foo.g, original_g)
  940. def test_patch_multiple_stacked_decorators(self):
  941. original_foo = Foo
  942. original_f = Foo.f
  943. original_g = Foo.g
  944. @patch.multiple(foo_name, f=DEFAULT)
  945. @patch.multiple(foo_name, foo=DEFAULT)
  946. @patch(foo_name + '.g')
  947. def test1(g, **kwargs):
  948. _test(g, **kwargs)
  949. @patch.multiple(foo_name, f=DEFAULT)
  950. @patch(foo_name + '.g')
  951. @patch.multiple(foo_name, foo=DEFAULT)
  952. def test2(g, **kwargs):
  953. _test(g, **kwargs)
  954. @patch(foo_name + '.g')
  955. @patch.multiple(foo_name, f=DEFAULT)
  956. @patch.multiple(foo_name, foo=DEFAULT)
  957. def test3(g, **kwargs):
  958. _test(g, **kwargs)
  959. def _test(g, **kwargs):
  960. f = kwargs.pop('f')
  961. foo = kwargs.pop('foo')
  962. self.assertFalse(kwargs)
  963. self.assertIs(Foo, original_foo)
  964. self.assertIs(Foo.f, f)
  965. self.assertIs(Foo.g, g)
  966. self.assertIs(Foo.foo, foo)
  967. self.assertTrue(is_instance(f, MagicMock))
  968. self.assertTrue(is_instance(g, MagicMock))
  969. self.assertTrue(is_instance(foo, MagicMock))
  970. test1()
  971. test2()
  972. test3()
  973. self.assertEqual(Foo.f, original_f)
  974. self.assertEqual(Foo.g, original_g)
  975. def test_patch_multiple_create_mocks_patcher(self):
  976. original_foo = Foo
  977. original_f = Foo.f
  978. original_g = Foo.g
  979. patcher = patch.multiple(foo_name, f=DEFAULT, g=3, foo=DEFAULT)
  980. result = patcher.start()
  981. try:
  982. f = result['f']
  983. foo = result['foo']
  984. self.assertEqual(set(result), set(['f', 'foo']))
  985. self.assertIs(Foo, original_foo)
  986. self.assertIs(Foo.f, f)
  987. self.assertIs(Foo.foo, foo)
  988. self.assertTrue(is_instance(f, MagicMock))
  989. self.assertTrue(is_instance(foo, MagicMock))
  990. finally:
  991. patcher.stop()
  992. self.assertEqual(Foo.f, original_f)
  993. self.assertEqual(Foo.g, original_g)
  994. def test_patch_multiple_decorating_class(self):
  995. test = self
  996. original_foo = Foo
  997. original_f = Foo.f
  998. original_g = Foo.g
  999. class SomeTest(object):
  1000. def _test(self, f, foo):
  1001. test.assertIs(Foo, original_foo)
  1002. test.assertIs(Foo.f, f)
  1003. test.assertEqual(Foo.g, 3)
  1004. test.assertIs(Foo.foo, foo)
  1005. test.assertTrue(is_instance(f, MagicMock))
  1006. test.assertTrue(is_instance(foo, MagicMock))
  1007. def test_two(self, f, foo):
  1008. self._test(f, foo)
  1009. def test_one(self, f, foo):
  1010. self._test(f, foo)
  1011. SomeTest = patch.multiple(
  1012. foo_name, f=DEFAULT, g=3, foo=DEFAULT
  1013. )(SomeTest)
  1014. thing = SomeTest()
  1015. thing.test_one()
  1016. thing.test_two()
  1017. self.assertEqual(Foo.f, original_f)
  1018. self.assertEqual(Foo.g, original_g)
  1019. def test_patch_multiple_create(self):
  1020. patcher = patch.multiple(Foo, blam='blam')
  1021. self.assertRaises(AttributeError, patcher.start)
  1022. patcher = patch.multiple(Foo, blam='blam', create=True)
  1023. patcher.start()
  1024. try:
  1025. self.assertEqual(Foo.blam, 'blam')
  1026. finally:
  1027. patcher.stop()
  1028. self.assertFalse(hasattr(Foo, 'blam'))
  1029. def test_patch_multiple_spec_set(self):
  1030. # if spec_set works then we can assume that spec and autospec also
  1031. # work as the underlying machinery is the same
  1032. patcher = patch.multiple(Foo, foo=DEFAULT, spec_set=['a', 'b'])
  1033. result = patcher.start()
  1034. try:
  1035. self.assertEqual(Foo.foo, result['foo'])
  1036. Foo.foo.a(1)
  1037. Foo.foo.b(2)
  1038. Foo.foo.a.assert_called_with(1)
  1039. Foo.foo.b.assert_called_with(2)
  1040. self.assertRaises(AttributeError, setattr, Foo.foo, 'c', None)
  1041. finally:
  1042. patcher.stop()
  1043. def test_patch_multiple_new_callable(self):
  1044. class Thing(object):
  1045. pass
  1046. patcher = patch.multiple(
  1047. Foo, f=DEFAULT, g=DEFAULT, new_callable=Thing
  1048. )
  1049. result = patcher.start()
  1050. try:
  1051. self.assertIs(Foo.f, result['f'])
  1052. self.assertIs(Foo.g, result['g'])
  1053. self.assertIsInstance(Foo.f, Thing)
  1054. self.assertIsInstance(Foo.g, Thing)
  1055. self.assertIsNot(Foo.f, Foo.g)
  1056. finally:
  1057. patcher.stop()
  1058. def test_nested_patch_failure(self):
  1059. original_f = Foo.f
  1060. original_g = Foo.g
  1061. @patch.object(Foo, 'g', 1)
  1062. @patch.object(Foo, 'missing', 1)
  1063. @patch.object(Foo, 'f', 1)
  1064. def thing1(): pass
  1065. @patch.object(Foo, 'missing', 1)
  1066. @patch.object(Foo, 'g', 1)
  1067. @patch.object(Foo, 'f', 1)
  1068. def thing2(): pass
  1069. @patch.object(Foo, 'g', 1)
  1070. @patch.object(Foo, 'f', 1)
  1071. @patch.object(Foo, 'missing', 1)
  1072. def thing3(): pass
  1073. for func in thing1, thing2, thing3:
  1074. self.assertRaises(AttributeError, func)
  1075. self.assertEqual(Foo.f, original_f)
  1076. self.assertEqual(Foo.g, original_g)
  1077. def test_new_callable_failure(self):
  1078. original_f = Foo.f
  1079. original_g = Foo.g
  1080. original_foo = Foo.foo
  1081. def crasher():
  1082. raise NameError('crasher')
  1083. @patch.object(Foo, 'g', 1)
  1084. @patch.object(Foo, 'foo', new_callable=crasher)
  1085. @patch.object(Foo, 'f', 1)
  1086. def thing1(): pass
  1087. @patch.object(Foo, 'foo', new_callable=crasher)
  1088. @patch.object(Foo, 'g', 1)
  1089. @patch.object(Foo, 'f', 1)
  1090. def thing2(): pass
  1091. @patch.object(Foo, 'g', 1)
  1092. @patch.object(Foo, 'f', 1)
  1093. @patch.object(Foo, 'foo', new_callable=crasher)
  1094. def thing3(): pass
  1095. for func in thing1, thing2, thing3:
  1096. self.assertRaises(NameError, func)
  1097. self.assertEqual(Foo.f, original_f)
  1098. self.assertEqual(Foo.g, original_g)
  1099. self.assertEqual(Foo.foo, original_foo)
  1100. def test_patch_multiple_failure(self):
  1101. original_f = Foo.f
  1102. original_g = Foo.g
  1103. patcher = patch.object(Foo, 'f', 1)
  1104. patcher.attribute_name = 'f'
  1105. good = patch.object(Foo, 'g', 1)
  1106. good.attribute_name = 'g'
  1107. bad = patch.object(Foo, 'missing', 1)
  1108. bad.attribute_name = 'missing'
  1109. for additionals in [good, bad], [bad, good]:
  1110. patcher.additional_patchers = additionals
  1111. @patcher
  1112. def func(): pass
  1113. self.assertRaises(AttributeError, func)
  1114. self.assertEqual(Foo.f, original_f)
  1115. self.assertEqual(Foo.g, original_g)
  1116. def test_patch_multiple_new_callable_failure(self):
  1117. original_f = Foo.f
  1118. original_g = Foo.g
  1119. original_foo = Foo.foo
  1120. def crasher():
  1121. raise NameError('crasher')
  1122. patcher = patch.object(Foo, 'f', 1)
  1123. patcher.attribute_name = 'f'
  1124. good = patch.object(Foo, 'g', 1)
  1125. good.attribute_name = 'g'
  1126. bad = patch.object(Foo, 'foo', new_callable=crasher)
  1127. bad.attribute_name = 'foo'
  1128. for additionals in [good, bad], [bad, good]:
  1129. patcher.additional_patchers = additionals
  1130. @patcher
  1131. def func(): pass
  1132. self.assertRaises(NameError, func)
  1133. self.assertEqual(Foo.f, original_f)
  1134. self.assertEqual(Foo.g, original_g)
  1135. self.assertEqual(Foo.foo, original_foo)
  1136. def test_patch_multiple_string_subclasses(self):
  1137. Foo = type('Foo', (str,), {'fish': 'tasty'})
  1138. foo = Foo()
  1139. @patch.multiple(foo, fish='nearly gone')
  1140. def test():
  1141. self.assertEqual(foo.fish, 'nearly gone')
  1142. test()
  1143. self.assertEqual(foo.fish, 'tasty')
  1144. @patch('unittest.mock.patch.TEST_PREFIX', 'foo')
  1145. def test_patch_test_prefix(self):
  1146. class Foo(object):
  1147. thing = 'original'
  1148. def foo_one(self):
  1149. return self.thing
  1150. def foo_two(self):
  1151. return self.thing
  1152. def test_one(self):
  1153. return self.thing
  1154. def test_two(self):
  1155. return self.thing
  1156. Foo = patch.object(Foo, 'thing', 'changed')(Foo)
  1157. foo = Foo()
  1158. self.assertEqual(foo.foo_one(), 'changed')
  1159. self.assertEqual(foo.foo_two(), 'changed')
  1160. self.assertEqual(foo.test_one(), 'original')
  1161. self.assertEqual(foo.test_two(), 'original')
  1162. @patch('unittest.mock.patch.TEST_PREFIX', 'bar')
  1163. def test_patch_dict_test_prefix(self):
  1164. class Foo(object):
  1165. def bar_one(self):
  1166. return dict(the_dict)
  1167. def bar_two(self):
  1168. return dict(the_dict)
  1169. def test_one(self):
  1170. return dict(the_dict)
  1171. def test_two(self):
  1172. return dict(the_dict)
  1173. the_dict = {'key': 'original'}
  1174. Foo = patch.dict(the_dict, key='changed')(Foo)
  1175. foo =Foo()
  1176. self.assertEqual(foo.bar_one(), {'key': 'changed'})
  1177. self.assertEqual(foo.bar_two(), {'key': 'changed'})
  1178. self.assertEqual(foo.test_one(), {'key': 'original'})
  1179. self.assertEqual(foo.test_two(), {'key': 'original'})
  1180. def test_patch_with_spec_mock_repr(self):
  1181. for arg in ('spec', 'autospec', 'spec_set'):
  1182. p = patch('%s.SomeClass' % __name__, **{arg: True})
  1183. m = p.start()
  1184. try:
  1185. self.assertIn(" name='SomeClass'", repr(m))
  1186. self.assertIn(" name='SomeClass.class_attribute'",
  1187. repr(m.class_attribute))
  1188. self.assertIn(" name='SomeClass()'", repr(m()))
  1189. self.assertIn(" name='SomeClass().class_attribute'",
  1190. repr(m().class_attribute))
  1191. finally:
  1192. p.stop()
  1193. def test_patch_nested_autospec_repr(self):
  1194. with patch('unittest.test.testmock.support', autospec=True) as m:
  1195. self.assertIn(" name='support.SomeClass.wibble()'",
  1196. repr(m.SomeClass.wibble()))
  1197. self.assertIn(" name='support.SomeClass().wibble()'",
  1198. repr(m.SomeClass().wibble()))
  1199. def test_mock_calls_with_patch(self):
  1200. for arg in ('spec', 'autospec', 'spec_set'):
  1201. p = patch('%s.SomeClass' % __name__, **{arg: True})
  1202. m = p.start()
  1203. try:
  1204. m.wibble()
  1205. kalls = [call.wibble()]
  1206. self.assertEqual(m.mock_calls, kalls)
  1207. self.assertEqual(m.method_calls, kalls)
  1208. self.assertEqual(m.wibble.mock_calls, [call()])
  1209. result = m()
  1210. kalls.append(call())
  1211. self.assertEqual(m.mock_calls, kalls)
  1212. result.wibble()
  1213. kalls.append(call().wibble())
  1214. self.assertEqual(m.mock_calls, kalls)
  1215. self.assertEqual(result.mock_calls, [call.wibble()])
  1216. self.assertEqual(result.wibble.mock_calls, [call()])
  1217. self.assertEqual(result.method_calls, [call.wibble()])
  1218. finally:
  1219. p.stop()
  1220. def test_patch_imports_lazily(self):
  1221. p1 = patch('squizz.squozz')
  1222. self.assertRaises(ImportError, p1.start)
  1223. with uncache('squizz'):
  1224. squizz = Mock()
  1225. sys.modules['squizz'] = squizz
  1226. squizz.squozz = 6
  1227. p1 = patch('squizz.squozz')
  1228. squizz.squozz = 3
  1229. p1.start()
  1230. p1.stop()
  1231. self.assertEqual(squizz.squozz, 3)
  1232. def test_patch_propagates_exc_on_exit(self):
  1233. class holder:
  1234. exc_info = None, None, None
  1235. class custom_patch(_patch):
  1236. def __exit__(self, etype=None, val=None, tb=None):
  1237. _patch.__exit__(self, etype, val, tb)
  1238. holder.exc_info = etype, val, tb
  1239. stop = __exit__
  1240. def with_custom_patch(target):
  1241. getter, attribute = _get_target(target)
  1242. return custom_patch(
  1243. getter, attribute, DEFAULT, None, False, None,
  1244. None, None, {}
  1245. )
  1246. @with_custom_patch('squizz.squozz')
  1247. def test(mock):
  1248. raise RuntimeError
  1249. with uncache('squizz'):
  1250. squizz = Mock()
  1251. sys.modules['squizz'] = squizz
  1252. self.assertRaises(RuntimeError, test)
  1253. self.assertIs(holder.exc_info[0], RuntimeError)
  1254. self.assertIsNotNone(holder.exc_info[1],
  1255. 'exception value not propagated')
  1256. self.assertIsNotNone(holder.exc_info[2],
  1257. 'exception traceback not propagated')
  1258. def test_create_and_specs(self):
  1259. for kwarg in ('spec', 'spec_set', 'autospec'):
  1260. p = patch('%s.doesnotexist' % __name__, create=True,
  1261. **{kwarg: True})
  1262. self.assertRaises(TypeError, p.start)
  1263. self.assertRaises(NameError, lambda: doesnotexist)
  1264. # check that spec with create is innocuous if the original exists
  1265. p = patch(MODNAME, create=True, **{kwarg: True})
  1266. p.start()
  1267. p.stop()
  1268. def test_multiple_specs(self):
  1269. original = PTModule
  1270. for kwarg in ('spec', 'spec_set'):
  1271. p = patch(MODNAME, autospec=0, **{kwarg: 0})
  1272. self.assertRaises(TypeError, p.start)
  1273. self.assertIs(PTModule, original)
  1274. for kwarg in ('spec', 'autospec'):
  1275. p = patch(MODNAME, spec_set=0, **{kwarg: 0})
  1276. self.assertRaises(TypeError, p.start)
  1277. self.assertIs(PTModule, original)
  1278. for kwarg in ('spec_set', 'autospec'):
  1279. p = patch(MODNAME, spec=0, **{kwarg: 0})
  1280. self.assertRaises(TypeError, p.start)
  1281. self.assertIs(PTModule, original)
  1282. def test_specs_false_instead_of_none(self):
  1283. p = patch(MODNAME, spec=False, spec_set=False, autospec=False)
  1284. mock = p.start()
  1285. try:
  1286. # no spec should have been set, so attribute access should not fail
  1287. mock.does_not_exist
  1288. mock.does_not_exist = 3
  1289. finally:
  1290. p.stop()
  1291. def test_falsey_spec(self):
  1292. for kwarg in ('spec', 'autospec', 'spec_set'):
  1293. p = patch(MODNAME, **{kwarg: 0})
  1294. m = p.start()
  1295. try:
  1296. self.assertRaises(AttributeError, getattr, m, 'doesnotexit')
  1297. finally:
  1298. p.stop()
  1299. def test_spec_set_true(self):
  1300. for kwarg in ('spec', 'autospec'):
  1301. p = patch(MODNAME, spec_set=True, **{kwarg: True})
  1302. m = p.start()
  1303. try:
  1304. self.assertRaises(AttributeError, setattr, m,
  1305. 'doesnotexist', 'something')
  1306. self.assertRaises(AttributeError, getattr, m, 'doesnotexist')
  1307. finally:
  1308. p.stop()
  1309. def test_callable_spec_as_list(self):
  1310. spec = ('__call__',)
  1311. p = patch(MODNAME, spec=spec)
  1312. m = p.start()
  1313. try:
  1314. self.assertTrue(callable(m))
  1315. finally:
  1316. p.stop()
  1317. def test_not_callable_spec_as_list(self):
  1318. spec = ('foo', 'bar')
  1319. p = patch(MODNAME, spec=spec)
  1320. m = p.start()
  1321. try:
  1322. self.assertFalse(callable(m))
  1323. finally:
  1324. p.stop()
  1325. def test_patch_stopall(self):
  1326. unlink = os.unlink
  1327. chdir = os.chdir
  1328. path = os.path
  1329. patch('os.unlink', something).start()
  1330. patch('os.chdir', something_else).start()
  1331. @patch('os.path')
  1332. def patched(mock_path):
  1333. patch.stopall()
  1334. self.assertIs(os.path, mock_path)
  1335. self.assertIs(os.unlink, unlink)
  1336. self.assertIs(os.chdir, chdir)
  1337. patched()
  1338. self.assertIs(os.path, path)
  1339. def test_stopall_lifo(self):
  1340. stopped = []
  1341. class thing(object):
  1342. one = two = three = None
  1343. def get_patch(attribute):
  1344. class mypatch(_patch):
  1345. def stop(self):
  1346. stopped.append(attribute)
  1347. return super(mypatch, self).stop()
  1348. return mypatch(lambda: thing, attribute, None, None,
  1349. False, None, None, None, {})
  1350. [get_patch(val).start() for val in ("one", "two", "three")]
  1351. patch.stopall()
  1352. self.assertEqual(stopped, ["three", "two", "one"])
  1353. def test_patch_dict_stopall(self):
  1354. dic1 = {}
  1355. dic2 = {1: 'a'}
  1356. dic3 = {1: 'A', 2: 'B'}
  1357. origdic1 = dic1.copy()
  1358. origdic2 = dic2.copy()
  1359. origdic3 = dic3.copy()
  1360. patch.dict(dic1, {1: 'I', 2: 'II'}).start()
  1361. patch.dict(dic2, {2: 'b'}).start()
  1362. @patch.dict(dic3)
  1363. def patched():
  1364. del dic3[1]
  1365. patched()
  1366. self.assertNotEqual(dic1, origdic1)
  1367. self.assertNotEqual(dic2, origdic2)
  1368. self.assertEqual(dic3, origdic3)
  1369. patch.stopall()
  1370. self.assertEqual(dic1, origdic1)
  1371. self.assertEqual(dic2, origdic2)
  1372. self.assertEqual(dic3, origdic3)
  1373. def test_patch_and_patch_dict_stopall(self):
  1374. original_unlink = os.unlink
  1375. original_chdir = os.chdir
  1376. dic1 = {}
  1377. dic2 = {1: 'A', 2: 'B'}
  1378. origdic1 = dic1.copy()
  1379. origdic2 = dic2.copy()
  1380. patch('os.unlink', something).start()
  1381. patch('os.chdir', something_else).start()
  1382. patch.dict(dic1, {1: 'I', 2: 'II'}).start()
  1383. patch.dict(dic2).start()
  1384. del dic2[1]
  1385. self.assertIsNot(os.unlink, original_unlink)
  1386. self.assertIsNot(os.chdir, original_chdir)
  1387. self.assertNotEqual(dic1, origdic1)
  1388. self.assertNotEqual(dic2, origdic2)
  1389. patch.stopall()
  1390. self.assertIs(os.unlink, original_unlink)
  1391. self.assertIs(os.chdir, original_chdir)
  1392. self.assertEqual(dic1, origdic1)
  1393. self.assertEqual(dic2, origdic2)
  1394. def test_special_attrs(self):
  1395. def foo(x=0):
  1396. """TEST"""
  1397. return x
  1398. with patch.object(foo, '__defaults__', (1, )):
  1399. self.assertEqual(foo(), 1)
  1400. self.assertEqual(foo(), 0)
  1401. orig_doc = foo.__doc__
  1402. with patch.object(foo, '__doc__', "FUN"):
  1403. self.assertEqual(foo.__doc__, "FUN")
  1404. self.assertEqual(foo.__doc__, orig_doc)
  1405. with patch.object(foo, '__module__', "testpatch2"):
  1406. self.assertEqual(foo.__module__, "testpatch2")
  1407. self.assertEqual(foo.__module__, 'unittest.test.testmock.testpatch')
  1408. with patch.object(foo, '__annotations__', dict([('s', 1, )])):
  1409. self.assertEqual(foo.__annotations__, dict([('s', 1, )]))
  1410. self.assertEqual(foo.__annotations__, dict())
  1411. def foo(*a, x=0):
  1412. return x
  1413. with patch.object(foo, '__kwdefaults__', dict([('x', 1, )])):
  1414. self.assertEqual(foo(), 1)
  1415. self.assertEqual(foo(), 0)
  1416. def test_patch_orderdict(self):
  1417. foo = OrderedDict()
  1418. foo['a'] = object()
  1419. foo['b'] = 'python'
  1420. original = foo.copy()
  1421. update_values = list(zip('cdefghijklmnopqrstuvwxyz', range(26)))
  1422. patched_values = list(foo.items()) + update_values
  1423. with patch.dict(foo, OrderedDict(update_values)):
  1424. self.assertEqual(list(foo.items()), patched_values)
  1425. self.assertEqual(foo, original)
  1426. with patch.dict(foo, update_values):
  1427. self.assertEqual(list(foo.items()), patched_values)
  1428. self.assertEqual(foo, original)
  1429. def test_dotted_but_module_not_loaded(self):
  1430. # This exercises the AttributeError branch of _dot_lookup.
  1431. # make sure it's there
  1432. import unittest.test.testmock.support
  1433. # now make sure it's not:
  1434. with patch.dict('sys.modules'):
  1435. del sys.modules['unittest.test.testmock.support']
  1436. del sys.modules['unittest.test.testmock']
  1437. del sys.modules['unittest.test']
  1438. del sys.modules['unittest']
  1439. # now make sure we can patch based on a dotted path:
  1440. @patch('unittest.test.testmock.support.X')
  1441. def test(mock):
  1442. pass
  1443. test()
  1444. def test_invalid_target(self):
  1445. class Foo:
  1446. pass
  1447. for target in ['', 12, Foo()]:
  1448. with self.subTest(target=target):
  1449. with self.assertRaises(TypeError):
  1450. patch(target)
  1451. def test_cant_set_kwargs_when_passing_a_mock(self):
  1452. @patch('unittest.test.testmock.support.X', new=object(), x=1)
  1453. def test(): pass
  1454. with self.assertRaises(TypeError):
  1455. test()
  1456. if __name__ == '__main__':
  1457. unittest.main()