com.github.timgent.sparkdataquality.checkssuite.ChecksSuiteResult.scala Maven / Gradle / Ivy

Go to download
package com.github.timgent.sparkdataquality.checkssuite

import java.time.Instant

import cats.Show
import com.github.timgent.sparkdataquality.checks.{CheckResult, CheckStatus}
import enumeratum._

/**
  *
  * @param overallStatus - Overall status of the CheckSuite. Dependent on the checks within the check suite
  * @param checkSuiteDescription - Description of the suite of checks that was run
  * @param checkResults - Sequence of CheckResult for every check in the CheckSuite
  * @param timestamp - the time the checks were run
  * @param checkTags - any tags associated with the CheckSuite
  */
case class ChecksSuiteResult(
    overallStatus: CheckSuiteStatus,
    checkSuiteDescription: String,
    checkResults: Seq[CheckResult],
    timestamp: Instant,
    checkTags: Map[String, String]
) {
  import cats.implicits._
  def prettyPrint = this.show
}

object ChecksSuiteResult {
  import cats.implicits._
  implicit val showChecksSuiteResult: Show[ChecksSuiteResult] = Show.show { checksSuiteResult =>
    val (successfulQcResults, unsuccessfulQcResults) = checksSuiteResult.checkResults.partition(_.status == CheckStatus.Success)
    s"""
       |SUCCESSFUL QC Checks:
       |
       |${successfulQcResults.map(_.show).mkString("\n\n - ")}
       | 
       |UNSUCCESSFUL QC Checks:
       | 
       |${unsuccessfulQcResults.map(_.show).mkString("\n\n - ")}
       |
       |""".stripMargin
  }
}

/**
  * Represents the overall status of a CheckSuite
  */
sealed trait CheckSuiteStatus extends EnumEntry

object CheckSuiteStatus extends Enum[CheckSuiteStatus] {
  val values = findValues
  case object Success extends CheckSuiteStatus
  case object Warning extends CheckSuiteStatus
  case object Error extends CheckSuiteStatus
}

case class ChecksSuitesResults(results: Seq[ChecksSuiteResult])