MockObjectTest.php 31 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034
  1. <?php
  2. /*
  3. * This file is part of the PHPUnit_MockObject package.
  4. *
  5. * (c) Sebastian Bergmann <sebastian@phpunit.de>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. class Framework_MockObjectTest extends PHPUnit_Framework_TestCase
  11. {
  12. public function testMockedMethodIsNeverCalled()
  13. {
  14. $mock = $this->getMockBuilder(AnInterface::class)
  15. ->getMock();
  16. $mock->expects($this->never())
  17. ->method('doSomething');
  18. }
  19. public function testMockedMethodIsNeverCalledWithParameter()
  20. {
  21. $mock = $this->getMockBuilder(SomeClass::class)
  22. ->getMock();
  23. $mock->expects($this->never())
  24. ->method('doSomething')
  25. ->with('someArg');
  26. }
  27. /**
  28. * @doesNotPerformAssertions
  29. */
  30. public function testMockedMethodIsNotCalledWhenExpectsAnyWithParameter()
  31. {
  32. $mock = $this->getMockBuilder(SomeClass::class)
  33. ->getMock();
  34. $mock->expects($this->any())
  35. ->method('doSomethingElse')
  36. ->with('someArg');
  37. }
  38. /**
  39. * @doesNotPerformAssertions
  40. */
  41. public function testMockedMethodIsNotCalledWhenMethodSpecifiedDirectlyWithParameter()
  42. {
  43. $mock = $this->getMockBuilder(SomeClass::class)
  44. ->getMock();
  45. $mock->method('doSomethingElse')
  46. ->with('someArg');
  47. }
  48. public function testMockedMethodIsCalledAtLeastOnce()
  49. {
  50. $mock = $this->getMockBuilder(AnInterface::class)
  51. ->getMock();
  52. $mock->expects($this->atLeastOnce())
  53. ->method('doSomething');
  54. $mock->doSomething();
  55. }
  56. public function testMockedMethodIsCalledAtLeastOnce2()
  57. {
  58. $mock = $this->getMockBuilder(AnInterface::class)
  59. ->getMock();
  60. $mock->expects($this->atLeastOnce())
  61. ->method('doSomething');
  62. $mock->doSomething();
  63. $mock->doSomething();
  64. }
  65. public function testMockedMethodIsCalledAtLeastTwice()
  66. {
  67. $mock = $this->getMockBuilder(AnInterface::class)
  68. ->getMock();
  69. $mock->expects($this->atLeast(2))
  70. ->method('doSomething');
  71. $mock->doSomething();
  72. $mock->doSomething();
  73. }
  74. public function testMockedMethodIsCalledAtLeastTwice2()
  75. {
  76. $mock = $this->getMockBuilder(AnInterface::class)
  77. ->getMock();
  78. $mock->expects($this->atLeast(2))
  79. ->method('doSomething');
  80. $mock->doSomething();
  81. $mock->doSomething();
  82. $mock->doSomething();
  83. }
  84. public function testMockedMethodIsCalledAtMostTwice()
  85. {
  86. $mock = $this->getMockBuilder(AnInterface::class)
  87. ->getMock();
  88. $mock->expects($this->atMost(2))
  89. ->method('doSomething');
  90. $mock->doSomething();
  91. $mock->doSomething();
  92. }
  93. public function testMockedMethodIsCalledAtMosttTwice2()
  94. {
  95. $mock = $this->getMockBuilder(AnInterface::class)
  96. ->getMock();
  97. $mock->expects($this->atMost(2))
  98. ->method('doSomething');
  99. $mock->doSomething();
  100. }
  101. public function testMockedMethodIsCalledOnce()
  102. {
  103. $mock = $this->getMockBuilder(AnInterface::class)
  104. ->getMock();
  105. $mock->expects($this->once())
  106. ->method('doSomething');
  107. $mock->doSomething();
  108. }
  109. public function testMockedMethodIsCalledOnceWithParameter()
  110. {
  111. $mock = $this->getMockBuilder(SomeClass::class)
  112. ->getMock();
  113. $mock->expects($this->once())
  114. ->method('doSomethingElse')
  115. ->with($this->equalTo('something'));
  116. $mock->doSomethingElse('something');
  117. }
  118. public function testMockedMethodIsCalledExactly()
  119. {
  120. $mock = $this->getMockBuilder(AnInterface::class)
  121. ->getMock();
  122. $mock->expects($this->exactly(2))
  123. ->method('doSomething');
  124. $mock->doSomething();
  125. $mock->doSomething();
  126. }
  127. public function testStubbedException()
  128. {
  129. $mock = $this->getMockBuilder(AnInterface::class)
  130. ->getMock();
  131. $mock->expects($this->any())
  132. ->method('doSomething')
  133. ->will($this->throwException(new Exception));
  134. $this->expectException(Exception::class);
  135. $mock->doSomething();
  136. }
  137. public function testStubbedWillThrowException()
  138. {
  139. $mock = $this->getMockBuilder(AnInterface::class)
  140. ->getMock();
  141. $mock->expects($this->any())
  142. ->method('doSomething')
  143. ->willThrowException(new Exception);
  144. $this->expectException(Exception::class);
  145. $mock->doSomething();
  146. }
  147. public function testStubbedReturnValue()
  148. {
  149. $mock = $this->getMockBuilder(AnInterface::class)
  150. ->getMock();
  151. $mock->expects($this->any())
  152. ->method('doSomething')
  153. ->will($this->returnValue('something'));
  154. $this->assertEquals('something', $mock->doSomething());
  155. $mock = $this->getMockBuilder(AnInterface::class)
  156. ->getMock();
  157. $mock->expects($this->any())
  158. ->method('doSomething')
  159. ->willReturn('something');
  160. $this->assertEquals('something', $mock->doSomething());
  161. }
  162. public function testStubbedReturnValueMap()
  163. {
  164. $map = [
  165. ['a', 'b', 'c', 'd'],
  166. ['e', 'f', 'g', 'h']
  167. ];
  168. $mock = $this->getMockBuilder(AnInterface::class)
  169. ->getMock();
  170. $mock->expects($this->any())
  171. ->method('doSomething')
  172. ->will($this->returnValueMap($map));
  173. $this->assertEquals('d', $mock->doSomething('a', 'b', 'c'));
  174. $this->assertEquals('h', $mock->doSomething('e', 'f', 'g'));
  175. $this->assertEquals(null, $mock->doSomething('foo', 'bar'));
  176. $mock = $this->getMockBuilder(AnInterface::class)
  177. ->getMock();
  178. $mock->expects($this->any())
  179. ->method('doSomething')
  180. ->willReturnMap($map);
  181. $this->assertEquals('d', $mock->doSomething('a', 'b', 'c'));
  182. $this->assertEquals('h', $mock->doSomething('e', 'f', 'g'));
  183. $this->assertEquals(null, $mock->doSomething('foo', 'bar'));
  184. }
  185. public function testStubbedReturnArgument()
  186. {
  187. $mock = $this->getMockBuilder(AnInterface::class)
  188. ->getMock();
  189. $mock->expects($this->any())
  190. ->method('doSomething')
  191. ->will($this->returnArgument(1));
  192. $this->assertEquals('b', $mock->doSomething('a', 'b'));
  193. $mock = $this->getMockBuilder(AnInterface::class)
  194. ->getMock();
  195. $mock->expects($this->any())
  196. ->method('doSomething')
  197. ->willReturnArgument(1);
  198. $this->assertEquals('b', $mock->doSomething('a', 'b'));
  199. }
  200. public function testFunctionCallback()
  201. {
  202. $mock = $this->getMockBuilder(SomeClass::class)
  203. ->setMethods(['doSomething'])
  204. ->getMock();
  205. $mock->expects($this->once())
  206. ->method('doSomething')
  207. ->will($this->returnCallback('functionCallback'));
  208. $this->assertEquals('pass', $mock->doSomething('foo', 'bar'));
  209. $mock = $this->getMockBuilder(SomeClass::class)
  210. ->setMethods(['doSomething'])
  211. ->getMock();
  212. $mock->expects($this->once())
  213. ->method('doSomething')
  214. ->willReturnCallback('functionCallback');
  215. $this->assertEquals('pass', $mock->doSomething('foo', 'bar'));
  216. }
  217. public function testStubbedReturnSelf()
  218. {
  219. $mock = $this->getMockBuilder(AnInterface::class)
  220. ->getMock();
  221. $mock->expects($this->any())
  222. ->method('doSomething')
  223. ->will($this->returnSelf());
  224. $this->assertEquals($mock, $mock->doSomething());
  225. $mock = $this->getMockBuilder(AnInterface::class)
  226. ->getMock();
  227. $mock->expects($this->any())
  228. ->method('doSomething')
  229. ->willReturnSelf();
  230. $this->assertEquals($mock, $mock->doSomething());
  231. }
  232. public function testStubbedReturnOnConsecutiveCalls()
  233. {
  234. $mock = $this->getMockBuilder(AnInterface::class)
  235. ->getMock();
  236. $mock->expects($this->any())
  237. ->method('doSomething')
  238. ->will($this->onConsecutiveCalls('a', 'b', 'c'));
  239. $this->assertEquals('a', $mock->doSomething());
  240. $this->assertEquals('b', $mock->doSomething());
  241. $this->assertEquals('c', $mock->doSomething());
  242. $mock = $this->getMockBuilder(AnInterface::class)
  243. ->getMock();
  244. $mock->expects($this->any())
  245. ->method('doSomething')
  246. ->willReturnOnConsecutiveCalls('a', 'b', 'c');
  247. $this->assertEquals('a', $mock->doSomething());
  248. $this->assertEquals('b', $mock->doSomething());
  249. $this->assertEquals('c', $mock->doSomething());
  250. }
  251. public function testStaticMethodCallback()
  252. {
  253. $mock = $this->getMockBuilder(SomeClass::class)
  254. ->setMethods(['doSomething'])
  255. ->getMock();
  256. $mock->expects($this->once())
  257. ->method('doSomething')
  258. ->will($this->returnCallback(['MethodCallback', 'staticCallback']));
  259. $this->assertEquals('pass', $mock->doSomething('foo', 'bar'));
  260. }
  261. public function testPublicMethodCallback()
  262. {
  263. $mock = $this->getMockBuilder(SomeClass::class)
  264. ->setMethods(['doSomething'])
  265. ->getMock();
  266. $mock->expects($this->once())
  267. ->method('doSomething')
  268. ->will($this->returnCallback([new MethodCallback, 'nonStaticCallback']));
  269. $this->assertEquals('pass', $mock->doSomething('foo', 'bar'));
  270. }
  271. public function testMockClassOnlyGeneratedOnce()
  272. {
  273. $mock1 = $this->getMockBuilder(AnInterface::class)
  274. ->getMock();
  275. $mock2 = $this->getMockBuilder(AnInterface::class)
  276. ->getMock();
  277. $this->assertEquals(get_class($mock1), get_class($mock2));
  278. }
  279. public function testMockClassDifferentForPartialMocks()
  280. {
  281. $mock1 = $this->getMockBuilder(PartialMockTestClass::class)
  282. ->getMock();
  283. $mock2 = $this->getMockBuilder(PartialMockTestClass::class)
  284. ->setMethods(['doSomething'])
  285. ->getMock();
  286. $mock3 = $this->getMockBuilder(PartialMockTestClass::class)
  287. ->setMethods(['doSomething'])
  288. ->getMock();
  289. $mock4 = $this->getMockBuilder(PartialMockTestClass::class)
  290. ->setMethods(['doAnotherThing'])
  291. ->getMock();
  292. $mock5 = $this->getMockBuilder(PartialMockTestClass::class)
  293. ->setMethods(['doAnotherThing'])
  294. ->getMock();
  295. $this->assertNotEquals(get_class($mock1), get_class($mock2));
  296. $this->assertNotEquals(get_class($mock1), get_class($mock3));
  297. $this->assertNotEquals(get_class($mock1), get_class($mock4));
  298. $this->assertNotEquals(get_class($mock1), get_class($mock5));
  299. $this->assertEquals(get_class($mock2), get_class($mock3));
  300. $this->assertNotEquals(get_class($mock2), get_class($mock4));
  301. $this->assertNotEquals(get_class($mock2), get_class($mock5));
  302. $this->assertEquals(get_class($mock4), get_class($mock5));
  303. }
  304. public function testMockClassStoreOverrulable()
  305. {
  306. $mock1 = $this->getMockBuilder(PartialMockTestClass::class)
  307. ->getMock();
  308. $mock2 = $this->getMockBuilder(PartialMockTestClass::class)
  309. ->setMockClassName('MyMockClassNameForPartialMockTestClass1')
  310. ->getMock();
  311. $mock3 = $this->getMockBuilder(PartialMockTestClass::class)
  312. ->getMock();
  313. $mock4 = $this->getMockBuilder(PartialMockTestClass::class)
  314. ->setMethods(['doSomething'])
  315. ->setMockClassName('AnotherMockClassNameForPartialMockTestClass')
  316. ->getMock();
  317. $mock5 = $this->getMockBuilder(PartialMockTestClass::class)
  318. ->setMockClassName('MyMockClassNameForPartialMockTestClass2')
  319. ->getMock();
  320. $this->assertNotEquals(get_class($mock1), get_class($mock2));
  321. $this->assertEquals(get_class($mock1), get_class($mock3));
  322. $this->assertNotEquals(get_class($mock1), get_class($mock4));
  323. $this->assertNotEquals(get_class($mock2), get_class($mock3));
  324. $this->assertNotEquals(get_class($mock2), get_class($mock4));
  325. $this->assertNotEquals(get_class($mock2), get_class($mock5));
  326. $this->assertNotEquals(get_class($mock3), get_class($mock4));
  327. $this->assertNotEquals(get_class($mock3), get_class($mock5));
  328. $this->assertNotEquals(get_class($mock4), get_class($mock5));
  329. }
  330. public function testGetMockWithFixedClassNameCanProduceTheSameMockTwice()
  331. {
  332. $mock = $this->getMockBuilder(stdClass::class)->setMockClassName('FixedName')->getMock();
  333. $mock = $this->getMockBuilder(stdClass::class)->setMockClassName('FixedName')->getMock();
  334. $this->assertInstanceOf(stdClass::class, $mock);
  335. }
  336. public function testOriginalConstructorSettingConsidered()
  337. {
  338. $mock1 = $this->getMockBuilder(PartialMockTestClass::class)
  339. ->getMock();
  340. $mock2 = $this->getMockBuilder(PartialMockTestClass::class)
  341. ->disableOriginalConstructor()
  342. ->getMock();
  343. $this->assertTrue($mock1->constructorCalled);
  344. $this->assertFalse($mock2->constructorCalled);
  345. }
  346. public function testOriginalCloneSettingConsidered()
  347. {
  348. $mock1 = $this->getMockBuilder(PartialMockTestClass::class)
  349. ->getMock();
  350. $mock2 = $this->getMockBuilder(PartialMockTestClass::class)
  351. ->disableOriginalClone()
  352. ->getMock();
  353. $this->assertNotEquals(get_class($mock1), get_class($mock2));
  354. }
  355. public function testGetMockForAbstractClass()
  356. {
  357. $mock = $this->getMockBuilder(AbstractMockTestClass::class)
  358. ->getMock();
  359. $mock->expects($this->never())
  360. ->method('doSomething');
  361. }
  362. /**
  363. * @dataProvider traversableProvider
  364. */
  365. public function testGetMockForTraversable($type)
  366. {
  367. $mock = $this->getMockBuilder($type)
  368. ->getMock();
  369. $this->assertInstanceOf(Traversable::class, $mock);
  370. }
  371. public function testMultipleInterfacesCanBeMockedInSingleObject()
  372. {
  373. $mock = $this->getMockBuilder([AnInterface::class, AnotherInterface::class])
  374. ->getMock();
  375. $this->assertInstanceOf(AnInterface::class, $mock);
  376. $this->assertInstanceOf(AnotherInterface::class, $mock);
  377. }
  378. public function testGetMockForTrait()
  379. {
  380. $mock = $this->getMockForTrait(AbstractTrait::class);
  381. $mock->expects($this->never())
  382. ->method('doSomething');
  383. $parent = get_parent_class($mock);
  384. $traits = class_uses($parent, false);
  385. $this->assertContains(AbstractTrait::class, $traits);
  386. }
  387. public function testClonedMockObjectShouldStillEqualTheOriginal()
  388. {
  389. $a = $this->getMockBuilder(stdClass::class)
  390. ->getMock();
  391. $b = clone $a;
  392. $this->assertEquals($a, $b);
  393. }
  394. public function testMockObjectsConstructedIndepentantlyShouldBeEqual()
  395. {
  396. $a = $this->getMockBuilder(stdClass::class)
  397. ->getMock();
  398. $b = $this->getMockBuilder(stdClass::class)
  399. ->getMock();
  400. $this->assertEquals($a, $b);
  401. }
  402. public function testMockObjectsConstructedIndepentantlyShouldNotBeTheSame()
  403. {
  404. $a = $this->getMockBuilder(stdClass::class)
  405. ->getMock();
  406. $b = $this->getMockBuilder(stdClass::class)
  407. ->getMock();
  408. $this->assertNotSame($a, $b);
  409. }
  410. public function testClonedMockObjectCanBeUsedInPlaceOfOriginalOne()
  411. {
  412. $x = $this->getMockBuilder(stdClass::class)
  413. ->getMock();
  414. $y = clone $x;
  415. $mock = $this->getMockBuilder(stdClass::class)
  416. ->setMethods(['foo'])
  417. ->getMock();
  418. $mock->expects($this->once())
  419. ->method('foo')
  420. ->with($this->equalTo($x));
  421. $mock->foo($y);
  422. }
  423. public function testClonedMockObjectIsNotIdenticalToOriginalOne()
  424. {
  425. $x = $this->getMockBuilder(stdClass::class)
  426. ->getMock();
  427. $y = clone $x;
  428. $mock = $this->getMockBuilder(stdClass::class)
  429. ->setMethods(['foo'])
  430. ->getMock();
  431. $mock->expects($this->once())
  432. ->method('foo')
  433. ->with($this->logicalNot($this->identicalTo($x)));
  434. $mock->foo($y);
  435. }
  436. public function testObjectMethodCallWithArgumentCloningEnabled()
  437. {
  438. $expectedObject = new stdClass;
  439. $mock = $this->getMockBuilder('SomeClass')
  440. ->setMethods(['doSomethingElse'])
  441. ->enableArgumentCloning()
  442. ->getMock();
  443. $actualArguments = [];
  444. $mock->expects($this->any())
  445. ->method('doSomethingElse')
  446. ->will(
  447. $this->returnCallback(
  448. function () use (&$actualArguments) {
  449. $actualArguments = func_get_args();
  450. }
  451. )
  452. );
  453. $mock->doSomethingElse($expectedObject);
  454. $this->assertEquals(1, count($actualArguments));
  455. $this->assertEquals($expectedObject, $actualArguments[0]);
  456. $this->assertNotSame($expectedObject, $actualArguments[0]);
  457. }
  458. public function testObjectMethodCallWithArgumentCloningDisabled()
  459. {
  460. $expectedObject = new stdClass;
  461. $mock = $this->getMockBuilder('SomeClass')
  462. ->setMethods(['doSomethingElse'])
  463. ->disableArgumentCloning()
  464. ->getMock();
  465. $actualArguments = [];
  466. $mock->expects($this->any())
  467. ->method('doSomethingElse')
  468. ->will(
  469. $this->returnCallback(
  470. function () use (&$actualArguments) {
  471. $actualArguments = func_get_args();
  472. }
  473. )
  474. );
  475. $mock->doSomethingElse($expectedObject);
  476. $this->assertEquals(1, count($actualArguments));
  477. $this->assertSame($expectedObject, $actualArguments[0]);
  478. }
  479. public function testArgumentCloningOptionGeneratesUniqueMock()
  480. {
  481. $mockWithCloning = $this->getMockBuilder('SomeClass')
  482. ->setMethods(['doSomethingElse'])
  483. ->enableArgumentCloning()
  484. ->getMock();
  485. $mockWithoutCloning = $this->getMockBuilder('SomeClass')
  486. ->setMethods(['doSomethingElse'])
  487. ->disableArgumentCloning()
  488. ->getMock();
  489. $this->assertNotEquals($mockWithCloning, $mockWithoutCloning);
  490. }
  491. public function testVerificationOfMethodNameFailsWithoutParameters()
  492. {
  493. $mock = $this->getMockBuilder(SomeClass::class)
  494. ->setMethods(['right', 'wrong'])
  495. ->getMock();
  496. $mock->expects($this->once())
  497. ->method('right');
  498. $mock->wrong();
  499. try {
  500. $mock->__phpunit_verify();
  501. $this->fail('Expected exception');
  502. } catch (PHPUnit_Framework_ExpectationFailedException $e) {
  503. $this->assertSame(
  504. "Expectation failed for method name is equal to <string:right> when invoked 1 time(s).\n"
  505. . "Method was expected to be called 1 times, actually called 0 times.\n",
  506. $e->getMessage()
  507. );
  508. }
  509. $this->resetMockObjects();
  510. }
  511. public function testVerificationOfMethodNameFailsWithParameters()
  512. {
  513. $mock = $this->getMockBuilder(SomeClass::class)
  514. ->setMethods(['right', 'wrong'])
  515. ->getMock();
  516. $mock->expects($this->once())
  517. ->method('right');
  518. $mock->wrong();
  519. try {
  520. $mock->__phpunit_verify();
  521. $this->fail('Expected exception');
  522. } catch (PHPUnit_Framework_ExpectationFailedException $e) {
  523. $this->assertSame(
  524. "Expectation failed for method name is equal to <string:right> when invoked 1 time(s).\n"
  525. . "Method was expected to be called 1 times, actually called 0 times.\n",
  526. $e->getMessage()
  527. );
  528. }
  529. $this->resetMockObjects();
  530. }
  531. public function testVerificationOfMethodNameFailsWithWrongParameters()
  532. {
  533. $mock = $this->getMockBuilder(SomeClass::class)
  534. ->setMethods(['right', 'wrong'])
  535. ->getMock();
  536. $mock->expects($this->once())
  537. ->method('right')
  538. ->with(['first', 'second']);
  539. try {
  540. $mock->right(['second']);
  541. } catch (PHPUnit_Framework_ExpectationFailedException $e) {
  542. $this->assertSame(
  543. "Expectation failed for method name is equal to <string:right> when invoked 1 time(s)\n"
  544. . "Parameter 0 for invocation SomeClass::right(Array (...)) does not match expected value.\n"
  545. . 'Failed asserting that two arrays are equal.',
  546. $e->getMessage()
  547. );
  548. }
  549. try {
  550. $mock->__phpunit_verify();
  551. $this->fail('Expected exception');
  552. } catch (PHPUnit_Framework_ExpectationFailedException $e) {
  553. $this->assertSame(
  554. "Expectation failed for method name is equal to <string:right> when invoked 1 time(s).\n"
  555. . "Parameter 0 for invocation SomeClass::right(Array (...)) does not match expected value.\n"
  556. . "Failed asserting that two arrays are equal.\n"
  557. . "--- Expected\n"
  558. . "+++ Actual\n"
  559. . "@@ @@\n"
  560. . " Array (\n"
  561. . "- 0 => 'first'\n"
  562. . "- 1 => 'second'\n"
  563. . "+ 0 => 'second'\n"
  564. . " )\n",
  565. $e->getMessage()
  566. );
  567. }
  568. $this->resetMockObjects();
  569. }
  570. public function testVerificationOfNeverFailsWithEmptyParameters()
  571. {
  572. $mock = $this->getMockBuilder(SomeClass::class)
  573. ->setMethods(['right', 'wrong'])
  574. ->getMock();
  575. $mock->expects($this->never())
  576. ->method('right')
  577. ->with();
  578. try {
  579. $mock->right();
  580. $this->fail('Expected exception');
  581. } catch (PHPUnit_Framework_ExpectationFailedException $e) {
  582. $this->assertSame(
  583. 'SomeClass::right() was not expected to be called.',
  584. $e->getMessage()
  585. );
  586. }
  587. $this->resetMockObjects();
  588. }
  589. public function testVerificationOfNeverFailsWithAnyParameters()
  590. {
  591. $mock = $this->getMockBuilder(SomeClass::class)
  592. ->setMethods(['right', 'wrong'])
  593. ->getMock();
  594. $mock->expects($this->never())
  595. ->method('right')
  596. ->withAnyParameters();
  597. try {
  598. $mock->right();
  599. $this->fail('Expected exception');
  600. } catch (PHPUnit_Framework_ExpectationFailedException $e) {
  601. $this->assertSame(
  602. 'SomeClass::right() was not expected to be called.',
  603. $e->getMessage()
  604. );
  605. }
  606. $this->resetMockObjects();
  607. }
  608. public function testWithAnythingInsteadOfWithAnyParameters()
  609. {
  610. $mock = $this->getMockBuilder(SomeClass::class)
  611. ->setMethods(['right', 'wrong'])
  612. ->getMock();
  613. $mock->expects($this->once())
  614. ->method('right')
  615. ->with($this->anything());
  616. try {
  617. $mock->right();
  618. $this->fail('Expected exception');
  619. } catch (PHPUnit_Framework_ExpectationFailedException $e) {
  620. $this->assertSame(
  621. "Expectation failed for method name is equal to <string:right> when invoked 1 time(s)\n" .
  622. "Parameter count for invocation SomeClass::right() is too low.\n" .
  623. 'To allow 0 or more parameters with any value, omit ->with() or use ->withAnyParameters() instead.',
  624. $e->getMessage()
  625. );
  626. }
  627. $this->resetMockObjects();
  628. }
  629. /**
  630. * See https://github.com/sebastianbergmann/phpunit-mock-objects/issues/81
  631. */
  632. public function testMockArgumentsPassedByReference()
  633. {
  634. $foo = $this->getMockBuilder('MethodCallbackByReference')
  635. ->setMethods(['bar'])
  636. ->disableOriginalConstructor()
  637. ->disableArgumentCloning()
  638. ->getMock();
  639. $foo->expects($this->any())
  640. ->method('bar')
  641. ->will($this->returnCallback([$foo, 'callback']));
  642. $a = $b = $c = 0;
  643. $foo->bar($a, $b, $c);
  644. $this->assertEquals(1, $b);
  645. }
  646. /**
  647. * See https://github.com/sebastianbergmann/phpunit-mock-objects/issues/81
  648. */
  649. public function testMockArgumentsPassedByReference2()
  650. {
  651. $foo = $this->getMockBuilder('MethodCallbackByReference')
  652. ->disableOriginalConstructor()
  653. ->disableArgumentCloning()
  654. ->getMock();
  655. $foo->expects($this->any())
  656. ->method('bar')
  657. ->will($this->returnCallback(
  658. function (&$a, &$b, $c) {
  659. $b = 1;
  660. }
  661. ));
  662. $a = $b = $c = 0;
  663. $foo->bar($a, $b, $c);
  664. $this->assertEquals(1, $b);
  665. }
  666. /**
  667. * @see https://github.com/sebastianbergmann/phpunit-mock-objects/issues/116
  668. */
  669. public function testMockArgumentsPassedByReference3()
  670. {
  671. $foo = $this->getMockBuilder('MethodCallbackByReference')
  672. ->setMethods(['bar'])
  673. ->disableOriginalConstructor()
  674. ->disableArgumentCloning()
  675. ->getMock();
  676. $a = new stdClass;
  677. $b = $c = 0;
  678. $foo->expects($this->any())
  679. ->method('bar')
  680. ->with($a, $b, $c)
  681. ->will($this->returnCallback([$foo, 'callback']));
  682. $this->assertNull($foo->bar($a, $b, $c));
  683. }
  684. /**
  685. * @see https://github.com/sebastianbergmann/phpunit/issues/796
  686. */
  687. public function testMockArgumentsPassedByReference4()
  688. {
  689. $foo = $this->getMockBuilder('MethodCallbackByReference')
  690. ->setMethods(['bar'])
  691. ->disableOriginalConstructor()
  692. ->disableArgumentCloning()
  693. ->getMock();
  694. $a = new stdClass;
  695. $b = $c = 0;
  696. $foo->expects($this->any())
  697. ->method('bar')
  698. ->with($this->isInstanceOf(stdClass::class), $b, $c)
  699. ->will($this->returnCallback([$foo, 'callback']));
  700. $this->assertNull($foo->bar($a, $b, $c));
  701. }
  702. /**
  703. * @requires extension soap
  704. */
  705. public function testCreateMockFromWsdl()
  706. {
  707. $mock = $this->getMockFromWsdl(__DIR__ . '/_fixture/GoogleSearch.wsdl', 'WsdlMock');
  708. $this->assertStringStartsWith(
  709. 'Mock_WsdlMock_',
  710. get_class($mock)
  711. );
  712. }
  713. /**
  714. * @requires extension soap
  715. */
  716. public function testCreateNamespacedMockFromWsdl()
  717. {
  718. $mock = $this->getMockFromWsdl(__DIR__ . '/_fixture/GoogleSearch.wsdl', 'My\\Space\\WsdlMock');
  719. $this->assertStringStartsWith(
  720. 'Mock_WsdlMock_',
  721. get_class($mock)
  722. );
  723. }
  724. /**
  725. * @requires extension soap
  726. */
  727. public function testCreateTwoMocksOfOneWsdlFile()
  728. {
  729. $a = $this->getMockFromWsdl(__DIR__ . '/_fixture/GoogleSearch.wsdl');
  730. $b = $this->getMockFromWsdl(__DIR__ . '/_fixture/GoogleSearch.wsdl');
  731. $this->assertStringStartsWith('Mock_GoogleSearch_', get_class($a));
  732. $this->assertEquals(get_class($a), get_class($b));
  733. }
  734. /**
  735. * @see https://github.com/sebastianbergmann/phpunit-mock-objects/issues/156
  736. * @ticket 156
  737. */
  738. public function testInterfaceWithStaticMethodCanBeStubbed()
  739. {
  740. $this->assertInstanceOf(
  741. InterfaceWithStaticMethod::class,
  742. $this->getMockBuilder(InterfaceWithStaticMethod::class)->getMock()
  743. );
  744. }
  745. /**
  746. * @expectedException PHPUnit_Framework_MockObject_BadMethodCallException
  747. */
  748. public function testInvokingStubbedStaticMethodRaisesException()
  749. {
  750. $mock = $this->getMockBuilder(ClassWithStaticMethod::class)->getMock();
  751. $mock->staticMethod();
  752. }
  753. /**
  754. * @see https://github.com/sebastianbergmann/phpunit-mock-objects/issues/171
  755. * @ticket 171
  756. */
  757. public function testStubForClassThatImplementsSerializableCanBeCreatedWithoutInvokingTheConstructor()
  758. {
  759. $this->assertInstanceOf(
  760. ClassThatImplementsSerializable::class,
  761. $this->getMockBuilder(ClassThatImplementsSerializable::class)
  762. ->disableOriginalConstructor()
  763. ->getMock()
  764. );
  765. }
  766. public function testGetMockForClassWithSelfTypeHint()
  767. {
  768. $this->assertInstanceOf(
  769. ClassWithSelfTypeHint::class,
  770. $this->getMockBuilder(ClassWithSelfTypeHint::class)->getMock()
  771. );
  772. }
  773. private function resetMockObjects()
  774. {
  775. $refl = new ReflectionObject($this);
  776. $refl = $refl->getParentClass();
  777. $prop = $refl->getProperty('mockObjects');
  778. $prop->setAccessible(true);
  779. $prop->setValue($this, []);
  780. }
  781. public function testStringableClassDoesNotThrow()
  782. {
  783. $mock = $this->getMockBuilder(StringableClass::class)->getMock();
  784. $this->assertInternalType('string', (string) $mock);
  785. }
  786. public function testStringableClassCanBeMocked()
  787. {
  788. $mock = $this->getMockBuilder(StringableClass::class)->getMock();
  789. $mock->method('__toString')->willReturn('foo');
  790. $this->assertSame('foo', (string) $mock);
  791. }
  792. public function traversableProvider()
  793. {
  794. return [
  795. ['Traversable'],
  796. ['\Traversable'],
  797. ['TraversableMockTestInterface'],
  798. [['Traversable']],
  799. [['Iterator','Traversable']],
  800. [['\Iterator','\Traversable']]
  801. ];
  802. }
  803. public function testParameterCallbackConstraintOnlyEvaluatedOnce()
  804. {
  805. $mock = $this->getMockBuilder(Foo::class)->setMethods(['bar'])->getMock();
  806. $expectedNumberOfCalls = 1;
  807. $callCount = 0;
  808. $mock->expects($this->exactly($expectedNumberOfCalls))->method('bar')
  809. ->with($this->callback(function ($argument) use (&$callCount) {
  810. return $argument === 'call_' . $callCount++;
  811. }));
  812. for ($i = 0; $i < $expectedNumberOfCalls; $i++) {
  813. $mock->bar('call_' . $i);
  814. }
  815. }
  816. }