Merge pull request #55 from pact-foundation/bugfix/givenproviderorder

Fixed issue reported in https://github.com/pact-foundation/pact-php/i…

README.md

@@ -26,7 +26,7 @@ Table of contents
     * [Make the Request](#make-the-request)
     * [Make Assertions](#make-assertions)
 * [Basic Provider Usage](#basic-provider-usage)
-    * [Create Unit Tests](#create-unit-tests)
+    * [Create Unit Tests](#create-unit-test)
     * [Start API](#start-api)
     * [Provider Verification](#provider-verification)
         * [Verify From Pact Broker](#verify-from-pact-broker)
@@ -160,8 +160,8 @@ Now that we have the request and response, we need to build the interaction and
 $config  = new MockServerEnvConfig();
 $builder = new InteractionBuilder($config);
 $builder
-    ->given('Get Hello')
-    ->uponReceiving('A get request to /hello/{name}')
+    ->given('a person exists')
+    ->uponReceiving('a get request to /hello/{name}')
     ->with($request)
     ->willRespondWith($response); // This has to be last. This is what makes an API request to the Mock Server to set the interaction.
 ```

composer.json

@@ -53,9 +53,7 @@
     },
     "scripts": {
         "start-provider": "php -S localhost:58000 -t example/src/Provider/public/",
-        "test": [
-            "php-cs-fixer fix --config .php_cs",
-            "phpunit --debug"
-        ]
+        "fix": "php-cs-fixer fix --config .php_cs",
+        "test": "phpunit --debug"
     }
 }

example/tests/Consumer/Service/ConsumerServiceGoodbyeTest.php

@@ -2,6 +2,7 @@
 
 namespace Consumer\Service;
 
+use PhpPact\Consumer\Exception\MissingEnvVariableException;
 use PhpPact\Consumer\InteractionBuilder;
 use PhpPact\Consumer\Model\ConsumerRequest;
 use PhpPact\Consumer\Model\ProviderResponse;
@@ -10,6 +11,9 @@
 
 class ConsumerServiceGoodbyeTest extends TestCase
 {
+    /**
+     * @throws MissingEnvVariableException
+     */
     public function testGetGoodbyeString()
     {
         $request = new ConsumerRequest();

example/tests/Consumer/Service/ConsumerServiceHelloTest.php

@@ -13,6 +13,8 @@ class ConsumerServiceHelloTest extends TestCase
 {
     /**
      * Example PACT test.
+     *
+     * @throws \Exception
      */
     public function testGetHelloString()
     {

example/tests/Provider/PactVerifyTest.php

@@ -3,6 +3,8 @@
 namespace Provider;
 
 use GuzzleHttp\Psr7\Uri;
+use PhpPact\Standalone\Installer\Exception\FileDownloadFailureException;
+use PhpPact\Standalone\Installer\Exception\NoDownloaderFoundException;
 use PhpPact\Standalone\ProviderVerifier\Model\VerifierConfig;
 use PhpPact\Standalone\ProviderVerifier\Verifier;
 use PHPUnit\Framework\TestCase;
@@ -37,6 +39,9 @@ protected function tearDown()
 
     /**
      * This test will run after the web server is started.
+     *
+     * @throws FileDownloadFailureException
+     * @throws NoDownloaderFoundException
      */
     public function testPactVerifyConsumer()
     {

src/PhpPact/Consumer/InteractionBuilder.php

@@ -41,7 +41,7 @@ public function __construct(MockServerConfigInterface $config)
      */
     public function given(string $description): InteractionBuilderInterface
     {
-        $this->interaction->setDescription($description);
+        $this->interaction->setProviderState($description);
 
         return $this;
     }
@@ -51,7 +51,7 @@ public function given(string $description): InteractionBuilderInterface
      */
     public function uponReceiving(string $providerState): InteractionBuilderInterface
     {
-        $this->interaction->setProviderState($providerState);
+        $this->interaction->setDescription($providerState);
 
         return $this;
     }

src/PhpPact/Consumer/Listener/PactTestListener.php

@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Psr7\Uri;
 use PhpPact\Broker\Service\BrokerHttpClient;
+use PhpPact\Consumer\Exception\MissingEnvVariableException;
 use PhpPact\Http\GuzzleClient;
 use PhpPact\Standalone\MockService\MockServer;
 use PhpPact\Standalone\MockService\MockServerConfigInterface;
@@ -42,6 +43,8 @@ class PactTestListener implements TestListener
      * PactTestListener constructor.
      *
      * @param string[] $testSuiteNames test suite names that need evaluated with the listener
+     *
+     * @throws MissingEnvVariableException
      */
     public function __construct(array $testSuiteNames)
     {
@@ -51,6 +54,8 @@ public function __construct(array $testSuiteNames)
 
     /**
      * @param TestSuite $suite
+     *
+     * @throws \Exception
      */
     public function startTestSuite(TestSuite $suite)
     {

src/PhpPact/Consumer/Matcher/Matcher.php

@@ -87,8 +87,10 @@ public function term($value, string $pattern): array
     /**
      * Alias for the term matcher.
      *
-     * @param mixed  $value   example value
-     * @param string $pattern valid Ruby regex pattern
+     * @param $value
+     * @param string $pattern
+     *
+     * @throws \Exception
      *
      * @return array
      */
@@ -102,6 +104,8 @@ public function regex($value, string $pattern)
      *
      * @param string $value valid ISO8601 date, example: 2010-01-01
      *
+     * @throws \Exception
+     *
      * @return array
      */
     public function dateISO8601(string $value): array

src/PhpPact/Standalone/Installer/InstallManager.php

@@ -64,7 +64,8 @@ public function setInstallers(array $installers): self
     }
 
     /**
-     * Install.
+     * @throws Exception\FileDownloadFailureException
+     * @throws NoDownloaderFoundException
      *
      * @return Scripts
      */

src/PhpPact/Standalone/Installer/Service/InstallerInterface.php

@@ -2,6 +2,7 @@
 
 namespace PhpPact\Standalone\Installer\Service;
 
+use PhpPact\Standalone\Installer\Exception\FileDownloadFailureException;
 use PhpPact\Standalone\Installer\Model\Scripts;
 
 /**
@@ -21,6 +22,8 @@ public function isEligible(): bool;
      *
      * @param string $destinationDir folder path to put the binaries
      *
+     * @throws FileDownloadFailureException
+     *
      * @return Scripts
      */
     public function install(string $destinationDir): Scripts;

src/PhpPact/Standalone/Installer/Service/InstallerLinux.php

@@ -8,6 +8,8 @@
 
 class InstallerLinux implements InstallerInterface
 {
+    const VERSION = '1.38.0';
+
     /**
      * @inheritDoc
      */
@@ -24,8 +26,7 @@ public function install(string $destinationDir): Scripts
         $fs = new Filesystem();
 
         if ($fs->exists($destinationDir . DIRECTORY_SEPARATOR . 'pact') === false) {
-            $version      = '1.29.2';
-            $fileName     = "pact-{$version}-linux-x86_64.tar.gz";
+            $fileName     = 'pact-' . self::VERSION . '-linux-x86_64.tar.gz';
             $tempFilePath = \sys_get_temp_dir() . DIRECTORY_SEPARATOR . $fileName;
 
             $this
@@ -54,7 +55,7 @@ public function install(string $destinationDir): Scripts
      */
     private function download(string $fileName, string $tempFilePath): self
     {
-        $uri  = "https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v1.29.2/{$fileName}";
+        $uri  = 'https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v' . self::VERSION . "/{$fileName}";
 
         $data = \file_get_contents($uri);
 

src/PhpPact/Standalone/Installer/Service/InstallerMac.php

@@ -8,6 +8,8 @@
 
 class InstallerMac implements InstallerInterface
 {
+    const VERSION = '1.38.0';
+
     /**
      * @inheritDoc
      */
@@ -24,8 +26,7 @@ public function install(string $destinationDir): Scripts
         $fs = new Filesystem();
 
         if ($fs->exists($destinationDir . DIRECTORY_SEPARATOR . 'pact') === false) {
-            $version      = '1.29.2';
-            $fileName     = "pact-{$version}-osx.tar.gz";
+            $fileName     = 'pact-' . self::VERSION . '-osx.tar.gz';
             $tempFilePath = \sys_get_temp_dir() . DIRECTORY_SEPARATOR . $fileName;
 
             $this
@@ -54,7 +55,7 @@ public function install(string $destinationDir): Scripts
      */
     private function download(string $fileName, string $tempFilePath): self
     {
-        $uri  = "https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v1.29.2/{$fileName}";
+        $uri  = 'https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v' . self::VERSION . "/{$fileName}";
 
         $data = \file_get_contents($uri);
 

src/PhpPact/Standalone/Installer/Service/InstallerWindows.php

@@ -13,6 +13,8 @@
  */
 class InstallerWindows implements InstallerInterface
 {
+    const VERSION = '1.38.0';
+
     /**
      * @inheritDoc
      */
@@ -29,8 +31,7 @@ public function install(string $destinationDir): Scripts
         $fs = new Filesystem();
 
         if ($fs->exists($destinationDir . DIRECTORY_SEPARATOR . 'pact') === false) {
-            $version      = '1.29.2';
-            $fileName     = "pact-{$version}-win32.zip";
+            $fileName     = 'pact-' . self::VERSION . '-win32.zip';
             $tempFilePath = __DIR__ . DIRECTORY_SEPARATOR . $fileName;
 
             $this
@@ -60,7 +61,7 @@ public function install(string $destinationDir): Scripts
      */
     private function download(string $fileName, string $tempFilePath): self
     {
-        $uri  = "https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v1.29.2/{$fileName}";
+        $uri  = 'https://github.com/pact-foundation/pact-ruby-standalone/releases/download/v' . self::VERSION . "/{$fileName}";
 
         $data = \file_get_contents($uri);
 

src/PhpPact/Standalone/MockService/MockServer.php

@@ -47,6 +47,7 @@ public function __construct(MockServerConfigInterface $config)
      * Start the Mock Server. Verify that it is running.
      *
      * @throws ProcessFailedException
+     * @throws Exception
      *
      * @return int process ID of the started Mock Server
      */

src/PhpPact/Standalone/MockService/MockServerEnvConfig.php

@@ -10,6 +10,11 @@
  */
 class MockServerEnvConfig extends MockServerConfig
 {
+    /**
+     * MockServerEnvConfig constructor.
+     *
+     * @throws MissingEnvVariableException
+     */
     public function __construct()
     {
         $this

src/PhpPact/Standalone/MockService/Service/MockServerHttpServiceInterface.php

@@ -3,6 +3,7 @@
 namespace PhpPact\Standalone\MockService\Service;
 
 use PhpPact\Consumer\Model\Interaction;
+use PhpPact\Exception\ConnectionException;
 
 /**
  * Interface MockServerHttpServiceInterface
@@ -12,6 +13,8 @@ interface MockServerHttpServiceInterface
     /**
      * Verify that the Ruby PhpPact Mock Server is running.
      *
+     * @throws ConnectionException
+     *
      * @return bool
      */
     public function healthCheck(): bool;

src/PhpPact/Standalone/ProviderVerifier/Verifier.php

@@ -5,6 +5,8 @@
 use PhpPact\Broker\Service\BrokerHttpClient;
 use PhpPact\Broker\Service\BrokerHttpClientInterface;
 use PhpPact\Http\GuzzleClient;
+use PhpPact\Standalone\Installer\Exception\FileDownloadFailureException;
+use PhpPact\Standalone\Installer\Exception\NoDownloaderFoundException;
 use PhpPact\Standalone\Installer\InstallManager;
 use PhpPact\Standalone\Installer\Service\InstallerInterface;
 use PhpPact\Standalone\ProviderVerifier\Model\VerifierConfigInterface;
@@ -90,7 +92,10 @@ public function getArguments(): array
      * @param string      $consumerName name of the consumer to be compared against
      * @param null|string $tag          optional tag of the consumer such as a branch name
      *
-     * @return self
+     * @throws \PhpPact\Standalone\Installer\Exception\FileDownloadFailureException
+     * @throws \PhpPact\Standalone\Installer\Exception\NoDownloaderFoundException
+     *
+     * @return Verifier
      */
     public function verify(string $consumerName, string $tag = null): self
     {
@@ -115,7 +120,10 @@ public function verify(string $consumerName, string $tag = null): self
      *
      * @param array $files paths to pact json files
      *
-     * @return self
+     * @throws FileDownloadFailureException
+     * @throws NoDownloaderFoundException
+     *
+     * @return Verifier
      */
     public function verifyFiles(array $files): self
     {
@@ -128,6 +136,9 @@ public function verifyFiles(array $files): self
 
     /**
      * Verify all Pacts from the Pact Broker are valid for the Provider.
+     *
+     * @throws FileDownloadFailureException
+     * @throws NoDownloaderFoundException
      */
     public function verifyAll()
     {
@@ -142,6 +153,9 @@ public function verifyAll()
      * Verify all PACTs for a given tag.
      *
      * @param string $tag
+     *
+     * @throws FileDownloadFailureException
+     * @throws NoDownloaderFoundException
      */
     public function verifyAllForTag(string $tag)
     {
@@ -170,6 +184,9 @@ public function registerInstaller(InstallerInterface $installer): self
      * Execute the Pact Verifier Service.
      *
      * @param array $arguments
+     *
+     * @throws \PhpPact\Standalone\Installer\Exception\FileDownloadFailureException
+     * @throws \PhpPact\Standalone\Installer\Exception\NoDownloaderFoundException
      */
     private function verifyAction(array $arguments)
     {

tests/PhpPact/Consumer/InteractionBuilderTest.php

@@ -20,6 +20,10 @@ class InteractionBuilderTest extends TestCase
     /** @var MockServer */
     private $mockServer;
 
+    /**
+     * @throws Exception\MissingEnvVariableException
+     * @throws \Exception
+     */
     protected function setUp()
     {
         $config            = new MockServerEnvConfig();
@@ -33,6 +37,10 @@ protected function tearDown()
         $this->mockServer->stop();
     }
 
+    /**
+     * @throws Exception\MissingEnvVariableException
+     * @throws \Exception
+     */
     public function testSimpleGet()
     {
         $matcher = new Matcher();
@@ -62,6 +70,9 @@ public function testSimpleGet()
         $this->assertTrue($result);
     }
 
+    /**
+     * @throws Exception\MissingEnvVariableException
+     */
     public function testPostWithBody()
     {
         $request = new ConsumerRequest();
@@ -97,6 +108,9 @@ public function testPostWithBody()
         $this->assertTrue($result);
     }
 
+    /**
+     * @throws Exception\MissingEnvVariableException
+     */
     public function testBuildWithEachLikeMatcher()
     {
         $matcher = new Matcher();