Feature | Add assertSentInOrder assertion to MockClient

src/Http/Faking/MockClient.php

@@ -259,6 +259,23 @@ public function assertNotSent(string|callable $request): void
  PHPUnit::assertTrue($result, 'An unexpected request was sent.');
  }
 
+ /**
+ * Assert that given requests were sent in order
+ *
+ * @param array<\Closure|class-string<Request>|string> $callbacks
+ * @return void
+ */
+ public function assertSentInOrder(array $callbacks): void
+ {
+ $this->assertSentCount(count($callbacks));
+
+ foreach ($callbacks as $index => $callback) {
+ $result = $this->checkRequestWasSent($callback, $index);
+
+ PHPUnit::assertTrue($result, 'An expected request (#'.($index + 1).') was not sent.');
+ }
+ }
+
  /**
  * Assert JSON response data was received
  *
@@ -300,19 +317,19 @@ public function assertSentCount(int $count, string $requestClass = null): void
  /**
  * Check if a given request was sent
  */
- protected function checkRequestWasSent(string|callable $request): bool
+ protected function checkRequestWasSent(string|callable $request, ?int $index = null): bool
  {
  $passed = false;
 
  if (is_callable($request)) {
- return $this->checkClosureAgainstResponses($request);
+ return $this->checkClosureAgainstResponses($request, $index);
  }
 
  if (is_string($request)) {
  if (class_exists($request) && Helpers::isSubclassOf($request, Request::class)) {
- $passed = $this->findResponseByRequest($request) instanceof Response;
+ $passed = $this->findResponseByRequest($request, $index) instanceof Response;
  } else {
- $passed = $this->findResponseByRequestUrl($request) instanceof Response;
+ $passed = $this->findResponseByRequestUrl($request, $index) instanceof Response;
  }
  }
 
@@ -330,12 +347,20 @@ protected function checkRequestWasNotSent(string|callable $request): bool
  /**
  * Assert a given request was sent.
  */
- public function findResponseByRequest(string $request): ?Response
+ public function findResponseByRequest(string $request, ?int $index = null): ?Response
  {
  if ($this->checkHistoryEmpty() === true) {
  return null;
  }
 
+ if(! is_null($index)) {
+ $recordedResponse = $this->getRecordedResponses()[$index];
+
+ if ($recordedResponse->getPendingRequest()->getRequest() instanceof $request) {
+ return $recordedResponse;
+ }
+ }
+
  $lastRequest = $this->getLastRequest();
 
  if ($lastRequest instanceof $request) {
@@ -354,12 +379,23 @@ public function findResponseByRequest(string $request): ?Response
  /**
  * Find a request that matches a given url pattern
  */
- public function findResponseByRequestUrl(string $url): ?Response
+ public function findResponseByRequestUrl(string $url, ?int $index = null): ?Response
  {
  if ($this->checkHistoryEmpty() === true) {
  return null;
  }
 
+ if(! is_null($index)) {
+ $response = $this->getRecordedResponses()[$index];
+ $pendingRequest = $response->getPendingRequest();
+
+ if (URLHelper::matches($url, $pendingRequest->getUrl())) {
+ return $response;
+ }
+
+ return null;
+ }
+
  $lastPendingRequest = $this->getLastPendingRequest();
 
  if ($lastPendingRequest instanceof PendingRequest && URLHelper::matches($url, $lastPendingRequest->getUrl())) {
@@ -410,12 +446,19 @@ public static function destroyGlobal(): void
  /**
  * Test if the closure can pass with the history.
  */
- private function checkClosureAgainstResponses(callable $closure): bool
+ private function checkClosureAgainstResponses(callable $closure, ?int $index = null): bool
  {
  if ($this->checkHistoryEmpty() === true) {
  return false;
  }
 
+ if(! is_null($index)) {
+ $response = $this->getRecordedResponses()[$index];
+ $request = $response->getPendingRequest()->getRequest();
+
+ return $closure($request, $response);
+ }
+
  // Let's first check if the latest response resolves the callable
  // with a successful result.
 

tests/Unit/MockClientAssertionsTest.php

@@ -8,6 +8,7 @@
 use Saloon\Http\Faking\MockResponse;
 use Saloon\Tests\Fixtures\Requests\UserRequest;
 use Saloon\Tests\Fixtures\Requests\ErrorRequest;
+use PHPUnit\Framework\ExpectationFailedException;
 use Saloon\Tests\Fixtures\Connectors\TestConnector;
 
 test('assertSent works with a request', function () {
@@ -207,3 +208,49 @@
  return $response->json() === ['name' => 'Marcel'] && $response->status() === 204;
  });
 });
+
+test('it can assert requests are sent in a specific order', function () {
+ $mockClient = new MockClient([
+ MockResponse::make(['name' => 'Sam']),
+ MockResponse::make(['name' => 'Taylor'], 201),
+ MockResponse::make(['name' => 'Marcel'], 204),
+ ]);
+
+ $connector = new TestConnector;
+
+ $connector->send(new UserRequest, $mockClient);
+ $connector->send(new UserRequest, $mockClient);
+ $connector->send(new UserRequest, $mockClient);
+
+ $mockClient->assertSentInOrder([
+ UserRequest::class,
+ function (UserRequest $request, Response $response) {
+ return $response->json() === ['name' => 'Taylor'];
+ },
+ '/user',
+ ]);
+});
+
+test('it can assert requests are sent in a specific order failure', function () {
+ $mockClient = new MockClient([
+ MockResponse::make(['name' => 'Sam']),
+ MockResponse::make(['name' => 'Taylor'], 201),
+ MockResponse::make(['name' => 'Marcel'], 204),
+ ]);
+
+ $connector = new TestConnector;
+
+ $connector->send(new UserRequest(userId: 2), $mockClient);
+ $connector->send(new UserRequest(userId: 1), $mockClient);
+ $connector->send(new UserRequest(), $mockClient);
+
+
+
+ $mockClient->assertSentInOrder([
+ UserRequest::class,
+ function (UserRequest $request) {
+ return $request->userId === 2;
+ },
+ '/user',
+ ]);
+})->expectException(ExpectationFailedException::class);