feat: add method to ProviderInfo with better type safety #1415

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

@@ -121,7 +121,7 @@ interface IPactBrokerClient {
     selectors: List<ConsumerVersionSelector>,
     providerTags: List<String> = emptyList(),
     enablePending: Boolean = false,
-    includeWipPactsSince: String
+    includeWipPactsSince: String?
   ): Result<List<PactBrokerResult>, Exception>
 
   fun getUrlForProvider(providerName: String, tag: String): String?
@@ -236,7 +236,7 @@ open class PactBrokerClient(
     selectors: List<ConsumerVersionSelector>,
     providerTags: List<String>,
     enablePending: Boolean,
-    includeWipPactsSince: String
+    includeWipPactsSince: String?
   ): Result<List<PactBrokerResult>, Exception> {
     val halClient = when (val navigateResult = handleWith<IHalClient> { newHalClient().navigate() }) {
       is Err<Exception> -> return navigateResult
@@ -272,7 +272,7 @@ open class PactBrokerClient(
     selectors: List<ConsumerVersionSelector>,
     enablePending: Boolean,
     providerTags: List<String>,
-    includeWipPactsSince: String,
+    includeWipPactsSince: String?,
     halClient: IHalClient,
     pactsForVerification: String,
     providerName: String
@@ -284,7 +284,7 @@ open class PactBrokerClient(
     if (enablePending) {
       body["providerVersionTags"] = jsonArray(providerTags)
       body["includePendingStatus"] = true
-      if (!includeWipPactsSince.isBlank()) {
+      if (includeWipPactsSince.isNotEmpty()) {
         body["includeWipPactsSince"] = includeWipPactsSince
       }
     }

provider/src/main/kotlin/au/com/dius/pact/provider/PactBrokerOptions.kt

@@ -0,0 +1,18 @@
+package au.com.dius.pact.provider
+
+data class PactBrokerOptions @JvmOverloads constructor(
+  /**
+   * Enable pending pacts
+   */
+  val enablePending: Boolean = false,
+
+  /**
+   * Provider tags. Required if pending pacts are enabled
+   */
+  val providerTags: List<String> = listOf(),
+
+  /**
+   * Only include WIP pacts since the provided date
+   */
+  val includeWipPactsSince: String? = null
+)

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

@@ -65,28 +65,37 @@ open class ProviderInfo @JvmOverloads constructor (
     hasPactsFromPactBrokerWithSelectors(options, pactBrokerUrl, emptyList())
 
   @JvmOverloads
-  @Suppress("TooGenericExceptionThrown")
   open fun hasPactsFromPactBrokerWithSelectors(
     options: Map<String, Any> = mapOf(),
     pactBrokerUrl: String,
     selectors: List<ConsumerVersionSelector>
   ): List<ConsumerInfo> {
     val enablePending = Utils.lookupInMap(options, "enablePending", Boolean::class.java, false)
-    if (enablePending && (!options.containsKey("providerTags") || options["providerTags"] !is List<*>)) {
-      throw RuntimeException("No providerTags: To use the pending pacts feature, you need to provide the list of " +
-        "provider names for the provider application version that will be published with the verification results")
-    }
     val providerTags = if (enablePending) {
-      options["providerTags"] as List<String>
+      options["providerTags"] as List<String>?
     } else {
       emptyList()
     }
     val includePactsSince = Utils.lookupInMap(options, "includeWipPactsSince", String::class.java, "")
-    val client = pactBrokerClient(pactBrokerUrl, options)
-    val consumersFromBroker = client.fetchConsumersWithSelectors(name, selectors, providerTags, enablePending,
-      includePactsSince)
-      .map { results -> results.map { ConsumerInfo.from(it) }
+    return hasPactsFromPactBrokerWithSelectors(pactBrokerUrl, selectors,
+      PactBrokerOptions(enablePending, providerTags.orEmpty(), includePactsSince))
+  }
+
+  @Suppress("TooGenericExceptionThrown")
+  open fun hasPactsFromPactBrokerWithSelectors(
+    pactBrokerUrl: String,
+    selectors: List<ConsumerVersionSelector>,
+    options: PactBrokerOptions
+  ): List<ConsumerInfo> {
+    if (options.enablePending && options.providerTags.isEmpty()) {
+      throw RuntimeException("No providerTags: To use the pending pacts feature, you need to provide the list of " +
+        "provider names for the provider application version that will be published with the verification results")
     }
+    val client = pactBrokerClient(pactBrokerUrl, mapOf())
+    val consumersFromBroker = client.fetchConsumersWithSelectors(name, selectors, options.providerTags,
+      options.enablePending, options.includeWipPactsSince)
+      .map { results -> results.map { ConsumerInfo.from(it) }
+      }
     return when (consumersFromBroker) {
       is Ok<List<ConsumerInfo>> -> {
         val list = consumersFromBroker.value

provider/src/test/groovy/au/com/dius/pact/provider/groovysupport/ProviderClientSpec.groovy

@@ -5,8 +5,6 @@ import au.com.dius.pact.core.model.ProviderState
 import au.com.dius.pact.core.model.Request
 import au.com.dius.pact.core.support.Json
 import au.com.dius.pact.core.model.ContentType as PactContentType
-@SuppressWarnings('UnusedImport')
-import au.com.dius.pact.provider.GroovyScalaUtils$
 import au.com.dius.pact.provider.IHttpClientFactory
 import au.com.dius.pact.provider.IProviderInfo
 import au.com.dius.pact.provider.ProviderClient
@@ -288,7 +286,7 @@ class ProviderClientSpec extends Specification {
 
   def 'execute request filter executes any scala closure'() {
     given:
-    provider.requestFilter = GroovyScalaUtils$.MODULE$.testRequestFilter()
+    provider.requestFilter = au.com.dius.pact.provider.GroovyScalaUtils$.MODULE$.testRequestFilter()
 
     when:
     client.executeRequestFilter(httpRequest)
@@ -703,5 +701,4 @@ class ProviderClientSpec extends Specification {
     then:
     result.contentType.toString() == 'text/plain; charset=ISO-8859-1'
   }
-
 }