fix: add more information to exception when there are no pacts to verify #1039

Author: Ronald Holshausen

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

@@ -7,6 +7,7 @@ import au.com.dius.pact.core.model.RequestResponseInteraction
 import au.com.dius.pact.core.pactbroker.TestResult
 import au.com.dius.pact.core.support.expressions.SystemPropertyResolver
 import au.com.dius.pact.core.support.expressions.ValueResolver
+import au.com.dius.pact.core.support.isNotEmpty
 import au.com.dius.pact.provider.ConsumerInfo
 import au.com.dius.pact.provider.DefaultTestResultAccumulator
 import au.com.dius.pact.provider.IProviderVerifier
@@ -364,28 +365,34 @@ open class PactVerificationInvocationContextProvider : TestTemplateInvocationCon
     logger.debug { "provideTestTemplateInvocationContexts called" }
     val tests = resolvePactSources(context)
     return when {
-      tests.isNotEmpty() -> tests.stream() as Stream<TestTemplateInvocationContext>
+      tests.first.isNotEmpty() -> tests.first.stream() as Stream<TestTemplateInvocationContext>
       AnnotationSupport.isAnnotated(context.requiredTestClass, IgnoreNoPactsToVerify::class.java) ->
         listOf(DummyTestTemplate).stream() as Stream<TestTemplateInvocationContext>
-      else -> throw NoPactsFoundException("No Pact files were found to verify")
+      else -> throw NoPactsFoundException("No Pact files were found to verify\n${tests.second}")
     }
   }
 
-  private fun resolvePactSources(context: ExtensionContext): List<PactVerificationExtension> {
+  private fun resolvePactSources(context: ExtensionContext): Pair<List<PactVerificationExtension>, String> {
+    var description = ""
     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")
     }
     val serviceName = providerInfo.get().value
+    description += "Provider: $serviceName"
 
     val consumerInfo = AnnotationSupport.findAnnotation(context.requiredTestClass, Consumer::class.java)
     val consumerName = consumerInfo.orElse(null)?.value
+    if (consumerName.isNotEmpty()) {
+      description += "\nConsumer: $consumerName"
+    }
 
     validateStateChangeMethods(context.requiredTestClass)
 
     logger.debug { "Verifying pacts for provider '$serviceName' and consumer '$consumerName'" }
 
     val pactSources = findPactSources(context).flatMap {
+      description += "\nSource: ${it.description()}"
       val valueResolver = getValueResolver(context)
       if (valueResolver != null) {
         it.setValueResolver(valueResolver)
@@ -394,9 +401,9 @@ open class PactVerificationInvocationContextProvider : TestTemplateInvocationCon
       filterPactsByAnnotations(pacts, context.requiredTestClass).map { pact -> pact to it.pactSource }
     }.filter { p -> consumerName == null || p.first.consumer.name == consumerName }
 
-    return pactSources.flatMap { pact ->
+    return Pair(pactSources.flatMap { pact ->
       pact.first.interactions.map { PactVerificationExtension(pact.first, pact.second, it, serviceName, consumerName) }
-    }
+    }, description)
   }
 
   protected open fun getValueResolver(context: ExtensionContext): ValueResolver? = null

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

@@ -174,7 +174,7 @@ class PactVerificationInvocationContextProviderSpec extends Specification {
 
     then:
     def exp = thrown(NoPactsFoundException)
-    exp.message == 'No Pact files where found to verify'
+    exp.message.startsWith('No Pact files were found to verify')
   }
 
   @Issue('#768')

provider/pact-jvm-provider/src/main/java/au/com/dius/pact/provider/junit/loader/PactLoader.java

@@ -30,4 +30,9 @@ public interface PactLoader {
    * @param valueResolver Value Resolver
    */
   default void setValueResolver(ValueResolver valueResolver) { }
+
+  /**
+   * Returns a description of this pact loader
+   */
+  default String description() { return this.getClass().getSimpleName(); };
 }

provider/pact-jvm-provider/src/main/java/au/com/dius/pact/provider/junit/loader/PactUrlLoader.java

@@ -30,6 +30,11 @@ public PactUrlLoader(final PactUrl pactUrl) {
         this(pactUrl.urls());
     }
 
+  @Override
+  public String description() {
+    return "URL(" + Arrays.toString(urls) + ")";
+  }
+
   public List<Pact> load(final String providerName) {
       return Arrays.stream(urls)
         .map(url -> {

provider/pact-jvm-provider/src/main/kotlin/au/com/dius/pact/provider/junit/loader/PactBrokerLoader.kt

@@ -55,6 +55,20 @@ open class PactBrokerLoader(
     pactBroker.valueResolver
   )
 
+  override fun description(): String {
+    val resolver = setupValueResolver()
+    val tags = pactBrokerTags?.flatMap { parseListExpression(it, resolver) }?.filter { it.isNotEmpty() }
+    val consumers = pactBrokerConsumers.flatMap { parseListExpression(it, resolver) }.filter { it.isNotEmpty() }
+    var source = getPactBrokerSource(resolver).description()
+    if (tags != null && tags.isNotEmpty()) {
+      source += " tags=$tags"
+    }
+    if (consumers.isNotEmpty()) {
+      source += " consumers=$consumers"
+    }
+    return source
+  }
+
   override fun overridePactUrl(pactUrl: String, consumer: String) {
     overriddenPactUrl = pactUrl
     overriddenConsumer = consumer
@@ -177,7 +191,7 @@ open class PactBrokerLoader(
 
   private fun getUrlForProvider(providerName: String, tag: String, pactBrokerClient: PactBrokerClient): String {
     return try {
-      pactBrokerClient.getUrlForProvider(providerName, tag)!!
+      pactBrokerClient.getUrlForProvider(providerName, tag) ?: "Unknown"
     } catch (e: Exception) {
       logger.debug(e) { "Failed to get provider URL from the pact broker" }
       "Unknown"

provider/pact-jvm-provider/src/main/kotlin/au/com/dius/pact/provider/junit/loader/PactFolderLoader.kt

@@ -22,6 +22,8 @@ class PactFolderLoader<I>(private val path: File) : PactLoader where I : Interac
 
   constructor(pactFolder: PactFolder) : this(pactFolder.value)
 
+  override fun description() = "Directory(${pactSource.dir})"
+
   override fun load(providerName: String): List<Pact<I>> {
     val pacts = mutableListOf<Pact<I>>()
     val pactFolder = resolvePath()