feat: use a dummy test for JUnit 5 tests with IgnoreNoPactsToVerify annotation #768

Author: Ronald Holshausen

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

@@ -0,0 +1,35 @@
+package au.com.dius.pact.provider.junit5
+
+import au.com.dius.pact.core.model.Interaction
+import au.com.dius.pact.core.model.Pact
+import au.com.dius.pact.provider.ProviderVerifier
+import org.apache.http.HttpRequest
+import org.junit.jupiter.api.extension.Extension
+import org.junit.jupiter.api.extension.ExtensionContext
+import org.junit.jupiter.api.extension.ParameterContext
+import org.junit.jupiter.api.extension.ParameterResolver
+import org.junit.jupiter.api.extension.TestTemplateInvocationContext
+
+object DummyTestTemplate : TestTemplateInvocationContext, ParameterResolver {
+
+  override fun getDisplayName(invocationIndex: Int) = "No pacts found to verify"
+
+  override fun getAdditionalExtensions(): MutableList<Extension> {
+    return mutableListOf(this)
+  }
+
+  override fun supportsParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Boolean {
+    return when (parameterContext.parameter.type) {
+      Pact::class.java -> true
+      Interaction::class.java -> true
+      HttpRequest::class.java -> true
+      PactVerificationContext::class.java -> true
+      ProviderVerifier::class.java -> true
+      else -> false
+    }
+  }
+
+  override fun resolveParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Any? {
+    return null
+  }
+}

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

@@ -16,6 +16,7 @@ import au.com.dius.pact.provider.ProviderVerifier
 import au.com.dius.pact.provider.TestResultAccumulator
 import au.com.dius.pact.provider.junit.AllowOverridePactUrl
 import au.com.dius.pact.provider.junit.Consumer
+import au.com.dius.pact.provider.junit.IgnoreNoPactsToVerify
 import au.com.dius.pact.provider.junit.JUnitProviderTestSupport
 import au.com.dius.pact.provider.junit.JUnitProviderTestSupport.checkForOverriddenPactUrl
 import au.com.dius.pact.provider.junit.JUnitProviderTestSupport.filterPactsByAnnotations
@@ -24,6 +25,7 @@ import au.com.dius.pact.provider.junit.Provider
 import au.com.dius.pact.provider.junit.State
 import au.com.dius.pact.provider.junit.StateChangeAction
 import au.com.dius.pact.provider.junit.VerificationReports
+import au.com.dius.pact.provider.junit.loader.NoPactsFoundException
 import au.com.dius.pact.provider.junit.loader.PactLoader
 import au.com.dius.pact.provider.junit.loader.PactSource
 import au.com.dius.pact.provider.reporters.ReporterManager
@@ -357,9 +359,19 @@ class PactVerificationStateChangeExtension(
  * a test template method on a test class annotated with a @Provider annotation.
  */
 open class PactVerificationInvocationContextProvider : TestTemplateInvocationContextProvider {
+
   override fun provideTestTemplateInvocationContexts(context: ExtensionContext): Stream<TestTemplateInvocationContext> {
     logger.debug { "provideTestTemplateInvocationContexts called" }
+    val tests = resolvePactSources(context)
+    return when {
+      tests.isNotEmpty() -> tests.stream() as Stream<TestTemplateInvocationContext>
+      AnnotationSupport.isAnnotated(context.requiredTestClass, IgnoreNoPactsToVerify::class.java) ->
+        listOf(DummyTestTemplate).stream() as Stream<TestTemplateInvocationContext>
+      else -> throw NoPactsFoundException("No Pact files where found to verify")
+    }
+  }
 
+  private fun resolvePactSources(context: ExtensionContext): List<PactVerificationExtension> {
     val providerInfo = AnnotationSupport.findAnnotation(context.requiredTestClass, Provider::class.java)
     if (!providerInfo.isPresent) {
       throw UnsupportedOperationException("Provider name should be specified by using @${Provider::class.java.name} annotation")
@@ -382,15 +394,9 @@ open class PactVerificationInvocationContextProvider : TestTemplateInvocationCon
       filterPactsByAnnotations(pacts, context.requiredTestClass).map { pact -> pact to it.pactSource }
     }.filter { p -> consumerName == null || p.first.consumer.name == consumerName }
 
-    val tests = pactSources.flatMap { pact ->
+    return pactSources.flatMap { pact ->
       pact.first.interactions.map { PactVerificationExtension(pact.first, pact.second, it, serviceName, consumerName) }
     }
-
-    if (tests.isEmpty()) {
-      throw UnsupportedOperationException("No Pact files where found to verify")
-    }
-
-    return tests.stream() as Stream<TestTemplateInvocationContext>
   }
 
   protected open fun getValueResolver(context: ExtensionContext): ValueResolver? = null

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

@@ -2,8 +2,10 @@ package au.com.dius.pact.provider.junit5
 
 import au.com.dius.pact.core.model.Pact
 import au.com.dius.pact.provider.junit.Consumer
+import au.com.dius.pact.provider.junit.IgnoreNoPactsToVerify
 import au.com.dius.pact.provider.junit.Provider
 import au.com.dius.pact.provider.junit.State
+import au.com.dius.pact.provider.junit.loader.NoPactsFoundException
 import au.com.dius.pact.provider.junit.loader.PactFilter
 import au.com.dius.pact.provider.junit.loader.PactFolder
 import au.com.dius.pact.provider.junit.loader.PactFolderLoader
@@ -40,13 +42,18 @@ class PactVerificationInvocationContextProviderSpec extends Specification {
     Target target
   }
 
-  static class InvalidStateChangeTestClass {
+  @Provider('myAwesomeService')
+  @Consumer('doesNotExist')
+  @PactFolder('pacts')
+  @IgnoreNoPactsToVerify
+  static class TestClassWithNoPactsWithIgnore {
+    @TestTarget
+    Target target
+  }
 
+  static class InvalidStateChangeTestClass {
     @State('one')
-    protected void incorrectStateChangeParameters(int one, String two, Map three) {
-
-    }
-
+    protected void incorrectStateChangeParameters(int one, String two, Map three) { }
   }
 
   static class InvalidStateChangeTestClass2 extends InvalidStateChangeTestClass {
@@ -166,10 +173,22 @@ class PactVerificationInvocationContextProviderSpec extends Specification {
     } ] as ExtensionContext)
 
     then:
-    def exp = thrown(UnsupportedOperationException)
+    def exp = thrown(NoPactsFoundException)
     exp.message == 'No Pact files where found to verify'
   }
 
+  @Issue('#768')
+  def 'returns a dummy test if there are no pacts to verify and IgnoreNoPactsToVerify is present'() {
+    when:
+    def result = provider.provideTestTemplateInvocationContexts(['getTestClass': {
+      Optional.of(TestClassWithNoPactsWithIgnore)
+    } ] as ExtensionContext).iterator().toList()
+
+    then:
+    result.size() == 1
+    result.first() instanceof DummyTestTemplate
+  }
+
   @Unroll
   def 'throws an exception if there are invalid state change methods'() {
     when: