Merge pull request #3 from DEVizzent/move_mockserver_communication_to_client_object

Move mockserver communication to client object and add new config to load expectations from a path

Author: DEVizzent

README.md

@@ -11,11 +11,14 @@ the request you have sent to mock server and manage the expectations of mockserv
 //You can create expectations before call your application in a test
 $I->createMockRequest('{"id": "elastic-get-entity-1", "httpRequest": {...}, "httpResponse": {...}}')
 $I->createMockRequest('{"id": "elastic-get-entity-2", "httpRequest": {...}, "httpResponse": {...}}')
+$I->createMockRequestFromJsonFile('/root/path/elastic-get-entity-3.json')
 $I->sendGet('/applition/endpoint/1');
 //After execute our application we can check our mocked HTTP communication
 $I->seeMockRequestWasCalled('elastic-get-entity-1');
 $I->seeMockRequestWasNotCalled('elastic-get-entity-2');
 $I->seeAllRequestWereMatched();
+$I->removeMockRequest("elastic-get-entity-2");
+$I->removeAllMockRequest();
 ```
 
 ## Installation
@@ -41,6 +44,8 @@ modules:
         cleanupBefore: 'test'
         ## Optional field, [enabled, disabled] allowed. Default: enabled
         notMatchedRequest: 'enabled' 
+        ## Optional field, path of the expectations folder or file to load before test
+        expectationsPath: '/absolute/expectations/path' 
 ```
 
 ### cleanupBefore
