• Example Search
• Project Search

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

• drunken-data-quality-master
  • src
    • main
      • scala
        • de
          • frosner
            • ddq
              • constraints
                • ColumnColumnConstraint.scala
                • NumberOfRowsConstraint.scala
                • TypeConversionConstraint.scala
                • ConditionalColumnConstraint.scala
                • ExactEqualityConstraint.scala
                • DateFormatConstraint.scala
                • CustomConstraint.scala
                • JoinableConstraint.scala
                • StringColumnConstraint.scala
                • ColumnConstraintUtil.scala
                • IllegalConstraintResultException.scala
                • UniqueKeyConstraint.scala
                • AnyOfConstraint.scala
                • ConstraintUtil.scala
                • RegexConstraint.scala
                • ConstraintStatus.scala
                • ConstraintResult.scala
                • Constraint.scala
                • FunctionalDependencyConstraint.scala
                • AlwaysNullConstraint.scala
                • ForeignKeyConstraint.scala
                • NeverNullConstraint.scala
              • core
                • Check.scala
                • CheckResult.scala
                • Runner.scala
              • reporters
                • ZeppelinReporter.scala
                • HumanReadableReporter.scala
                • ConsoleReporter.scala
                • Reporter.scala
                • MarkdownReporter.scala
                • EmailReporter.scala
                • Log4jReporter.scala
    • test
      • resources
        • log4j.properties
      • scala
        • de
          • frosner
            • ddq
              • testutils
                • TestData.scala
                • DummyConstraint.scala
                • SparkContexts.scala
                • DummyConstraintResult.scala
              • constraints
                • NeverNullConstraintTest.scala
                • ExactEqualityConstraintTest.scala
                • NumberOfRowsConstraintTest.scala
                • AlwaysNullConstraintTest.scala
                • TypeConversionConstraintTest.scala
                • ForeignKeyConstraintTest.scala
                • ConstraintUtilTest.scala
                • UniqueKeyConstraintTest.scala
                • CustomConstraintTest.scala
                • DateFormatConstraintTest.scala
                • RegexConstraintTest.scala
                • FunctionalDependencyConstraintTest.scala
                • ColumnColumnConstraintTest.scala
                • StringColumnConstraintTest.scala
                • JoinableConstraintTest.scala
                • AnyOfConstraintTest.scala
                • ConditionalColumnConstraintTest.scala
              • core
                • CheckTest.scala
                • RunnerTest.scala
              • reporters
                • ZeppelinReporterTest.scala
                • Log4jReporterTest.scala
                • ConsoleReporterTest.scala
                • EmailReporterTest.scala
                • MarkdownReporterTest.scala
  • logo
    • DDQ.svg
  • LICENSE
  • project
    • build.properties
    • plugin.sbt
  • python
    • test-requirements.txt
    • pyddq
      • reporters.py
      • exceptions.py
      • __init__.py
      • jvm_conversions.py
      • core.py
      • streams.py
    • README.rst
    • setup.py
    • setup.cfg
    • tests
      • integration
        • test_constraints.py
        • test_reporters.py
        • test_check.py
      • unit
        • test_streams.py
        • test_constraints.py
        • test_reporters.py
        • utils.py
        • test_check.py
        • conftest.py
    • requirements.txt
    • .gitignore
  • .travis.yml
  • README.md
  • build.sbt
  • .gitignore

package de.frosner.ddq.reporters

import java.io.{ByteArrayOutputStream, PrintStream}

import de.frosner.ddq.constraints._
import de.frosner.ddq.core._
import de.frosner.ddq.testutils.{DummyConstraint, DummyConstraintResult}
import org.apache.spark.sql.DataFrame
import org.mockito.Mockito._
import org.scalatest.mock.MockitoSugar
import org.scalatest.{FlatSpec, Matchers}

class MarkdownReporterTest extends FlatSpec with Matchers with MockitoSugar {

  "A Markdown reporter" should "produce correct output for a check with constraints" in {
    val baos = new ByteArrayOutputStream()
    val markdownReporter = new MarkdownReporter(new PrintStream(baos))

    val df = mock[DataFrame]
    val dfName = "myDf"
    val dfColumns = Array("1", "2")
    val dfCount = 5
    when(df.columns).thenReturn(dfColumns)

    val header = s"Checking $dfName"
    val prologue = s"It has a total number of ${dfColumns.size} columns and $dfCount rows."
    val message1 = "1"
    val status1 = ConstraintSuccess
    val constraint1 = DummyConstraint(message1, status1)
    val result1 = constraint1.fun(df)

    val message2 = "2"
    val status2 = ConstraintFailure
    val constraint2 = DummyConstraint(message2, status2)
    val result2 = constraint2.fun(df)

    val message3 = "3"
    val status3 = ConstraintError(new IllegalArgumentException())
    val constraint3 = DummyConstraint(message3, status3)
    val result3 = DummyConstraintResult(constraint3, message3, status3)

    val constraints = Map[Constraint, ConstraintResult[Constraint]](
      constraint1 -> result1,
      constraint2 -> result2,
      constraint3 -> result3
    )

    val check = Check(df, Some(dfName), Option.empty, constraints.keys.toSeq)

    markdownReporter.report(CheckResult(constraints, check, dfCount))
    val expectedOutput = s"""**$header**

$prologue

- *SUCCESS*: ${result1.message}
- *FAILURE*: ${result2.message}
- *ERROR*: ${result3.message}

"""

    baos.toString shouldBe expectedOutput
  }

  it should "produce correct output for a check without constraint" in {
    val baos = new ByteArrayOutputStream()
    val markdownReporter = new MarkdownReporter(new PrintStream(baos))

    val df = mock[DataFrame]
    val dfName = "myDf"
    val dfColumns = Array("1", "2")
    val dfCount = 5
    when(df.columns).thenReturn(dfColumns)

    val header = s"Checking $dfName"
    val prologue = s"It has a total number of ${dfColumns.size} columns and $dfCount rows."
    val check = Check(df, Some(dfName), Option.empty, Seq.empty)

    markdownReporter.report(CheckResult(Map.empty, check, dfCount))
    val expectedOutput = s"""**$header**

$prologue

Nothing to check!

"""

    baos.toString shouldBe expectedOutput
  }

}