summaryrefslogtreecommitdiff
path: root/examples/scala-js/sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/testing/TestOutputConsole.scala
blob: 9aad9565dc5fb0eca582823da42f5576c51d0d50 (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
/*                     __                                               *\
**     ________ ___   / /  ___      __ ____  Scala.js sbt plugin        **
**    / __/ __// _ | / /  / _ | __ / // __/  (c) 2013, LAMP/EPFL        **
**  __\ \/ /__/ __ |/ /__/ __ |/_// /_\ \    http://scala-js.org/       **
** /____/\___/_/ |_/____/_/ | |__/ /____/                               **
**                          |/____/                                     **
\*                                                                      */


package scala.scalajs.sbtplugin.testing

import sbt.testing.Logger
import sbt.testing.EventHandler

import scala.scalajs.tools.env.JSConsole
import scala.scalajs.tools.sourcemap.SourceMapper
import scala.scalajs.tools.classpath.{CompleteClasspath, IRClasspath}

import scala.collection.mutable.ArrayBuffer

import scala.util.Try

import java.util.regex._

/** This parses the messages sent from the test bridge and forwards
 *  the calls to SBT. It also buffers all log messages and allows to
 *  pipe them to multiple loggers in a synchronized fashion. This
 *  ensures that log messages aren't interleaved due to parallelism.
 */
class TestOutputConsole(
    base: JSConsole,
    handler: EventHandler,
    events: Events,
    classpath: CompleteClasspath,
    noSourceMap: Boolean) extends JSConsole {

  import TestOutputConsole._
  import events._

  private val traceBuf = new ArrayBuffer[StackTraceElement]
  private val logBuffer = new ArrayBuffer[LogElement]

  /* See #727: source mapping does not work with CompleteIRClasspath, so
   * don't bother to try.
   */
  private val ignoreSourceMapping =
    noSourceMap || classpath.isInstanceOf[IRClasspath]

  private lazy val sourceMapper = new SourceMapper(classpath)

  override def log(msg: Any): Unit = {
    val data = msg.toString
    val sepPos = data.indexOf("|")

    if (sepPos == -1)
      log(_.error, s"Malformed message: $data")
    else {
      val op = data.substring(0, sepPos)
      val message = unescape(data.substring(sepPos + 1))

      op match {
        case "console-log" =>
          base.log(message)
        case "error" =>
          val trace = getTrace()
          logWithEvent(_.error,
            messageWithStack(message, trace),
            Error(new TestException(message, trace))
          )
        case "failure" =>
          val trace = getTrace()
          logWithEvent(_.error,
            messageWithStack(message, trace),
            Failure(new TestException(message, trace))
          )
        case "succeeded" =>
          noTrace()
          logWithEvent(_.info, message, Succeeded)
        case "skipped" =>
          noTrace()
          logWithEvent(_.info, message, Skipped)
        case "pending" =>
          noTrace()
          logWithEvent(_.info, message, Pending)
        case "ignored" =>
          noTrace()
          logWithEvent(_.info, message, Ignored)
        case "canceled" =>
          noTrace()
          logWithEvent(_.info, message, Canceled)
        case "error-log" =>
          noTrace()
          log(_.error, message)
        case "info" =>
          noTrace()
          log(_.info, message)
        case "warn" =>
          noTrace()
          log(_.warn, message)
        case "trace" =>
          val Array(className, methodName, fileName,
              lineNumberStr, columnNumberStr) = message.split('|')

          def tryParse(num: String, name: String) = Try(num.toInt).getOrElse {
            log(_.warn, s"Couldn't parse $name number in StackTrace: $num")
            -1
          }

          val lineNumber   = tryParse(lineNumberStr, "line")
          val columnNumber = tryParse(columnNumberStr, "column")

          val ste =
            new StackTraceElement(className, methodName, fileName, lineNumber)

          if (ignoreSourceMapping)
            traceBuf += ste
          else
            traceBuf += sourceMapper.map(ste, columnNumber)
        case _ =>
          noTrace()
          log(_.error, s"Unknown op: $op. Originating log message: $data")
      }
    }
  }

  private def noTrace() = {
    if (traceBuf.nonEmpty)
      log(_.warn, s"Discarding ${traceBuf.size} stack elements")
    traceBuf.clear()
  }

  private def getTrace() = {
    val res = traceBuf.toArray
    traceBuf.clear()
    res
  }

  private def messageWithStack(message: String, stack: Array[StackTraceElement]): String =
    message + stack.mkString("\n", "\n", "")

  private def log(method: LogMethod, message: String): Unit =
    logBuffer.append(LogElement(method, message))

  private def logWithEvent(method: LogMethod,
      message: String, event: Event): Unit = {
    handler handle event
    log(method, message)
  }

  def pipeLogsTo(loggers: Array[Logger]): Unit = {
    TestOutputConsole.synchronized {
      for {
        LogElement(method, message) <- logBuffer
        logger <- loggers
      } method(logger) {
        if (logger.ansiCodesSupported) message
        else removeColors(message)
      }
    }
  }

  def allLogs: List[LogElement] = logBuffer.toList

  private val colorPattern = raw"\033\[\d{1,2}m"

  private def removeColors(message: String): String =
    message.replaceAll(colorPattern, "")

  private val unEscPat = Pattern.compile("(\\\\\\\\|\\\\n|\\\\r)")
  private def unescape(message: String): String = {
    val m = unEscPat.matcher(message)
    val res = new StringBuffer()
    while (m.find()) {
      val repl = m.group() match {
        case "\\\\" => "\\\\"
        case "\\n" => "\n"
        case "\\r" => "\r"
      }
      m.appendReplacement(res, repl);
    }
    m.appendTail(res);
    res.toString
  }

}

object TestOutputConsole {
  type LogMethod = Logger => (String => Unit)
  case class LogElement(method: LogMethod, message: String)
}