Add support for providerVersionBranches #1554

pact-foundation · May 25, 2022 · 90f821f · 90f821f
1 parent 2931d69
commit 90f821f
Show file tree

Hide file tree

Showing 12 changed files with 240 additions and 91 deletions.
diff --git a/core/pactbroker/src/main/kotlin/au/com/dius/pact/core/pactbroker/PactBrokerClient.kt b/core/pactbroker/src/main/kotlin/au/com/dius/pact/core/pactbroker/PactBrokerClient.kt
@@ -158,6 +158,7 @@ interface IPactBrokerClient {
     providerName: String,
     selectors: List<ConsumerVersionSelector>,
     providerTags: List<String> = emptyList(),
+    providerBranches: List<String> = emptyList(),
     enablePending: Boolean = false,
     includeWipPactsSince: String?
   ): Result<List<PactBrokerResult>, Exception>
@@ -299,6 +300,7 @@ open class PactBrokerClient(
     providerName: String,
     selectors: List<ConsumerVersionSelector>,
     providerTags: List<String>,
+    providerBranches: List<String>,
     enablePending: Boolean,
     includeWipPactsSince: String?
   ): Result<List<PactBrokerResult>, Exception> {
@@ -314,9 +316,9 @@ open class PactBrokerClient(
     return if (pactsForVerification != null) {
       val selectorsRawJson = System.getProperty("pactbroker.consumerversionselectors.rawjson")
       if(!selectorsRawJson.isNullOrBlank()){
-        fetchPactsUsingNewEndpointRaw(selectorsRawJson, enablePending, providerTags, includeWipPactsSince, halClient, pactsForVerification, providerName)
+        fetchPactsUsingNewEndpointRaw(selectorsRawJson, enablePending, providerTags, providerBranches, includeWipPactsSince, halClient, pactsForVerification, providerName)
       } else {
-        fetchPactsUsingNewEndpointTyped(selectors, enablePending, providerTags, includeWipPactsSince, halClient, pactsForVerification, providerName)
+        fetchPactsUsingNewEndpointTyped(selectors, enablePending, providerTags, providerBranches, includeWipPactsSince, halClient, pactsForVerification, providerName)
       }
     } else {
       handleWith {
@@ -341,31 +343,34 @@ open class PactBrokerClient(
     selectorsTyped: List<ConsumerVersionSelector>,
     enablePending: Boolean,
     providerTags: List<String>,
+    providerBranches: List<String>,
     includeWipPactsSince: String?,
     halClient: IHalClient,
     pactsForVerification: String,
     providerName: String
   ): Result<List<PactBrokerResult>, Exception> {
     val selectorsJson = jsonArray(selectorsTyped.map { it.toJson() })
-    return fetchPactsUsingNewEndpoint(selectorsJson, enablePending, providerTags, includeWipPactsSince, halClient, pactsForVerification, providerName)
+    return fetchPactsUsingNewEndpoint(selectorsJson, enablePending, providerTags, providerBranches, includeWipPactsSince, halClient, pactsForVerification, providerName)
   }
 
   private fun fetchPactsUsingNewEndpointRaw(
     selectorsRaw: String,
     enablePending: Boolean,
     providerTags: List<String>,
+    providerBranches: List<String>,
     includeWipPactsSince: String?,
     halClient: IHalClient,
     pactsForVerification: String,
     providerName: String
   ): Result<List<PactBrokerResult>, Exception> {
-    return fetchPactsUsingNewEndpoint(JsonParser.parseString(selectorsRaw), enablePending, providerTags, includeWipPactsSince, halClient, pactsForVerification, providerName)
+    return fetchPactsUsingNewEndpoint(JsonParser.parseString(selectorsRaw), enablePending, providerTags, providerBranches, includeWipPactsSince, halClient, pactsForVerification, providerName)
   }
 
   private fun fetchPactsUsingNewEndpoint(
     selectorsJson: JsonValue,
     enablePending: Boolean,
     providerTags: List<String>,
+    providerBranches: List<String>,
     includeWipPactsSince: String?,
     halClient: IHalClient,
     pactsForVerification: String,
@@ -379,6 +384,7 @@ open class PactBrokerClient(
     body["includePendingStatus"] = enablePending
     if (enablePending) {
       body["providerVersionTags"] = jsonArray(providerTags)
+      body["providerVersionBranches"] = jsonArray(providerBranches)
       if (includeWipPactsSince.isNotEmpty()) {
         body["includeWipPactsSince"] = includeWipPactsSince
       }

diff --git a/core/pactbroker/src/test/groovy/au/com/dius/pact/core/pactbroker/PactBrokerClientSpec.groovy b/core/pactbroker/src/test/groovy/au/com/dius/pact/core/pactbroker/PactBrokerClientSpec.groovy
@@ -95,7 +95,7 @@ class PactBrokerClientSpec extends Specification {
     }
 
     when:
-    def consumers = client.fetchConsumersWithSelectors('provider', [], [], false, '').value
+    def consumers = client.fetchConsumersWithSelectors('provider', [], [], [], false, '').value
 
     then:
     consumers == []
@@ -113,7 +113,7 @@ class PactBrokerClientSpec extends Specification {
     }
 
     when:
-    def consumers = client.fetchConsumersWithSelectors('provider', [], [], false, '').value
+    def consumers = client.fetchConsumersWithSelectors('provider', [], [], [], false, '').value
 
     then:
     consumers != []
@@ -134,7 +134,7 @@ class PactBrokerClientSpec extends Specification {
 
     when:
     def consumers = client.fetchConsumersWithSelectors('provider',
-            [ new ConsumerVersionSelector('tag', true, null, null) ], [], false, '').value
+            [ new ConsumerVersionSelector('tag', true, null, null) ], [], [], false, '').value
 
     then:
     consumers != []
@@ -156,7 +156,7 @@ class PactBrokerClientSpec extends Specification {
     when:
     def consumers = client.fetchConsumersWithSelectors('provider',
             [ new ConsumerVersionSelector('tag', true, null, null),
-              new ConsumerVersionSelector('anotherTag', true, null, null) ], [], false, '').value
+              new ConsumerVersionSelector('anotherTag', true, null, null) ], [], [], false, '').value
 
     then:
     consumers.size() == 2
@@ -185,7 +185,7 @@ class PactBrokerClientSpec extends Specification {
 
     when:
     def consumers = client.fetchConsumersWithSelectors('provider',
-            [ new ConsumerVersionSelector('tag', true, null, null) ], [], false, '').value
+            [ new ConsumerVersionSelector('tag', true, null, null) ], [], [], false, '').value
 
     then:
     consumers != []
@@ -206,7 +206,7 @@ class PactBrokerClientSpec extends Specification {
 
     when:
     def consumers = client.fetchConsumersWithSelectors('provider',
-      [ new ConsumerVersionSelector('tag', true, null, null) ], [], false, '').value
+      [ new ConsumerVersionSelector('tag', true, null, null) ], [], [], false, '').value
 
     then:
     consumers == []
@@ -399,7 +399,7 @@ class PactBrokerClientSpec extends Specification {
     ''')
 
     when:
-    def result = client.fetchConsumersWithSelectors('provider', selectors, [], false, '')
+    def result = client.fetchConsumersWithSelectors('provider', selectors, [], [], false, '')
 
     then:
     1 * halClient.navigate() >> halClient
@@ -432,7 +432,7 @@ class PactBrokerClientSpec extends Specification {
     ''')
 
     when:
-    def result = client.fetchConsumersWithSelectors('provider', [], [], false, '')
+    def result = client.fetchConsumersWithSelectors('provider', [], [], [], false, '')
 
     then:
     1 * halClient.navigate() >> halClient
@@ -450,7 +450,7 @@ class PactBrokerClientSpec extends Specification {
     }
 
     when:
-    def result = client.fetchConsumersWithSelectors('provider', [], [], false, '')
+    def result = client.fetchConsumersWithSelectors('provider', [], [], [], false, '')
 
     then:
     1 * halClient.navigate() >> halClient
@@ -478,7 +478,7 @@ class PactBrokerClientSpec extends Specification {
     }
     ''')
     when:
-    def result = client.fetchConsumersWithSelectors('provider', selectors, [], false, '2020-24-06')
+    def result = client.fetchConsumersWithSelectors('provider', selectors, [], [], false, '2020-24-06')
 
     then:
     1 * halClient.navigate() >> halClient
@@ -495,7 +495,7 @@ class PactBrokerClientSpec extends Specification {
     }
     def selectors = [ new ConsumerVersionSelector('DEV', true, null, null) ]
     def json = '{"consumerVersionSelectors":[{"latest":true,"tag":"DEV"}],"includePendingStatus":true,' +
-      '"includeWipPactsSince":"2020-24-06","providerVersionTags":[]}'
+      '"includeWipPactsSince":"2020-24-06","providerVersionBranches":[],"providerVersionTags":[]}'
     def jsonResult = JsonParser.INSTANCE.parseString('''
     {
       "_embedded": {
@@ -505,7 +505,7 @@ class PactBrokerClientSpec extends Specification {
     }
     ''')
     when:
-    def result = client.fetchConsumersWithSelectors('provider', selectors, [], true, '2020-24-06')
+    def result = client.fetchConsumersWithSelectors('provider', selectors, [], [], true, '2020-24-06')
 
     then:
     1 * halClient.navigate() >> halClient
@@ -524,7 +524,7 @@ class PactBrokerClientSpec extends Specification {
 
     when:
     def result = client.fetchConsumersWithSelectors('provider',
-      [ new ConsumerVersionSelector(null, true, 'consumer', null) ], [], false, '')
+      [ new ConsumerVersionSelector(null, true, 'consumer', null) ], [], [], false, '')
 
     then:
     1 * halClient.navigate() >> halClient
@@ -580,7 +580,7 @@ class PactBrokerClientSpec extends Specification {
     ]
 
     when:
-    def result = client.fetchConsumersWithSelectors('provider', selectors, [], false, '')
+    def result = client.fetchConsumersWithSelectors('provider', selectors, [], [], false, '')
 
     then:
     1 * halClient.navigate() >> halClient
@@ -604,7 +604,7 @@ class PactBrokerClientSpec extends Specification {
     ]
 
     when:
-    def result = client.fetchConsumersWithSelectors('provider', selectors, [], false, '')
+    def result = client.fetchConsumersWithSelectors('provider', selectors, [], [], false, '')
 
     then:
     1 * halClient.navigate() >> {
@@ -664,7 +664,7 @@ class PactBrokerClientSpec extends Specification {
     def expectedJson = '{"consumerVersionSelectors":[{"mainBranch":true}],"includePendingStatus":false}'
 
     when:
-    client.fetchConsumersWithSelectors('provider', [], [], false, '')
+    client.fetchConsumersWithSelectors('provider', [], [], [], false, '')
 
     then:
     1 * halClient.postJson('pb:provider-pacts-for-verification', _, expectedJson)

diff --git a/pact-publish/src/test/groovy/broker/PactBrokerClientPactSpec.groovy b/pact-publish/src/test/groovy/broker/PactBrokerClientPactSpec.groovy
@@ -11,7 +11,7 @@ import com.github.michaelbull.result.Err
 import com.github.michaelbull.result.Ok
 import spock.lang.Specification
 
-@SuppressWarnings(['UnnecessaryGetter', 'LineLength', 'NestedBlockDepth', 'AbcMetric', 'MethodSize', 'ClassSize'])
+@SuppressWarnings(['GroovyAssignabilityCheck','UnnecessaryGetter', 'LineLength', 'NestedBlockDepth', 'AbcMetric', 'MethodSize', 'ClassSize'])
 class PactBrokerClientPactSpec extends Specification {
 
   private PactBrokerClient pactBrokerClient
@@ -917,7 +917,7 @@ class PactBrokerClientPactSpec extends Specification {
     def result = pactBroker.runTest { server, context ->
       def consumerPacts = pactBrokerClient.fetchConsumersWithSelectors('Activity Service', [
           new ConsumerVersionSelector('test', true, null, null)
-      ], [], false, '')
+      ], [], [], false, '')
       assert consumerPacts instanceof Ok
       assert consumerPacts.value.size == 2
       assert !consumerPacts.value[0].pending
@@ -960,7 +960,8 @@ class PactBrokerClientPactSpec extends Specification {
             latest true
           }
         ])
-        providerVersionTags(['master'])
+        providerVersionTags(['tag'])
+        providerVersionBranches(['master'])
         includePendingStatus true
       }
       willRespondWith(status: 200)
@@ -1030,7 +1031,7 @@ class PactBrokerClientPactSpec extends Specification {
     def result = pactBroker.runTest { server, context ->
       def consumerPacts = pactBrokerClient.fetchConsumersWithSelectors('Activity Service', [
         new ConsumerVersionSelector('test', true, null, null)
-      ], ['master'], true, '')
+      ], ['tag'], ['master'], true, '')
       assert consumerPacts instanceof Ok
       assert consumerPacts.value.size == 2
       assert !consumerPacts.value[0].pending
@@ -1073,7 +1074,8 @@ class PactBrokerClientPactSpec extends Specification {
             latest true
           }
         ])
-        providerVersionTags(['master'])
+        providerVersionTags(['tag'])
+        providerVersionBranches(['master'])
         includePendingStatus true
         includeWipPactsSince '2020-06-24'
       }
@@ -1154,7 +1156,7 @@ class PactBrokerClientPactSpec extends Specification {
     def result = pactBroker.runTest { server, context ->
       def consumerPacts = pactBrokerClient.fetchConsumersWithSelectors('Activity Service', [
         new ConsumerVersionSelector('test', true, null, null)
-      ], ['master'], true, '2020-06-24')
+      ], ['tag'], ['master'], true, '2020-06-24')
       assert consumerPacts instanceof Ok
       assert consumerPacts.value.size == 2
       assert !consumerPacts.value[0].wip

diff --git a/provider/gradle/src/main/kotlin/au/com/dius/pact/provider/gradle/GradleProviderInfo.kt b/provider/gradle/src/main/kotlin/au/com/dius/pact/provider/gradle/GradleProviderInfo.kt
@@ -105,10 +105,11 @@ open class GradleProviderInfo(name: String, val project: Project) : ProviderInfo
 
     val pending = brokerConfig!!.enablePending ?: false
     if (pending && (brokerConfig!!.providerTags.isNullOrEmpty() ||
-      brokerConfig!!.providerTags!!.any { it.trim().isEmpty() })) {
+      brokerConfig!!.providerTags!!.any { it.trim().isEmpty() }) && (brokerConfig!!.providerBranches.isNullOrEmpty() ||
+              brokerConfig!!.providerBranches!!.any { it.trim().isEmpty() })) {
       throw GradleScriptException(
         """
-        |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.
+        |No providerTags or providerBranches: 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.
         |
         |For instance:
         |

diff --git a/provider/gradle/src/main/kotlin/au/com/dius/pact/provider/gradle/PactBrokerConsumerConfig.kt b/provider/gradle/src/main/kotlin/au/com/dius/pact/provider/gradle/PactBrokerConsumerConfig.kt
@@ -8,7 +8,8 @@ import au.com.dius.pact.core.pactbroker.ConsumerVersionSelector
 data class PactBrokerConsumerConfig @JvmOverloads constructor(
   var selectors: List<ConsumerVersionSelector>? = listOf(),
   var enablePending: Boolean? = false,
-  var providerTags: List<String>? = listOf()
+  var providerTags: List<String>? = listOf(),
+  var providerBranches: List<String>? = listOf()
 ) {
   companion object {
     @JvmStatic

diff --git a/...der/gradle/src/test/groovy/au/com/dius/pact/provider/gradle/GradleProviderInfoSpec.groovy b/...der/gradle/src/test/groovy/au/com/dius/pact/provider/gradle/GradleProviderInfoSpec.groovy
@@ -32,15 +32,16 @@ class GradleProviderInfoSpec extends Specification {
       selectors = latestTags('test')
       enablePending = true
       providerTags = ['master']
+      providerBranches = ['master']
     }
 
     then:
     provider.brokerConfig == new PactBrokerConsumerConfig([new ConsumerVersionSelector('test', true, null, null)],
-      true, ['master'])
+      true, ['master'], ['master'])
   }
 
   @Unroll
-  def 'fromPactBroker throws an exception if pending pacts is enabled but there are no provider tags'() {
+  def 'fromPactBroker throws an exception if pending pacts is enabled but there are no provider tags or provider branches'() {
     given:
     def provider = new GradleProviderInfo('provider', Mock(Project))
 
@@ -49,16 +50,18 @@ class GradleProviderInfoSpec extends Specification {
       selectors = latestTags('test')
       enablePending = true
       providerTags = tags
+      providerBranches = branches
     }
 
     then:
     def ex = thrown(GradleScriptException)
-    ex.message.trim().startsWith('No providerTags: To use the pending pacts feature, you need to provide the list of ' +
+    ex.message.trim().startsWith('No providerTags or providerBranches: To use the pending pacts feature, you need to provide the list of ' +
       'provider names')
 
     where:
 
     tags << [null, [], ['']]
+    branches << [null, [], ['']]
   }
 
   def 'supports specifying a fallback tag'() {