feat: support handling output from verification via plugins

core/support/src/main/kotlin/au/com/dius/pact/core/support/json/JsonValue.kt

@@ -63,6 +63,10 @@ sealed class JsonValue {
     fun append(value: JsonValue) {
       values.add(value)
     }
+
+    fun appendAll(list: List<JsonValue>) {
+      values.addAll(list)
+    }
   }
 
   class Object @JvmOverloads constructor (val entries: MutableMap<String, JsonValue> = mutableMapOf()) : JsonValue() {

gradle.properties

@@ -17,4 +17,4 @@ junit5Version=5.8.2
 bytebuddyVersion=1.12.7
 kotlinLogging=2.0.10
 kotlinResult=1.1.12
-pluginDriverVersion=0.1.2
+pluginDriverVersion=0.1.3

provider/junit/src/main/kotlin/au/com/dius/pact/provider/junit/InteractionRunner.kt

@@ -156,7 +156,7 @@ open class InteractionRunner(
     for (interaction in pact.interactions) {
       val description = describeChild(interaction)
       val interactionId = interaction.interactionId
-      var testResult: VerificationResult = VerificationResult.Ok(interactionId)
+      var testResult: VerificationResult = VerificationResult.Ok(interactionId, emptyList())
       val pending = when {
         interaction.isV4() && interaction.asV4Interaction().pending -> true
         pact.source is BrokerUrlSource -> (pact.source as BrokerUrlSource).result?.pending == true

provider/junit5/src/main/kotlin/au/com/dius/pact/provider/junit5/PactVerificationContext.kt

@@ -55,9 +55,11 @@ data class PactVerificationContext @JvmOverloads constructor(
     val testContext = store.get("interactionContext") as PactVerificationContext
     try {
       Metrics.sendMetrics(MetricEvent.ProviderVerificationRan(1, "junit5"))
+
       val result = validateTestExecution(client, request, testContext.executionContext ?: mutableMapOf())
-        .filterIsInstance<VerificationResult.Failed>()
-      this.testExecutionResult.addAll(result)
+      verifier!!.displayOutput(result.flatMap { it.getResultOutput() })
+
+      this.testExecutionResult.addAll(result.filterIsInstance<VerificationResult.Failed>())
       if (testExecutionResult.isNotEmpty()) {
         verifier!!.displayFailures(testExecutionResult)
         if (testExecutionResult.any { !it.pending }) {

provider/spring/src/main/kotlin/au/com/dius/pact/provider/spring/target/MockTestingTarget.kt

@@ -91,7 +91,7 @@ abstract class MockTestingTarget(
       callVerifierFn(provider, consumer, verifier, failures)
     }
 
-    val initial = VerificationResult.Ok(interaction.interactionId)
+    val initial = VerificationResult.Ok(interaction.interactionId, emptyList())
     val result = results.fold(initial) { acc: VerificationResult, r -> acc.merge(r) }
 
     reportTestResult(result, verifier)

provider/src/main/kotlin/au/com/dius/pact/provider/ProviderVerifier.kt

@@ -302,6 +302,11 @@ interface IProviderVerifier {
     context: Map<String, Any>
   ): VerificationResult
 
+  /**
+   * Display any output to the user
+   */
+  fun displayOutput(output: List<String>)
+
   /**
    * Source of the verification (Gradle/Maven/Junit)
    */
@@ -397,7 +402,7 @@ open class ProviderVerifier @JvmOverloads constructor (
             failures, pending)
         } else {
           val expectedResponse = (interaction as SynchronousRequestResponse).response
-          var result: VerificationResult = VerificationResult.Ok(interactionId)
+          var result: VerificationResult = VerificationResult.Ok(interactionId, emptyList())
           methodsAnnotatedWith.forEach {
             val response = invokeProviderMethod(it, null) as Map<String, Any>
             val body = OptionalBody.body(response["data"] as String?)
@@ -512,7 +517,7 @@ open class ProviderVerifier @JvmOverloads constructor (
   ): VerificationResult {
     return if (comparison is Ok && comparison.value.mismatches.isEmpty()) {
       emitEvent(Event.BodyComparisonOk)
-      VerificationResult.Ok(interactionId)
+      VerificationResult.Ok(interactionId, emptyList())
     } else {
       emitEvent(Event.BodyComparisonFailed(comparison))
       val description = "$comparisonDescription has a matching body"
@@ -540,7 +545,7 @@ open class ProviderVerifier @JvmOverloads constructor (
     pending: Boolean
   ): VerificationResult {
     val interactionId = message.interactionId
-    var result: VerificationResult = VerificationResult.Ok(interactionId)
+    var result: VerificationResult = VerificationResult.Ok(interactionId, emptyList())
     methods.forEach { method ->
       val messageFactory: Function<String, Any> =
         Function { invokeProviderMethod(method, providerMethodInstance.apply(method))!! }
@@ -620,7 +625,7 @@ open class ProviderVerifier @JvmOverloads constructor (
   ): VerificationResult {
     return if (comparison.isEmpty()) {
       emitEvent(Event.MetadataComparisonOk())
-      VerificationResult.Ok(interactionId)
+      VerificationResult.Ok(interactionId, emptyList())
     } else {
       emitEvent(Event.IncludesMetadata)
       var result: VerificationResult = VerificationResult.Failed("Metadata had differences",
@@ -773,7 +778,7 @@ open class ProviderVerifier @JvmOverloads constructor (
   ): VerificationResult {
     return if (mismatch == null) {
       reporters.forEach { it.statusComparisonOk(status) }
-      VerificationResult.Ok(interactionId)
+      VerificationResult.Ok(interactionId, emptyList())
     } else {
       reporters.forEach { it.statusComparisonFailed(status, mismatch.description()) }
       val description = "$comparisonDescription: has status code $status"
@@ -791,7 +796,7 @@ open class ProviderVerifier @JvmOverloads constructor (
     interactionId: String,
     pending: Boolean
   ): VerificationResult {
-    val ok = VerificationResult.Ok(interactionId)
+    val ok = VerificationResult.Ok(interactionId, emptyList())
     return if (headers.isEmpty()) {
       ok
     } else {
@@ -965,7 +970,7 @@ open class ProviderVerifier @JvmOverloads constructor (
       interaction
     )) {
       is Ok -> if (result.value.ok) {
-        VerificationResult.Ok(interaction.interactionId)
+        VerificationResult.Ok(interaction.interactionId, result.value.output)
       } else {
         VerificationResult.Failed("Verification via plugin failed", "Verification Failed",
           mapOf(interaction.interactionId.orEmpty() to
@@ -976,14 +981,18 @@ open class ProviderVerifier @JvmOverloads constructor (
                   BodyMismatch(it.expected, it.actual, it.mismatch, it.path)
                 )
               }
-            })
+            }), output = result.value.output
         )
       }
       is Err -> VerificationResult.Failed("Verification via plugin failed",
         "Verification Failed - ${result.error}")
     }
   }
 
+  override fun displayOutput(output: List<String>) {
+    emitEvent(Event.DisplayUserOutput(output))
+  }
+
   @Suppress("TooGenericExceptionCaught", "TooGenericExceptionThrown")
   fun loadPactFileForConsumer(consumer: IConsumerInfo): Pact {
     var pactSource = consumer.resolvePactSource()

provider/src/main/kotlin/au/com/dius/pact/provider/VerificationResult.kt

@@ -119,13 +119,18 @@ sealed class VerificationResult {
   /**
    * Result was successful
    */
-  data class Ok @JvmOverloads constructor(val interactionIds: Set<String> = emptySet()) : VerificationResult() {
+  data class Ok @JvmOverloads constructor(
+    val interactionIds: Set<String> = emptySet(),
+    val output: List<String> = emptyList()
+  ) : VerificationResult() {
 
-    constructor(interactionId: String?) : this(if (interactionId.isNullOrEmpty())
-      emptySet() else setOf(interactionId))
+    constructor(
+      interactionId: String?,
+      output: List<String>
+    ) : this(if (interactionId.isNullOrEmpty()) emptySet() else setOf(interactionId), output)
 
     override fun merge(result: VerificationResult) = when (result) {
-      is Ok -> this.copy(interactionIds = interactionIds + result.interactionIds)
+      is Ok -> this.copy(interactionIds = interactionIds + result.interactionIds, output = output + result.output)
       is Failed -> result.merge(this)
     }
 
@@ -141,19 +146,21 @@ sealed class VerificationResult {
     val failures: VerificationFailures = mapOf(),
     val pending: Boolean = false,
     @Deprecated("use failures instead")
-    var results: List<Map<String, Any?>> = emptyList()
+    var results: List<Map<String, Any?>> = emptyList(),
+    val output: List<String> = emptyList()
   ) : VerificationResult() {
     override fun merge(result: VerificationResult) = when (result) {
       is Ok -> this.copy(failures = failures + result.interactionIds
         .associateWith {
           (if (failures.containsKey(it)) failures[it] else emptyList<VerificationFailureType>())!!
-        })
+        }, output = output + result.output)
       is Failed -> Failed(when {
         description.isNotEmpty() && result.description.isNotEmpty() && description != result.description ->
           "$description, ${result.description}"
         description.isNotEmpty() -> description
         else -> result.description
-      }, verificationDescription, mergeFailures(failures, result.failures), pending && result.pending)
+      }, verificationDescription, mergeFailures(failures, result.failures),
+        pending && result.pending, output = output + result.output)
     }
 
     private fun mergeFailures(failures: VerificationFailures, other: VerificationFailures): VerificationFailures {
@@ -209,4 +216,14 @@ sealed class VerificationResult {
    * Convert to a test result
    */
   abstract fun toTestResult(): TestResult
+
+  /**
+   * Return any output for the result
+   */
+  fun getResultOutput(): List<String> {
+    return when (this) {
+      is Failed -> this.output
+      is Ok -> this.output
+    }
+  }
 }

provider/src/main/kotlin/au/com/dius/pact/provider/reporters/AnsiConsoleReporter.kt

@@ -318,6 +318,9 @@ class AnsiConsoleReporter(
   override fun receive(event: Event) {
     when (event) {
       is Event.DisplayInteractionComments -> displayComments(event)
+      is Event.DisplayUserOutput -> for (line in event.output) {
+        println(line)
+      }
       else -> super.receive(event)
     }
   }

provider/src/main/kotlin/au/com/dius/pact/provider/reporters/Events.kt

@@ -17,4 +17,9 @@ sealed class Event {
   data class MetadataComparisonFailed(val key: String, val value: Any?, val comparison: Any): Event()
   data class InteractionDescription(val interaction: Interaction): Event()
   data class DisplayInteractionComments(val comments: Map<String, JsonValue>) : Event()
+
+  /**
+   * Output to display to the user
+   */
+  class DisplayUserOutput(val output: List<String>) : Event()
 }

provider/src/main/kotlin/au/com/dius/pact/provider/reporters/JsonReporter.kt

@@ -305,6 +305,16 @@ class JsonReporter(
       is Event.DisplayInteractionComments ->
         jsonData["execution"].asArray()!!.last()["consumer"].asObject()!!["comments"] =
           JsonValue.Object(event.comments.toMutableMap())
+      is Event.DisplayUserOutput -> {
+        val consumer = jsonData["execution"].asArray()!!.last()["consumer"].asObject()!!
+        val outputJson = event.output.map { JsonValue.StringValue(it) }
+
+        if (!consumer.has("output")) {
+          consumer["output"] = JsonValue.Array(outputJson.toMutableList())
+        } else {
+          consumer["output"].asArray()!!.appendAll(outputJson)
+        }
+      }
       else -> super.receive(event)
     }
   }

provider/src/main/kotlin/au/com/dius/pact/provider/reporters/MarkdownReporter.kt

@@ -533,6 +533,7 @@ class MarkdownReporter(
   override fun receive(event: Event) {
     when (event) {
       is Event.DisplayInteractionComments -> events.add(MREvent("displayComments", displayComments(event)))
+      is Event.DisplayUserOutput -> events.add(MREvent("displayOutput", event.output.joinToString("\n")))
       else -> super.receive(event)
     }
   }

provider/src/main/kotlin/au/com/dius/pact/provider/reporters/SLF4JReporter.kt

@@ -322,6 +322,7 @@ class SLF4JReporter(
   override fun receive(event: Event) {
     when (event) {
       is Event.DisplayInteractionComments -> displayComments(event)
+      is Event.DisplayUserOutput -> log.info(event.output.joinToString("\n"))
       else -> super.receive(event)
     }
   }

provider/src/main/kotlin/au/com/dius/pact/provider/reporters/VerifierReporter.kt

@@ -100,6 +100,7 @@ abstract class BaseVerifierReporter: VerifierReporter {
       is Event.MetadataComparisonFailed -> metadataComparisonFailed(event.key, event.value, event.comparison)
       is Event.InteractionDescription -> interactionDescription(event.interaction)
       is Event.DisplayInteractionComments -> {}
+      else -> {}
     }
   }
 }

provider/src/test/groovy/au/com/dius/pact/provider/VerificationResultSpec.groovy

@@ -21,22 +21,22 @@ class VerificationResultSpec extends Specification {
 
     where:
 
-    result1                        | result2                        | result3
-    new VerificationResult.Ok()    | new VerificationResult.Ok()    | new VerificationResult.Ok()
-    new VerificationResult.Ok()    | failed([error1], '')           | failed([error1], '')
-    failed([error1], '')           | new VerificationResult.Ok()    | failed([error1], '')
-    failed([error1], '')           | failed([error2], '')           | failed([error1, error2], '')
-    failed([error1], 'A')          | failed([error2], '')           | failed([error1, error2], 'A')
-    failed([error1], '')           | failed([error2], 'B')          | failed([error1, error2], 'B')
-    failed([error1], 'A')          | failed([error2], 'B')          | failed([error1, error2], 'A, B')
-    failed([error1], 'A')          | failed([error2], 'A')          | failed([error1, error2], 'A')
-    failed([error1], 'A')          | failed([error2], 'A')          | failed([error1, error2], 'A')
-    failed([error1], '', true)     | failed([error2], 'A', true)    | failed([error1, error2], 'A', true)
-    failed([error1], '', true)     | failed([error2], 'A', false)   | failed([error1, error2], 'A', false)
-    failed(['1': [error1]], '')    | new VerificationResult.Ok('1') | failed(['1': [error1]], '')
-    failed(['1': [error1]], '')    | new VerificationResult.Ok('2') | failed(['1': [error1], '2': []], '')
-    new VerificationResult.Ok('1') | failed(['1': [error1]], '')    | failed(['1': [error1]], '')
-    new VerificationResult.Ok('2') | failed(['1': [error1]], '')    | failed(['1': [error1], '2': []], '')
+    result1                            | result2                            | result3
+    new VerificationResult.Ok()        | new VerificationResult.Ok()        | new VerificationResult.Ok()
+    new VerificationResult.Ok()        | failed([error1], '')               | failed([error1], '')
+    failed([error1], '')               | new VerificationResult.Ok()        | failed([error1], '')
+    failed([error1], '')               | failed([error2], '')               | failed([error1, error2], '')
+    failed([error1], 'A')              | failed([error2], '')               | failed([error1, error2], 'A')
+    failed([error1], '')               | failed([error2], 'B')              | failed([error1, error2], 'B')
+    failed([error1], 'A')              | failed([error2], 'B')              | failed([error1, error2], 'A, B')
+    failed([error1], 'A')              | failed([error2], 'A')              | failed([error1, error2], 'A')
+    failed([error1], 'A')              | failed([error2], 'A')              | failed([error1, error2], 'A')
+    failed([error1], '', true)         | failed([error2], 'A', true)        | failed([error1, error2], 'A', true)
+    failed([error1], '', true)         | failed([error2], 'A', false)       | failed([error1, error2], 'A', false)
+    failed(['1': [error1]], '')        | new VerificationResult.Ok('1', []) | failed(['1': [error1]], '')
+    failed(['1': [error1]], '')        | new VerificationResult.Ok('2', []) | failed(['1': [error1], '2': []], '')
+    new VerificationResult.Ok('1', []) | failed(['1': [error1]], '')        | failed(['1': [error1]], '')
+    new VerificationResult.Ok('2', []) | failed(['1': [error1]], '')        | failed(['1': [error1], '2': []], '')
   }
 
   def 'convert to TestResult - Exception'() {