fix: JSON reporter was generated incorrect failure JSON #980

Author: Ronald Holshausen

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

@@ -18,6 +18,7 @@ import au.com.dius.pact.core.model.Response
 import au.com.dius.pact.core.model.isNullOrEmpty
 import au.com.dius.pact.core.model.messaging.Message
 import au.com.dius.pact.core.support.Json
+import com.github.salomonbrys.kotson.jsonObject
 import com.google.gson.JsonParser
 import mu.KLogging
 import org.apache.http.entity.ContentType
@@ -26,7 +27,12 @@ import java.nio.charset.Charset
 data class BodyComparisonResult(
   val mismatches: Map<String, List<BodyMismatch>> = emptyMap(),
   val diff: List<String> = emptyList()
-)
+) {
+  fun toJson() = jsonObject(
+    "mismatches" to Json.toJson(mismatches.mapValues { entry -> entry.value.map { it.description() } }),
+    "diff" to diff.joinToString("\n")
+  )
+}
 
 data class ComparisonResult(
   val statusMismatch: StatusMismatch? = null,

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

@@ -1,5 +1,8 @@
 package au.com.dius.pact.provider.reporters
 
+import arrow.core.Either
+import au.com.dius.pact.core.matchers.BodyTypeMismatch
+import au.com.dius.pact.core.matchers.HeaderMismatch
 import au.com.dius.pact.core.model.BasePact
 import au.com.dius.pact.core.model.FileSource
 import au.com.dius.pact.core.model.Interaction
@@ -10,6 +13,7 @@ import au.com.dius.pact.core.model.UrlPactSource
 import au.com.dius.pact.core.support.Json
 import au.com.dius.pact.core.support.hasProperty
 import au.com.dius.pact.core.support.property
+import au.com.dius.pact.provider.BodyComparisonResult
 import au.com.dius.pact.provider.IConsumerInfo
 import au.com.dius.pact.provider.IProviderInfo
 import com.github.salomonbrys.kotson.array
@@ -19,6 +23,7 @@ import com.github.salomonbrys.kotson.jsonObject
 import com.github.salomonbrys.kotson.obj
 import com.github.salomonbrys.kotson.set
 import com.github.salomonbrys.kotson.string
+import com.github.salomonbrys.kotson.toJson
 import com.google.gson.JsonObject
 import com.google.gson.JsonParser
 import org.apache.commons.lang3.exception.ExceptionUtils
@@ -191,15 +196,27 @@ class JsonReporter(
     if (!verification.has("header")) {
       verification["header"] = jsonObject()
     }
-    verification["header"].obj[key] = Json.toJson(comparison)
+    verification["header"].obj[key] = when (comparison) {
+      is List<*> -> Json.toJson(comparison.map {
+        when (it) {
+          is HeaderMismatch -> it.mismatch.toJson()
+          else -> Json.toJson(it)
+        }
+      })
+      else -> Json.toJson(comparison)
+    }
   }
 
   override fun bodyComparisonOk() { }
 
   override fun bodyComparisonFailed(comparison: Any) {
     val verification = jsonData["execution"].array.last()["interactions"].array.last()["verification"].obj
     verification["result"] = FAILED
-    verification["body"] = Json.toJson(comparison)
+    verification["body"] = when (comparison) {
+      is Either.Left<*> -> Json.toJson((comparison as Either.Left<BodyTypeMismatch>).a.description())
+      is Either.Right<*> -> (comparison as Either.Right<BodyComparisonResult>).b.toJson()
+      else -> Json.toJson(comparison)
+    }
   }
 
   override fun errorHasNoAnnotatedMethodsFoundForInteraction(interaction: Interaction) {
@@ -239,7 +256,7 @@ class JsonReporter(
   override fun metadataComparisonOk() { }
 
   companion object {
-    const val REPORT_FORMAT = "0.0.0"
+    const val REPORT_FORMAT = "0.1.0"
     const val FAILED = "failed"
   }
 }

provider/pact-jvm-provider/src/test/groovy/au/com/dius/pact/provider/reporters/JsonReporterSpec.groovy

@@ -1,15 +1,20 @@
 package au.com.dius.pact.provider.reporters
 
+import arrow.core.Either
+import au.com.dius.pact.core.matchers.BodyMismatch
+import au.com.dius.pact.core.matchers.HeaderMismatch
 import au.com.dius.pact.core.model.Request
 import au.com.dius.pact.core.model.RequestResponseInteraction
 import au.com.dius.pact.core.model.Response
+import au.com.dius.pact.provider.BodyComparisonResult
 import au.com.dius.pact.provider.ConsumerInfo
 import au.com.dius.pact.provider.ProviderInfo
+import com.google.gson.JsonParser
 import groovy.json.JsonOutput
 import groovy.json.JsonSlurper
 import spock.lang.Specification
 
-@SuppressWarnings('UnnecessaryObjectReferences')
+@SuppressWarnings(['UnnecessaryObjectReferences', 'LineLength'])
 class JsonReporterSpec extends Specification {
 
   private File reportDir
@@ -105,4 +110,82 @@ class JsonReporterSpec extends Specification {
     reportJson.execution.first().interactions.first().interaction.description == 'Interaction 1'
   }
 
+  def 'generates the correct JSON for validation failures'() {
+    given:
+    def reporter = new JsonReporter('test', reportDir)
+    def provider1 = new ProviderInfo(name: 'provider1')
+    def consumer = new ConsumerInfo(name: 'Consumer')
+    def interaction1 = new RequestResponseInteraction('Interaction 1', [], new Request(), new Response())
+
+    when:
+    reporter.initialise(provider1)
+    reporter.reportVerificationForConsumer(consumer, provider1, null)
+    reporter.interactionDescription(interaction1)
+    reporter.statusComparisonFailed(200, 'expected status of 201 but was 200')
+    reporter.headerComparisonFailed('HEADER-X', [''], [
+      new HeaderMismatch('HEADER-X', 'Y', '', "Expected a header 'HEADER-X' but was missing")
+    ])
+    reporter.bodyComparisonFailed(
+      new Either.Right(new BodyComparisonResult([
+        '$.0': [
+          new BodyMismatch(
+            JsonParser.parseString('{"doesNotExist":"Test","documentId":0}'),
+            JsonParser.parseString('{"documentId":0,"documentCategoryId":5,"documentCategoryCode":null,"contentLength":0,"tags":null}'),
+            'Expected doesNotExist="Test" but was missing', '$.0', '''{
+              -  "doesNotExist": "Test",
+              -  "documentId": 0
+              +  "documentId": 0,
+              +  "documentCategoryId": 5,
+              +  "documentCategoryCode": null,
+              +  "contentLength": 0,
+              +  "tags": null
+              }''')],
+        '$.1': [
+          new BodyMismatch(JsonParser.parseString('{"doesNotExist":"Test","documentId":0}'),
+            JsonParser.parseString('{"documentId":1,"documentCategoryId":5,"documentCategoryCode":null,"contentLength":0,"tags":null}'),
+              'Expected doesNotExist="Test" but was missing', '$.1', '''{
+              -  "doesNotExist": "Test",
+              -  "documentId": 0
+              +  "documentId": 1,
+              +  "documentCategoryId": 5,
+              +  "documentCategoryCode": null,
+              +  "contentLength": 0,
+              +  "tags": null
+              }''')]
+      ], [
+        '  {',
+        '-    " doesNotExist ": " Test ",',
+        '-    " documentId ": 0',
+        '+    " documentId ": 0,',
+        '+    " documentCategoryId ": 5,',
+        '+    " documentCategoryCode ": null,',
+        '+    " contentLength ": 0,',
+        '+    " tags ": null',
+        '+  },',
+        '+  {',
+        '+    " documentId ": 1,',
+        '+    " documentCategoryId ": 5,',
+        '+    " documentCategoryCode ": null,',
+        '+    " contentLength ": 0,',
+        '+    " tags ": null',
+        '  }'
+      ]))
+    )
+    reporter.finaliseReport()
+
+    def reportJson = new JsonSlurper().parse(new File(reportDir, 'provider1.json'))
+
+    then:
+    reportJson.provider.name == 'provider1'
+    reportJson.execution.size == 1
+    reportJson.execution[0].interactions.size == 1
+    reportJson.execution[0].interactions[0].verification.result == 'failed'
+    reportJson.execution[0].interactions[0].verification.status == ['expected status of 201 but was 200']
+    reportJson.execution[0].interactions[0].verification.header == ['HEADER-X': ["Expected a header 'HEADER-X' but was missing"]]
+    reportJson.execution[0].interactions[0].verification.body.mismatches == [
+      '$.0': ['Expected doesNotExist="Test" but was missing'],
+      '$.1': ['Expected doesNotExist="Test" but was missing']
+    ]
+  }
+
 }