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     new File("test-results").mkdirs
  25
  26     fileWriter = new FileWriter(
  27       scala.util.Properties.envOrElse("SBT_TAP_OUTPUT", "test-results/test.tap")
  28     )
  29   }
  30
  31   def startGroup(name: String) =
  32     writeTapDiag("start", name)
  33
  34   def endGroup(name: String, result: TestResult.Value) =
  35     writeTapDiag("end", name, "with result", result.toString.toLowerCase)
  36
  37   def endGroup(name: String, t: Throwable) = {
  38     writeTapDiag("end", name)
  39     writeTapDiag(stackTraceForError(t))
  40   }
  41
  42   def testEvent(event: TestEvent) = {
  43     event.detail.foreach { e: TEvent =>
  44       e.result match {
  45         case TResult.Success => writeTap("ok", testId.incrementAndGet, "-", e.testName)
  46         case TResult.Error | TResult.Failure =>
  47           writeTap("not ok", testId.incrementAndGet, "-", e.testName)
  48           // TODO: It would be nice if we could report the exact line in the test where this happened.
  49           writeTapDiag(stackTraceForError(e.error))
  50         case TResult.Skipped =>
  51           // it doesn't look like this framework distinguishes between pending and ignored.
  52           writeTap("ok", testId.incrementAndGet, e.testName, "#", "skip", e.testName)
  53       }
  54     }
  55   }
  56
  57   override def doComplete(finalResult: TestResult.Value) = {
  58     writeTap("1.." + testId.get)
  59     fileWriter.close
  60   }
  61
  62   private def writeTap(s: Any*) = {
  63     fileWriter.write(s.mkString("", " ", "\n"))
  64     fileWriter.flush
  65   }
  66
  67   private def writeTapDiag(s: Any*) =
  68     writeTap("#", s.mkString("", " ", "\n").trim.replaceAll("\\n", "\n# "))
  69
  70   private def stackTraceForError(t: Throwable): String = {
  71     val sw = new StringWriter
  72     val printWriter = new PrintWriter(sw)
  73     t.printStackTrace(printWriter)
  74     sw.toString
  75   }
  76 }