Dogcows Code - chaz/sbt-tap/blob - src/main/scala/SbtTapReporting.scala

   1 import java.io.{PrintWriter, StringWriter, File, FileWriter}
   2 import sbt._
   3 import org.scalatools.testing.{Event => TEvent, Result => TResult}
   4
   5 import java.util.concurrent.atomic.AtomicInteger
   6
   7 object SbtTapReporting extends Plugin {
   8   def apply() = new SbtTapListener
   9 }
  10
  11 /**
  12  * Listens to sbt test listener events and writes them to a tap compatible file. Results for all groups
  13  * go to a single file although it might be desirable to generate one tap file per group.
  14  * <p>
  15  * sbt runs tests in parallel and the protocol does not seem to provide a way to match a group to a test event. It
  16  * does look line one thread calls startGroup/testEvent/endGroup sequentially and using thread local to keep
  17  * the current active group might be one way to go.
  18  */
  19 class SbtTapListener extends TestsListener {
  20   var testId = new AtomicInteger(0)
  21   var fileWriter: FileWriter = _
  22
  23   override def doInit = {
  24     val filename = scala.util.Properties.envOrElse("SBT_TAP_OUTPUT", "test-results/test.tap")
  25     val file = new File(filename)
  26     new File(file.getParent).mkdirs
  27     fileWriter = new FileWriter(file)
  28   }
  29
  30   def startGroup(name: String) =
  31     writeTapDiag("start", name)
  32
  33   def endGroup(name: String, result: TestResult.Value) =
  34     writeTapDiag("end", name, "with result", result.toString.toLowerCase)
  35
  36   def endGroup(name: String, t: Throwable) = {
  37     writeTapDiag("end", name)
  38     writeTapDiag(stackTraceForError(t))
  39   }
  40
  41   def testEvent(event: TestEvent) = {
  42     event.detail.foreach { e: TEvent =>
  43       e.result match {
  44         case TResult.Success => writeTap("ok", testId.incrementAndGet, "-", e.testName)
  45         case TResult.Error | TResult.Failure =>
  46           writeTap("not ok", testId.incrementAndGet, "-", e.testName)
  47           // TODO: It would be nice if we could report the exact line in the test where this happened.
  48           writeTapDiag(stackTraceForError(e.error))
  49         case TResult.Skipped =>
  50           // it doesn't look like this framework distinguishes between pending and ignored.
  51           writeTap("ok", testId.incrementAndGet, e.testName, "#", "skip", e.testName)
  52       }
  53     }
  54   }
  55
  56   override def doComplete(finalResult: TestResult.Value) = {
  57     writeTap("1.." + testId.get)
  58     fileWriter.close
  59   }
  60
  61   private def writeTap(s: Any*) = {
  62     fileWriter.write(s.mkString("", " ", "\n"))
  63     fileWriter.flush
  64   }
  65
  66   private def writeTapDiag(s: Any*) =
  67     writeTap("#", s.mkString("", " ", "\n").trim.replaceAll("\\n", "\n# "))
  68
  69   private def stackTraceForError(t: Throwable): String = {
  70     val sw = new StringWriter
  71     val printWriter = new PrintWriter(sw)
  72     t.printStackTrace(printWriter)
  73     sw.toString
  74   }
  75 }