Add not-matched-request as an error

Author: DEVizzent

src/MockServerHelper.php

@@ -11,20 +11,27 @@
 
 class MockServerHelper extends Module
 {
+    const CONFIG_NOT_MATCHED_REQUEST = 'not-matched-request';
+    const NOT_MATCHED_REQUEST_ACTIVATED = 'activated';
+    const CONFIG_URL = 'url';
     private Client $mockserverClient;
     public function __construct(ModuleContainer $moduleContainer, ?array $config = null)
     {
-        $this->requiredFields = ['url'];
+        $this->requiredFields = [self::CONFIG_URL];
         $this->config['cleanupBefore'] = 'test';
+        $this->config[self::CONFIG_NOT_MATCHED_REQUEST] = self::NOT_MATCHED_REQUEST_ACTIVATED;
         parent::__construct($moduleContainer, $config);
     }
 
 
     public function _initialize(): void
     {
         $this->mockserverClient = new Client([
-            'base_uri'  => $this->config['url']
+            'base_uri'  => $this->config[self::CONFIG_URL]
         ]);
+        if (self::NOT_MATCHED_REQUEST_ACTIVATED === $this->config[self::CONFIG_NOT_MATCHED_REQUEST]) {
+            $this->createMockRequest(file_get_contents(__DIR__.'/not-matched-request.json'));
+        }
     }
 
     public function _beforeSuite(array $settings = []): void
@@ -62,6 +69,22 @@ public function seeMockRequestWasNotCalled(string $expectationId): void
         $this->seeMockRequestWasCalled($expectationId, 0);
     }
 
+    public function createMockRequest(string $json): void
+    {
+        $request = new Request(
+            'PUT',
+            '/mockserver/expectation',
+            ['Content-Type' => 'application/json'],
+            $json
+        );
+        $response = $this->mockserverClient->sendRequest($request);
+        Assert::assertEquals(
+            201,
+            $response->getStatusCode(),
+            $response->getBody()->getContents()
+        );
+    }
+
     public function clearMockServerLogs(): void
     {
         $request = new Request('PUT', '/mockserver/clear?type=log');
@@ -73,4 +96,19 @@ public function clearMockServerLogs(): void
         );
 
     }
+
+    public function deactivateNotMatchedRequest(): void
+    {
+        $body = json_encode([
+            'id' => self::CONFIG_NOT_MATCHED_REQUEST
+        ]);
+        $request = new Request('PUT', '/mockserver/clear?type=expectations', [], $body);
+        $response = $this->mockserverClient->sendRequest($request);
+        Assert::assertEquals(
+            200,
+            $response->getStatusCode(),
+            $response->getBody()->getContents()
+        );
+
+    }
 }

src/not-matched-request.json

@@ -0,0 +1,12 @@
+{
+  "id": "not-matched-request",
+  "priority": -100,
+  "httpRequest": {},
+  "httpResponse": {
+    "statusCode": 500,
+    "reasonPhrase": "Internal Server Error",
+    "body": {
+      "message": "Request not matched by MockServer"
+    }
+  }
+}

tests/Integration/NotMatchedRequestTest.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Test\DEVizzent\CodeceptionMockServerHelper\Integration;
+
+use Codeception\Lib\ModuleContainer;
+use DEVizzent\CodeceptionMockServerHelper\MockServerHelper;
+use GuzzleHttp\Client;
+use PHPUnit\Framework\ExpectationFailedException;
+use PHPUnit\Framework\TestCase;
+
+class NotMatchedRequestTest extends TestCase
+{
+    const NOT_MATCHED_URI = 'https://jsonplaceholder.typicode.com/posts/3';
+    private MockServerHelper $sot;
+    private Client $client;
+
+    private function initialize(string $notMatchedRequestConfig): void
+    {
+        $moduleContainer = $this->createMock(ModuleContainer::class);
+        $this->sot = new MockServerHelper(
+            $moduleContainer,
+            ['url' => 'http://mockserver:1080', 'not-matched-request' => $notMatchedRequestConfig]
+        );
+        $this->sot->_initialize();
+        $this->client = new Client(['proxy' => 'http://mockserver:1080', 'verify' => false]);
+        $this->sot->clearMockServerLogs();
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+        $this->sot->deactivateNotMatchedRequest();
+    }
+
+    public function testActivateNotMatchedRequestCreateExpectation()
+    {
+        $this->initialize('activated');
+        $this->sot->seeMockRequestWasNotCalled('not-matched-request');
+    }
+
+    public function testActivateNotMatchedRequestWasCreatedAndCalled()
+    {
+        $this->initialize('activated');
+        $this->client->request('GET', self::NOT_MATCHED_URI, ['http_errors' => false]);
+        $this->sot->seeMockRequestWasCalled('not-matched-request', 1);
+    }
+
+    public function testActivateNotMatchedRequestWasCreatedAndDeactivated()
+    {
+        $this->initialize('activated');
+        $this->sot->deactivateNotMatchedRequest();
+        $this->client->request('GET', self::NOT_MATCHED_URI, ['http_errors' => false]);
+        $this->sot->seeMockRequestWasNotCalled('not-matched-request');
+    }
+
+
+}

tests/Integration/SeeMockRequestWasNotCalledTest.php

@@ -29,7 +29,8 @@ public function testExpectationWasNotCalled(): void
     }
 
     public function testExpectationWasNotCalledButItWasThrowException(): void
-    {$this->expectException(ExpectationFailedException::class);
+    {
+        $this->expectException(ExpectationFailedException::class);
         $this->expectExceptionMessageMatches(
             '#^Request not found exactly 0 times, expected:((.|\n)*) but was:((.|\n)*)'
             . 'Failed asserting that 406 matches expected 202\.$#'
@@ -38,7 +39,7 @@ public function testExpectationWasNotCalledButItWasThrowException(): void
         $this->sot->seeMockRequestWasNotCalled('get-post-2');
     }
 
-    public function testExpectationWasCalledThrowException(): void
+    public function testExpectationWasCalledNotExistExpectationThrowException(): void
     {
         $this->expectException(ExpectationFailedException::class);
         $this->expectExceptionMessage(