feat: created a Spring JUnit 5 module #1023

Author: Ronald Holshausen

provider/pact-jvm-provider-junit5-spring/README.md

@@ -0,0 +1,40 @@
+# Pact Spring/JUnit5 Support
+
+This module extends the base [Pact JUnit5 module](../pact-jvm-provider-junit5). See that for more details.
+
+For writing Spring Pact verification tests with JUnit 5, there is an JUnit 5 Invocation Context Provider that you can use with 
+the `@TestTemplate` annotation. This will generate a test for each interaction found for the pact files for the provider.
+
+To use it, add the `@Provider` and `@ExtendWith(SpringExtension.class)` and one of the pact source annotations to your test class (as per a JUnit 5 test), then
+add a method annotated with `@TestTemplate` and `@ExtendWith(PactVerificationSpringProvider.class)` that
+takes a `PactVerificationContext` parameter. You will need to call `verifyInteraction()` on the context parameter in
+your test template method.
+
+For example:
+
+```java
+@ExtendWith(SpringExtension.class)
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
+@Provider("Animal Profile Service")
+@PactBroker
+public class ContractVerificationTest {
+
+    @TestTemplate
+    @ExtendWith(PactVerificationSpringProvider.class)
+    void pactVerificationTestTemplate(PactVerificationContext context) {
+      context.verifyInteraction();
+    }
+
+}
+```
+
+You will now be able to setup all the required properties using the Spring context, e.g. creating an application
+YAML file in the test resources:
+
+```yaml
+pactbroker:
+  host: your.broker.host
+  auth:
+    username: broker-user
+    password: broker.password
+```

provider/pact-jvm-provider-junit5-spring/build.gradle

@@ -0,0 +1,5 @@
+dependencies {
+  implementation project(path: ":provider:pact-jvm-provider-junit5", configuration: 'default')
+  implementation 'org.springframework:spring-context:5.2.3.RELEASE'
+  implementation 'org.springframework:spring-test:5.2.3.RELEASE'
+}

provider/pact-jvm-provider-junit5-spring/src/main/kotlin/au/com/dius/pact/provider/spring/junit5/PactVerificationSpringProvider.kt

@@ -0,0 +1,19 @@
+package au.com.dius.pact.provider.spring.junit5
+
+import au.com.dius.pact.core.support.expressions.ValueResolver
+import au.com.dius.pact.provider.junit5.PactVerificationInvocationContextProvider
+import org.junit.jupiter.api.extension.ExtensionContext
+import org.springframework.test.context.TestContextManager
+import org.springframework.test.context.junit.jupiter.SpringExtension
+
+class PactVerificationSpringProvider() : PactVerificationInvocationContextProvider() {
+
+  override fun getValueResolver(context: ExtensionContext): ValueResolver? {
+    val store = context.root.getStore(ExtensionContext.Namespace.create(SpringExtension::class.java))
+    val testClass = context.requiredTestClass
+    val testContextManager = store.getOrComputeIfAbsent(testClass, { TestContextManager(testClass) },
+      TestContextManager::class.java)
+    val environment = testContextManager.testContext.applicationContext.environment
+    return SpringEnvironmentResolver(environment)
+  }
+}

provider/pact-jvm-provider-junit5-spring/src/main/kotlin/au/com/dius/pact/provider/spring/junit5/SpringEnvironmentResolver.kt

@@ -0,0 +1,14 @@
+package au.com.dius.pact.provider.spring.junit5
+
+import au.com.dius.pact.core.support.expressions.SystemPropertyResolver
+import au.com.dius.pact.core.support.expressions.ValueResolver
+import org.springframework.core.env.Environment
+
+class SpringEnvironmentResolver(private val environment: Environment) : ValueResolver {
+  override fun resolveValue(property: String?): String? {
+    val tuple = SystemPropertyResolver.PropertyValueTuple(property).invoke()
+    return environment.getProperty(tuple.propertyName, tuple.defaultValue)
+  }
+
+  override fun propertyDefined(property: String) = environment.containsProperty(property)
+}

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

@@ -356,7 +356,7 @@ class PactVerificationStateChangeExtension(
  * Main TestTemplateInvocationContextProvider for JUnit 5 Pact verification tests. This class needs to be applied to
  * a test template method on a test class annotated with a @Provider annotation.
  */
-class PactVerificationInvocationContextProvider : TestTemplateInvocationContextProvider {
+open class PactVerificationInvocationContextProvider : TestTemplateInvocationContextProvider {
   override fun provideTestTemplateInvocationContexts(context: ExtensionContext): Stream<TestTemplateInvocationContext> {
     logger.debug { "provideTestTemplateInvocationContexts called" }
 
@@ -374,7 +374,12 @@ class PactVerificationInvocationContextProvider : TestTemplateInvocationContextP
     logger.debug { "Verifying pacts for provider '$serviceName' and consumer '$consumerName'" }
 
     val pactSources = findPactSources(context).flatMap {
-      filterPactsByAnnotations(it.load(serviceName), context.requiredTestClass).map { pact -> pact to it.pactSource }
+      val valueResolver = getValueResolver(context)
+      if (valueResolver != null) {
+        it.setValueResolver(valueResolver)
+      }
+      val pacts = it.load(serviceName)
+      filterPactsByAnnotations(pacts, context.requiredTestClass).map { pact -> pact to it.pactSource }
     }.filter { p -> consumerName == null || p.first.consumer.name == consumerName }
 
     val tests = pactSources.flatMap { pact ->
@@ -388,6 +393,8 @@ class PactVerificationInvocationContextProvider : TestTemplateInvocationContextP
     return tests.stream() as Stream<TestTemplateInvocationContext>
   }
 
+  protected open fun getValueResolver(context: ExtensionContext): ValueResolver? = null
+
   private fun validateStateChangeMethods(testClass: Class<*>) {
     val errors = mutableListOf<String>()
     AnnotationSupport.findAnnotatedMethods(testClass, State::class.java, HierarchyTraversalMode.TOP_DOWN).forEach {

settings.gradle

@@ -25,6 +25,7 @@ include   'provider:pact-jvm-provider-maven'
 include   'provider:pact-jvm-provider-junit'
 include   'provider:pact-jvm-provider-junit5'
 include   'provider:pact-jvm-provider-spring'
+include   'provider:pact-jvm-provider-junit5-spring'
 
 if (JavaVersion.current().isJava8()) {
   include 'provider:pact-jvm-provider-lein'