feat: added a can-i-deploy Gradle task #994

Author: Ronald Holshausen

core/pact-broker/src/main/kotlin/au/com/dius/pact/core/pactbroker/PactBrokerClient.kt

@@ -57,6 +57,13 @@ sealed class TestResult {
   }
 }
 
+sealed class Latest {
+  data class UseLatest(val latest: Boolean): Latest()
+  data class UseLatestTag(val latestTag: String): Latest()
+}
+
+data class CanIDeployResult(val ok: Boolean, val message: String, val reason: String)
+
 /**
  * Client for the pact broker service
  */
@@ -294,6 +301,10 @@ open class PactBrokerClient(val pactBrokerUrl: String, val options: Map<String,
     }
   }
 
+  open fun canIDeploy(pacticipant: String, pacticipantVersion: String, latest: Latest, to: String?): CanIDeployResult {
+    return CanIDeployResult(false, "", "")
+  }
+
   companion object : KLogging() {
     const val LATEST_PROVIDER_PACTS_WITH_NO_TAG = "pb:latest-untagged-pact-version"
     const val LATEST_PROVIDER_PACTS = "pb:latest-provider-pacts"

provider/pact-jvm-provider-gradle/src/main/groovy/au/com/dius/pact/provider/gradle/Broker.groovy

@@ -0,0 +1,15 @@
+package au.com.dius.pact.provider.gradle
+
+import groovy.transform.ToString
+
+/**
+ * Config for pact broker
+ */
+@ToString
+class Broker {
+  String pactBrokerUrl
+  String pactBrokerToken
+  String pactBrokerUsername
+  String pactBrokerPassword
+  String pactBrokerAuthenticationScheme
+}

provider/pact-jvm-provider-gradle/src/main/groovy/au/com/dius/pact/provider/gradle/PactCanIDeployTask.groovy

@@ -0,0 +1,74 @@
+package au.com.dius.pact.provider.gradle
+
+import au.com.dius.pact.core.pactbroker.Latest
+import au.com.dius.pact.core.pactbroker.PactBrokerClient
+import org.apache.commons.lang3.StringUtils
+import org.fusesource.jansi.Ansi
+import org.fusesource.jansi.AnsiConsole
+import org.gradle.api.DefaultTask
+import org.gradle.api.GradleScriptException
+import org.gradle.api.tasks.TaskAction
+
+/**
+ * Task to push pact files to a pact broker
+ */
+@SuppressWarnings('Println')
+class PactCanIDeployTask extends DefaultTask {
+
+  @TaskAction
+  void canIDeploy() {
+    AnsiConsole.systemInstall()
+    if (!project.pact.broker) {
+      throw new GradleScriptException('You must add a pact broker configuration to your build before you can ' +
+        'use the CanIDeploy task', null)
+    }
+
+    Broker config = project.pact.broker
+    def options = [:]
+    if (StringUtils.isNotEmpty(config.pactBrokerToken)) {
+      options.authentication = [config.pactBrokerAuthenticationScheme ?: 'bearer',
+                                config.pactBrokerToken]
+    } else if (StringUtils.isNotEmpty(config.pactBrokerUsername)) {
+      options.authentication = [config.pactBrokerAuthenticationScheme ?: 'basic',
+                                config.pactBrokerUsername, config.pactBrokerPassword]
+    }
+    def brokerClient = new PactBrokerClient(config.pactBrokerUrl, options)
+    if (!project.hasProperty('pacticipant')) {
+      throw new GradleScriptException('The CanIDeploy task requires -Ppacticipant=...', null)
+    }
+    String pacticipant = project.property('pacticipant')
+    if (!project.hasProperty('pacticipantVersion')) {
+      throw new GradleScriptException('The CanIDeploy task requires -PpacticipantVersion=...', null)
+    }
+    String pacticipantVersion = project.property('pacticipantVersion')
+    Latest latest = new Latest.UseLatest(false)
+    if (project.hasProperty('latest')) {
+      String latestProp = project.property('latest')
+      if (latestProp == 'true') {
+        latest = new Latest.UseLatest(true)
+      } else if (latestProp == 'false') {
+        latest = new Latest.UseLatest(false)
+      } else {
+        latest = new Latest.UseLatestTag(latestProp)
+      }
+    }
+    String to = null
+    if (project.hasProperty('to')) {
+      to = project.property('to')
+    }
+    def result = brokerClient.canIDeploy(pacticipant, pacticipantVersion, latest, to)
+    if (result.ok) {
+      AnsiConsole.out().println(Ansi.ansi().a('Computer says yes \\o/ ').a(result.message).a('\n\n')
+        .fg(Ansi.Color.GREEN).a(result.reason).reset())
+    } else {
+      AnsiConsole.out().println(Ansi.ansi().a('Computer says no ¯\\_(ツ)_/¯ ').a(result.message).a('\n\n')
+        .fg(Ansi.Color.RED).a(result.reason).reset())
+    }
+
+    AnsiConsole.systemUninstall()
+
+    if (!result.ok) {
+      throw new GradleScriptException("Can you deploy? Computer says no ¯\\_(ツ)_/¯ ${result.message}", null)
+    }
+  }
+}

provider/pact-jvm-provider-gradle/src/main/groovy/au/com/dius/pact/provider/gradle/PactPlugin.groovy

@@ -24,9 +24,11 @@ class PactPlugin implements Plugin<Project> {
         project.task(PACT_VERIFY, description: 'Verify your pacts against your providers', group: GROUP)
         project.task('pactPublish', description: 'Publish your pacts to a pact broker', type: PactPublishTask,
             group: GROUP)
+        project.task('canIDeploy', description: 'Check if it is safe to deploy by checking whether or not the ' +
+          'specified pacticipant versions are compatible', type: PactCanIDeployTask,
+          group: GROUP)
 
         project.afterEvaluate {
-
             if (it.pact == null) {
               throw new GradleScriptException('No pact block was found in the project', null)
             } else if (!(it.pact instanceof PactPluginExtension)) {

provider/pact-jvm-provider-gradle/src/main/groovy/au/com/dius/pact/provider/gradle/PactPluginExtension.groovy

@@ -13,8 +13,8 @@ class PactPluginExtension {
     final NamedDomainObjectContainer<GradleProviderInfo> serviceProviders
 
     PactPublish publish
-
     VerificationReports reports
+    Broker broker
 
     PactPluginExtension(NamedDomainObjectContainer<GradleProviderInfo> serviceProviders) {
         this.serviceProviders = serviceProviders
@@ -36,4 +36,10 @@ class PactPluginExtension {
         reports = new VerificationReports()
         configureAction.execute(reports)
     }
+
+    @SuppressWarnings('ConfusingMethodName')
+    void broker(Action<? extends Broker> configureAction) {
+      broker = new Broker()
+      configureAction.execute(broker)
+    }
 }

provider/pact-jvm-provider-gradle/src/main/groovy/au/com/dius/pact/provider/gradle/PactPublishTask.groovy

@@ -34,16 +34,21 @@ class PactPublishTask extends DefaultTask {
           version = version.call()
         }
 
+        def brokerConfig = project.pact.broker
+        if (!brokerConfig) {
+          brokerConfig = project.pact.publish
+        }
+
         def options = [:]
-        if (StringUtils.isNotEmpty(pactPublish.pactBrokerToken)) {
-            options.authentication = [pactPublish.pactBrokerAuthenticationScheme ?: 'bearer',
-                                      pactPublish.pactBrokerToken]
+        if (StringUtils.isNotEmpty(brokerConfig.pactBrokerToken)) {
+            options.authentication = [brokerConfig.pactBrokerAuthenticationScheme ?: 'bearer',
+                                      brokerConfig.pactBrokerToken]
         }
-        else if (StringUtils.isNotEmpty(pactPublish.pactBrokerUsername)) {
-          options.authentication = [pactPublish.pactBrokerAuthenticationScheme ?: 'basic',
-                                    pactPublish.pactBrokerUsername, pactPublish.pactBrokerPassword]
+        else if (StringUtils.isNotEmpty(brokerConfig.pactBrokerUsername)) {
+          options.authentication = [brokerConfig.pactBrokerAuthenticationScheme ?: 'basic',
+                                    brokerConfig.pactBrokerUsername, brokerConfig.pactBrokerPassword]
         }
-        def brokerClient = new PactBrokerClient(pactPublish.pactBrokerUrl, options)
+        def brokerClient = new PactBrokerClient(brokerConfig.pactBrokerUrl, options)
         File pactDirectory = pactPublish.pactDirectory as File
         boolean anyFailed = false
         pactDirectory.eachFileMatch(FileType.FILES, ~/.*\.json/) { pactFile ->

provider/pact-jvm-provider-maven/build.gradle

@@ -35,6 +35,11 @@ task generatePom(type: GenerateMavenPom, dependsOn: [":provider:pact-jvm-provide
         pluginNode.appendNode('artifactId', 'maven-plugin-plugin')
         pluginNode.appendNode('version', project.mavenPluginPluginVersion)
         pluginNode.appendNode('configuration').appendNode('goalPrefix', 'pact')
+
+      def repository = asNode().appendNode('repositories').appendNode('repository')
+      repository.appendNode('id', 'jcenter')
+      repository.appendNode('name', 'jcenter')
+      repository.appendNode('url', 'https://jcenter.bintray.com')
     }
 }