feat: Refactor http client mock

BREAKING CHANGE: Request matcher behaviour has changed for headers, queryParams, requestParams and multiparts

Author: Stephan Wentz

README.http-client-trait.md

@@ -7,14 +7,10 @@ To use the mock http client, configure the `MockRequestBuilderCollection` as `mo
 Example symfony config:
 
 ```yaml
-# config/packages/http_client.yaml
+# config/packages/mock_request_builder.yaml
 when@test:
     services:
-        Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestBuilderCollection:
-            arguments:
-                - '@Brainbits\FunctionalTestHelpers\HttpClientMock\SymfonyMockResponseFactory'
-
-        Brainbits\FunctionalTestHelpers\HttpClientMock\SymfonyMockResponseFactory: ~
+        Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestBuilderCollection: ~
 ```
 
 ```yaml

TODO.md

@@ -1,5 +1,2 @@
 - Make firewall context configurable in RequestBuilder
 - Mark RequestBuilderFactory as Symfony specific
-- Remove json()-deprecation from MockRequestBuilder
-- Create better fail-description for missing MockRequestCollection in test case
-- Make match immutable

UPGRADE-7.0.md

@@ -0,0 +1,7 @@
+UPGRADE FROM 6.x to 7.0
+=======================
+
+HttpClientMock
+--------------
+
+ * Remove `SymfonyMockResponseFactory` definition and argument from `MockRequestBuilderCollection` in mock_request_builder.yaml.

src/HttpClientMock/CallStack.php

@@ -15,13 +15,13 @@
 
 use const PHP_EOL;
 
-/** @implements IteratorAggregate<MockRequestBuilder> */
+/** @implements IteratorAggregate<RealRequest> */
 final class CallStack implements Countable, IteratorAggregate
 {
-    /** @var MockRequestBuilder[] */
+    /** @var RealRequest[] */
     private array $calls;
 
-    public function __construct(MockRequestBuilder ...$calls)
+    public function __construct(RealRequest ...$calls)
     {
         $this->calls = $calls;
     }
@@ -33,7 +33,7 @@ public static function fromCallStacks(CallStack ...$callStacks): self
         return new self(...$requests);
     }
 
-    public function first(): MockRequestBuilder|null
+    public function first(): RealRequest|null
     {
         if (!count($this->calls)) {
             return null;
@@ -52,7 +52,7 @@ public function count(): int
         return count($this->calls);
     }
 
-    /** @return Traversable<MockRequestBuilder>|MockRequestBuilder[] */
+    /** @return Traversable<RealRequest> */
     public function getIterator(): Traversable
     {
         yield from $this->calls;

src/HttpClientMock/Compare.php

@@ -4,25 +4,114 @@
 
 namespace Brainbits\FunctionalTestHelpers\HttpClientMock\Exception;
 
-use Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestBuilder;
-use Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestMatch;
+use Brainbits\FunctionalTestHelpers\HttpClientMock\Matcher\Hit;
+use Brainbits\FunctionalTestHelpers\HttpClientMock\Matcher\MatchResult;
+use Brainbits\FunctionalTestHelpers\HttpClientMock\Matcher\Mismatch;
+use Brainbits\FunctionalTestHelpers\HttpClientMock\Matcher\Missing;
+use Brainbits\FunctionalTestHelpers\HttpClientMock\RealRequest;
 use RuntimeException;
 
+use function array_map;
+use function explode;
+use function implode;
 use function sprintf;
 
 use const PHP_EOL;
 
 final class NoMatchingMockRequest extends RuntimeException implements HttpClientMockException
 {
-    /** @param MockRequestMatch[] $matches */
-    public static function fromMockRequest(MockRequestBuilder $request, array $matches): self
+    public static function noBuilders(RealRequest $request): self
+    {
+        $message = sprintf('No mock request builders given for:%s%s%s', PHP_EOL, $request, PHP_EOL);
+
+        return new self($message);
+    }
+
+    /** @param MatchResult[] $matchResults */
+    public static function fromResults(RealRequest $request, array $matchResults): self
     {
         $message = sprintf('No matching mock request builder found for:%s%s%s', PHP_EOL, $request, PHP_EOL);
+        $message .= sprintf('%sMock request builders:%s', PHP_EOL, PHP_EOL);
+
+        $tick = '✔';
+        $cross = '✘';
+
+        foreach ($matchResults as $key => $matchResult) {
+            $no = $key + 1;
+            $name = $matchResult->getName();
+
+            $message .= sprintf(
+                '#%s %s%s',
+                $no,
+                $name ?? '(unnamed)',
+                PHP_EOL,
+            );
+
+            foreach ($matchResult->getResults() as $result) {
+                if ($result instanceof Hit) {
+                    if ($result->key) {
+                        $line = sprintf(
+                            '%s %s %s matches "%s"',
+                            $tick,
+                            $result->matcher,
+                            $result->key,
+                            $result->actual,
+                        );
+                    } else {
+                        $line = sprintf(
+                            '%s %s matches "%s"',
+                            $tick,
+                            $result->matcher,
+                            $result->actual,
+                        );
+                    }
+                } elseif ($result instanceof Mismatch) {
+                    if ($result->key) {
+                        $line = sprintf(
+                            '%s %s %s "%s" does not match "%s"',
+                            $cross,
+                            $result->matcher,
+                            $result->key,
+                            $result->actual ?? 'NULL',
+                            $result->expected,
+                        );
+                    } else {
+                        $line = sprintf(
+                            '%s %s "%s" does not match "%s"',
+                            $cross,
+                            $result->matcher,
+                            $result->actual ?? 'NULL',
+                            $result->expected,
+                        );
+                    }
+                } elseif ($result instanceof Missing) {
+                    $line = sprintf(
+                        '%s %s %s missing',
+                        $cross,
+                        $result->matcher,
+                        $result->key,
+                    );
+                } else {
+                    continue;
+                }
+
+                $message .= sprintf(
+                    '  %s (%s)%s',
+                    $line,
+                    $result->score,
+                    PHP_EOL,
+                );
 
-        if ($matches) {
-            $message .= sprintf('%sReasons:%s', PHP_EOL, PHP_EOL);
-            foreach ($matches as $match) {
-                $message .= sprintf('- %s%s', $match->getReason(), PHP_EOL);
+                if ($result instanceof Mismatch && $result->diff) { // phpcs:ignore
+                    $diff = implode(
+                        PHP_EOL,
+                        array_map(
+                            static fn ($line) => '    ' . $line,
+                            explode(PHP_EOL, $result->diff),
+                        ),
+                    );
+                    $message .= $diff . PHP_EOL;
+                }
             }
         }
 

src/HttpClientMock/Exception/NoMatchingMockRequest.php

@@ -23,9 +23,15 @@ public static function allResponsesProcessed(): self
         return new self('All responses have already been processed');
     }
 
-    public static function withRequest(self $decorated, MockRequestBuilder $request): self
+    public static function withRequest(self $decorated, MockRequestBuilder $requestBuilder): self
     {
-        $message = sprintf('%s for:%s%s%s', $decorated->getMessage(), PHP_EOL, $request, PHP_EOL);
+        $message = sprintf(
+            '%s for:%s%s%s',
+            $decorated->getMessage(),
+            PHP_EOL,
+            $requestBuilder,
+            PHP_EOL,
+        );
 
         return new self($message, $decorated->getCode(), $decorated->getPrevious());
     }

src/HttpClientMock/Exception/NoResponseMock.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Brainbits\FunctionalTestHelpers\HttpClientMock\Exception;
+
+use RuntimeException;
+
+use function sprintf;
+
+final class UriContainsQueryParameters extends RuntimeException implements HttpClientMockException
+{
+    public static function fromUri(string $uri): self
+    {
+        return new self(sprintf('Given uri %s conts query parameters, use queryParam() calls instead.', $uri));
+    }
+}