Refactor the configuration and add validation

Author: DEVizzent

src/Config/CleanUpBefore.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace DEVizzent\CodeceptionMockServerHelper\Config;
+
+use InvalidArgumentException;
+use PHP_CodeSniffer\Tests\Core\File\testFECNClass;
+
+class CleanUpBefore
+{
+    public const TEST = 'test';
+    public const SUITE = 'suite';
+    public const NEVER = 'never';
+    private const ALLOWED_VALUES = [self::TEST, self::SUITE, self::NEVER];
+    private string $value;
+
+    public function __construct(string $value)
+    {
+        if (!in_array($value, self::ALLOWED_VALUES, true)) {
+            $message = sprintf(
+                '"%s" is not allowed value for cleanUpBefore. Only %s are valid',
+                $value,
+                implode(', ', self::ALLOWED_VALUES)
+            );
+            throw new InvalidArgumentException($message);
+        }
+        $this->value = $value;
+    }
+
+    public function isTest(): bool
+    {
+        return self::TEST === $this->value;
+    }
+
+    public function isSuite(): bool
+    {
+        return self::SUITE === $this->value;
+    }
+}

src/Config/NotMatchedRequest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace DEVizzent\CodeceptionMockServerHelper\Config;
+
+use InvalidArgumentException;
+
+class NotMatchedRequest
+{
+    public const ENABLED = 'enabled';
+    public const DISABLED = 'disabled';
+    private const ALLOWED_VALUES = [self::ENABLED, self::DISABLED];
+    private string $value;
+
+    public function __construct(string $value)
+    {
+        if (!in_array($value, self::ALLOWED_VALUES, true)) {
+            $message = sprintf(
+                '"%s" is not allowed value for notMatchedRequest. Only %s are valid',
+                $value,
+                implode(', ', self::ALLOWED_VALUES)
+            );
+            throw new InvalidArgumentException($message);
+        }
+        $this->value = $value;
+    }
+
+    public function isEnabled(): bool
+    {
+        return self::ENABLED === $this->value;
+    }
+}

src/MockServerHelper.php

@@ -5,45 +5,62 @@
 use Codeception\Lib\ModuleContainer;
 use Codeception\Module;
 use Codeception\TestInterface;
