feat: Updated Gradle plugin to use new hasPactsFromPactBrokerWithSelectors #942

Author: Ronald Holshausen

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

@@ -47,6 +47,11 @@ import au.com.dius.pact.core.support.handleWith
  * Interface to a HAL Client
  */
 interface IHalClient {
+  /**
+   * Navigates to the Root
+   */
+  fun navigate(): IHalClient
+
   /**
    * Navigates the URL associated with the given link using the current HAL document
    * @param options Map of key-value pairs to use for parsing templated links
@@ -247,6 +252,11 @@ open class HalClient @JvmOverloads constructor(
     return httpClient!!
   }
 
+  override fun navigate(): IHalClient {
+    pathInfo = fetch(ROOT)
+    return this
+  }
+
   override fun navigate(options: Map<String, Any>, link: String): IHalClient {
     pathInfo = pathInfo ?: fetch(ROOT)
     pathInfo = fetchLink(link, options)

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

@@ -137,7 +137,7 @@ open class PactBrokerClient(val pactBrokerUrl: String, val options: Map<String,
    * Fetches all consumers for the given provider and selectors
    */
   open fun fetchConsumersWithSelectors(provider: String, consumerVersionSelectors: List<ConsumerVersionSelector>): Either<Exception, List<PactResult>> {
-    val halClient = newHalClient()
+    val halClient = newHalClient().navigate()
     val pactsForVerification = when {
       halClient.linkUrl(PROVIDER_PACTS_FOR_VERIFICATION) != null -> PROVIDER_PACTS_FOR_VERIFICATION
       halClient.linkUrl(BETA_PROVIDER_PACTS_FOR_VERIFICATION) != null -> BETA_PROVIDER_PACTS_FOR_VERIFICATION

core/pact-broker/src/test/groovy/au/com/dius/pact/core/pactbroker/PactBrokerClientSpec.groovy

@@ -352,6 +352,7 @@ class PactBrokerClientSpec extends Specification {
     def result = client.fetchConsumersWithSelectors('provider', selectors)
 
     then:
+    1 * halClient.navigate() >> halClient
     1 * halClient.linkUrl('pb:provider-pacts-for-verification') >> 'URL'
     1 * halClient.postJson('pb:provider-pacts-for-verification', [provider: 'provider'], json) >> new Either.Right(jsonResult)
     result.right
@@ -382,6 +383,7 @@ class PactBrokerClientSpec extends Specification {
     def result = client.fetchConsumersWithSelectors('provider', [])
 
     then:
+    1 * halClient.navigate() >> halClient
     1 * halClient.linkUrl('pb:provider-pacts-for-verification') >> null
     1 * halClient.linkUrl('beta:provider-pacts-for-verification') >> 'URL'
     1 * halClient.postJson('beta:provider-pacts-for-verification', _, _) >> new Either.Right(jsonResult)
@@ -399,6 +401,7 @@ class PactBrokerClientSpec extends Specification {
     def result = client.fetchConsumersWithSelectors('provider', [])
 
     then:
+    1 * halClient.navigate() >> halClient
     1 * halClient.linkUrl('pb:provider-pacts-for-verification') >> null
     1 * halClient.linkUrl('beta:provider-pacts-for-verification') >> null
     0 * halClient.postJson(_, _, _)

provider/pact-jvm-provider/src/main/kotlin/au/com/dius/pact/provider/ProviderClient.kt

@@ -9,6 +9,7 @@ import au.com.dius.pact.core.model.ProviderState
 import au.com.dius.pact.core.model.Request
 import au.com.dius.pact.core.model.UrlSource
 import au.com.dius.pact.core.pactbroker.PactBrokerConsumer
+import au.com.dius.pact.core.pactbroker.PactResult
 import au.com.dius.pact.core.support.Json
 import groovy.lang.Binding
 import groovy.lang.Closure
@@ -166,6 +167,12 @@ open class ConsumerInfo @JvmOverloads constructor (
         pactSource = BrokerUrlSource(url = consumer.source, pactBrokerUrl = consumer.pactBrokerUrl, tag = consumer.tag),
         pactFileAuthentication = consumer.pactFileAuthentication
       )
+
+    fun from(consumer: PactResult) =
+      ConsumerInfo(name = consumer.name,
+        pactSource = BrokerUrlSource(url = consumer.source, pactBrokerUrl = consumer.pactBrokerUrl),
+        pactFileAuthentication = consumer.pactFileAuthentication
+      )
   }
 }
 

provider/pact-jvm-provider/src/main/kotlin/au/com/dius/pact/provider/ProviderInfo.kt

@@ -1,8 +1,10 @@
 package au.com.dius.pact.provider
 
+import arrow.core.Either
 import au.com.dius.pact.core.model.DefaultPactReader
 import au.com.dius.pact.core.model.FileSource
 import au.com.dius.pact.core.model.Interaction
+import au.com.dius.pact.core.pactbroker.ConsumerVersionSelector
 import au.com.dius.pact.core.pactbroker.PactBrokerClient
 import org.apache.commons.lang3.builder.HashCodeBuilder
 import org.apache.commons.lang3.builder.ToStringBuilder
@@ -55,12 +57,8 @@ open class ProviderInfo @JvmOverloads constructor (
   }
 
   @JvmOverloads
-  open fun hasPactsFromPactBroker(options: Map<String, Any> = mapOf(), pactBrokerUrl: String): List<ConsumerInfo> {
-    val client = PactBrokerClient(pactBrokerUrl, options)
-    val consumersFromBroker = client.fetchConsumers(name).map { ConsumerInfo.from(it) }
-    consumers.addAll(consumersFromBroker)
-    return consumersFromBroker
-  }
+  open fun hasPactsFromPactBroker(options: Map<String, Any> = mapOf(), pactBrokerUrl: String) =
+    hasPactsFromPactBrokerWithSelectors(options, pactBrokerUrl, emptyList())
 
   @JvmOverloads
   open fun hasPactsFromPactBrokerWithTag(
@@ -74,6 +72,29 @@ open class ProviderInfo @JvmOverloads constructor (
     return consumersFromBroker
   }
 
+  @JvmOverloads
+  open fun hasPactsFromPactBrokerWithSelectors(
+    options: Map<String, Any> = mapOf(),
+    pactBrokerUrl: String,
+    selectors: List<ConsumerVersionSelector>
+  ): List<ConsumerInfo> {
+    val client = PactBrokerClient(pactBrokerUrl, options)
+    val consumersFromBroker = client.fetchConsumersWithSelectors(name, selectors).map { results ->
+      results.map { ConsumerInfo.from(it) }
+    }
+    return when (consumersFromBroker) {
+      is Either.Right<*> -> {
+        val list = (consumersFromBroker as Either.Right<List<ConsumerInfo>>).b
+        consumers.addAll(list)
+        list
+      }
+      is Either.Left<*> -> {
+        throw RuntimeException("Call to fetch pacts from Pact Broker failed with an exception",
+          consumersFromBroker.a as Exception)
+      }
+    }
+  }
+
   open fun setupConsumerListFromPactFiles(consumersGroup: ConsumersGroup): MutableList<IConsumerInfo> {
     val pactFileDirectory = consumersGroup.pactFileLocation ?: return mutableListOf()
     if (!pactFileDirectory.exists() || !pactFileDirectory.canRead()) {