org.opencypher.okapi.testing.TestNameFixture.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016-2019 "Neo4j Sweden, AB" [https://neo4j.com]
 *
 * 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.
 *
 * Attribution Notice under the terms of the Apache License 2.0
 *
 * This work was created by the collective efforts of the openCypher community.
 * Without limiting the terms of Section 6, any Derivative Work that is not
 * approved by the public consensus process of the openCypher Implementers Group
 * should not be described as “Cypher” (and Cypher® is a registered trademark of
 * Neo4j Inc.) or as "openCypher". Extensions by implementers or prototypes or
 * proposals for change that have been documented or implemented should only be
 * described as "implementation extensions to Cypher" or as "proposed changes to
 * Cypher that are not yet approved by the openCypher community".
 */
package org.opencypher.okapi.testing

import org.scalatest.{Args, Status}

trait TestNameFixture extends BaseTestSuite {

  /**
    * Separator string for splitting test description and test name.
    *
    * e.g. separator "runs " and the following test definition:
    *
    * {{{
    * describe("description") {
    *   it("runs testName") {
    *     // ..
    *   }
    * }
    * }}}
    *
    * returns 'testName'.
    *
    *
    * @return
    */
  protected def separator: String

  final def testName: String = __testName.get

  private var __testName: Option[String] = None

  override protected def runTest(testName: String, args: Args): Status = {
    val separatorIndex = testName.indexOf(separator)

    val name = separatorIndex match {
      case -1 => testName
      case _ => testName.substring(separatorIndex + separator.length).trim.stripMargin
    }
    __testName = Some(name)
    try {
      super.runTest(testName, args)
    } finally {
      __testName = None
    }
  }
}