+use DEVizzent\CodeceptionMockServerHelper\Config\CleanUpBefore;
+use DEVizzent\CodeceptionMockServerHelper\Config\NotMatchedRequest;
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Request;
 use PHPUnit\Framework\Assert;
 
 class MockServerHelper extends Module
 {
-    const CONFIG_NOT_MATCHED_REQUEST = 'not-matched-request';
-    const NOT_MATCHED_REQUEST_ACTIVATED = 'activated';
-    const CONFIG_URL = 'url';
+    private const CONFIG_NOT_MATCHED_REQUEST = 'notMatchedRequest';
+    private const CONFIG_URL = 'url';
+    private const CONFIG_CLEANUP_BEFORE = 'cleanupBefore';
+    public const NOT_MATCHED_REQUEST_ID = 'not-matched-request';
     private Client $mockserverClient;
+    private CleanUpBefore $cleanUpBefore;
+    private NotMatchedRequest $notMatchedRequest;
+    /** @param array<string, string>|null $config */
     public function __construct(ModuleContainer $moduleContainer, ?array $config = null)
     {
         $this->requiredFields = [self::CONFIG_URL];
-        $this->config['cleanupBefore'] = 'test';
-        $this->config[self::CONFIG_NOT_MATCHED_REQUEST] = self::NOT_MATCHED_REQUEST_ACTIVATED;
+        $this->cleanUpBefore = new CleanUpBefore(CleanUpBefore::TEST);
+        $this->notMatchedRequest = new NotMatchedRequest(NotMatchedRequest::ENABLED);
         parent::__construct($moduleContainer, $config);
     }
 
 
     public function _initialize(): void
     {
+        parent::_initialize();
+        if (is_string($this->config[self::CONFIG_NOT_MATCHED_REQUEST] ?? null)) {
+            $this->notMatchedRequest = new NotMatchedRequest($this->config[self::CONFIG_NOT_MATCHED_REQUEST]);
+        }
+        if (is_string($this->config[self::CONFIG_CLEANUP_BEFORE] ?? null)) {
+            $this->cleanUpBefore = new CleanUpBefore($this->config[self::CONFIG_CLEANUP_BEFORE]);
+        }
         $this->mockserverClient = new Client([
             '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'));
+        if ($this->notMatchedRequest->isEnabled()) {
+            $expectationJson = file_get_contents(__DIR__ . '/not-matched-request.json');
+            Assert::assertIsString($expectationJson);
+            $this->createMockRequest($expectationJson);
         }
     }
 
     public function _beforeSuite(array $settings = []): void
     {
-        if ('suite' === $this->config['cleanupBefore']) {
+        parent::_beforeSuite($settings);
+        if ($this->cleanUpBefore->isSuite()) {
             $this->clearMockServerLogs();
         }
     }
 
-    public function _before(TestInterface $test):void
+    public function _before(TestInterface $test): void
     {
-        if ('test' === $this->config['cleanupBefore']) {
+        parent::_before($test);
+        if ($this->cleanUpBefore->isTest()) {
             $this->clearMockServerLogs();
         }
     }
@@ -94,21 +111,20 @@ public function clearMockServerLogs(): void
             $response->getStatusCode(),
             $response->getBody()->getContents()
         );
-
     }
 
     public function deactivateNotMatchedRequest(): void
     {
         $body = json_encode([
-            'id' => self::CONFIG_NOT_MATCHED_REQUEST
+            'id' => self::NOT_MATCHED_REQUEST_ID
         ]);
+        Assert::assertIsString($body);
         $request = new Request('PUT', '/mockserver/clear?type=expectations', [], $body);
         $response = $this->mockserverClient->sendRequest($request);
         Assert::assertEquals(
             200,
             $response->getStatusCode(),
             $response->getBody()->getContents()
         );
-
     }
-}
+}

tests/Integration/NotMatchedRequestTest.php

@@ -3,14 +3,15 @@
 namespace Test\DEVizzent\CodeceptionMockServerHelper\Integration;
 
 use Codeception\Lib\ModuleContainer;
+use DEVizzent\CodeceptionMockServerHelper\Config\NotMatchedRequest;
 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 const NOT_MATCHED_URI = 'https://jsonplaceholder.typicode.com/posts/3';
     private MockServerHelper $sot;
     private Client $client;
 
@@ -19,7 +20,7 @@ private function initialize(string $notMatchedRequestConfig): void
         $moduleContainer = $this->createMock(ModuleContainer::class);
         $this->sot = new MockServerHelper(
             $moduleContainer,
-            ['url' => 'http://mockserver:1080', 'not-matched-request' => $notMatchedRequestConfig]
+            ['url' => 'http://mockserver:1080', 'notMatchedRequest' => $notMatchedRequestConfig]
         );
         $this->sot->_initialize();
         $this->client = new Client(['proxy' => 'http://mockserver:1080', 'verify' => false]);
@@ -34,24 +35,15 @@ protected function tearDown(): void
 
     public function testActivateNotMatchedRequestCreateExpectation()
     {
-        $this->initialize('activated');
+        $this->initialize(NotMatchedRequest::ENABLED);
         $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->initialize(NotMatchedRequest::ENABLED);
         $this->sot->deactivateNotMatchedRequest();
         $this->client->request('GET', self::NOT_MATCHED_URI, ['http_errors' => false]);
         $this->sot->seeMockRequestWasNotCalled('not-matched-request');
     }
-
-
-}
+}

tests/Integration/SeeMockRequestWasCalledTest.php

@@ -45,4 +45,4 @@ public function testExpectationNotWasCalledThrowException2(): void
         );
         $this->sot->seeMockRequestWasCalled('not-existing-expectation');
     }
-}
+}

tests/Integration/SeeMockRequestWasNotCalledTest.php

@@ -48,4 +48,4 @@ public function testExpectationWasCalledNotExistExpectationThrowException(): voi
         );
         $this->sot->seeMockRequestWasNotCalled('not-existing-expectation');
     }
-}
+}