testpatch.py 54 KB

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