Play Framework/Scala example source code file (PlayTestListener.scala)

This example Play Framework source code file (PlayTestListener.scala) is included in my "Source Code Warehouse" project. The intent of this project is to help you more easily find Play Framework (and Scala) source code examples by using tags.

All credit for the original source code belongs to Play Framework; I'm just trying to make examples easier to find. (For my Scala work, see my Scala examples and tutorials.)

Play Framework tags/keywords

errors, failed, passed, play, play framework, playtestlistener, plugin, runtimeexception, sbt, string, test, testevent, testslistener, tevent, total

The PlayTestListener.scala Play Framework example source code

/*
 * Copyright (C) 2009-2013 Typesafe Inc. <http://www.typesafe.com>
 */
package play.sbtplugin.test

import sbt._
import sbt.testing.{ Event => TEvent, Status => TStatus }

private[play] class PlayTestListener extends TestsListener {

  private var skipped, errors, passed, failures = 0

  private def count(event: TEvent) {
    event.status match {
      case TStatus.Error => errors += 1
      case TStatus.Success => passed += 1
      case TStatus.Failure => failures += 1
      case TStatus.Skipped => skipped += 1
      case _ => ()
    }
  }

  private def playReport(messageName: String, attributes: (String, String)*) {
    result.append("<li>" + messageName + " " + attributes.map {
      case (k, v) => k + ": " + tidy(v)
    }.mkString(" ") + "</li>")
  }

  val result = new collection.mutable.ListBuffer[String]

  override def doComplete(finalResult: TestResult.Value) {
    val totalCount = failures + errors + skipped + passed
    val postfix = "Total " + totalCount + ", Failed " + failures + ", Errors " + errors + ", Passed " + passed + ", Skipped " + skipped
    result.append("</ul>")
    result.append("<p>" + postfix + "</p>")
  }

  // There is a "side-effecting nullary methods are discouraged" warning but we can't fix it because we're overriding SBT
  override def doInit {
    result.append("<p>Executing Test suit</p>")
    result.append("<ul>")
    failures = 0
    errors = 0
    passed = 0
    skipped = 0
  }

  /** called for each class or equivalent grouping */
  override def startGroup(name: String) {
    playReport("test", "started" -> name)
  }

  /** called for each test method or equivalent */
  override def testEvent(event: TestEvent) {

    event match {
      case e =>
        for (d <- e.detail) {
          event.detail.foreach(count)
          d match {
            case te: TEvent =>
              te.status match {
                case TStatus.Success => playReport("test case", "finished, result" -> event.result.get.toString)
                case TStatus.Error | TStatus.Failure =>
                  val e = SbtOptionalThrowable.unapply(te.throwable).getOrElse(new RuntimeException("some unexpected error occurred during test execution"))
                  playReport("test", "failed" -> te.fullyQualifiedName, "details" -> (e.toString +
                    "\n" + e.getStackTrace.mkString("\n at ", "\n at ", "")))
                case TStatus.Skipped =>
                  playReport("test", "ignored" -> te.fullyQualifiedName)
                case _ => ()
              }
          }
        }
    }

  }

  /** called if there was an error during test */
  override def endGroup(name: String, t: Throwable) {}
  /** called if test completed */
  override def endGroup(name: String, result: TestResult.Value) {}

  def tidy(s: String) = s
    .replace("\u0085", "")
    .replace("\u2028", "")
    .replace("\u2029", "")
}