HttpClientTest.php 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105
  1. <?php
  2. namespace Illuminate\Tests\Http;
  3. use GuzzleHttp\Promise\PromiseInterface;
  4. use GuzzleHttp\Psr7\Response as Psr7Response;
  5. use Illuminate\Contracts\Events\Dispatcher;
  6. use Illuminate\Http\Client\Events\RequestSending;
  7. use Illuminate\Http\Client\Events\ResponseReceived;
  8. use Illuminate\Http\Client\Factory;
  9. use Illuminate\Http\Client\PendingRequest;
  10. use Illuminate\Http\Client\Pool;
  11. use Illuminate\Http\Client\Request;
  12. use Illuminate\Http\Client\RequestException;
  13. use Illuminate\Http\Client\Response;
  14. use Illuminate\Http\Client\ResponseSequence;
  15. use Illuminate\Support\Collection;
  16. use Illuminate\Support\Str;
  17. use Mockery as m;
  18. use OutOfBoundsException;
  19. use PHPUnit\Framework\AssertionFailedError;
  20. use PHPUnit\Framework\TestCase;
  21. use Symfony\Component\VarDumper\VarDumper;
  22. class HttpClientTest extends TestCase
  23. {
  24. /**
  25. * @var \Illuminate\Http\Client\Factory
  26. */
  27. protected $factory;
  28. protected function setUp(): void
  29. {
  30. parent::setUp();
  31. $this->factory = new Factory;
  32. }
  33. protected function tearDown(): void
  34. {
  35. m::close();
  36. }
  37. public function testStubbedResponsesAreReturnedAfterFaking()
  38. {
  39. $this->factory->fake();
  40. $response = $this->factory->post('http://laravel.com/test-missing-page');
  41. $this->assertTrue($response->ok());
  42. }
  43. public function testUnauthorizedRequest()
  44. {
  45. $this->factory->fake([
  46. 'laravel.com' => $this->factory::response('', 401),
  47. ]);
  48. $response = $this->factory->post('http://laravel.com');
  49. $this->assertTrue($response->unauthorized());
  50. }
  51. public function testForbiddenRequest()
  52. {
  53. $this->factory->fake([
  54. 'laravel.com' => $this->factory::response('', 403),
  55. ]);
  56. $response = $this->factory->post('http://laravel.com');
  57. $this->assertTrue($response->forbidden());
  58. }
  59. public function testResponseBodyCasting()
  60. {
  61. $this->factory->fake([
  62. '*' => ['result' => ['foo' => 'bar']],
  63. ]);
  64. $response = $this->factory->get('http://foo.com/api');
  65. $this->assertSame('{"result":{"foo":"bar"}}', $response->body());
  66. $this->assertSame('{"result":{"foo":"bar"}}', (string) $response);
  67. $this->assertIsArray($response->json());
  68. $this->assertSame(['foo' => 'bar'], $response->json()['result']);
  69. $this->assertSame(['foo' => 'bar'], $response->json('result'));
  70. $this->assertSame('bar', $response->json('result.foo'));
  71. $this->assertSame('default', $response->json('missing_key', 'default'));
  72. $this->assertSame(['foo' => 'bar'], $response['result']);
  73. $this->assertIsObject($response->object());
  74. $this->assertSame('bar', $response->object()->result->foo);
  75. }
  76. public function testResponseCanBeReturnedAsCollection()
  77. {
  78. $this->factory->fake([
  79. '*' => ['result' => ['foo' => 'bar']],
  80. ]);
  81. $response = $this->factory->get('http://foo.com/api');
  82. $this->assertInstanceOf(Collection::class, $response->collect());
  83. $this->assertEquals(collect(['result' => ['foo' => 'bar']]), $response->collect());
  84. $this->assertEquals(collect(['foo' => 'bar']), $response->collect('result'));
  85. $this->assertEquals(collect(['bar']), $response->collect('result.foo'));
  86. $this->assertEquals(collect(), $response->collect('missing_key'));
  87. }
  88. public function testSendRequestBody()
  89. {
  90. $body = '{"test":"phpunit"}';
  91. $fakeRequest = function (Request $request) use ($body) {
  92. self::assertSame($body, $request->body());
  93. return ['my' => 'response'];
  94. };
  95. $this->factory->fake($fakeRequest);
  96. $this->factory->withBody($body, 'application/json')->send('get', 'http://foo.com/api');
  97. }
  98. public function testUrlsCanBeStubbedByPath()
  99. {
  100. $this->factory->fake([
  101. 'foo.com/*' => ['page' => 'foo'],
  102. 'bar.com/*' => ['page' => 'bar'],
  103. '*' => ['page' => 'fallback'],
  104. ]);
  105. $fooResponse = $this->factory->post('http://foo.com/test');
  106. $barResponse = $this->factory->post('http://bar.com/test');
  107. $fallbackResponse = $this->factory->post('http://fallback.com/test');
  108. $this->assertSame('foo', $fooResponse['page']);
  109. $this->assertSame('bar', $barResponse['page']);
  110. $this->assertSame('fallback', $fallbackResponse['page']);
  111. $this->factory->assertSent(function (Request $request) {
  112. return $request->url() === 'http://foo.com/test' &&
  113. $request->hasHeader('Content-Type', 'application/json');
  114. });
  115. }
  116. public function testCanSendJsonData()
  117. {
  118. $this->factory->fake();
  119. $this->factory->withHeaders([
  120. 'X-Test-Header' => 'foo',
  121. 'X-Test-ArrayHeader' => ['bar', 'baz'],
  122. ])->post('http://foo.com/json', [
  123. 'name' => 'Taylor',
  124. ]);
  125. $this->factory->assertSent(function (Request $request) {
  126. return $request->url() === 'http://foo.com/json' &&
  127. $request->hasHeader('Content-Type', 'application/json') &&
  128. $request->hasHeader('X-Test-Header', 'foo') &&
  129. $request->hasHeader('X-Test-ArrayHeader', ['bar', 'baz']) &&
  130. $request['name'] === 'Taylor';
  131. });
  132. }
  133. public function testCanSendFormData()
  134. {
  135. $this->factory->fake();
  136. $this->factory->asForm()->post('http://foo.com/form', [
  137. 'name' => 'Taylor',
  138. 'title' => 'Laravel Developer',
  139. ]);
  140. $this->factory->assertSent(function (Request $request) {
  141. return $request->url() === 'http://foo.com/form' &&
  142. $request->hasHeader('Content-Type', 'application/x-www-form-urlencoded') &&
  143. $request['name'] === 'Taylor';
  144. });
  145. }
  146. public function testRecordedCallsAreEmptiedWhenFakeIsCalled()
  147. {
  148. $this->factory->fake([
  149. 'http://foo.com/*' => ['page' => 'foo'],
  150. ]);
  151. $this->factory->get('http://foo.com/test');
  152. $this->factory->assertSent(function (Request $request) {
  153. return $request->url() === 'http://foo.com/test';
  154. });
  155. $this->factory->fake();
  156. $this->factory->assertNothingSent();
  157. }
  158. public function testSpecificRequestIsNotBeingSent()
  159. {
  160. $this->factory->fake();
  161. $this->factory->post('http://foo.com/form', [
  162. 'name' => 'Taylor',
  163. ]);
  164. $this->factory->assertNotSent(function (Request $request) {
  165. return $request->url() === 'http://foo.com/form' &&
  166. $request['name'] === 'Peter';
  167. });
  168. }
  169. public function testNoRequestIsNotBeingSent()
  170. {
  171. $this->factory->fake();
  172. $this->factory->assertNothingSent();
  173. }
  174. public function testRequestCount()
  175. {
  176. $this->factory->fake();
  177. $this->factory->assertSentCount(0);
  178. $this->factory->post('http://foo.com/form', [
  179. 'name' => 'Taylor',
  180. ]);
  181. $this->factory->assertSentCount(1);
  182. $this->factory->post('http://foo.com/form', [
  183. 'name' => 'Jim',
  184. ]);
  185. $this->factory->assertSentCount(2);
  186. }
  187. public function testCanSendMultipartData()
  188. {
  189. $this->factory->fake();
  190. $this->factory->asMultipart()->post('http://foo.com/multipart', [
  191. [
  192. 'name' => 'foo',
  193. 'contents' => 'data',
  194. 'headers' => ['X-Test-Header' => 'foo'],
  195. ],
  196. ]);
  197. $this->factory->assertSent(function (Request $request) {
  198. return $request->url() === 'http://foo.com/multipart' &&
  199. Str::startsWith($request->header('Content-Type')[0], 'multipart') &&
  200. $request[0]['name'] === 'foo';
  201. });
  202. }
  203. public function testFilesCanBeAttached()
  204. {
  205. $this->factory->fake();
  206. $this->factory->attach('foo', 'data', 'file.txt', ['X-Test-Header' => 'foo'])
  207. ->post('http://foo.com/file');
  208. $this->factory->assertSent(function (Request $request) {
  209. return $request->url() === 'http://foo.com/file' &&
  210. Str::startsWith($request->header('Content-Type')[0], 'multipart') &&
  211. $request[0]['name'] === 'foo' &&
  212. $request->hasFile('foo', 'data', 'file.txt');
  213. });
  214. }
  215. public function testCanSendMultipartDataWithSimplifiedParameters()
  216. {
  217. $this->factory->fake();
  218. $this->factory->asMultipart()->post('http://foo.com/multipart', [
  219. 'foo' => 'bar',
  220. ]);
  221. $this->factory->assertSent(function (Request $request) {
  222. return $request->url() === 'http://foo.com/multipart' &&
  223. Str::startsWith($request->header('Content-Type')[0], 'multipart') &&
  224. $request[0]['name'] === 'foo' &&
  225. $request[0]['contents'] === 'bar';
  226. });
  227. }
  228. public function testCanSendMultipartDataWithBothSimplifiedAndExtendedParameters()
  229. {
  230. $this->factory->fake();
  231. $this->factory->asMultipart()->post('http://foo.com/multipart', [
  232. 'foo' => 'bar',
  233. [
  234. 'name' => 'foobar',
  235. 'contents' => 'data',
  236. 'headers' => ['X-Test-Header' => 'foo'],
  237. ],
  238. ]);
  239. $this->factory->assertSent(function (Request $request) {
  240. return $request->url() === 'http://foo.com/multipart' &&
  241. Str::startsWith($request->header('Content-Type')[0], 'multipart') &&
  242. $request[0]['name'] === 'foo' &&
  243. $request[0]['contents'] === 'bar' &&
  244. $request[1]['name'] === 'foobar' &&
  245. $request[1]['contents'] === 'data' &&
  246. $request[1]['headers']['X-Test-Header'] === 'foo';
  247. });
  248. }
  249. public function testItCanSendToken()
  250. {
  251. $this->factory->fake();
  252. $this->factory->withToken('token')->post('http://foo.com/json');
  253. $this->factory->assertSent(function (Request $request) {
  254. return $request->url() === 'http://foo.com/json' &&
  255. $request->hasHeader('Authorization', 'Bearer token');
  256. });
  257. }
  258. public function testItCanSendUserAgent()
  259. {
  260. $this->factory->fake();
  261. $this->factory->withUserAgent('Laravel')->post('http://foo.com/json');
  262. $this->factory->assertSent(function (Request $request) {
  263. return $request->url() === 'http://foo.com/json' &&
  264. $request->hasHeader('User-Agent', 'Laravel');
  265. });
  266. }
  267. public function testItOnlySendsOneUserAgentHeader()
  268. {
  269. $this->factory->fake();
  270. $this->factory->withUserAgent('Laravel')
  271. ->withUserAgent('FooBar')
  272. ->post('http://foo.com/json');
  273. $this->factory->assertSent(function (Request $request) {
  274. $userAgent = $request->header('User-Agent');
  275. return $request->url() === 'http://foo.com/json' &&
  276. count($userAgent) === 1 &&
  277. $userAgent[0] === 'FooBar';
  278. });
  279. }
  280. public function testSequenceBuilder()
  281. {
  282. $this->factory->fake([
  283. '*' => $this->factory->sequence()
  284. ->push('Ok', 201)
  285. ->push(['fact' => 'Cats are great!'])
  286. ->pushFile(__DIR__.'/fixtures/test.txt')
  287. ->pushStatus(403),
  288. ]);
  289. $response = $this->factory->get('https://example.com');
  290. $this->assertSame('Ok', $response->body());
  291. $this->assertSame(201, $response->status());
  292. $response = $this->factory->get('https://example.com');
  293. $this->assertSame(['fact' => 'Cats are great!'], $response->json());
  294. $this->assertSame(200, $response->status());
  295. $response = $this->factory->get('https://example.com');
  296. $this->assertSame("This is a story about something that happened long ago when your grandfather was a child.\n", $response->body());
  297. $this->assertSame(200, $response->status());
  298. $response = $this->factory->get('https://example.com');
  299. $this->assertSame('', $response->body());
  300. $this->assertSame(403, $response->status());
  301. $this->expectException(OutOfBoundsException::class);
  302. // The sequence is empty, it should throw an exception.
  303. $this->factory->get('https://example.com');
  304. }
  305. public function testSequenceBuilderCanKeepGoingWhenEmpty()
  306. {
  307. $this->factory->fake([
  308. '*' => $this->factory->sequence()
  309. ->dontFailWhenEmpty()
  310. ->push('Ok'),
  311. ]);
  312. $response = $this->factory->get('https://laravel.com');
  313. $this->assertSame('Ok', $response->body());
  314. // The sequence is empty, but it should not fail.
  315. $this->factory->get('https://laravel.com');
  316. }
  317. public function testAssertSequencesAreEmpty()
  318. {
  319. $this->factory->fake([
  320. '*' => $this->factory->sequence()
  321. ->push('1')
  322. ->push('2'),
  323. ]);
  324. $this->factory->get('https://example.com');
  325. $this->factory->get('https://example.com');
  326. $this->factory->assertSequencesAreEmpty();
  327. }
  328. public function testFakeSequence()
  329. {
  330. $this->factory->fakeSequence()
  331. ->pushStatus(201)
  332. ->pushStatus(301);
  333. $this->assertSame(201, $this->factory->get('https://example.com')->status());
  334. $this->assertSame(301, $this->factory->get('https://example.com')->status());
  335. }
  336. public function testWithCookies()
  337. {
  338. $this->factory->fakeSequence()->pushStatus(200);
  339. $response = $this->factory->withCookies(
  340. ['foo' => 'bar'], 'https://laravel.com'
  341. )->get('https://laravel.com');
  342. $this->assertCount(1, $response->cookies()->toArray());
  343. /** @var \GuzzleHttp\Cookie\CookieJarInterface $responseCookies */
  344. $responseCookie = $response->cookies()->toArray()[0];
  345. $this->assertSame('foo', $responseCookie['Name']);
  346. $this->assertSame('bar', $responseCookie['Value']);
  347. $this->assertSame('https://laravel.com', $responseCookie['Domain']);
  348. }
  349. public function testGetWithArrayQueryParam()
  350. {
  351. $this->factory->fake();
  352. $this->factory->get('http://foo.com/get', ['foo' => 'bar']);
  353. $this->factory->assertSent(function (Request $request) {
  354. return $request->url() === 'http://foo.com/get?foo=bar'
  355. && $request['foo'] === 'bar';
  356. });
  357. }
  358. public function testGetWithStringQueryParam()
  359. {
  360. $this->factory->fake();
  361. $this->factory->get('http://foo.com/get', 'foo=bar');
  362. $this->factory->assertSent(function (Request $request) {
  363. return $request->url() === 'http://foo.com/get?foo=bar'
  364. && $request['foo'] === 'bar';
  365. });
  366. }
  367. public function testGetWithQuery()
  368. {
  369. $this->factory->fake();
  370. $this->factory->get('http://foo.com/get?foo=bar&page=1');
  371. $this->factory->assertSent(function (Request $request) {
  372. return $request->url() === 'http://foo.com/get?foo=bar&page=1'
  373. && $request['foo'] === 'bar'
  374. && $request['page'] === '1';
  375. });
  376. }
  377. public function testGetWithQueryWontEncode()
  378. {
  379. $this->factory->fake();
  380. $this->factory->get('http://foo.com/get?foo;bar;1;5;10&page=1');
  381. $this->factory->assertSent(function (Request $request) {
  382. return $request->url() === 'http://foo.com/get?foo;bar;1;5;10&page=1'
  383. && ! isset($request['foo'])
  384. && ! isset($request['bar'])
  385. && $request['page'] === '1';
  386. });
  387. }
  388. public function testGetWithArrayQueryParamOverwrites()
  389. {
  390. $this->factory->fake();
  391. $this->factory->get('http://foo.com/get?foo=bar&page=1', ['hello' => 'world']);
  392. $this->factory->assertSent(function (Request $request) {
  393. return $request->url() === 'http://foo.com/get?hello=world'
  394. && $request['hello'] === 'world';
  395. });
  396. }
  397. public function testGetWithArrayQueryParamEncodes()
  398. {
  399. $this->factory->fake();
  400. $this->factory->get('http://foo.com/get', ['foo;bar; space test' => 'laravel']);
  401. $this->factory->assertSent(function (Request $request) {
  402. return $request->url() === 'http://foo.com/get?foo%3Bbar%3B%20space%20test=laravel'
  403. && $request['foo;bar; space test'] === 'laravel';
  404. });
  405. }
  406. public function testCanConfirmManyHeaders()
  407. {
  408. $this->factory->fake();
  409. $this->factory->withHeaders([
  410. 'X-Test-Header' => 'foo',
  411. 'X-Test-ArrayHeader' => ['bar', 'baz'],
  412. ])->post('http://foo.com/json');
  413. $this->factory->assertSent(function (Request $request) {
  414. return $request->url() === 'http://foo.com/json' &&
  415. $request->hasHeaders([
  416. 'X-Test-Header' => 'foo',
  417. 'X-Test-ArrayHeader' => ['bar', 'baz'],
  418. ]);
  419. });
  420. }
  421. public function testCanConfirmManyHeadersUsingAString()
  422. {
  423. $this->factory->fake();
  424. $this->factory->withHeaders([
  425. 'X-Test-Header' => 'foo',
  426. 'X-Test-ArrayHeader' => ['bar', 'baz'],
  427. ])->post('http://foo.com/json');
  428. $this->factory->assertSent(function (Request $request) {
  429. return $request->url() === 'http://foo.com/json' &&
  430. $request->hasHeaders('X-Test-Header');
  431. });
  432. }
  433. public function testExceptionAccessorOnSuccess()
  434. {
  435. $resp = new Response(new Psr7Response());
  436. $this->assertNull($resp->toException());
  437. }
  438. public function testExceptionAccessorOnFailure()
  439. {
  440. $error = [
  441. 'error' => [
  442. 'code' => 403,
  443. 'message' => 'The Request can not be completed',
  444. ],
  445. ];
  446. $response = new Psr7Response(403, [], json_encode($error));
  447. $resp = new Response($response);
  448. $this->assertInstanceOf(RequestException::class, $resp->toException());
  449. }
  450. public function testRequestExceptionSummary()
  451. {
  452. $this->expectException(RequestException::class);
  453. $this->expectExceptionMessage('{"error":{"code":403,"message":"The Request can not be completed"}}');
  454. $error = [
  455. 'error' => [
  456. 'code' => 403,
  457. 'message' => 'The Request can not be completed',
  458. ],
  459. ];
  460. $response = new Psr7Response(403, [], json_encode($error));
  461. throw new RequestException(new Response($response));
  462. }
  463. public function testRequestExceptionTruncatedSummary()
  464. {
  465. $this->expectException(RequestException::class);
  466. $this->expectExceptionMessage('{"error":{"code":403,"message":"The Request can not be completed because quota limit was exceeded. Please, check our sup (truncated...)');
  467. $error = [
  468. 'error' => [
  469. 'code' => 403,
  470. 'message' => 'The Request can not be completed because quota limit was exceeded. Please, check our support team to increase your limit',
  471. ],
  472. ];
  473. $response = new Psr7Response(403, [], json_encode($error));
  474. throw new RequestException(new Response($response));
  475. }
  476. public function testRequestExceptionEmptyBody()
  477. {
  478. $this->expectException(RequestException::class);
  479. $this->expectExceptionMessageMatches('/HTTP request returned status code 403$/');
  480. $response = new Psr7Response(403);
  481. throw new RequestException(new Response($response));
  482. }
  483. public function testOnErrorDoesntCallClosureOnInformational()
  484. {
  485. $status = 0;
  486. $client = $this->factory->fake([
  487. 'laravel.com' => $this->factory::response('', 101),
  488. ]);
  489. $response = $client->get('laravel.com')
  490. ->onError(function ($response) use (&$status) {
  491. $status = $response->status();
  492. });
  493. $this->assertSame(0, $status);
  494. $this->assertSame(101, $response->status());
  495. }
  496. public function testOnErrorDoesntCallClosureOnSuccess()
  497. {
  498. $status = 0;
  499. $client = $this->factory->fake([
  500. 'laravel.com' => $this->factory::response('', 201),
  501. ]);
  502. $response = $client->get('laravel.com')
  503. ->onError(function ($response) use (&$status) {
  504. $status = $response->status();
  505. });
  506. $this->assertSame(0, $status);
  507. $this->assertSame(201, $response->status());
  508. }
  509. public function testOnErrorDoesntCallClosureOnRedirection()
  510. {
  511. $status = 0;
  512. $client = $this->factory->fake([
  513. 'laravel.com' => $this->factory::response('', 301),
  514. ]);
  515. $response = $client->get('laravel.com')
  516. ->onError(function ($response) use (&$status) {
  517. $status = $response->status();
  518. });
  519. $this->assertSame(0, $status);
  520. $this->assertSame(301, $response->status());
  521. }
  522. public function testOnErrorCallsClosureOnClientError()
  523. {
  524. $status = 0;
  525. $client = $this->factory->fake([
  526. 'laravel.com' => $this->factory::response('', 401),
  527. ]);
  528. $response = $client->get('laravel.com')
  529. ->onError(function ($response) use (&$status) {
  530. $status = $response->status();
  531. });
  532. $this->assertSame(401, $status);
  533. $this->assertSame(401, $response->status());
  534. }
  535. public function testOnErrorCallsClosureOnServerError()
  536. {
  537. $status = 0;
  538. $client = $this->factory->fake([
  539. 'laravel.com' => $this->factory::response('', 501),
  540. ]);
  541. $response = $client->get('laravel.com')
  542. ->onError(function ($response) use (&$status) {
  543. $status = $response->status();
  544. });
  545. $this->assertSame(501, $status);
  546. $this->assertSame(501, $response->status());
  547. }
  548. public function testSinkToFile()
  549. {
  550. $this->factory->fakeSequence()->push('abc123');
  551. $destination = __DIR__.'/fixtures/sunk.txt';
  552. if (file_exists($destination)) {
  553. unlink($destination);
  554. }
  555. $this->factory->withOptions(['sink' => $destination])->get('https://example.com');
  556. $this->assertFileExists($destination);
  557. $this->assertSame('abc123', file_get_contents($destination));
  558. unlink($destination);
  559. }
  560. public function testSinkToResource()
  561. {
  562. $this->factory->fakeSequence()->push('abc123');
  563. $resource = fopen('php://temp', 'w');
  564. $this->factory->sink($resource)->get('https://example.com');
  565. $this->assertSame(0, ftell($resource));
  566. $this->assertSame('abc123', stream_get_contents($resource));
  567. }
  568. public function testSinkWhenStubbedByPath()
  569. {
  570. $this->factory->fake([
  571. 'foo.com/*' => ['page' => 'foo'],
  572. ]);
  573. $resource = fopen('php://temp', 'w');
  574. $this->factory->sink($resource)->get('http://foo.com/test');
  575. $this->assertSame(json_encode(['page' => 'foo']), stream_get_contents($resource));
  576. }
  577. public function testCanAssertAgainstOrderOfHttpRequestsWithUrlStrings()
  578. {
  579. $this->factory->fake();
  580. $exampleUrls = [
  581. 'http://example.com/1',
  582. 'http://example.com/2',
  583. 'http://example.com/3',
  584. ];
  585. foreach ($exampleUrls as $url) {
  586. $this->factory->get($url);
  587. }
  588. $this->factory->assertSentInOrder($exampleUrls);
  589. }
  590. public function testAssertionsSentOutOfOrderThrowAssertionFailed()
  591. {
  592. $this->factory->fake();
  593. $exampleUrls = [
  594. 'http://example.com/1',
  595. 'http://example.com/2',
  596. 'http://example.com/3',
  597. ];
  598. $this->factory->get($exampleUrls[0]);
  599. $this->factory->get($exampleUrls[2]);
  600. $this->factory->get($exampleUrls[1]);
  601. $this->expectException(AssertionFailedError::class);
  602. $this->factory->assertSentInOrder($exampleUrls);
  603. }
  604. public function testWrongNumberOfRequestsThrowAssertionFailed()
  605. {
  606. $this->factory->fake();
  607. $exampleUrls = [
  608. 'http://example.com/1',
  609. 'http://example.com/2',
  610. 'http://example.com/3',
  611. ];
  612. $this->factory->get($exampleUrls[0]);
  613. $this->factory->get($exampleUrls[1]);
  614. $this->expectException(AssertionFailedError::class);
  615. $this->factory->assertSentInOrder($exampleUrls);
  616. }
  617. public function testCanAssertAgainstOrderOfHttpRequestsWithCallables()
  618. {
  619. $this->factory->fake();
  620. $exampleUrls = [
  621. function ($request) {
  622. return $request->url() === 'http://example.com/1';
  623. },
  624. function ($request) {
  625. return $request->url() === 'http://example.com/2';
  626. },
  627. function ($request) {
  628. return $request->url() === 'http://example.com/3';
  629. },
  630. ];
  631. $this->factory->get('http://example.com/1');
  632. $this->factory->get('http://example.com/2');
  633. $this->factory->get('http://example.com/3');
  634. $this->factory->assertSentInOrder($exampleUrls);
  635. }
  636. public function testCanAssertAgainstOrderOfHttpRequestsWithCallablesAndHeaders()
  637. {
  638. $this->factory->fake();
  639. $executionOrder = [
  640. function (Request $request) {
  641. return $request->url() === 'http://foo.com/json' &&
  642. $request->hasHeader('Content-Type', 'application/json') &&
  643. $request->hasHeader('X-Test-Header', 'foo') &&
  644. $request->hasHeader('X-Test-ArrayHeader', ['bar', 'baz']) &&
  645. $request['name'] === 'Taylor';
  646. },
  647. function (Request $request) {
  648. return $request->url() === 'http://bar.com/json' &&
  649. $request->hasHeader('Content-Type', 'application/json') &&
  650. $request->hasHeader('X-Test-Header', 'bar') &&
  651. $request->hasHeader('X-Test-ArrayHeader', ['bar', 'baz']) &&
  652. $request['name'] === 'Taylor';
  653. },
  654. ];
  655. $this->factory->withHeaders([
  656. 'X-Test-Header' => 'foo',
  657. 'X-Test-ArrayHeader' => ['bar', 'baz'],
  658. ])->post('http://foo.com/json', [
  659. 'name' => 'Taylor',
  660. ]);
  661. $this->factory->withHeaders([
  662. 'X-Test-Header' => 'bar',
  663. 'X-Test-ArrayHeader' => ['bar', 'baz'],
  664. ])->post('http://bar.com/json', [
  665. 'name' => 'Taylor',
  666. ]);
  667. $this->factory->assertSentInOrder($executionOrder);
  668. }
  669. public function testCanAssertAgainstOrderOfHttpRequestsWithCallablesAndHeadersFailsCorrectly()
  670. {
  671. $this->factory->fake();
  672. $executionOrder = [
  673. function (Request $request) {
  674. return $request->url() === 'http://bar.com/json' &&
  675. $request->hasHeader('Content-Type', 'application/json') &&
  676. $request->hasHeader('X-Test-Header', 'bar') &&
  677. $request->hasHeader('X-Test-ArrayHeader', ['bar', 'baz']) &&
  678. $request['name'] === 'Taylor';
  679. },
  680. function (Request $request) {
  681. return $request->url() === 'http://foo.com/json' &&
  682. $request->hasHeader('Content-Type', 'application/json') &&
  683. $request->hasHeader('X-Test-Header', 'foo') &&
  684. $request->hasHeader('X-Test-ArrayHeader', ['bar', 'baz']) &&
  685. $request['name'] === 'Taylor';
  686. },
  687. ];
  688. $this->factory->withHeaders([
  689. 'X-Test-Header' => 'foo',
  690. 'X-Test-ArrayHeader' => ['bar', 'baz'],
  691. ])->post('http://foo.com/json', [
  692. 'name' => 'Taylor',
  693. ]);
  694. $this->factory->withHeaders([
  695. 'X-Test-Header' => 'bar',
  696. 'X-Test-ArrayHeader' => ['bar', 'baz'],
  697. ])->post('http://bar.com/json', [
  698. 'name' => 'Taylor',
  699. ]);
  700. $this->expectException(AssertionFailedError::class);
  701. $this->factory->assertSentInOrder($executionOrder);
  702. }
  703. public function testCanDump()
  704. {
  705. $dumped = [];
  706. VarDumper::setHandler(function ($value) use (&$dumped) {
  707. $dumped[] = $value;
  708. });
  709. $this->factory->fake()->dump(1, 2, 3)->withOptions(['delay' => 1000])->get('http://foo.com');
  710. $this->assertSame(1, $dumped[0]);
  711. $this->assertSame(2, $dumped[1]);
  712. $this->assertSame(3, $dumped[2]);
  713. $this->assertInstanceOf(Request::class, $dumped[3]);
  714. $this->assertSame(1000, $dumped[4]['delay']);
  715. VarDumper::setHandler(null);
  716. }
  717. public function testResponseSequenceIsMacroable()
  718. {
  719. ResponseSequence::macro('customMethod', function () {
  720. return 'yes!';
  721. });
  722. $this->assertSame('yes!', $this->factory->fakeSequence()->customMethod());
  723. }
  724. public function testRequestsCanBeAsync()
  725. {
  726. $request = new PendingRequest($this->factory);
  727. $promise = $request->async()->get('http://foo.com');
  728. $this->assertInstanceOf(PromiseInterface::class, $promise);
  729. $this->assertSame($promise, $request->getPromise());
  730. }
  731. public function testClientCanBeSet()
  732. {
  733. $client = $this->factory->buildClient();
  734. $request = new PendingRequest($this->factory);
  735. $this->assertNotSame($client, $request->buildClient());
  736. $request->setClient($client);
  737. $this->assertSame($client, $request->buildClient());
  738. }
  739. public function testRequestsCanReplaceOptions()
  740. {
  741. $request = new PendingRequest($this->factory);
  742. $request = $request->withOptions(['http_errors' => true, 'connect_timeout' => 10]);
  743. $this->assertSame(['http_errors' => true, 'connect_timeout' => 10], $request->getOptions());
  744. $request = $request->withOptions(['connect_timeout' => 20]);
  745. $this->assertSame(['http_errors' => true, 'connect_timeout' => 20], $request->getOptions());
  746. }
  747. public function testMultipleRequestsAreSentInThePool()
  748. {
  749. $this->factory->fake([
  750. '200.com' => $this->factory::response('', 200),
  751. '400.com' => $this->factory::response('', 400),
  752. '500.com' => $this->factory::response('', 500),
  753. ]);
  754. $responses = $this->factory->pool(function (Pool $pool) {
  755. return [
  756. $pool->get('200.com'),
  757. $pool->get('400.com'),
  758. $pool->get('500.com'),
  759. ];
  760. });
  761. $this->assertSame(200, $responses[0]->status());
  762. $this->assertSame(400, $responses[1]->status());
  763. $this->assertSame(500, $responses[2]->status());
  764. }
  765. public function testMultipleRequestsAreSentInThePoolWithKeys()
  766. {
  767. $this->factory->fake([
  768. '200.com' => $this->factory::response('', 200),
  769. '400.com' => $this->factory::response('', 400),
  770. '500.com' => $this->factory::response('', 500),
  771. ]);
  772. $responses = $this->factory->pool(function (Pool $pool) {
  773. return [
  774. $pool->as('test200')->get('200.com'),
  775. $pool->as('test400')->get('400.com'),
  776. $pool->as('test500')->get('500.com'),
  777. ];
  778. });
  779. $this->assertSame(200, $responses['test200']->status());
  780. $this->assertSame(400, $responses['test400']->status());
  781. $this->assertSame(500, $responses['test500']->status());
  782. }
  783. public function testTheRequestSendingAndResponseReceivedEventsAreFiredWhenARequestIsSent()
  784. {
  785. $events = m::mock(Dispatcher::class);
  786. $events->shouldReceive('dispatch')->times(5)->with(m::type(RequestSending::class));
  787. $events->shouldReceive('dispatch')->times(5)->with(m::type(ResponseReceived::class));
  788. $factory = new Factory($events);
  789. $factory->fake();
  790. $factory->get('https://example.com');
  791. $factory->head('https://example.com');
  792. $factory->post('https://example.com');
  793. $factory->patch('https://example.com');
  794. $factory->delete('https://example.com');
  795. }
  796. public function testTheRequestSendingAndResponseReceivedEventsAreFiredWhenARequestIsSentAsync()
  797. {
  798. $events = m::mock(Dispatcher::class);
  799. $events->shouldReceive('dispatch')->times(5)->with(m::type(RequestSending::class));
  800. $events->shouldReceive('dispatch')->times(5)->with(m::type(ResponseReceived::class));
  801. $factory = new Factory($events);
  802. $factory->fake();
  803. $factory->pool(function (Pool $pool) {
  804. return [
  805. $pool->get('https://example.com'),
  806. $pool->head('https://example.com'),
  807. $pool->post('https://example.com'),
  808. $pool->patch('https://example.com'),
  809. $pool->delete('https://example.com'),
  810. ];
  811. });
  812. }
  813. public function testTheTransferStatsAreCalledSafelyWhenFakingTheRequest()
  814. {
  815. $this->factory->fake(['https://example.com' => ['world' => 'Hello world']]);
  816. $stats = $this->factory->get('https://example.com')->handlerStats();
  817. $effectiveUri = $this->factory->get('https://example.com')->effectiveUri();
  818. $this->assertIsArray($stats);
  819. $this->assertEmpty($stats);
  820. $this->assertNull($effectiveUri);
  821. }
  822. public function testTransferStatsArePresentWhenFakingTheRequestUsingAPromiseResponse()
  823. {
  824. $this->factory->fake(['https://example.com' => $this->factory->response()]);
  825. $effectiveUri = $this->factory->get('https://example.com')->effectiveUri();
  826. $this->assertSame('https://example.com', (string) $effectiveUri);
  827. }
  828. public function testClonedClientsWorkSuccessfullyWithTheRequestObject()
  829. {
  830. $events = m::mock(Dispatcher::class);
  831. $events->shouldReceive('dispatch')->once()->with(m::type(RequestSending::class));
  832. $events->shouldReceive('dispatch')->once()->with(m::type(ResponseReceived::class));
  833. $factory = new Factory($events);
  834. $factory->fake(['example.com' => $factory->response('foo', 200)]);
  835. $client = $factory->timeout(10);
  836. $clonedClient = clone $client;
  837. $clonedClient->get('https://example.com');
  838. }
  839. public function testRequestIsMacroable()
  840. {
  841. Request::macro('customMethod', function () {
  842. return 'yes!';
  843. });
  844. $this->factory->fake(function (Request $request) {
  845. $this->assertSame('yes!', $request->customMethod());
  846. return $this->factory->response();
  847. });
  848. $this->factory->get('https://example.com');
  849. }
  850. public function testItCanAddAuthorizationHeaderIntoRequestUsingBeforeSendingCallback()
  851. {
  852. $this->factory->fake();
  853. $this->factory->beforeSending(function (Request $request) {
  854. $requestLine = sprintf(
  855. '%s %s HTTP/%s',
  856. $request->toPsrRequest()->getMethod(),
  857. $request->toPsrRequest()->getUri()->withScheme('')->withHost(''),
  858. $request->toPsrRequest()->getProtocolVersion()
  859. );
  860. return $request->toPsrRequest()->withHeader('Authorization', 'Bearer '.$requestLine);
  861. })->get('http://foo.com/json');
  862. $this->factory->assertSent(function (Request $request) {
  863. return
  864. $request->url() === 'http://foo.com/json' &&
  865. $request->hasHeader('Authorization', 'Bearer GET /json HTTP/1.1');
  866. });
  867. }
  868. }