Merge pull request #331 from tienvx/reorganize-examples

chore: reorganize examples (create separate directory for each example)

README.md

@@ -102,7 +102,7 @@ All of the following code will be used exclusively for the Consumer.
 
 Create a standard PHPUnit test case class and function.
 
-[Click here](/example/tests/Consumer/Service/ConsumerServiceHelloTest.php) to see the full sample file.
+[Click here](/example/json/consumer/tests/Service/ConsumerServiceHelloTest.php) to see the full sample file.
 
 ### Create Mock Request
 
@@ -381,7 +381,7 @@ to processing class.   Aside from changing default ports, this should be transpa
 Both the provider and consumer side make heavy use of lambda functions.
 
 ### Consumer Side Message Processing
-The examples provided are pretty basic.   See examples\tests\MessageConsumer.
+The examples provided are pretty basic.   See [example](/example/message/consumer/tests/ExampleMessageConsumerTest.php).
 1. Create the content and metadata (array)
 1. Annotate the MessageBuilder appropriate content and states
     1. Given = Provider State
@@ -425,7 +425,7 @@ Handle these requests on your provider:
    1. Return message's content in body
    2. Return message's metadata in header `PACT-MESSAGE-METADATA`
 
-[Click here](/example/src/Provider/public/index.php) to see the full sample file.
+[Click here](/example/message/provider/public/index.php) to see the full sample file.
 
 ## Usage for the optional `pact-stub-service`
 

composer.json

@@ -42,21 +42,14 @@
     "autoload-dev": {
         "psr-4": {
             "PhpPactTest\\": "tests/PhpPact",
-            "Consumer\\": [
-                "example/src/Consumer",
-                "example/tests/Consumer"
-            ],
-            "MessageConsumer\\": [
-                "example/src/MessageConsumer",
-                "example/tests/MessageConsumer"
-            ],
-            "MessageProvider\\": [
-                "example/src/MessageProvider",
-                "example/tests/MessageProvider"
-            ],
-            "Provider\\": [
-                "example/src/Provider"
-            ]
+            "JsonConsumer\\": "example/json/consumer/src",
+            "JsonConsumer\\Tests\\": "example/json/consumer/tests",
+            "JsonProvider\\": "example/json/provider/src",
+            "JsonProvider\\Tests\\": "example/json/provider/tests",
+            "MessageConsumer\\": "example/message/consumer/src",
+            "MessageConsumer\\Tests\\": "example/message/consumer/tests",
+            "MessageProvider\\": "example/message/provider/src",
+            "MessageProvider\\Tests\\": "example/message/provider/tests"
         }
     },
     "scripts": {
@@ -65,8 +58,8 @@
         "lint": "php-cs-fixer fix --dry-run",
         "fix": "php-cs-fixer fix",
         "test": [
-            "php -r \"array_map('unlink', glob('./example/output/*.json'));\"",
-            "phpunit --debug -c example/phpunit.all.xml"
+            "php -r \"array_map('unlink', glob('./example/*/pacts/*.json'));\"",
+            "phpunit --debug"
         ]
     },
     "extra": {

example/json/consumer/phpunit.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="../../../vendor/autoload.php" colors="true">
+    <testsuites>
+        <testsuite name="PhpPact Example Tests">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="PACT_LOGLEVEL" value="DEBUG"/>
+    </php>
+</phpunit>

example/src/Consumer/Service/HttpClientService.php → example/json/consumer/src/Service/HttpClientService.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Consumer\Service;
+namespace JsonConsumer\Service;
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Uri;

example/tests/Consumer/Service/ConsumerServiceGoodbyeTest.php → example/json/consumer/tests/Service/ConsumerServiceGoodbyeTest.php

@@ -1,19 +1,16 @@
 <?php
 
-namespace Consumer\Service;
+namespace JsonConsumer\Tests\Service;
 
+use JsonConsumer\Service\HttpClientService;
 use PhpPact\Consumer\InteractionBuilder;
 use PhpPact\Consumer\Model\ConsumerRequest;
 use PhpPact\Consumer\Model\ProviderResponse;
-use PhpPact\Standalone\Exception\MissingEnvVariableException;
-use PhpPact\Standalone\MockService\MockServerEnvConfig;
+use PhpPact\Standalone\MockService\MockServerConfig;
 use PHPUnit\Framework\TestCase;
 
 class ConsumerServiceGoodbyeTest extends TestCase
 {
-    /**
-     * @throws MissingEnvVariableException
-     */
     public function testGetGoodbyeString()
     {
         $request = new ConsumerRequest();
@@ -30,8 +27,15 @@ public function testGetGoodbyeString()
                 'message' => 'Goodbye, Bob'
             ]);
 
-        $config      = new MockServerEnvConfig();
-        $builder     = new InteractionBuilder($config);
+        $config = new MockServerConfig();
+        $config
+            ->setConsumer('jsonConsumer')
+            ->setProvider('jsonProvider')
+            ->setPactDir(__DIR__.'/../../../pacts');
+        if ($logLevel = \getenv('PACT_LOGLEVEL')) {
+            $config->setLogLevel($logLevel);
+        }
+        $builder = new InteractionBuilder($config);
         $builder
             ->given('Get Goodbye')
             ->uponReceiving('A get request to /goodbye/{name}')

example/tests/Consumer/Service/ConsumerServiceHelloTest.php → example/json/consumer/tests/Service/ConsumerServiceHelloTest.php

@@ -1,12 +1,13 @@
 <?php
 
-namespace Consumer\Service;
+namespace JsonConsumer\Tests\Service;
 
+use JsonConsumer\Service\HttpClientService;
 use PhpPact\Consumer\InteractionBuilder;
 use PhpPact\Consumer\Matcher\Matcher;
 use PhpPact\Consumer\Model\ConsumerRequest;
 use PhpPact\Consumer\Model\ProviderResponse;
-use PhpPact\Standalone\MockService\MockServerEnvConfig;
+use PhpPact\Standalone\MockService\MockServerConfig;
 use PHPUnit\Framework\TestCase;
 
 class ConsumerServiceHelloTest extends TestCase
@@ -37,7 +38,14 @@ public function testGetHelloString()
             ]);
 
         // Create a configuration that reflects the server that was started. You can create a custom MockServerConfigInterface if needed.