@@ -62,6 +67,10 @@ our expectations, returning a 500 error with a message `Request not matched by M
 It allows us to validate all request our application do, are expected and we haven't change our communication with 
 external services.
 
+### expectationsPath
+
+Get the file or files in the path, and send the content to create expectations on mockserver. 
+
 ## About
 
 ### Requirements

docker-compose.yml

@@ -12,9 +12,6 @@ services:
     container_name: mockserver
     image: mockserver/mockserver
     environment:
-      MOCKSERVER_INITIALIZATION_JSON_PATH: /expectations/**.json
       MOCKSERVER_LOG_LEVEL: ${MOCKSERVER_LOG_LEVEL}
     ports:
-      - "1080:1080"
-    volumes:
-      - ./docker/mockserver/expectations:/expectations
+      - "1080:1080"

src/Client/MockServer.php

@@ -62,6 +62,16 @@ public function removeById(string $mockRequestId): void
             $response->getBody()->getContents()
         );
     }
+    public function removeAllExpectations(): void
+    {
+        $request = new Request('PUT', '/mockserver/clear?type=expectations');
+        $response = $this->mockserverClient->sendRequest($request);
+        Assert::assertEquals(
+            200,
+            $response->getStatusCode(),
+            $response->getBody()->getContents()
+        );
+    }
 
     public function clearLogs(): void
     {

src/Config/ExpectationsPath.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace DEVizzent\CodeceptionMockServerHelper\Config;
+
+use DEVizzent\CodeceptionMockServerHelper\MockServerHelper;
+use InvalidArgumentException;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use SplFileInfo;
+
+class ExpectationsPath
+{
+    private string $path = '';
+
+    public function __construct(string $path = '')
+    {
+        if ('' === $path) {
+            $this->set($path);
+        }
+    }
+
+    private function set(string $path): void
+    {
+        $path = realpath($path);
+        if (false !== $path) {
+            $this->path = $path;
+            return;
+        }
+        throw new InvalidArgumentException(sprintf('"%s" is not a valid path for "expectationsPath"', $path));
+    }
+
+    /**
+     * @return array<string>
+     */
+    public function getExpectationsFiles(): iterable
+    {
+        if ('' !== $this->path) {
+            return [];
+        }
+        if (!is_dir($this->path)) {
+            return [$this->path];
+        }
+        $recursiveIterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($this->path));
+        $files = [];
+        /** @var SplFileInfo $file */
+        foreach ($recursiveIterator as $file) {
+            if ($file->isDir()) {
+                continue;
+            }
+            $files[] = $file->getPathname();
+        }
+        return $files;
+    }
+}

src/MockServerHelper.php

@@ -7,27 +7,31 @@
 use Codeception\TestInterface;
 use DEVizzent\CodeceptionMockServerHelper\Client\MockServer;
 use DEVizzent\CodeceptionMockServerHelper\Config\CleanUpBefore;
+use DEVizzent\CodeceptionMockServerHelper\Config\ExpectationsPath;
 use DEVizzent\CodeceptionMockServerHelper\Config\NotMatchedRequest;
 use GuzzleHttp\Client;
-use GuzzleHttp\Psr7\Request;
 use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\AssertionFailedError;
 use PHPUnit\Framework\ExpectationFailedException;
 
 class MockServerHelper extends Module
 {
     private const CONFIG_NOT_MATCHED_REQUEST = 'notMatchedRequest';
     private const CONFIG_URL = 'url';
     private const CONFIG_CLEANUP_BEFORE = 'cleanupBefore';
+    private const CONFIG_EXPECTATIONS_PATH = 'expectationsPath';
     public const NOT_MATCHED_REQUEST_ID = 'not-matched-request';
     private MockServer $mockserver;
     private CleanUpBefore $cleanUpBefore;
     private NotMatchedRequest $notMatchedRequest;
+    private ExpectationsPath $expectationPath;
     /** @param array<string, string>|null $config */
     public function __construct(ModuleContainer $moduleContainer, ?array $config = null)
     {
         $this->requiredFields = [self::CONFIG_URL];
         $this->cleanUpBefore = new CleanUpBefore(CleanUpBefore::TEST);
         $this->notMatchedRequest = new NotMatchedRequest(NotMatchedRequest::ENABLED);
+        $this->expectationPath = new ExpectationsPath();
         parent::__construct($moduleContainer, $config);
     }
 
@@ -41,17 +45,22 @@ public function _initialize(): void
         if (is_string($this->config[self::CONFIG_CLEANUP_BEFORE] ?? null)) {
             $this->cleanUpBefore = new CleanUpBefore($this->config[self::CONFIG_CLEANUP_BEFORE]);
         }
+        if (is_string($this->config[self::CONFIG_EXPECTATIONS_PATH] ?? null)) {
+            $this->expectationPath = new ExpectationsPath($this->config[self::CONFIG_EXPECTATIONS_PATH]);
+        }
         $this->mockserver = new MockServer(new Client([
             'base_uri'  => $this->config[self::CONFIG_URL]
         ]));
         if ($this->notMatchedRequest->isEnabled()) {
-            $expectationJson = file_get_contents(__DIR__ . '/not-matched-request.json');
-            Assert::assertIsString($expectationJson);
-            $this->createMockRequest($expectationJson);
+            $this->createMockRequestFromJsonFile(__DIR__ . '/not-matched-request.json');
             return;
         }
 
-        $this->deactivateNotMatchedRequest();
+        try {
+            $this->deactivateNotMatchedRequest();
+        } catch (AssertionFailedError $exception) {
+            return;
+        }
     }
 
     public function _beforeSuite($settings = []): void
@@ -60,6 +69,9 @@ public function _beforeSuite($settings = []): void
         if ($this->cleanUpBefore->isSuite()) {
             $this->mockserver->clearLogs();
         }
+        foreach ($this->expectationPath->getExpectationsFiles() as $expectationFile) {
+            $this->createMockRequestFromJsonFile($expectationFile);
+        }
     }
 
     public function _before(TestInterface $test): void
@@ -105,6 +117,11 @@ public function removeMockRequest(string $mockRequestId): void
         $this->mockserver->removeById($mockRequestId);
     }
 
+    public function removeAllMockRequest(): void
+    {
+        $this->mockserver->removeAllExpectations();
+    }
+
     public function clearMockServerLogs(): void
     {
         $this->mockserver->clearLogs();
@@ -114,4 +131,11 @@ public function deactivateNotMatchedRequest(): void
     {
         $this->mockserver->removeById(self::NOT_MATCHED_REQUEST_ID);
     }
+
+    public function createMockRequestFromJsonFile(string $expectationFile): void
+    {
+        $expectationJson = file_get_contents($expectationFile);
+        Assert::assertIsString($expectationJson);
+        $this->createMockRequest($expectationJson);
+    }
 }

tests/Integration/NotMatchedRequestTest.php

@@ -20,17 +20,22 @@ private function initialize(string $notMatchedRequestConfig): void
         $moduleContainer = $this->createMock(ModuleContainer::class);
         $this->sot = new MockServerHelper(
             $moduleContainer,
-            ['url' => 'http://mockserver:1080', 'notMatchedRequest' => $notMatchedRequestConfig]
+            [
+                'url' => 'http://mockserver:1080',
+                'notMatchedRequest' => $notMatchedRequestConfig,
+                'expectationsPath' => __DIR__ . '/../../docker/mockserver/expectations',
+            ]
         );
         $this->sot->_initialize();
+        $this->sot->_beforeSuite();
         $this->client = new Client(['proxy' => 'http://mockserver:1080', 'verify' => false]);
         $this->sot->clearMockServerLogs();
     }
 
     protected function tearDown(): void
     {
+        $this->sot->removeAllMockRequest();
         parent::tearDown();
-        $this->sot->deactivateNotMatchedRequest();
     }
 
     public function testActivateNotMatchedRequestCreateExpectation()

tests/Integration/SeeAllRequestWereMatchedTest.php

@@ -17,13 +17,24 @@ class SeeAllRequestWereMatchedTest extends TestCase
     protected function initialize(string $notMatchedRequest): void
     {
         $moduleContainer = $this->createMock(ModuleContainer::class);
-        $config = ['url' => 'http://mockserver:1080', 'notMatchedRequest' => $notMatchedRequest];
+        $config = [
+            'url' => 'http://mockserver:1080',
+            'notMatchedRequest' => $notMatchedRequest,
+            'expectationsPath' => __DIR__ . '/../../docker/mockserver/expectations',
+        ];
         $this->sot = new MockServerHelper($moduleContainer, $config);
         $this->sot->_initialize();
+        $this->sot->_beforeSuite();
         $this->client = new Client(['proxy' => 'http://mockserver:1080', 'verify' => false]);
         $this->sot->clearMockServerLogs();
     }
 
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+        $this->sot->removeAllMockRequest();
+    }
+
     public function testAllRequestWereMatchedWhenConfigDisabledThrowException(): void
     {
         $this->initialize(NotMatchedRequest::DISABLED);

tests/Integration/SeeMockRequestWasCalledTest.php

@@ -17,12 +17,23 @@ protected function setUp(): void
     {
         parent::setUp();
         $moduleContainer = $this->createMock(ModuleContainer::class);
-        $this->sot = new MockServerHelper($moduleContainer, ['url' => 'http://mockserver:1080']);
+        $config = [
+            'url' => 'http://mockserver:1080',
+            'expectationsPath' => __DIR__ . '/../../docker/mockserver/expectations',
+        ];
+        $this->sot = new MockServerHelper($moduleContainer, $config);
         $this->sot->_initialize();
+        $this->sot->_beforeSuite();
         $this->client = new Client(['proxy' => 'http://mockserver:1080', 'verify' => false]);
         $this->sot->clearMockServerLogs();
     }
 
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+        $this->sot->removeAllMockRequest();
+    }
+
     public function testExpectationWasCalled(): void
     {
         $this->client->request('GET', 'https://jsonplaceholder.typicode.com/posts/1');

tests/Integration/SeeMockRequestWasNotCalledTest.php

@@ -16,13 +16,24 @@ class SeeMockRequestWasNotCalledTest extends TestCase
     protected function setUp(): void
     {
         parent::setUp();
+        $config = [
+            'url' => 'http://mockserver:1080',
+            'expectationsPath' => __DIR__ . '/../../docker/mockserver/expectations',
+        ];
         $moduleContainer = $this->createMock(ModuleContainer::class);
-        $this->sot = new MockServerHelper($moduleContainer, ['url' => 'http://mockserver:1080']);
+        $this->sot = new MockServerHelper($moduleContainer, $config);
         $this->sot->_initialize();
+        $this->sot->_beforeSuite();
         $this->client = new Client(['proxy' => 'http://mockserver:1080', 'verify' => false]);
         $this->sot->clearMockServerLogs();
     }
 
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+        $this->sot->removeAllMockRequest();
+    }
+
     public function testExpectationWasNotCalled(): void
     {
         $this->sot->seeMockRequestWasNotCalled('get-post-2');