Use Client in helper and add the configuration to load expectation for a path

Author: DEVizzent

src/Config/ExpectationsPath.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace DEVizzent\CodeceptionMockServerHelper\Config;
+
+use DEVizzent\CodeceptionMockServerHelper\MockServerHelper;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use SplFileInfo;
+
+class ExpectationsPath
+{
+    private string $path = '';
+
+    public function __construct(string $path = '')
+    {
+        if (!empty($path)) {
+            $this->set($path);
+        }
+    }
+
+    private function set(string $path)
+    {
+        $path = realpath($path);
+        if ($path) {
+            $this->path = $path;
+            return;
+        }
+        throw new \InvalidArgumentException(sprintf('"%s" is not a valid path for "expectationsPath"', $path));
+    }
+
+    public function getExpectationsFiles(): iterable
+    {
+        if (empty($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,20 @@ 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) {}
     }
 
     public function _beforeSuite($settings = []): void
@@ -60,6 +67,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 +115,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 +129,11 @@ public function deactivateNotMatchedRequest(): void
     {
         $this->mockserver->removeById(self::NOT_MATCHED_REQUEST_ID);
     }
+
+    public function createMockRequestFromJsonFile($expectationFile): void
+    {
+        $expectationJson = file_get_contents($expectationFile);
+        Assert::assertIsString($expectationJson);
+        $this->createMockRequest($expectationJson);
+    }
 }