Merge branch 'iamdavidfrancis-master'

pact-foundation · Jul 21, 2017 · e192bbe · e192bbe
2 parents fa7d5da + 9337f38
commit e192bbe
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 7 deletions.
diff --git a/PactNet.Tests/Core/PactVerifierHostConfigTests.cs b/PactNet.Tests/Core/PactVerifierHostConfigTests.cs
@@ -97,6 +97,24 @@ public void Ctor_WhenCalled_SetsOutputters()
             Assert.Equal(verifierConfig.Outputters, config.Outputters);
         }
 
+        [Fact]
+        public void Ctor_WhenCalledWithPublishVerificationResults_SetsTheCorrectArgs()
+        {
+            var baseUri = new Uri("http://127.0.0.1");
+            var pactUri = "./tester-pact/pact-file.json";
+            var providerStateSetupUri = new Uri("http://127.0.0.1/states/");
+
+            var verifierConfig = new PactVerifierConfig();
+            verifierConfig.PublishVerificationResults = true;
+            verifierConfig.ProviderVersion = "1.0.0";
+
+            var config = GetSubject(baseUri: baseUri, pactUri: pactUri, providerStateSetupUri: providerStateSetupUri, verifierConfig: verifierConfig);
+
+            var expectedArguments = BuildExpectedArguments(baseUri, pactUri, providerStateSetupUri, publishVerificationResults: true, providerVersion: "1.0.0");
+
+            Assert.Equal(expectedArguments, config.Arguments);
+        }
+
         [Fact]
         public void Ctor_WhenVerifierConfigIsNull_SetsOutputtersToNull()
         {
@@ -109,12 +127,15 @@ private string BuildExpectedArguments(
             Uri baseUri, 
             string pactUri, 
             Uri providerStateSetupUri,
-            PactUriOptions pactUriOptions = null)
+            PactUriOptions pactUriOptions = null,
+            bool publishVerificationResults = false,
+            string providerVersion = "")
         {
             var providerStateOption = providerStateSetupUri != null ? $" --provider-states-setup-url {providerStateSetupUri.OriginalString}" : "";
             var brokerCredentials = pactUriOptions != null ? $" --broker-username \"{pactUriOptions.Username}\" --broker-password \"{pactUriOptions.Password}\"" : "";
+            var publishResults = publishVerificationResults ? $" --publish-verification-results=true --provider-app-version=\"{providerVersion}\"" : string.Empty;
 
-            return $"--pact-urls \"{pactUri}\" --provider-base-url {baseUri.OriginalString}{providerStateOption}{brokerCredentials}";
+            return $"--pact-urls \"{pactUri}\" --provider-base-url {baseUri.OriginalString}{providerStateOption}{brokerCredentials}{publishResults}";
         }
     }
 }
diff --git a/PactNet.Tests/PactVerifierTests.cs b/PactNet.Tests/PactVerifierTests.cs
@@ -15,6 +15,16 @@ private IPactVerifier GetSubject()
             return new PactVerifier(hostConfig => _mockVerifierCoreHost, new PactVerifierConfig());
         }
 