-        $config  = new MockServerEnvConfig();
+        $config = new MockServerConfig();
+        $config
+            ->setConsumer('jsonConsumer')
+            ->setProvider('jsonProvider')
+            ->setPactDir(__DIR__.'/../../../pacts');
+        if ($logLevel = \getenv('PACT_LOGLEVEL')) {
+            $config->setLogLevel($logLevel);
+        }
         $builder = new InteractionBuilder($config);
         $builder
             ->uponReceiving('A get request to /hello/{name}')

example/pacts/someconsumer-someprovider.json → example/json/pacts/jsonConsumer-jsonProvider.json

@@ -1,6 +1,6 @@
 {
   "consumer": {
-    "name": "someConsumer"
+    "name": "jsonConsumer"
   },
   "interactions": [
     {
@@ -63,15 +63,15 @@
   ],
   "metadata": {
     "pactRust": {
-      "ffi": "0.4.4",
-      "mockserver": "1.0.3",
-      "models": "1.0.13"
+      "ffi": "0.4.7",
+      "mockserver": "1.2.3",
+      "models": "1.1.9"
     },
     "pactSpecification": {
       "version": "3.0.0"
     }
   },
   "provider": {
-    "name": "someProvider"
+    "name": "jsonProvider"
   }
 }

example/json/provider/phpunit.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="../../../vendor/autoload.php" colors="true">
+    <testsuites>
+        <testsuite name="PhpPact Example Tests">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="PACT_LOGLEVEL" value="DEBUG"/>
+    </php>
+</phpunit>

example/src/Provider/public/index.php → example/json/provider/public/index.php

@@ -1,6 +1,6 @@
 <?php
 
-use Provider\ExampleProvider;
+use JsonProvider\ExampleProvider;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
 use Slim\Factory\AppFactory;
@@ -26,20 +26,6 @@
     return $response->withHeader('Content-Type', 'application/json');
 });
 
-$app->post('/pact-messages', function (Request $request, Response $response) use ($provider) {
-    $body = $request->getParsedBody();
-    $message = $provider->dispatchMessage($body['description'], $body['providerStates']);
-    if ($message) {
-        $response->getBody()->write(\json_encode($message->getContents()));
-
-        return $response
-            ->withHeader('Content-Type', 'application/json')
-            ->withHeader('Pact-Message-Metadata', \base64_encode(\json_encode($message->getMetadata())));
-    }
-
-    return $response;
-});
-
 $app->post('/pact-change-state', function (Request $request, Response $response) use ($provider) {
     $body = $request->getParsedBody();
     $provider->changeSate($body['action'], $body['state'], $body['params']);

example/json/provider/src/ExampleProvider.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace JsonProvider;
+
+class ExampleProvider
+{
+    private array $currentState = [];
+
+    public function sayHello(string $name): string
+    {
+        return "Hello, {$name}";
+    }
+
+    public function sayGoodbye(string $name): string
+    {
+        return "Goodbye, {$name}";
+    }
+
+    public function changeSate(string $action, string $state, array $params): void
+    {
+        $this->currentState = [
+            'action' => $action,
+            'state' => $state,
+            'params' => $params,
+        ];
+    }
+}

example/json/provider/tests/PactVerifyTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace JsonProvider\Tests;
+
+use GuzzleHttp\Psr7\Uri;
+use PhpPact\Standalone\ProviderVerifier\Model\VerifierConfig;
+use PhpPact\Standalone\ProviderVerifier\Verifier;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Process\Process;
+
+class PactVerifyTest extends TestCase
+{
+    private Process $process;
+
+    /**
+     * Run the PHP build-in web server.
+     */
+    protected function setUp(): void
+    {
+        $publicPath    =  __DIR__ . '/../public/';
+
+        $this->process = new Process(['php', '-S', '127.0.0.1:7202', '-t', $publicPath]);
+
+        $this->process->start();
+        $this->process->waitUntil(function (): bool {
+            $fp = @fsockopen('127.0.0.1', 7202);
+            $isOpen = is_resource($fp);
+            if ($isOpen) {
+                fclose($fp);
+            }
+
+            return $isOpen;
+        });
+    }
+
+    /**
+     * Stop the web server process once complete.
+     */
+    protected function tearDown(): void
+    {
+        $this->process->stop();
+    }
+
+    /**
+     * This test will run after the web server is started.
+     */
+    public function testPactVerifyConsumer()
+    {
+        $config = new VerifierConfig();
+        $config->getProviderInfo()
+            ->setName('jsonProvider') // Providers name to fetch.
+            ->setHost('localhost')
+            ->setPort(7202);
+        $config->getProviderState()
+            ->setStateChangeUrl(new Uri('http://localhost:7202/pact-change-state'))
+        ;
+        if ($level = \getenv('PACT_LOGLEVEL')) {
+            $config->setLogLevel($level);
+        }
+
+        $verifier = new Verifier($config);
+        $verifier->addFile(__DIR__ . '/../../pacts/jsonConsumer-jsonProvider.json');
+
+        $verifyResult = $verifier->verify();
+
+        $this->assertTrue($verifyResult);
+    }
+}

example/message/consumer/phpunit.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="../../../vendor/autoload.php" colors="true">
+    <testsuites>
+        <testsuite name="PhpPact Example Tests">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="PACT_LOGLEVEL" value="DEBUG"/>
+    </php>
+</phpunit>

example/src/MessageConsumer/receive.php → example/message/consumer/src/receive.php

@@ -1,6 +1,6 @@
 <?php
 
-require_once __DIR__ . '/../../../vendor/autoload.php';
+require_once __DIR__ . '/../../../../vendor/autoload.php';
 require_once __DIR__ . '/ExampleMessageConsumer.php';
 
 use PhpAmqpLib\Connection\AMQPStreamConnection;