I-5 Implement logic to get most similar notMatched request and show a diff

Author: DEVizzent

src/Client/MockServer.php

@@ -2,6 +2,7 @@
 
 namespace DEVizzent\CodeceptionMockServerHelper\Client;
 
+use DEVizzent\CodeceptionMockServerHelper\MockServerHelper;
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Request;
 use PHPUnit\Framework\Assert;
@@ -33,6 +34,21 @@ public function verify(string $expectationId, ?int $times = null): void
             $response->getBody()->getContents()
         );
     }
+
+    public function getNotMatchedRequests(): array
+    {
+        $notMatchedRequests = [];
+        $request = new Request('PUT', '/mockserver/retrieve?format=json&type=request_responses');
+        $response = $this->mockserverClient->sendRequest($request);
+        $requestResponses = json_decode($response->getBody()->getContents(), true);
+        foreach ($requestResponses as $requestResponse) {
+            $message = $requestResponse['httpResponse']['body']['message'] ?? '';
+            if ($message === 'Request not matched by MockServer') {
+                $notMatchedRequests[] = $requestResponse['httpRequest'];
+            }
+        }
+        return $notMatchedRequests;
+    }
     public function create(string $json): void
     {
         $request = new Request(

src/MockServerHelper.php

@@ -10,6 +10,7 @@
 use DEVizzent\CodeceptionMockServerHelper\Config\ExpectationsPath;
 use DEVizzent\CodeceptionMockServerHelper\Config\NotMatchedRequest;
 use GuzzleHttp\Client;
+use Jfcherng\Diff\DiffHelper;
 use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\AssertionFailedError;
 use PHPUnit\Framework\ExpectationFailedException;
@@ -25,6 +26,7 @@ class MockServerHelper extends Module
     private CleanUpBefore $cleanUpBefore;
     private NotMatchedRequest $notMatchedRequest;
     private ExpectationsPath $expectationPath;
+
     /** @param array<string, string>|null $config */
     public function __construct(ModuleContainer $moduleContainer, ?array $config = null)
     {
@@ -49,7 +51,7 @@ public function _initialize(): void
             $this->expectationPath = new ExpectationsPath($this->config[self::CONFIG_EXPECTATIONS_PATH]);
         }
         $this->mockserver = new MockServer(new Client([
-            'base_uri'  => $this->config[self::CONFIG_URL]
+            'base_uri' => $this->config[self::CONFIG_URL]
         ]));
         if ($this->notMatchedRequest->isEnabled()) {
             $this->createMockRequestFromJsonFile(__DIR__ . '/not-matched-request.json');
@@ -84,7 +86,29 @@ public function _before(TestInterface $test): void
 
     public function seeMockRequestWasCalled(string $expectationId, ?int $times = null): void
     {
-        $this->mockserver->verify($expectationId, $times);
+        try {
+            $this->mockserver->verify($expectationId, $times);
+        } catch (AssertionFailedError $exception) {
+            //throw $exception;
+            preg_match('#(.|\n)* expected:<(?<expected>\{(.|\n)*\})> but was:<(.|\n)*>#', $exception->getMessage(), $matches);
+            if (empty($matches)) {
+                throw $exception;
+            }
+            $expected = json_decode($matches['expected'], true);
+            $notMatchedRequests = $this->mockserver->getNotMatchedRequests();
+            $currentSimilityRatio = 0;
+            $expectedFormatted = $this->formatMockServerRequest($expected);
+            foreach ($notMatchedRequests as $notMatchedRequest) {
+                $diff = DiffHelper::calculate($expectedFormatted, $this->formatMockServerRequest($notMatchedRequest));
+                $statistics = DiffHelper::getStatistics();
+                $similityRatio = $statistics['unmodified'] - $statistics['inserted'] - $statistics['deleted'];
+                if ($currentSimilityRatio < $similityRatio) {
+                    $currentSimilityRatio = $similityRatio;
+                    $bestDiff = $diff;
+                }
+            }
+            throw new AssertionFailedError('Impossible match request: '. PHP_EOL . $bestDiff);
+        }
     }
 
     public function seeMockRequestWasNotCalled(string $expectationId): void
@@ -138,4 +162,10 @@ public function createMockRequestFromJsonFile(string $expectationFile): void
         Assert::assertIsString($expectationJson);
         $this->createMockRequest($expectationJson);
     }
+
+    public function formatMockServerRequest(array $mockServerRequest): string
+    {
+        ksort($mockServerRequest);
+        return json_encode($mockServerRequest, JSON_PRETTY_PRINT);
+    }
 }

tests/Integration/SeeMockRequestWasCalledTest.php

@@ -5,6 +5,7 @@
 use Codeception\Lib\ModuleContainer;
 use DEVizzent\CodeceptionMockServerHelper\MockServerHelper;
 use GuzzleHttp\Client;
+use PHPUnit\Framework\AssertionFailedError;
 use PHPUnit\Framework\ExpectationFailedException;
 use PHPUnit\Framework\TestCase;
 
@@ -56,4 +57,28 @@ public function testExpectationNotWasCalledThrowException2(): void
         );
         $this->sot->seeMockRequestWasCalled('not-existing-expectation');
     }
+
+    public function testExpectationWasCalledButWasNotWithGoodRecomendation(): void
+    {
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/posts/2', ['http_errors'=>false]);
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/posts/2', ['http_errors'=>false]);
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/posts/5', ['http_errors'=>false, 'headers' => ['randomHeader' => 'value']]);
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/users/3/albums', ['http_errors'=>false]);
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessageMatches('#.*"path": "\\\/users\\\/3\\\/albums".*#');
+        $this->sot->seeMockRequestWasCalled('get-post-1');
+    }
+
+    public function testExpectationWasCalledButWasNotWithGoodRecomendation2(): void
+    {
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/posts/2', ['http_errors'=>false]);
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/posts/2', ['http_errors'=>false]);
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/posts/5', ['http_errors'=>false]);
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/users/3/albums', ['http_errors'=>false, 'headers' => ['randomHeader' => 'value']]);
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessageMatches('#.*"path": "\\\/posts\\\/5".*#');
+        $this->sot->seeMockRequestWasCalled('get-post-1');
+    }
 }