Merge pull request #494 from tienvx/refactor-pact-driver

refactor: Merge PactDriver and PactRegistry
pact-foundation · Feb 29, 2024 · 0795996 · 0795996
2 parents bcee663 + e876d5e
commit 0795996
Show file tree

Hide file tree

Showing 32 changed files with 385 additions and 165 deletions.
diff --git a/compatibility-suite/tests/Service/PactWriter.php b/compatibility-suite/tests/Service/PactWriter.php
@@ -5,7 +5,6 @@
 use PhpPact\Config\PactConfigInterface;
 use PhpPact\Consumer\Driver\Pact\PactDriver;
 use PhpPact\Consumer\Registry\Interaction\InteractionRegistry;
-use PhpPact\Consumer\Registry\Pact\PactRegistry;
 use PhpPact\FFI\Client;
 use PhpPact\Standalone\MockService\MockServerConfig;
 use PhpPactTest\CompatibilitySuite\Constant\Path;
@@ -29,12 +28,10 @@ public function write(int $id, PactPath $pactPath, string $mode = PactConfigInte
             ->setPactSpecificationVersion($this->specificationVersion)
             ->setPactFileWriteMode($mode);
         $client = new Client();
-        $pactRegistry = new PactRegistry($client);
-        $pactDriver = new PactDriver($client, $config, $pactRegistry);
-        $interactionRegistry = new InteractionRegistry($client, $pactRegistry);
+        $pactDriver = new PactDriver($client, $config);
+        $interactionRegistry = new InteractionRegistry($client, $pactDriver);
 
         $interaction = $this->storage->get(InteractionsStorageInterface::PACT_WRITER_DOMAIN, $id);
-        $pactDriver->setUp();
         $interactionRegistry->registerInteraction($interaction);
         $pactDriver->writePact();
         $pactDriver->cleanUp();

diff --git a/compatibility-suite/tests/Service/Server.php b/compatibility-suite/tests/Service/Server.php
@@ -7,7 +7,6 @@
 use PhpPact\Consumer\Driver\Pact\PactDriverInterface;
 use PhpPact\Consumer\Registry\Interaction\InteractionRegistry;
 use PhpPact\Consumer\Registry\Interaction\InteractionRegistryInterface;
-use PhpPact\Consumer\Registry\Pact\PactRegistry;
 use PhpPact\Consumer\Service\MockServer;
 use PhpPact\Consumer\Service\MockServerInterface;
 use PhpPact\FFI\Client;
@@ -45,16 +44,14 @@ public function __construct(
         $this->logger = new Logger();
 
         $client = new Client();
-        $pactRegistry = new PactRegistry($client);
-        $this->pactDriver = new PactDriver($client, $this->config, $pactRegistry);
-        $this->mockServer = new MockServer($client, $pactRegistry, $this->config, $this->logger);
-        $this->interactionRegistry = new InteractionRegistry($client, $pactRegistry);
+        $this->pactDriver = new PactDriver($client, $this->config);
+        $this->mockServer = new MockServer($client, $this->pactDriver, $this->config, $this->logger);
+        $this->interactionRegistry = new InteractionRegistry($client, $this->pactDriver);
     }
 
     public function register(int ...$ids): void
     {
         $interactions = array_map(fn (int $id) => $this->storage->get(InteractionsStorageInterface::SERVER_DOMAIN, $id), $ids);
-        $this->pactDriver->setUp();
         foreach ($interactions as $interaction) {
             $this->interactionRegistry->registerInteraction($interaction);
         }

diff --git a/compatibility-suite/tests/Service/SyncMessagePactWriter.php b/compatibility-suite/tests/Service/SyncMessagePactWriter.php
@@ -5,7 +5,6 @@
 use PhpPact\Config\PactConfigInterface;
 use PhpPact\Consumer\Driver\Pact\PactDriver;
 use PhpPact\Consumer\Model\Message;
-use PhpPact\Consumer\Registry\Pact\PactRegistry;
 use PhpPact\FFI\Client;
 use PhpPact\Standalone\MockService\MockServerConfig;
 use PhpPact\SyncMessage\Registry\Interaction\SyncMessageRegistry;
@@ -29,11 +28,9 @@ public function write(Message $message, PactPath $pactPath, string $mode = PactC
             ->setPactSpecificationVersion($this->specificationVersion)
             ->setPactFileWriteMode($mode);
         $client = new Client();
-        $pactRegistry = new PactRegistry($client);
-        $pactDriver = new PactDriver($client, $config, $pactRegistry);
-        $messageRegistry = new SyncMessageRegistry($client, $pactRegistry);
+        $pactDriver = new PactDriver($client, $config);
+        $messageRegistry = new SyncMessageRegistry($client, $pactDriver);
 
-        $pactDriver->setUp();
         $messageRegistry->registerMessage($message);
         $pactDriver->writePact();
         $pactDriver->cleanUp();

diff --git a/src/PhpPact/Consumer/Driver/Exception/DriverException.php b/src/PhpPact/Consumer/Driver/Exception/DriverException.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace PhpPact\Consumer\Driver\Exception;
+
+use PhpPact\Consumer\Exception\ConsumerException;
+
+class DriverException extends ConsumerException
+{
+}
diff --git a/src/PhpPact/Consumer/Driver/Exception/MissingPactException.php b/src/PhpPact/Consumer/Driver/Exception/MissingPactException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace PhpPact\Consumer\Driver\Exception;
+
+class MissingPactException extends DriverException
+{
+}
diff --git a/src/PhpPact/Consumer/Driver/Interaction/InteractionDriver.php b/src/PhpPact/Consumer/Driver/Interaction/InteractionDriver.php
@@ -2,15 +2,13 @@
 
 namespace PhpPact\Consumer\Driver\Interaction;
 
-use PhpPact\Consumer\Driver\Pact\PactDriverInterface;
 use PhpPact\Consumer\Model\Interaction;
 use PhpPact\Consumer\Registry\Interaction\InteractionRegistryInterface;
 use PhpPact\Consumer\Service\MockServerInterface;
 
 class InteractionDriver implements InteractionDriverInterface
 {
     public function __construct(
-        private PactDriverInterface $pactDriver,
         private InteractionRegistryInterface $interactionRegistry,
         private MockServerInterface $mockServer,
     ) {
@@ -23,7 +21,6 @@ public function verifyInteractions(): bool
 
     public function registerInteraction(Interaction $interaction): bool
     {
-        $this->pactDriver->setUp();
         $this->interactionRegistry->registerInteraction($interaction);
         $this->mockServer->start();
 

diff --git a/src/PhpPact/Consumer/Driver/Interaction/MessageDriver.php b/src/PhpPact/Consumer/Driver/Interaction/MessageDriver.php
@@ -31,7 +31,6 @@ public function writePactAndCleanUp(): bool
 
     public function registerMessage(Message $message): void
     {
-        $this->pactDriver->setUp();
         $this->messageRegistry->registerMessage($message);
     }
 }
diff --git a/src/PhpPact/Consumer/Driver/Pact/PactDriver.php b/src/PhpPact/Consumer/Driver/Pact/PactDriver.php
@@ -4,29 +4,35 @@
 
 use Composer\Semver\Comparator;
 use PhpPact\Config\PactConfigInterface;
+use PhpPact\Consumer\Driver\Exception\MissingPactException;
 use PhpPact\Consumer\Exception\PactFileNotWroteException;
-use PhpPact\Consumer\Registry\Pact\PactRegistryInterface;
+use PhpPact\Consumer\Model\Pact\Pact;
 use PhpPact\FFI\ClientInterface;
 
 class PactDriver implements PactDriverInterface
 {
+    protected ?Pact $pact = null;
+
     public function __construct(
         protected ClientInterface $client,
-        protected PactConfigInterface $config,
-        protected PactRegistryInterface $pactRegistry
+        protected PactConfigInterface $config
     ) {
+        $this->setUp();
     }
 
     public function cleanUp(): void
     {
-        $this->pactRegistry->deletePact();
+        $this->validatePact();
+        $this->client->call('pactffi_free_pact_handle', $this->pact->handle);
+        $this->pact = null;
     }
 
     public function writePact(): void
     {
+        $this->validatePact();
         $error = $this->client->call(
             'pactffi_pact_handle_write_file',
-            $this->pactRegistry->getId(),
+            $this->pact->handle,
             $this->config->getPactDir(),
             $this->config->getPactFileWriteMode() === PactConfigInterface::MODE_OVERWRITE
         );
@@ -35,11 +41,18 @@ public function writePact(): void
         }
     }
 
-    public function setUp(): void
+    public function getPact(): Pact
     {
-        $this
-            ->initWithLogLevel()
-            ->registerPact();
+        $this->validatePact();
+
+        return $this->pact;
+    }
+
+    protected function setUp(): void
+    {
+        $this->initWithLogLevel();
+        $this->newPact();
+        $this->withSpecification();
     }
 
     protected function getSpecification(): int
@@ -58,29 +71,33 @@ protected function getSpecification(): int
         };
     }
 
+    protected function validatePact(): void
+    {
+        if (!$this->pact) {
+            throw new MissingPactException();
+        }
+    }
+
     private function versionEqualTo(string $version): bool
     {
         return Comparator::equalTo($this->config->getPactSpecificationVersion(), $version);
     }
 
-    private function initWithLogLevel(): self
+    private function initWithLogLevel(): void
     {
         $logLevel = $this->config->getLogLevel();
         if ($logLevel) {
             $this->client->call('pactffi_init_with_log_level', $logLevel);
         }
-
-        return $this;
     }
 
-    private function registerPact(): self
+    private function newPact(): void
     {
-        $this->pactRegistry->registerPact(
-            $this->config->getConsumer(),
-            $this->config->getProvider(),
-            $this->getSpecification()
-        );
+        $this->pact = new Pact($this->client->call('pactffi_new_pact', $this->config->getConsumer(), $this->config->getProvider()));
+    }
 
-        return $this;
+    private function withSpecification(): void
+    {
+        $this->client->call('pactffi_with_specification', $this->pact->handle, $this->getSpecification());
     }
 }
diff --git a/src/PhpPact/Consumer/Driver/Pact/PactDriverInterface.php b/src/PhpPact/Consumer/Driver/Pact/PactDriverInterface.php
@@ -2,11 +2,13 @@
 
 namespace PhpPact\Consumer\Driver\Pact;
 
+use PhpPact\Consumer\Model\Pact\Pact;
+
 interface PactDriverInterface
 {
-    public function setUp(): void;
-
     public function cleanUp(): void;
 
     public function writePact(): void;
+
+    public function getPact(): Pact;
 }
diff --git a/src/PhpPact/Consumer/Factory/InteractionDriverFactory.php b/src/PhpPact/Consumer/Factory/InteractionDriverFactory.php
@@ -6,7 +6,6 @@
 use PhpPact\Consumer\Driver\Interaction\InteractionDriverInterface;
 use PhpPact\Consumer\Driver\Pact\PactDriver;
 use PhpPact\Consumer\Registry\Interaction\InteractionRegistry;
-use PhpPact\Consumer\Registry\Pact\PactRegistry;
 use PhpPact\FFI\Client;
 use PhpPact\Standalone\MockService\MockServerConfigInterface;
 use PhpPact\Consumer\Service\MockServer;
@@ -16,11 +15,10 @@ class InteractionDriverFactory implements InteractionDriverFactoryInterface
     public function create(MockServerConfigInterface $config): InteractionDriverInterface
     {
         $client = new Client();
-        $pactRegistry = new PactRegistry($client);
-        $pactDriver = new PactDriver($client, $config, $pactRegistry);
-        $mockServer = new MockServer($client, $pactRegistry, $config);
-        $interactionRegistry = new InteractionRegistry($client, $pactRegistry);
+        $pactDriver = new PactDriver($client, $config);
+        $mockServer = new MockServer($client, $pactDriver, $config);
+        $interactionRegistry = new InteractionRegistry($client, $pactDriver);
 
-        return new InteractionDriver($pactDriver, $interactionRegistry, $mockServer);
+        return new InteractionDriver($interactionRegistry, $mockServer);
     }
 }
diff --git a/src/PhpPact/Consumer/Factory/MessageDriverFactory.php b/src/PhpPact/Consumer/Factory/MessageDriverFactory.php
@@ -7,17 +7,15 @@
 use PhpPact\Consumer\Driver\Pact\PactDriver;
 use PhpPact\Config\PactConfigInterface;
 use PhpPact\Consumer\Registry\Interaction\MessageRegistry;
-use PhpPact\Consumer\Registry\Pact\PactRegistry;
 use PhpPact\FFI\Client;
 
 class MessageDriverFactory implements MessageDriverFactoryInterface
 {
     public function create(PactConfigInterface $config): MessageDriverInterface
     {
         $client = new Client();
-        $pactRegistry = new PactRegistry($client);
-        $pactDriver = new PactDriver($client, $config, $pactRegistry);
-        $messageRegistry = new MessageRegistry($client, $pactRegistry);
+        $pactDriver = new PactDriver($client, $config);
+        $messageRegistry = new MessageRegistry($client, $pactDriver);
 
         return new MessageDriver($client, $pactDriver, $messageRegistry);
     }

diff --git a/src/PhpPact/Consumer/Model/Pact/Pact.php b/src/PhpPact/Consumer/Model/Pact/Pact.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace PhpPact\Consumer\Model\Pact;
+
+class Pact
+{
+    public function __construct(public readonly int $handle)
+    {
+    }
+}
diff --git a/src/PhpPact/Consumer/Registry/Interaction/AbstractRegistry.php b/src/PhpPact/Consumer/Registry/Interaction/AbstractRegistry.php
@@ -2,7 +2,7 @@
 
 namespace PhpPact\Consumer\Registry\Interaction;
 
-use PhpPact\Consumer\Registry\Pact\PactRegistryInterface;
+use PhpPact\Consumer\Driver\Pact\PactDriverInterface;
 use PhpPact\FFI\ClientInterface;
 
 abstract class AbstractRegistry implements RegistryInterface
@@ -11,7 +11,7 @@ abstract class AbstractRegistry implements RegistryInterface
 
     public function __construct(
         protected ClientInterface $client,
-        protected PactRegistryInterface $pactRegistry
+        protected PactDriverInterface $pactDriver
     ) {
     }
 

diff --git a/src/PhpPact/Consumer/Registry/Interaction/InteractionRegistry.php b/src/PhpPact/Consumer/Registry/Interaction/InteractionRegistry.php
@@ -2,11 +2,11 @@
 
 namespace PhpPact\Consumer\Registry\Interaction;
 
+use PhpPact\Consumer\Driver\Pact\PactDriverInterface;
 use PhpPact\Consumer\Registry\Interaction\Part\RequestRegistry;
 use PhpPact\Consumer\Registry\Interaction\Part\RequestRegistryInterface;
 use PhpPact\Consumer\Registry\Interaction\Part\ResponseRegistry;
 use PhpPact\Consumer\Registry\Interaction\Part\ResponseRegistryInterface;
-use PhpPact\Consumer\Registry\Pact\PactRegistryInterface;
 use PhpPact\Consumer\Model\ConsumerRequest;
 use PhpPact\Consumer\Model\Interaction;
 use PhpPact\Consumer\Model\ProviderResponse;
@@ -20,11 +20,11 @@ class InteractionRegistry extends AbstractRegistry implements InteractionRegistr
 
     public function __construct(
         ClientInterface $client,
-        PactRegistryInterface $pactRegistry,
+        PactDriverInterface $pactDriver,
         ?RequestRegistryInterface $requestRegistry = null,
         ?ResponseRegistryInterface $responseRegistry = null,
     ) {
-        parent::__construct($client, $pactRegistry);
+        parent::__construct($client, $pactDriver);
         $this->requestRegistry = $requestRegistry ?? new RequestRegistry($client, $this);
         $this->responseRegistry = $responseRegistry ?? new ResponseRegistry($client, $this);
     }
@@ -43,7 +43,7 @@ public function registerInteraction(Interaction $interaction): bool
 
     protected function newInteraction(string $description): self
     {
-        $this->id = $this->client->call('pactffi_new_interaction', $this->pactRegistry->getId(), $description);
+        $this->id = $this->client->call('pactffi_new_interaction', $this->pactDriver->getPact()->handle, $description);
 
         return $this;
     }

diff --git a/src/PhpPact/Consumer/Registry/Interaction/MessageRegistry.php b/src/PhpPact/Consumer/Registry/Interaction/MessageRegistry.php
@@ -2,13 +2,13 @@
 
 namespace PhpPact\Consumer\Registry\Interaction;
 
+use PhpPact\Consumer\Driver\Pact\PactDriverInterface;
 use PhpPact\Consumer\Model\Body\Binary;
 use PhpPact\Consumer\Model\Body\Text;
 use PhpPact\Consumer\Model\Message;
 use PhpPact\Consumer\Model\ProviderState;
 use PhpPact\Consumer\Registry\Interaction\Body\BodyRegistryInterface;
 use PhpPact\Consumer\Registry\Interaction\Body\MessageContentsRegistry;
-use PhpPact\Consumer\Registry\Pact\PactRegistryInterface;
 use PhpPact\FFI\ClientInterface;
 
 class MessageRegistry extends AbstractRegistry implements MessageRegistryInterface
@@ -17,10 +17,10 @@ class MessageRegistry extends AbstractRegistry implements MessageRegistryInterfa
 
     public function __construct(
         ClientInterface $client,
-        PactRegistryInterface $pactRegistry,
+        PactDriverInterface $pactDriver,
         ?BodyRegistryInterface $messageContentsRegistry = null
     ) {
-        parent::__construct($client, $pactRegistry);
+        parent::__construct($client, $pactDriver);
         $this->messageContentsRegistry = $messageContentsRegistry ?? new MessageContentsRegistry($client, $this);
     }
 
@@ -37,7 +37,7 @@ public function registerMessage(Message $message): void
 
     protected function newInteraction(string $description): self
     {
-        $this->id = $this->client->call('pactffi_new_message_interaction', $this->pactRegistry->getId(), $description);
+        $this->id = $this->client->call('pactffi_new_message_interaction', $this->pactDriver->getPact()->handle, $description);
 
         return $this;
     }