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
  33   def testEvent(event: TestEvent) {
  34     event.detail.foreach { e: TEvent =>
  35       e.result match {
  36         case TResult.Success => writeTapFields("ok", testId.incrementAndGet(), "-", e.testName())
  37         case TResult.Error | TResult.Failure =>
  38           writeTapFields("not ok", testId.incrementAndGet(), "-", e.testName())
  39           // According to the TAP spec, as long as there is any kind of whitespace, this output should belong to the
  40           // the test that failed and it should get displayed in the UI.
  41           // TODO:It would be nice if we could report the exact line in the test where this happened.
  42           writeTapFields(" ", stackTraceForError(e.error()))
  43         case TResult.Skipped =>
  44           // it doesn't look like this framework distinguishes between pending and ignored.
  45           writeTapFields("ok", testId.incrementAndGet(), e.testName(), "#", "skip", e.testName())
  46       }
  47     }
  48   }
  49
  50   override def doComplete(finalResult: TestResult.Value) {
  51     writeTapFields("1.." + testId.get)
  52     fileWriter.close()
  53   }
  54
  55   private def writeTapFields(s: Any*) {
  56     fileWriter.write(s.mkString("",  " ", "\n"))
  57     fileWriter.flush()
  58   }
  59
  60   private def stackTraceForError(t: Throwable): String = {
  61     val sw = new StringWriter()
  62     val printWriter = new PrintWriter(sw)
  63     t.printStackTrace(printWriter)
  64     sw.toString
  65   }
  66   def endGroup(name: String, t: Throwable) { }
  67
  68   def endGroup(name: String, result: TestResult.Value) { }
  69 }