name.lakhin.eliah.projects.papacarlo.test.utils.ParserSpec.scala Maven / Gradle / Ivy

/*
   Copyright 2013 Ilya Lakhin (Илья Александрович Лахин)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
package name.lakhin.eliah.projects
package papacarlo.test.utils

import name.lakhin.eliah.projects.papacarlo.{Syntax, Lexer}
import org.scalatest.FunSpec
import net.liftweb.json.JsonAST._

abstract class ParserSpec(parserName: String,
                          inputBase: String = Resources.DefaultResourceBase,
                          outputBase: String = Resources.DefaultResourceBase)
  extends FunSpec {

  protected def lexer: Lexer
  protected def parser: (Lexer, Syntax)

  private val resources = new Resources(inputBase, outputBase)

  private val monitors:
    Map[String, (String, () => Monitor, Boolean)] = Map(
      "token" ->
        (
          "tokenize",
          () => new TokenizerMonitor(lexer),
          true
        ),
      "fragment" ->
        (
          "produce fragments",
          () => new FragmentationMonitor(lexer),
          true
        ),
      "cache" ->
        (
          "track cache",
          () => {
            val (lexer, syntax) = parser
            new CacheMonitor(lexer, syntax)
          },
          true
        ),
      "node" ->
        (
          "produce syntax nodes",
          () => {
            val (lexer, syntax) = parser
            new NodeMonitor(lexer, syntax)
          },
          true
        ),
      "error" ->
        (
          "produce syntax errors",
          () => {
            val (lexer, syntax) = parser
            new ErrorMonitor(lexer, syntax)
          },
          true
        ),
      "empty" ->
        (
          "parse",
          () => {
            val (lexer, syntax) = parser
            new EmptyMonitor(lexer, syntax)
          },
          false
        ),
      "debug" ->
        (
          "debug",
          () => {
            val (lexer, syntax) = parser
            new DebugMonitor(lexer, syntax)
          },
          false
        )
    )

  private val tests =
    resources.json[Map[String, Map[String, JValue]]](parserName, "config.json")
      .map({
        case (testName, settings) =>
          Test(
            resources = resources,

            parserName = parserName,

            testName = testName,

            steps = settings
              .get("steps")
              .flatMap {
                case JInt(value) => Some(value.toInt)
                case _ => None
              }
              .getOrElse((0 until 100)
                .find(step => !resources.exist(
                  parserName + "/" + testName + "/input",
                  "step" + step + ".txt"
                ))
                .getOrElse(100)),

            monitors = settings.get("monitors").flatMap {
              case JArray(monitors: List[JValue]) =>
                Some(monitors.flatMap {
                  case JString(monitor) => Some(monitor)
                  case _ => None
                }.toSet)

              case _ => None
            }.getOrElse(monitors.filter(_._2._3).keys.toSet),

            shortOutput = settings
              .get("shortOutput")
              .exists(_ == JBool(value = true)),

            outputFrom = settings
              .get("outputFrom")
              .flatMap {
                case JInt(value) => Some(value.toInt)
                case _ => None
              }
              .getOrElse(0),

            independentSteps = settings
              .get("independentSteps")
              .exists(_ == JBool(value = true))
          )
      })

  private def constructMonitor(test: Test, constructor: () => Monitor) = {
    val monitor = constructor()
    monitor.shortOutput = test.shortOutput
    monitor
  }

  for (test <- tests) {
    describe(test.testName + " test") {

      for ((monitorName, (description, monitorConstructor, default)) <-
           monitors)
        if (test.monitors.contains(monitorName))
          it("should " + description) {
            var monitor = constructMonitor(test, monitorConstructor)

            var statistics = List.empty[Long]
            var results = List.empty[String]

            for (step <- 0 until test.steps) {
              if (test.independentSteps)
                monitor = constructMonitor(test, monitorConstructor)

              monitor.prepare()
              statistics ::= monitor.input(test.inputs.getOrElse(step, ""))
              val result = monitor.getResult
              monitor.release()
              if (step >= test.outputFrom)
                test.write(monitorName, step, result)
              results ::= result
            }

            resources.update(
              parserName + "/" + test.testName + "/statistics",
              monitorName + ".txt",
              statistics.reverse.zipWithIndex.map {
                case (time, step) => "Step " + step + ": " + time + "ms"
              }.mkString("\n")
            )

            for ((result, step) <- results.reverse.zipWithIndex)
              if (step >= test.outputFrom)
                assert(
                  result == test.prototypes.get(monitorName)
                    .flatMap(_.get(step)).getOrElse(""),
                  "Step " + step + " result did not equal to the prototype"
                )
          }
    }
  }
}