feat: Plugin verifyInteraction requires the Pact and Interaction

Ronald Holshausen · Ronald Holshausen · commit 53baadfa98a8 · 2022-03-31T11:40:13.000+11:00
diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,4 @@
-groovyVersion=3.0.8
+groovyVersion=3.0.10
 kotlinVersion=1.6.10
 httpBuilderVersion=1.0.4
 commonsLang3Version=3.12.0
diff --git a/provider/README.md b/provider/README.md
@@ -48,7 +48,7 @@ class ReadmeExamplePactJVMProviderJUnitTest {
     consumer.setPactSource(new UrlSource(
       ReadmeExamplePactJVMProviderJUnitTest.getResource('/pacts/zoo_app-animal_service.json').toString()))
 
-    testConsumerPact = DefaultPactReader.INSTANCE.loadPact(consumer.getPactSource()) as Pact<RequestResponseInteraction>
+    testConsumerPact = DefaultPactReader.INSTANCE.loadPact(consumer.getPactSource())
   }
 
   @Test
diff --git a/provider/junit5/src/main/kotlin/au/com/dius/pact/provider/junit5/PactVerificationContext.kt b/provider/junit5/src/main/kotlin/au/com/dius/pact/provider/junit5/PactVerificationContext.kt
@@ -2,6 +2,7 @@ package au.com.dius.pact.provider.junit5
 
 import au.com.dius.pact.core.matchers.DefaultResponseGenerator
 import au.com.dius.pact.core.model.Interaction
+import au.com.dius.pact.core.model.Pact
 import au.com.dius.pact.core.model.PactSource
 import au.com.dius.pact.core.model.RequestResponseInteraction
 import au.com.dius.pact.core.model.V4Interaction
@@ -19,6 +20,8 @@ import au.com.dius.pact.provider.ProviderVerifier
 import au.com.dius.pact.provider.VerificationFailureType
 import au.com.dius.pact.provider.VerificationResult
 import au.com.dius.pact.provider.junitsupport.TestDescription
