aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/scala/org/perl8/test/harness/SummaryReporter.scala
blob: a5fe1e093d662e2037f5148f1f62a9c134c8c731 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
package com.iinteractive.test.harness

import com.iinteractive.test.tap.{TAPEvent,TAPResult,TodoDirective}
import com.iinteractive.test.tap.{StartEvent,ResultEvent,PlanEvent,EndEvent}
import com.iinteractive.test.Test

/** Runs a series of tests. The TAP output from these tests is parsed, and
  * output is produced which is similar in style to Perl's
  * [[https://metacpan.org/module/Test::Harness Test::Harness]].
  */
class SummaryReporter extends MultiTestReporter with SummarizedTests {
  def run (testNames: Seq[String]): Int = {
    val results = runTests(testNames)
    val success = results.values.forall(_.success)
    printTestSummary(success, results)
    if (success) 0 else 1
  }

  protected def runTests (testNames: Seq[String]): Map[String, TAPResult] = {
    val maxLength = testNames.map(_.length).max

    testNames.map { name =>
      val callbackGenerator: () => TAPEvent => Unit = () => {
        var width             = 0
        var tests             = 0
        var plan: Option[Int] = None

        def status = {
          tests + "/" + plan.getOrElse("?")
        }

        def printStatus (st: String) {
          print("\r" + (" " * width) + "\r")
          val line =
            name + " " + ("." * (maxLength - name.length)) + ".. " + st
          width = line.length
          print(line)
          Console.out.flush
        }

        (e: TAPEvent) => e match {
          case StartEvent => {
            printStatus("")
          }
          case PlanEvent(p) => {
            plan = Some(p.plan)
            printStatus(status)
          }
          case ResultEvent(r) => {
            tests += 1
            printStatus(status)
          }
          case EndEvent(result) => {
            if (result.success) {
              printStatus("")
              println("ok")
            }
            else {
              val results = result.results.length
              val failed = result.results.count { t =>
                !t.passed && !t.directive.isDefined
              }

              printStatus("")
              println("Dubious, test returned " + result.exitCode)
              println("Failed " + failed + "/" + results + " subtests")
            }
          }
          case _ => ()
        }
      }

      name -> runOneTest(newInstance[Test](name), callbackGenerator())
    }.toMap
  }

  protected def printTestSummary (
    success: Boolean,
    results: Map[String, TAPResult]
  ) {
    printSuccess(success)
    printLongSummary(results)
    printShortSummary(results)
    printPassFail(success, results)
  }

  private def printSuccess (success: Boolean) {
    if (success) {
      println("All tests successful.")
    }
  }

  private def printShortSummary (results: Map[String, TAPResult]) {
    val files = results.size
    val tests = results.values.map(_.results.length).sum
    println("Files=" + files + ", Tests=" + tests)
  }

  private def printLongSummary (results: Map[String, TAPResult]) {
    val todoSucceeded = results.mapValues { r =>
      r.results.filter { t =>
        t.directive match {
          case Some(TodoDirective(_)) => t.passed
          case _                      => false
        }
      }
    }.filter(_._2.length > 0)

    val testsFailed = results.mapValues { r =>
      r.results.filter { t =>
        t.directive match {
          case None => !t.passed
          case _    => false
        }
      }
    }.filter(_._2.length > 0)

    val testNames = (todoSucceeded ++ testsFailed).keys

    if (testNames.nonEmpty) {
      println("")
      println("Test Summary Report")
      println("-------------------")

      val maxLength = testNames.map(_.length).max

      for (name <- testNames) {
        val result = results(name)

        println(
          name + (" " * (maxLength - name.length)) + "               " +
          "(Tests: " + result.results.length + " " +
          "Failed: " + testsFailed.getOrElse(name, Nil).length + ")"
        )

        if (testsFailed.isDefinedAt(name)) {
          val fails = testsFailed(name)
          println(
            "  Failed test" + (if (fails.length > 1) "s" else "") + ": " +
            fails.map(_.number).mkString(", ")
          )
        }

        if (todoSucceeded.isDefinedAt(name)) {
          val todos = todoSucceeded(name)
          println(
            "  TODO passed: " +
            todos.map(_.number).mkString(", ")
          )
        }

        val exitCode = results(name).exitCode
        if (exitCode != 0) {
          println("  Non-zero exit status: " + exitCode)
        }
      }
    }
  }

  private def printPassFail (
    success: Boolean,
    results: Map[String, TAPResult]
  ) {
    if (success) {
      println("Result: PASS")
    }
    else {
      println("Result: FAIL")

      val testResults = results.values

      val testsFailed = testResults.map { r =>
        r.results.count { t =>
          t.directive match {
            case None => !t.passed
            case _    => false
          }
        }
      }.filter(_ > 0)
      val failedFiles = testsFailed.size
      val failedTests = testsFailed.sum

      val allFiles = testResults.size
      val allTests = testResults.map(_.results.length).sum

      println(
        "Failed " + failedFiles + "/" + allFiles + " test programs. " +
        failedTests + "/" + allTests + " subtests failed."
      )
    }
  }
}