Have multiple test cases be run by template

Author: timvahlbrock

consumer/junit5/src/main/kotlin/au/com/dius/pact/consumer/junit5/AsynchronousMessageContext.kt

@@ -6,4 +6,7 @@ import org.junit.jupiter.api.extension.TestTemplateInvocationContext
 class AsynchronousMessageContext(
     val message: V4Interaction.AsynchronousMessage
 ): TestTemplateInvocationContext {
+    override fun getDisplayName(invocationIndex: Int): String {
+        return message.description
+    }
 }

consumer/junit5/src/main/kotlin/au/com/dius/pact/consumer/junit5/PactConsumerTestExt.kt

@@ -30,6 +30,7 @@ import au.com.dius.pact.core.support.expressions.DataType
 import au.com.dius.pact.core.support.expressions.ExpressionParser
 import au.com.dius.pact.core.support.isNotEmpty
 import io.github.oshai.kotlinlogging.KLogging
+import org.apache.hc.core5.util.ReflectionUtils
 import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.api.Nested
 import org.junit.jupiter.api.TestTemplate
@@ -268,36 +269,38 @@ class PactConsumerTestExt : Extension, BeforeTestExecutionCallback, BeforeAllCal
   ): BasePact {
     val store = context.getStore(NAMESPACE)
     val key = "pact:${providerInfo.providerName}"
+    var methods = pactMethods
+    if (methods.isEmpty()) {
+      methods = AnnotationSupport.findAnnotatedMethods(context.requiredTestClass, Pact::class.java, HierarchyTraversalMode.TOP_DOWN)
+              .map { m -> m.name}
+    }
+
     return when {
       store[key] != null -> store[key] as BasePact
       else -> {
-        val pact = if (pactMethods.isEmpty()) {
-          lookupPact(providerInfo, "", context)
-        } else {
-          val head = pactMethods.first()
-          val tail = pactMethods.drop(1)
-          val initial = lookupPact(providerInfo, head, context)
-          tail.fold(initial) { acc, method ->
-            val pact = lookupPact(providerInfo, method, context)
-
-            if (pact.provider != acc.provider) {
-              // Should not really get here, as the Pacts should have been sorted by provider
-              throw IllegalArgumentException("You are using different Pacts with different providers for the same test" +
-                " ('${acc.provider}') and '${pact.provider}'). A separate test (and ideally a separate test class)" +
-                " should be used for each provider.")
-            }
+        val head = methods.first()
+        val tail = methods.drop(1)
+        val initial = lookupPact(providerInfo, head, context)
+        val pact = tail.fold(initial) { acc, method ->
+          val pact = lookupPact(providerInfo, method, context)
+
+          if (pact.provider != acc.provider) {
+            // Should not really get here, as the Pacts should have been sorted by provider
+            throw IllegalArgumentException("You are using different Pacts with different providers for the same test" +
+              " ('${acc.provider}') and '${pact.provider}'). A separate test (and ideally a separate test class)" +
+              " should be used for each provider.")
+          }
 
-            if (pact.consumer != acc.consumer) {
-              logger.warn {
-                "WARNING: You are using different Pacts with different consumers for the same test " +
-                  "('${acc.consumer}') and '${pact.consumer}'). The second consumer will be ignored and dropped from " +
-                  "the Pact and the interactions merged. If this is not your intention, you need to create a " +
-                  "separate test for each consumer."
-              }
+          if (pact.consumer != acc.consumer) {
+            logger.warn {
+              "WARNING: You are using different Pacts with different consumers for the same test " +
+                "('${acc.consumer}') and '${pact.consumer}'). The second consumer will be ignored and dropped from " +
+                "the Pact and the interactions merged. If this is not your intention, you need to create a " +
+                "separate test for each consumer."
             }
-
-            acc.mergeInteractions(pact.interactions) as BasePact
           }
+
+          acc.mergeInteractions(pact.interactions) as BasePact
         }
         store.put(key, pact)
         pact

consumer/junit5/src/test/kotlin/au/com/dius/pact/consumer/junit5/TestTemplateTest.kt

@@ -0,0 +1,62 @@
+package au.com.dius.pact.consumer.junit5
+
+import au.com.dius.pact.consumer.dsl.LambdaDsl.newJsonBody
+import au.com.dius.pact.consumer.dsl.PactBuilder
+import au.com.dius.pact.core.model.PactSpecVersion
+import au.com.dius.pact.core.model.V4Interaction
+import au.com.dius.pact.core.model.V4Pact
+import au.com.dius.pact.core.model.annotations.Pact
+import org.hamcrest.MatcherAssert.assertThat
+import org.hamcrest.Matchers.equalTo
+import org.hamcrest.Matchers.`is`
+import org.hamcrest.Matchers.notNullValue
+import org.junit.jupiter.api.TestTemplate
+import org.junit.jupiter.api.extension.ExtendWith
+
+@ExtendWith(value = [PactConsumerTestExt::class])
+@PactTestFor(providerName = "checkout-service", providerType = ProviderType.ASYNCH, pactVersion = PactSpecVersion.V4)
+class TestTemplateTest {
+  companion object {
+    private val reservationBody = newJsonBody { o ->
+      o.stringType("purchaseId", "111")
+      o.stringType("name", "PURCHASE_STARTED")
+      o.eachLike("products", 1) { items ->
+        items.stringType("productID", "1")
+        items.stringType("productType", "FLIGHT")
+        items.stringType("availabilityId", "28e80c5987c6a242516ccdc004235b5e")
+      }
+    }.build()
+
+    private val cancelationBody = newJsonBody { o ->
+      o.stringType("purchaseId", "111")
+      o.stringType("reason", "user canceled")
+    }.build()
+
+    @JvmStatic
+    @Pact(consumer = "reservation-service", provider = "checkout-service")
+    fun pactForReservationBooking(builder: PactBuilder): V4Pact {
+      return builder
+              .usingLegacyMessageDsl()
+              .hasPactWith("checkout-service")
+              .expectsToReceive("a purchase started message to book a reservation")
+              .withContent(reservationBody)
+              .toPact()
+    }
+
+    @JvmStatic
+    @Pact(consumer = "reservation-service", provider = "checkout-service")
+    fun pactForCancellationBooking(builder: PactBuilder): V4Pact {
+      return builder
+              .usingLegacyMessageDsl()
+              .hasPactWith("checkout-service")
+              .expectsToReceive("a cancellation message to cancel a reservation")
+              .withContent(cancelationBody)
+              .toPact()
+    }
+  }
+
+  @TestTemplate
+  fun testPactForReservationBooking(message: V4Interaction.AsynchronousMessage) {
+    assertThat(message, `is`(notNullValue()))
+  }
+}