Start using Codeception Module config to set mockserver url and log cleanup

Author: DEVizzent

src/MockServerHelper.php

@@ -2,24 +2,43 @@
 
 namespace DEVizzent\CodeceptionMockServerHelper;
 
-use Codeception\Lib\ModuleContainer;
 use Codeception\Module;
+use Codeception\TestInterface;
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Request;
 use PHPUnit\Framework\Assert;
 
 class MockServerHelper extends Module
 {
+    protected array $config = [
+        'url'          => 'http://mockserver:1080',
+        'cleanupBefore' => 'test'
+    ];
+
     private Client $mockserverClient;
 
     /**
      * @param array<string, string> $config
      */
-    public function __construct(ModuleContainer $moduleContainer, ?array $config = null)
+    public function _initialize()
+    {
+        $this->mockserverClient = new Client(['base_uri'  => $this->config['url']]);
+    }
+
+    public function _beforeSuite(array $settings = [])
     {
-        parent::__construct($moduleContainer, $config);
-        $this->mockserverClient = new Client(['base_uri'  => 'http://mockserver:1080']);
+        if ('suite' === $this->config['cleanupBefore']) {
+            $this->clearMockServerLogs();
+        }
     }
+
+    public function _before(TestInterface $test)
+    {
+        if ('test' === $this->config['cleanupBefore']) {
+            $this->clearMockServerLogs();
+        }
+    }
+
     public function seeMockRequestWasCalled(string $expectationId, ?int $times = null): void
     {
         $body = json_encode([
@@ -41,7 +60,7 @@ public function seeMockRequestWasNotCalled(string $expectationId): void
         $this->seeMockRequestWasCalled($expectationId, 0);
     }
 
-    public function resetMockServerLogs(): void
+    public function clearMockServerLogs(): void
     {
         $request = new Request('PUT', '/mockserver/clear?type=log');
         $response = $this->mockserverClient->sendRequest($request);

tests/Integration/SeeMockRequestWasCalledTest.php

@@ -2,6 +2,7 @@
 
 namespace Integration;
 
+use Codeception\Lib\ModuleContainer;
 use DEVizzent\CodeceptionMockServerHelper\MockServerHelper;
 use GuzzleHttp\Client;
 use PHPUnit\Framework\ExpectationFailedException;
@@ -15,9 +16,11 @@ class SeeMockRequestWasCalledTest extends TestCase
     protected function setUp(): void
     {
         parent::setUp();
-        $this->sot = new MockServerHelper();
+        $moduleContainer = $this->createMock(ModuleContainer::class);
+        $this->sot = new MockServerHelper($moduleContainer);
+        $this->sot->_initialize();
         $this->client = new Client(['proxy' => 'http://mockserver:1080', 'verify' => false]);
-        $this->sot->resetMockServerLogs();
+        $this->sot->clearMockServerLogs();
     }
 
     public function testExpectationWasCalled(): void

tests/Integration/SeeMockRequestWasNotCalledTest.php

@@ -2,6 +2,7 @@
 
 namespace Integration;
 
+use Codeception\Lib\ModuleContainer;
 use DEVizzent\CodeceptionMockServerHelper\MockServerHelper;
 use GuzzleHttp\Client;
 use PHPUnit\Framework\ExpectationFailedException;
@@ -15,15 +16,28 @@ class SeeMockRequestWasNotCalledTest extends TestCase
     protected function setUp(): void
     {
         parent::setUp();
-        $this->sot = new MockServerHelper();
+        $moduleContainer = $this->createMock(ModuleContainer::class);
+        $this->sot = new MockServerHelper($moduleContainer);
+        $this->sot->_initialize();
         $this->client = new Client(['proxy' => 'http://mockserver:1080', 'verify' => false]);
+        $this->sot->clearMockServerLogs();
     }
 
     public function testExpectationWasNotCalled(): void
     {
         $this->sot->seeMockRequestWasNotCalled('get-post-2');
     }
 
+    public function testExpectationWasNotCalledButItWasThrowException(): void
+    {$this->expectException(ExpectationFailedException::class);
+        $this->expectExceptionMessageMatches(
+            '#^Request not found exactly 0 times, expected:((.|\n)*) but was:((.|\n)*)'
+            . 'Failed asserting that 406 matches expected 202\.$#'
+        );
+        $this->client->request('GET', 'https://jsonplaceholder.typicode.com/posts/2');
+        $this->sot->seeMockRequestWasNotCalled('get-post-2');
+    }
+
     public function testExpectationWasCalledThrowException(): void
     {
         $this->expectException(ExpectationFailedException::class);