+import com.github.michaelbull.result.Err
+import com.github.michaelbull.result.Ok
 import org.junit.jupiter.api.extension.ExtensionContext
 
 /**
@@ -34,6 +37,7 @@ data class PactVerificationContext @JvmOverloads constructor(
   var providerInfo: IProviderInfo,
   val consumer: IConsumerInfo,
   val interaction: Interaction,
+  val pact: Pact,
   var testExecutionResult: MutableList<VerificationResult.Failed> = mutableListOf()
 ) {
   val stateChangeHandlers: MutableList<Any> = mutableListOf()
@@ -120,7 +124,11 @@ data class PactVerificationContext @JvmOverloads constructor(
         }
       }
       PactVerification.PLUGIN -> {
-        return listOf(verifier!!.verifyInteractionViaPlugin(providerInfo, consumer, interaction,
+        val v4pact = when(val p = pact.asV4Pact()) {
+          is Ok -> p.value
+          is Err -> throw RuntimeException("Plugins can only be used with V4 Pacts")
+        }
+        return listOf(verifier!!.verifyInteractionViaPlugin(providerInfo, consumer, v4pact, interaction.asV4Interaction(),
           client, request, context + ("userConfig" to target.userConfig)))
       }
       else -> {
diff --git a/provider/junit5/src/main/kotlin/au/com/dius/pact/provider/junit5/PactVerificationExtension.kt b/provider/junit5/src/main/kotlin/au/com/dius/pact/provider/junit5/PactVerificationExtension.kt
@@ -97,9 +97,14 @@ open class PactVerificationExtension(
     val store = context.getStore(namespace)
     val pending = interaction.isV4() && interaction.asV4Interaction().pending ||
       pactSource is BrokerUrlSource && pactSource.result?.pending == true
-    val verificationContext = PactVerificationContext(store, context,
+    val verificationContext = PactVerificationContext(
+      store,
+      context,
       consumer = ConsumerInfo(pact.consumer.name, pactSource = pactSource, pending = pending),
-      interaction = interaction, providerInfo = ProviderInfo(serviceName))
+      interaction = interaction,
+      pact = pact,
+      providerInfo = ProviderInfo(serviceName)
+    )
     store.put("interactionContext", verificationContext)
   }
 
diff --git a/provider/junit5/src/test/groovy/au/com/dius/pact/provider/junit5/PactVerificationContextSpec.groovy b/provider/junit5/src/test/groovy/au/com/dius/pact/provider/junit5/PactVerificationContextSpec.groovy
@@ -1,8 +1,11 @@
 package au.com.dius.pact.provider.junit5
 
+import au.com.dius.pact.core.model.Consumer
 import au.com.dius.pact.core.model.Interaction
+import au.com.dius.pact.core.model.Provider
 import au.com.dius.pact.core.model.Request
 import au.com.dius.pact.core.model.RequestResponseInteraction
+import au.com.dius.pact.core.model.RequestResponsePact
 import au.com.dius.pact.core.model.Response
 import au.com.dius.pact.core.support.expressions.ValueResolver
 import au.com.dius.pact.provider.ConsumerInfo
@@ -41,10 +44,11 @@ class PactVerificationContextSpec extends Specification {
     IConsumerInfo consumer = new ConsumerInfo('Test')
     Interaction interaction = new RequestResponseInteraction('Test Interaction', [], new Request(),
       new Response(), '12345')
+    def pact = new RequestResponsePact(new Provider(), new Consumer(), [interaction ])
     List<VerificationResult> testResults = []
 
     context = new PactVerificationContext(store, extContext, target, verifier, valueResolver,
-      provider, consumer, interaction, testResults)
+      provider, consumer, interaction, pact, testResults)
 
     when:
     context.verifyInteraction()
@@ -85,10 +89,11 @@ class PactVerificationContextSpec extends Specification {
     }
     Interaction interaction = new RequestResponseInteraction('Test Interaction', [], new Request(),
       new Response(), '12345')
+    def pact = new RequestResponsePact(new Provider(), new Consumer(), [ interaction ])
     List<VerificationResult> testResults = []
 
     context = new PactVerificationContext(store, extContext, target, verifier, valueResolver,
-      provider, consumer, interaction, testResults)
+      provider, consumer, interaction, pact, testResults)
 
     when:
     context.verifyInteraction()
diff --git a/provider/junit5/src/test/groovy/au/com/dius/pact/provider/junit5/PactVerificationExtensionSpec.groovy b/provider/junit5/src/test/groovy/au/com/dius/pact/provider/junit5/PactVerificationExtensionSpec.groovy
@@ -42,7 +42,7 @@ class PactVerificationExtensionSpec extends Specification {
     PactBrokerSource pactSource = new PactBrokerSource('localhost', '80', 'http')
 
     context = new PactVerificationContext(store, extContext, Stub(TestTarget), Stub(IProviderVerifier),
-      Stub(ValueResolver), Stub(IProviderInfo), Stub(IConsumerInfo), interaction1, [])
+      Stub(ValueResolver), Stub(IProviderInfo), Stub(IConsumerInfo), interaction1, pact, [])
 
     PactVerificationExtension extension = new PactVerificationExtension(filteredPact, pactSource, interaction1,
       'service', 'consumer', mockValueResolver)
@@ -77,7 +77,7 @@ class PactVerificationExtensionSpec extends Specification {
     PactBrokerSource pactSource = new PactBrokerSource('localhost', '80', 'http')
 
     context = new PactVerificationContext(store, extContext, Stub(TestTarget), Stub(IProviderVerifier),
-      Stub(ValueResolver), Stub(IProviderInfo), Stub(IConsumerInfo), interaction1, [])
+      Stub(ValueResolver), Stub(IProviderInfo), Stub(IConsumerInfo), interaction1, pact, [])
 
     PactVerificationExtension extension = new PactVerificationExtension(pact, pactSource, interaction1,
       'service', 'consumer', mockValueResolver)
@@ -111,7 +111,7 @@ class PactVerificationExtensionSpec extends Specification {
     def pact = new RequestResponsePact(new Provider(), new Consumer(), [interaction1, interaction2 ], [:], pactSource)
 
     context = new PactVerificationContext(store, extContext, Stub(TestTarget), Stub(IProviderVerifier),
-      Stub(ValueResolver), Stub(IProviderInfo), Stub(IConsumerInfo), interaction1, [])
+      Stub(ValueResolver), Stub(IProviderInfo), Stub(IConsumerInfo), interaction1, pact, [])
 
     PactVerificationExtension extension = new PactVerificationExtension(pact, pactSource, interaction1,
       'service', 'consumer', mockValueResolver)
diff --git a/provider/junit5/src/test/groovy/au/com/dius/pact/provider/junit5/PactVerificationStateChangeExtensionSpec.groovy b/provider/junit5/src/test/groovy/au/com/dius/pact/provider/junit5/PactVerificationStateChangeExtensionSpec.groovy
@@ -80,7 +80,7 @@ class PactVerificationStateChangeExtensionSpec extends Specification {
     store = Mock(ExtensionContext.Store)
     provider = Mock()
     consumer = Mock()
-    pactContext = new PactVerificationContext(store, testContext, provider, consumer, interaction)
+    pactContext = new PactVerificationContext(store, testContext, provider, consumer, interaction, pact)
   }
 
   @Unroll
@@ -120,6 +120,7 @@ class PactVerificationStateChangeExtensionSpec extends Specification {
     given:
     def state = new ProviderState('test state')
     def interaction = new RequestResponseInteraction('test', [ state ])
+    pact = new RequestResponsePact(new Provider(), new Consumer(), [ interaction ])
     def context = Mock(ExtensionContext) {
       getStore(_) >> store
       getRequiredTestClass() >> TestClass
@@ -129,7 +130,7 @@ class PactVerificationStateChangeExtensionSpec extends Specification {
     IProviderVerifier verifier = Mock()
     ValueResolver resolver = Mock()
     def verificationContext = new PactVerificationContext(store, context, target, verifier, resolver, provider,
-      consumer, interaction, [])
+      consumer, interaction, pact, [])
     store.get(_) >> verificationContext
     verificationExtension = new PactVerificationStateChangeExtension(interaction, pactSource)
 
diff --git a/provider/src/main/kotlin/au/com/dius/pact/provider/ProviderVerifier.kt b/provider/src/main/kotlin/au/com/dius/pact/provider/ProviderVerifier.kt
@@ -19,6 +19,8 @@ import au.com.dius.pact.core.model.ProviderState
 import au.com.dius.pact.core.model.SynchronousRequestResponse
 import au.com.dius.pact.core.model.UrlPactSource
 import au.com.dius.pact.core.model.UrlSource
+import au.com.dius.pact.core.model.V4Interaction
+import au.com.dius.pact.core.model.V4Pact
 import au.com.dius.pact.core.model.generators.GeneratorTestMode
 import au.com.dius.pact.core.model.messaging.Message
 import au.com.dius.pact.core.model.messaging.MessageInteraction
@@ -290,7 +292,8 @@ interface IProviderVerifier {
   fun verifyInteractionViaPlugin(
     providerInfo: IProviderInfo,
     consumer: IConsumerInfo,
-    interaction: Interaction,
+    pact: V4Pact,
+    interaction: V4Interaction,
     client: Any?,
     request: Any?,
     context: Map<String, Any>
@@ -943,13 +946,20 @@ open class ProviderVerifier @JvmOverloads constructor (
   override fun verifyInteractionViaPlugin(
     providerInfo: IProviderInfo,
     consumer: IConsumerInfo,
-    interaction: Interaction,
+    pact: V4Pact,
+    interaction: V4Interaction,
     client: Any?,
     request: Any?,
     context: Map<String, Any>
   ): VerificationResult {
     val userConfig = context["userConfig"] as Map<String, Any?>? ?: emptyMap()
-    return when (val result = DefaultPluginManager.verifyInteraction(client as CatalogueEntry, request as InteractionVerificationData, userConfig)) {
+    return when (val result = DefaultPluginManager.verifyInteraction(
+      client as CatalogueEntry,
+      request as InteractionVerificationData,
+      userConfig,
+      pact,
+      interaction
+    )) {
       is Ok -> if (result.value.ok) {
         VerificationResult.Ok(interaction.interactionId)
       } else {
diff --git a/provider/src/test/groovy/au/com/dius/pact/provider/readme/ReadmeExamplePactJVMProviderJUnitTest.groovy b/provider/src/test/groovy/au/com/dius/pact/provider/readme/ReadmeExamplePactJVMProviderJUnitTest.groovy
@@ -4,7 +4,6 @@ import au.com.dius.pact.core.model.DefaultPactReader
 import au.com.dius.pact.core.model.Interaction
 import au.com.dius.pact.core.model.Pact
 import au.com.dius.pact.core.model.ProviderState
-import au.com.dius.pact.core.model.RequestResponseInteraction
 import au.com.dius.pact.core.model.UrlSource
 import au.com.dius.pact.provider.ConsumerInfo
 import au.com.dius.pact.provider.HttpClientFactory
@@ -56,7 +55,7 @@ class ReadmeExamplePactJVMProviderJUnitTest {
     consumer.setPactSource(new UrlSource(
       ReadmeExamplePactJVMProviderJUnitTest.getResource('/pacts/zoo_app-animal_service.json').toString()))
 
-    testConsumerPact = DefaultPactReader.INSTANCE.loadPact(consumer.getPactSource()) as Pact<RequestResponseInteraction>
+    testConsumerPact = DefaultPactReader.INSTANCE.loadPact(consumer.getPactSource())
   }
 
   @Test

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-groovyVersion=3.0.8`
	`1`	`+groovyVersion=3.0.10`
`2`	`2`	`kotlinVersion=1.6.10`
`3`	`3`	`httpBuilderVersion=1.0.4`
`4`	`4`	`commonsLang3Version=3.12.0`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ class ReadmeExamplePactJVMProviderJUnitTest {`
`48`	`48`	`consumer.setPactSource(new UrlSource(`
`49`	`49`	`ReadmeExamplePactJVMProviderJUnitTest.getResource('/pacts/zoo_app-animal_service.json').toString()))`
`50`	`50`
`51`		`- testConsumerPact = DefaultPactReader.INSTANCE.loadPact(consumer.getPactSource()) as Pact<RequestResponseInteraction>`
	`51`	`+ testConsumerPact = DefaultPactReader.INSTANCE.loadPact(consumer.getPactSource())`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`@Test`