au.com.dius.pact.provider.reporters.MarkdownReporter.kt Maven / Gradle / Ivy

Go to download
package au.com.dius.pact.provider.reporters

import au.com.dius.pact.core.model.BasePact
import au.com.dius.pact.core.model.Interaction
import au.com.dius.pact.core.model.Pact
import au.com.dius.pact.core.model.PactSource
import au.com.dius.pact.core.model.UrlPactSource
import au.com.dius.pact.core.support.hasProperty
import au.com.dius.pact.core.support.property
import au.com.dius.pact.provider.IConsumerInfo
import au.com.dius.pact.provider.IProviderInfo
import java.io.BufferedWriter
import java.io.File
import java.io.FileWriter
import java.io.PrintWriter
import java.time.ZonedDateTime

/**
 * Pact verifier reporter that displays the results of the verification in a markdown document
 */
class MarkdownReporter(
  var name: String,
  override var reportDir: File?,
  override var ext: String
) : VerifierReporter {

  constructor(name: String, reportDir: File?) : this(name, reportDir, ".md")

  override lateinit var reportFile: File

  init {
    if (reportDir == null) {
      reportDir = File(System.getProperty("user.dir"))
    }
    reportFile = File(reportDir, "$name$ext")
  }

  private var pw: PrintWriter? = null

  override fun initialise(provider: IProviderInfo) {
    if (pw != null) {
      pw!!.close()
    }

    reportDir!!.mkdirs()
    reportFile = File(reportDir, provider.name + ext)
    pw = PrintWriter(BufferedWriter(FileWriter(reportFile, true)))
    pw!!.write("""
      # ${provider.name}
    
      | Description    | Value |
      | -------------- | ----- |
      | Date Generated | ${ZonedDateTime.now()} |
      | Pact Version   | ${BasePact.lookupVersion()} |
    
    """.trimIndent())
  }

  override fun finaliseReport() {
    pw!!.close()
  }

  override fun reportVerificationForConsumer(consumer: IConsumerInfo, provider: IProviderInfo, tag: String?) {
    val report = StringBuilder("## Verifying a pact between _${consumer.name}_ and _${provider.name}_")
    if (tag != null) {
      report.append(" for tag $tag")
    }
    report.append("\n\n")
    pw!!.write(report.toString())
  }

  override fun verifyConsumerFromUrl(pactUrl: UrlPactSource, consumer: IConsumerInfo) {
    pw!!.write("From `${pactUrl.description()}`
\n")
  }

  override fun verifyConsumerFromFile(pactFile: PactSource, consumer: IConsumerInfo) {
    pw!!.write("From `${pactFile.description()}`
\n")
  }

  override fun pactLoadFailureForConsumer(consumer: IConsumerInfo, message: String) { }

  override fun warnProviderHasNoConsumers(provider: IProviderInfo) { }

  override fun warnPactFileHasNoInteractions(pact: Pact) { }

  override fun interactionDescription(interaction: Interaction) {
    pw!!.write("${interaction.description}  \n")
  }

  override fun stateForInteraction(state: String, provider: IProviderInfo, consumer: IConsumerInfo, isSetup: Boolean) {
    pw!!.write("Given **$state**  \n")
  }

  override fun warnStateChangeIgnored(state: String, provider: IProviderInfo, consumer: IConsumerInfo) {
    pw!!.write("    WARNING: State Change ignored as " +
      "there is no stateChange URL  \n")
  }

  override fun stateChangeRequestFailedWithException(
    state: String,
    provider: IProviderInfo,
    consumer: IConsumerInfo,
    isSetup: Boolean,
    e: Exception,
    printStackTrace: Boolean
  ) {
    reportFile.printWriter().use {
      it.write("    State Change Request Failed - ${e.message}" +
        "\n\n```\n")
      e.printStackTrace(it)
      it.write("\n```\n\n")
    }
  }

  override fun stateChangeRequestFailed(state: String, provider: IProviderInfo, isSetup: Boolean, httpStatus: String) {
    pw!!.write("    State Change Request Failed - $httpStatus" +
      "  \n")
  }

  override fun warnStateChangeIgnoredDueToInvalidUrl(
    state: String,
    provider: IProviderInfo,
    isSetup: Boolean,
    stateChangeHandler: Any
  ) {
    pw!!.write("    WARNING: State Change ignored as " +
      "there is no stateChange URL, received `$stateChangeHandler`  \n")
  }

  override fun requestFailed(
    provider: IProviderInfo,
    interaction: Interaction,
    interactionMessage: String,
    e: Exception,
    printStackTrace: Boolean
  ) {
    pw!!.write("    Request Failed - ${e.message}\n\n```\n")
    e.printStackTrace(pw!!)
    pw!!.write("\n```\n\n")
  }

  override fun returnsAResponseWhich() {
    pw!!.write("  returns a response which  \n")
  }

  override fun statusComparisonOk(status: Int) {
    pw!!.write("    has status code **$status** " +
      "(OK)  \n")
  }

  override fun statusComparisonFailed(status: Int, comparison: Any) {
    pw!!.write("    has status code **$status** " +
      "(FAILED)\n\n```\n")
    if (comparison.hasProperty("message")) {
      pw!!.write(comparison.property("message")?.get(comparison).toString())
    } else {
      pw!!.write(comparison.toString())
    }
    pw!!.write("\n```\n\n")
  }

  override fun includesHeaders() {
    pw!!.write("    includes headers  \n")
  }

  override fun headerComparisonOk(key: String, value: List) {
    pw!!.write("      \"**$key**\" with value \"**$value**\" " +
      "(OK)  \n")
  }

  override fun headerComparisonFailed(key: String, value: List, comparison: Any) {
    pw!!.write("      \"**$key**\" with value \"**$value**\" " +
      "(FAILED)  \n\n```\n$comparison\n```\n\n")
  }

  override fun bodyComparisonOk() {
    pw!!.write("    has a matching body (OK)  \n")
  }

  override fun bodyComparisonFailed(comparison: Any) {
    pw!!.write("    has a matching body (FAILED)  \n\n")
    pw!!.write("| Path | Failure |\n")
    pw!!.write("| ---- | ------- |\n")

    val property = comparison.property("comparison")?.get(comparison)
    when {
      comparison is String -> pw!!.write("|\$|$comparison|\n")
      property is Map<*, *> -> pw!!.write(property.map {
        val mismatches = (it.value as List>).joinToString("; ") { mismatch ->
          mismatch["mismatch"].toString()
        }
        "|${it.key}|$mismatches|"
      }.joinToString("\n"))
      else -> pw!!.write("|\$|$property|")
    }
    pw!!.write("\n\n")
    if (comparison.hasProperty("diff")) {
      pw!!.write("Diff:\n\n")
      renderDiff(pw!!, comparison.property("diff")?.get(comparison))
      pw!!.write("\n\n")
    }
  }

  private fun renderDiff(pw: PrintWriter, diff: Any?) {
    pw.write("```diff\n")
    if (diff is List<*>) {
      pw.write(diff.joinToString("\n"))
    } else {
      pw.write(diff.toString())
    }
    pw.write("\n```\n")
  }

  override fun errorHasNoAnnotatedMethodsFoundForInteraction(interaction: Interaction) { }

  override fun verificationFailed(interaction: Interaction, e: Exception, printStackTrace: Boolean) {
    pw!!.write("    Verification Failed - ${e.message}\n\n```\n")
    e.printStackTrace(pw)
    pw!!.write("\n```\n\n")
  }

  override fun generatesAMessageWhich() {
    pw!!.write("  generates a message which  \n")
  }

  override fun displayFailures(failures: Map) { }

  override fun metadataComparisonFailed(key: String, value: Any?, comparison: Any) {
    pw!!.write("      \"**$key**\" with value \"**$value**\" " +
      "(FAILED)  \n")
    pw!!.write("\n```\n$comparison\n```\n\n")
  }

  override fun includesMetadata() {
    pw!!.write("    includes metadata  \n")
  }

  override fun metadataComparisonOk(key: String, value: Any?) {
    pw!!.write("      \"**$key**\" with value \"**$value**\" " +
      "(OK)  \n")
  }

  override fun metadataComparisonOk() {
    pw!!.write("    has matching metadata (OK)\n")
  }
}