Merge pull request #1884 from schmidthappens/update/add-support-for-spring7

feat: Add support for Spring 7 and Spring Boot 4

Author: rholshausen

pact-jvm-server/src/test/groovy/au/com/dius/pact/server/MainSpec.groovy

@@ -66,7 +66,7 @@ class MainSpec extends Specification {
     def process = invokeApp(true, '--daemon', '--debug', '31311')
 
     when:
-    process.waitFor(500, TimeUnit.MILLISECONDS)
+    process.waitFor(2000, TimeUnit.MILLISECONDS)
     def result = createMock('31311', pact)
 
     then:

provider/spring7/README.md

@@ -0,0 +1,168 @@
+# Pact Spring7/Spring Boot4 + JUnit5 Support
+
+This module extends the base [Pact JUnit5 module](/provider/junit5/README.md) (See that for more details) and adds support
+for Spring 7 and Spring Boot 4.
+
+**NOTE: This module requires JDK 17+**
+
+## Dependency
+The combined library (JUnit5 + Spring7) is available on maven central using:
+
+group-id = au.com.dius.pact.provider
+artifact-id = spring7
+version-id = 4.5.x
+
+## Usage
+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)` or `@SpringbootTest` 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(PactVerificationSpring7Provider.class)` that takes a `PactVerificationContext` parameter. You will need to
+call `verifyInteraction()` on the context parameter in your test template method.
+
+For example:
+
+```java
+@AutoConfigureMockMvc
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
+@Provider("Animal Profile Service")
+@PactBroker
+public class ContractVerificationTest {
+
+    @TestTemplate
+    @ExtendWith(PactVerificationSpring7Provider.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
+```
+
+You can also run pact tests against `MockMvc` without need to spin up the whole application context which takes time 
+and often requires more additional setup (e.g. database). In order to run lightweight tests just use `@WebMvcTest` 
+from Spring and `Spring7MockMvcTestTarget` as a test target before each test. 
+
+For example:
+```java
+@WebMvcTest
+@Provider("myAwesomeService")
+@PactBroker
+class ContractVerificationTest {
+    
+    @Autowired
+    private MockMvc mockMvc;
+
+    @TestTemplate
+    @ExtendWith(PactVerificationSpring7Provider.class)
+    void pactVerificationTestTemplate(PactVerificationContext context) {
+      context.verifyInteraction();
+    }
+    
+    @BeforeEach
+    void before(PactVerificationContext context) {
+        context.setTarget(new Spring7MockMvcTestTarget(mockMvc));
+    }
+}
+```
+
+You can also use `Spring7MockMvcTestTarget` for tests without spring context by providing the controllers manually. 
+
+For example:
+```java
+@Provider("myAwesomeService")
+@PactFolder("pacts")
+class MockMvcTestTargetStandaloneMockMvcTestJava {
+
+    @TestTemplate
+    @ExtendWith(PactVerificationSpring7Provider.class)
+    void pactVerificationTestTemplate(PactVerificationContext context) {
+        context.verifyInteraction();
+    }
+
+    @BeforeEach
+    void before(PactVerificationContext context) {
+        Spring7MockMvcTestTarget testTarget = new Spring7MockMvcTestTarget();
+        testTarget.setControllers(new DataResource());
+        context.setTarget(testTarget);
+    }
+
+    @RestController
+    static class DataResource {
+        @GetMapping("/data")
+        @ResponseStatus(HttpStatus.NO_CONTENT)
+        void getData(@RequestParam("ticketId") String ticketId) {
+        }
+    }
+}
+```
+
+**Important:** Since `@WebMvcTest` starts only Spring MVC components you can't use `PactVerificationSpring7Provider` 
+and need to fallback to `PactVerificationInvocationContextProvider`
+
+## Webflux tests
+
+You can test Webflux routing functions using the `WebFluxSpring7Target` target class. The easiest way to do it is to get Spring to
+autowire your handler and router into the test and then pass the routing function to the target.
+
+For example:
+
+```java
+  @Autowired
+  YourRouter router;
+
+  @Autowired
+  YourHandler handler;
+
+  @BeforeEach
+  void setup(PactVerificationContext context) {
+    context.setTarget(new WebFluxSpring7Target(router.route(handler)));
+  }
+
+  @TestTemplate
+  @ExtendWith(PactVerificationSpring7Provider.class)
+  void pactVerificationTestTemplate(PactVerificationContext context) {
+    context.verifyInteraction();
+  }
+```
+
+## Modifying requests
+
+As documented in [Pact JUnit5 module](/provider/junit5/README.md#modifying-the-requests-before-they-are-sent), you can
+inject a request object to modify the requests made. However, depending on the Pact test target you are using,
+you need to use a different class.
+
+| Test Target                                   | Class to use                     |
+|-----------------------------------------------|----------------------------------|
+| HttpTarget, HttpsTarget, SpringBootHttpTarget | org.apache.http.HttpRequest      |
+| Spring7MockMvcTestTarget                      | MockHttpServletRequestBuilder    |
+| WebFluxSpring7Target                          | WebTestClient.RequestHeadersSpec |
+
+# Verifying V4 Pact files that require plugins
+
+Pact files that require plugins can be verified with version 4.3.0+. For details on how plugins work, see the
+[Pact plugin project](https://github.com/pact-foundation/pact-plugins).
+
+Each required plugin is defined in the `plugins` section in the Pact metadata in the Pact file. The plugins will be
+loaded from the plugin directory. By default, this is `~/.pact/plugins` or the value of the `PACT_PLUGIN_DIR` environment
+variable. Each plugin required by the Pact file must be installed there. You will need to follow the installation
+instructions for each plugin, but the default is to unpack the plugin into a sub-directory `<plugin-name>-<plugin-version>`
+(i.e., for the Protobuf plugin 0.0.0 it will be `protobuf-0.0.0`). The plugin manifest file must be present for the
+plugin to be able to be loaded.
+
+# Test Analytics
+
+We are tracking anonymous analytics to gather important usage statistics like JVM version
+and operating system. To disable tracking, set the 'pact_do_not_track' system property or environment
+variable to 'true'.

provider/spring7/build.gradle

@@ -0,0 +1,26 @@
+plugins {
+  id 'au.com.dius.pact.kotlin-library-conventions'
+}
+
+description = 'Provider Spring7/Spring Boot4 + JUnit5 Support'
+group = 'au.com.dius.pact.provider'
+
+dependencies {
+  api project(':provider:junit5')
+
+  implementation 'org.springframework:spring-context:7.0.0'
+  implementation 'org.springframework:spring-test:7.0.0'
+  implementation 'org.springframework:spring-web:7.0.0'
+  implementation 'org.springframework:spring-webflux:7.0.0'
+  implementation 'jakarta.servlet:jakarta.servlet-api:6.1.0'
+  implementation 'org.hamcrest:hamcrest:3.0'
+  implementation 'org.apache.commons:commons-lang3'
+  implementation 'javax.mail:mail:1.5.0-b01'
+
+  testImplementation 'org.springframework.boot:spring-boot-starter-test-classic:4.0.0'
+  testImplementation 'org.springframework.boot:spring-boot-starter-webmvc:4.0.0'
+  testImplementation 'org.springframework.boot:spring-boot-starter-security-test:4.0.0'
+  testImplementation 'org.apache.groovy:groovy'
+  testImplementation 'org.mockito:mockito-core:5.20.0'
+  testImplementation 'org.yaml:snakeyaml:2.5'
+}

provider/spring7/description.txt

@@ -0,0 +1 @@
+Pact-JVM - Provider Spring7/Spring Boot4 + JUnit5 Support

provider/spring7/src/main/kotlin/au/com/dius/pact/provider/spring/spring7/PactVerificationSpring7Extension.kt

@@ -0,0 +1,42 @@
+package au.com.dius.pact.provider.spring.spring7
+
+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.provider.junit5.PactVerificationContext
+import au.com.dius.pact.provider.junit5.PactVerificationExtension
+import org.junit.jupiter.api.extension.ExtensionContext
+import org.junit.jupiter.api.extension.ParameterContext
+import org.springframework.test.web.reactive.server.WebTestClient
+import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder
+
+open class PactVerificationSpring7Extension(
+  pact: Pact,
+  pactSource: PactSource,
+  interaction: Interaction,
+  serviceName: String,
+  consumerName: String?
+) : PactVerificationExtension(pact, pactSource, interaction, serviceName, consumerName) {
+  constructor(context: PactVerificationExtension) : this(context.pact, context.pactSource, context.interaction,
+    context.serviceName, context.consumerName)
+
+  override fun supportsParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Boolean {
+    val store = extensionContext.getStore(ExtensionContext.Namespace.create("pact-jvm"))
+    val testContext = store.get("interactionContext") as PactVerificationContext
+    val target = testContext.currentTarget()
+    return when (parameterContext.parameter.type) {
+      MockHttpServletRequestBuilder::class.java -> target is Spring7MockMvcTestTarget
+      WebTestClient.RequestHeadersSpec::class.java -> target is WebFluxSpring7Target
+      else -> super.supportsParameter(parameterContext, extensionContext)
+    }
+  }
+
+  override fun resolveParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Any? {
+    val store = extensionContext.getStore(ExtensionContext.Namespace.create("pact-jvm"))
+    return when (parameterContext.parameter.type) {
+      MockHttpServletRequestBuilder::class.java -> store.get("request")
+      WebTestClient.RequestHeadersSpec::class.java -> store.get("request")
+      else -> super.resolveParameter(parameterContext, extensionContext)
+    }
+  }
+}

provider/spring7/src/main/kotlin/au/com/dius/pact/provider/spring/spring7/PactVerificationSpring7Provider.kt

@@ -0,0 +1,32 @@
+package au.com.dius.pact.provider.spring.spring7
+
+import au.com.dius.pact.core.support.expressions.ValueResolver
+import au.com.dius.pact.provider.junit5.PactVerificationExtension
+import au.com.dius.pact.provider.junit5.PactVerificationInvocationContextProvider
+import org.junit.jupiter.api.extension.ExtensionContext
+import org.junit.jupiter.api.extension.TestTemplateInvocationContext
+import org.springframework.test.context.TestContextManager
+import org.springframework.test.context.junit.jupiter.SpringExtension
+import java.util.stream.Stream
+
+open class PactVerificationSpring7Provider : 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 Spring7EnvironmentResolver(environment)
+  }
+
+  override fun provideTestTemplateInvocationContexts(context: ExtensionContext): Stream<TestTemplateInvocationContext> {
+    return super.provideTestTemplateInvocationContexts(context).map {
+      if (it is PactVerificationExtension) {
+        PactVerificationSpring7Extension(it)
+      } else {
+        it
+      }
+    }
+  }
+}

provider/spring7/src/main/kotlin/au/com/dius/pact/provider/spring/spring7/Spring7EnvironmentResolver.kt

@@ -0,0 +1,24 @@
+package au.com.dius.pact.provider.spring.spring7
+
+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 Spring7EnvironmentResolver(private val environment: Environment) : ValueResolver {
+    override fun resolveValue(property: String?): String? {
+        val tuple = SystemPropertyResolver.PropertyValueTuple(property).invoke()
+
+        val name = tuple.propertyName ?: return null
+        val defaultValue = tuple.defaultValue ?: return null
+
+        return environment.getProperty(name, defaultValue)
+    }
+
+    override fun resolveValue(property: String?, default: String?): String? {
+        val name = property ?: return null
+        val defaultValue = default ?: return null
+        return environment.getProperty(name, defaultValue)
+    }
+
+  override fun propertyDefined(property: String) = environment.containsProperty(property)
+}