feat: allow JUnit 5 tests to have state change methods on additional classes #943

Author: Ronald Holshausen

provider/pact-jvm-provider-junit/README.md

@@ -157,7 +157,7 @@ be expanded in the expression. For this to work, just make your provider state m
 
 ### Using multiple classes for the state change methods
 
-If you have a large number of state change methods, you can split things up bu moving them to other classes. There are
+If you have a large number of state change methods, you can split things up by moving them to other classes. There are
 two ways you can do this:
 
 #### Use interfaces

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

@@ -65,6 +65,12 @@ For example, configure it by adding the following to your POM:
 
 Provider State Methods work in the same way as with JUnit 4 tests, refer to the [Pact junit runner](../pact-jvm-provider-junit/README.md) docs.
 
+### Using multiple classes for the state change methods
+
+If you have a large number of state change methods, you can split things up by moving them to other classes. You will 
+need to specify the additional classes on the test context in a `Before` method. Do this with the `withStateHandler` 
+or `setStateHandlers` methods. See [StateAnnotationsOnAdditionalClassTest](pact-jvm-provider-junit5/src/test/java/au/com/dius/pact/provider/junit5/StateAnnotationsOnAdditionalClassTest.java) for an example. 
+
 ## Modifying the requests before they are sent
 
 **Important Note:** You should only use this feature for things that can not be persisted in the pact file. By modifying

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

@@ -49,7 +49,7 @@ import kotlin.reflect.full.findAnnotation
  * The instance that holds the context for the test of an interaction. The test target will need to be set on it in
  * the before each phase of the test, and the verifyInteraction method must be called in the test template method.
  */
-data class PactVerificationContext(
+data class PactVerificationContext @JvmOverloads constructor(
   private val store: ExtensionContext.Store,
   private val context: ExtensionContext,
   var target: TestTarget = HttpTestTarget(port = 8080),
@@ -60,6 +60,7 @@ data class PactVerificationContext(
   val interaction: Interaction,
   internal var testExecutionResult: TestResult = TestResult.Ok
 ) {
+  val stateChangeHandlers: MutableList<Any> = mutableListOf()
   var executionContext: Map<String, Any>? = null
 
   /**
@@ -109,6 +110,15 @@ data class PactVerificationContext(
         interaction.description, failures)
     }
   }
+
+  fun withStateChangeHandlers(vararg stateClasses: Any): PactVerificationContext {
+    stateChangeHandlers.addAll(stateClasses)
+    return this
+  }
+
+  fun addStateChangeHandlers(vararg stateClasses: Any) {
+    stateChangeHandlers.addAll(stateClasses)
+  }
 }
 
 /**
@@ -265,7 +275,8 @@ class PactVerificationStateChangeExtension(
     val testContext = store.get("interactionContext") as PactVerificationContext
 
     try {
-      val providerStateContext = invokeStateChangeMethods(extensionContext, interaction.providerStates, StateChangeAction.SETUP)
+      val providerStateContext = invokeStateChangeMethods(extensionContext, testContext,
+        interaction.providerStates, StateChangeAction.SETUP)
       testContext.executionContext = mapOf("providerState" to providerStateContext)
     } catch (e: Exception) {
       logger.error(e) { "Provider state change callback failed" }
@@ -276,28 +287,33 @@ class PactVerificationStateChangeExtension(
 
   override fun afterTestExecution(context: ExtensionContext) {
     logger.debug { "afterEach for interaction '${interaction.description}'" }
-    invokeStateChangeMethods(context, interaction.providerStates, StateChangeAction.TEARDOWN)
+    val store = context.getStore(ExtensionContext.Namespace.create("pact-jvm"))
+    val testContext = store.get("interactionContext") as PactVerificationContext
+
+    invokeStateChangeMethods(context, testContext, interaction.providerStates, StateChangeAction.TEARDOWN)
   }
 
   private fun invokeStateChangeMethods(
     context: ExtensionContext,
+    testContext: PactVerificationContext,
     providerStates: List<ProviderState>,
     action: StateChangeAction
   ): Map<String, Any?> {
     val errors = mutableListOf<String>()
 
     val providerStateContext = mutableMapOf<String, Any?>()
     providerStates.forEach { state ->
-      val stateChangeMethods = findStateChangeMethods(context.requiredTestClass, state)
+      val stateChangeMethods = findStateChangeMethods(context.requiredTestInstance,
+        testContext.stateChangeHandlers, state)
       if (stateChangeMethods.isEmpty()) {
         errors.add("Did not find a test class method annotated with @State(\"${state.name}\")")
       } else {
-        stateChangeMethods.filter { it.second.action == action }.forEach { (method, _) ->
-          logger.debug { "Invoking state change method ${method.name} for state '${state.name}'" }
+        stateChangeMethods.filter { it.second.action == action }.forEach { (method, _, instance) ->
+          logger.debug { "Invoking state change method ${method.name} for state '${state.name}' on $instance" }
           val stateChangeValue = if (method.parameterCount > 0) {
-            ReflectionSupport.invokeMethod(method, context.requiredTestInstance, state.params)
+            ReflectionSupport.invokeMethod(method, instance, state.params)
           } else {
-            ReflectionSupport.invokeMethod(method, context.requiredTestInstance)
+            ReflectionSupport.invokeMethod(method, instance)
           }
 
           if (stateChangeValue is Map<*, *>) {
@@ -314,9 +330,20 @@ class PactVerificationStateChangeExtension(
     return providerStateContext
   }
 
-  private fun findStateChangeMethods(testClass: Class<*>, state: ProviderState): List<Pair<Method, State>> {
-    return AnnotationSupport.findAnnotatedMethods(testClass, State::class.java, HierarchyTraversalMode.TOP_DOWN)
-      .map { it to it.getAnnotation(State::class.java) }
+  private fun findStateChangeMethods(
+    testClass: Any,
+    stateChangeHandlers: List<Any>,
+    state: ProviderState
+  ): List<Triple<Method, State, Any>> {
+    val stateChangeClasses =
+      AnnotationSupport.findAnnotatedMethods(testClass.javaClass, State::class.java, HierarchyTraversalMode.TOP_DOWN)
+        .map { it to testClass }
+        .plus(stateChangeHandlers.flatMap { handler ->
+          AnnotationSupport.findAnnotatedMethods(handler.javaClass, State::class.java, HierarchyTraversalMode.TOP_DOWN)
+            .map { it to handler }
+        })
+    return stateChangeClasses
+      .map { Triple(it.first, it.first.getAnnotation(State::class.java), it.second) }
       .filter { it.second.value.any { s -> state.name == s } }
   }
 

provider/pact-jvm-provider-junit5/src/test/groovy/au/com/dius/pact/provider/junit5/PactVerificationStateChangeExtensionSpec.groovy

@@ -24,6 +24,9 @@ class PactVerificationStateChangeExtensionSpec extends Specification {
   Interaction interaction
   private TestResultAccumulator testResultAcc
   RequestResponsePact pact
+  private PactVerificationContext pactContext
+  private ExtensionContext testContext
+  private ExtensionContext.Store store
 
   static class TestClass {
 
@@ -53,11 +56,20 @@ class PactVerificationStateChangeExtensionSpec extends Specification {
     }
   }
 
+  private TestClass testInstance
+
   def setup() {
     interaction = new RequestResponseInteraction('test')
     pact = new RequestResponsePact(new Provider(), new Consumer(), [ interaction ])
     testResultAcc = Mock(TestResultAccumulator)
     verificationExtension = new PactVerificationStateChangeExtension(pact, interaction, testResultAcc)
+    testInstance = new TestClass()
+    testContext = [
+      'getTestClass': { Optional.of(TestClass) },
+      'getTestInstance': { Optional.of(testInstance) }
+    ] as ExtensionContext
+    store = [:] as ExtensionContext.Store
+    pactContext = new PactVerificationContext(store, testContext, 'test', interaction)
   }
 
   @Unroll
@@ -66,8 +78,7 @@ class PactVerificationStateChangeExtensionSpec extends Specification {
     def state = new ProviderState('test state')
 
     when:
-    verificationExtension.invokeStateChangeMethods(['getTestClass': { Optional.of(testClass) } ] as ExtensionContext,
-      [state], StateChangeAction.SETUP)
+    verificationExtension.invokeStateChangeMethods(testContext, pactContext, [state], StateChangeAction.SETUP)
 
     then:
     thrown(MissingStateChangeMethod)
@@ -80,16 +91,12 @@ class PactVerificationStateChangeExtensionSpec extends Specification {
   def 'invokes the state change method for the provider state'() {
     given:
     def state = new ProviderState('Test 2', [a: 'A', b: 'B'])
-    def testInstance = new TestClass()
 
     when:
     testInstance.state2Called = false
     testInstance.state2TeardownCalled = false
     testInstance.state3Called = null
-    verificationExtension.invokeStateChangeMethods([
-      'getTestClass': { Optional.of(TestClass) },
-      'getTestInstance': { Optional.of(testInstance) }
-    ] as ExtensionContext, [state], StateChangeAction.SETUP)
+    verificationExtension.invokeStateChangeMethods(testContext, pactContext, [state], StateChangeAction.SETUP)
 
     then:
     testInstance.state2Called

provider/pact-jvm-provider-junit5/src/test/java/au/com/dius/pact/provider/junit5/StateAnnotationsOnAdditionalClassTest.java

@@ -0,0 +1,44 @@
+package au.com.dius.pact.provider.junit5;
+
+import au.com.dius.pact.provider.junit.Provider;
+import au.com.dius.pact.provider.junit.loader.PactFolder;
+import com.github.tomakehurst.wiremock.WireMockServer;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestTemplate;
+import org.junit.jupiter.api.extension.ExtendWith;
+import ru.lanwen.wiremock.ext.WiremockResolver;
+import ru.lanwen.wiremock.ext.WiremockResolver.Wiremock;
+import ru.lanwen.wiremock.ext.WiremockUriResolver;
+import ru.lanwen.wiremock.ext.WiremockUriResolver.WiremockUri;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+@Provider("providerWithMultipleInteractions")
+@PactFolder("pacts")
+@ExtendWith({
+    WiremockResolver.class,
+    WiremockUriResolver.class
+})
+class StateAnnotationsOnAdditionalClassTest {
+
+  private WireMockServer server;
+
+  @TestTemplate
+  @ExtendWith(PactVerificationInvocationContextProvider.class)
+  void testTemplate(PactVerificationContext context) {
+    context.verifyInteraction();
+  }
+
+  @BeforeEach
+  void before(PactVerificationContext context, @Wiremock WireMockServer server,
+      @WiremockUri String uri) throws MalformedURLException {
+    this.server = server;
+    context.addStateChangeHandlers(new StateClass1(server), new StateClass2(server));
+    context.setTarget(HttpTestTarget.fromUrl(new URL(uri)));
+  }
+
+  public WireMockServer server() {
+    return this.server;
+  }
+}

provider/pact-jvm-provider-junit5/src/test/java/au/com/dius/pact/provider/junit5/StateClass1.java

@@ -0,0 +1,16 @@
+package au.com.dius.pact.provider.junit5;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+
+public class StateClass1 implements StateInterface1 {
+  private final WireMockServer server;
+
+  public StateClass1(WireMockServer server) {
+    this.server = server;
+  }
+
+  @Override
+  public WireMockServer server() {
+    return server;
+  }
+}

provider/pact-jvm-provider-junit5/src/test/java/au/com/dius/pact/provider/junit5/StateClass2.java

@@ -0,0 +1,16 @@
+package au.com.dius.pact.provider.junit5;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+
+public class StateClass2 implements StateInterface2 {
+  private final WireMockServer server;
+
+  public StateClass2(WireMockServer server) {
+    this.server = server;
+  }
+
+  @Override
+  public WireMockServer server() {
+    return server;
+  }
+}