+        [Fact]
+        public void PactVerifier_WhenCalledWithPublishVerificationResultsAndNoProviderVersion_ThrowsArgumentException()
+        {
+            var config = new PactVerifierConfig();
+            config.PublishVerificationResults = true;
+            config.ProviderVersion = string.Empty;
+
+            Assert.Throws<ArgumentException>(() => new PactVerifier(config));
+        }
+
         [Fact]
         public void ProviderState_WhenCalledWithSetupUri_SetsProviderStateSetupUri()
         {

diff --git a/PactNet/Core/PactVerifierHostConfig.cs b/PactNet/Core/PactVerifierHostConfig.cs
@@ -13,11 +13,12 @@ internal class PactVerifierHostConfig : IPactCoreHostConfig
 
         public PactVerifierHostConfig(Uri baseUri, string pactUri, PactUriOptions pactBrokerUriOptions, Uri providerStateSetupUri, PactVerifierConfig config)
         {
-            var providerStateOption = providerStateSetupUri != null ? $" --provider-states-setup-url {providerStateSetupUri.OriginalString}" : "";
-            var brokerCredentials = pactBrokerUriOptions != null ? $" --broker-username \"{pactBrokerUriOptions.Username}\" --broker-password \"{pactBrokerUriOptions.Password}\"" : "";
+            var providerStateOption = providerStateSetupUri != null ? $" --provider-states-setup-url {providerStateSetupUri.OriginalString}" : string.Empty;
+            var brokerCredentials = pactBrokerUriOptions != null ? $" --broker-username \"{pactBrokerUriOptions.Username}\" --broker-password \"{pactBrokerUriOptions.Password}\"" : string.Empty;
+            var publishResults = config?.PublishVerificationResults == true ? $" --publish-verification-results=true --provider-app-version=\"{config.ProviderVersion}\"" : string.Empty;
 
             Script = "pact-provider-verifier.rb";
-            Arguments = $"--pact-urls \"{FixPathForRuby(pactUri)}\" --provider-base-url {baseUri.OriginalString}{providerStateOption}{brokerCredentials}";
+            Arguments = $"--pact-urls \"{FixPathForRuby(pactUri)}\" --provider-base-url {baseUri.OriginalString}{providerStateOption}{brokerCredentials}{publishResults}";
             WaitForExit = true;
             Outputters = config?.Outputters;
         }

diff --git a/PactNet/PactVerifier.cs b/PactNet/PactVerifier.cs
@@ -20,6 +20,11 @@ internal PactVerifier(Func<PactVerifierHostConfig, IPactCoreHost> pactVerifierHo
         {
             _pactVerifierHostFactory = pactVerifierHostFactory;
             _config = config;
+
+            if (config.PublishVerificationResults && IsNullOrEmpty(config.ProviderVersion))
+            {
+                throw new ArgumentException($"config.{nameof(config.ProviderVersion)} is required when config.{nameof(config.PublishVerificationResults)} is true.");
+            }
         }
 
         public PactVerifier(PactVerifierConfig config) : 

diff --git a/PactNet/PactVerifierConfig.cs b/PactNet/PactVerifierConfig.cs
@@ -6,6 +6,10 @@ namespace PactNet
     public class PactVerifierConfig
     {
         public IEnumerable<IOutput> Outputters { get; set; }
+
+        public bool PublishVerificationResults { get; set; }
+
+        public string ProviderVersion { get; set; }
 
         public PactVerifierConfig()
         {

diff --git a/README.md b/README.md
@@ -236,9 +236,9 @@ public class SomethingApiTests
             .HonoursPactWith("Consumer")
             .PactUri("..\\..\\..\\Consumer.Tests\\pacts\\consumer-something_api.json")
             //or
-            .PactUri("http://pact-broker/pacts/provider/Something%20Api/consumer/Consumer/version/latest") //You can specify a http or https uri
+            .PactUri("http://pact-broker/pacts/provider/Something%20Api/consumer/Consumer/latest") //You can specify a http or https uri
             //or
-            .PactUri("http://pact-broker/pacts/provider/Something%20Api/consumer/Consumer/version/latest", new PactUriOptions("someuser", "somepassword")) //You can also specify http/https basic auth details
+            .PactUri("http://pact-broker/pacts/provider/Something%20Api/consumer/Consumer/latest", new PactUriOptions("someuser", "somepassword")) //You can also specify http/https basic auth details
             .Verify();
     }
   }
@@ -360,6 +360,28 @@ pactPublisher.PublishToBroker(
     "1.0.2", new [] { "master" });
 ```
 
+### Publishing Provider Verification Results to a Broker
+This feature allows the result of the Provider verification to be pushed to the broker and displayed on the index page.
+In order for this to work you must set the ProviderVersion, PublishVerificationResults and use a pact broker uri. If you do not use a broker uri no verification results will be published. See the code snippet code below.
+For more info and compatibility details [refer to this](https://github.com/pact-foundation/pact_broker/wiki/Provider-verification-results).
+
+```c#
+var buildNumber = Environment.GetEnvironmentVariable("BUILD_NUMBER");
+
+//Assuming build number is only set in the CI environment
+var config = new PactVerifierConfig
+{
+	ProviderVersion = !string.IsNullOrEmpty(buildNumber) ? buildNumber : null, //NOTE: This is required for this feature to work
+	PublishVerificationResults = !string.IsNullOrEmpty(buildNumber)
+};
+IPactVerifier pactVerifier = new PactVerifier(config);
+pactVerifier
+	.ServiceProvider("Something Api", serviceUri)
+	.HonoursPactWith("Consumer")
+	.PactUri("http://pact-broker/pacts/provider/Something%20Api/consumer/Consumer/latest") //NOTE: This must be a pact broker url for this feature to work
+	.Verify();
+```
+
 #### Related Tools
 You might also find the following tool and library helpful: