org.scalatest.refspec.RefSpecLike.scala Maven / Gradle / Ivy
/*
* Copyright 2001-2013 Artima, Inc.
*
* 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 org.scalatest.refspec
import org.scalatest._
import org.scalatest.exceptions._
import Suite._
import org.scalactic.Requirements._
import org.scalatest.events._
import scala.reflect.NameTransformer._
import RefSpec.equalIfRequiredCompactify
import RefSpec.isTestMethod
import StackDepthExceptionHelper.posOrElseStackDepthFun
import java.lang.reflect.{Method, Modifier, InvocationTargetException}
import org.scalactic.{source, Prettifier}
/**
* Implementation trait for class RefSpec, which facilitates a “behavior-driven” style of development (BDD), in which tests
* are methods, optionally nested inside singleton objects defining textual scopes.
*
*
* RefSpec is a class, not a trait, to minimize compile time given there is a slight compiler overhead to
* mixing in traits compared to extending classes. If you need to mix the behavior of RefSpec
* into some other class, you can use this trait instead, because class RefSpec does nothing more than extend this trait and add a nice toString implementation.
*
*
*
* See the documentation of the class for a detailed overview of RefSpec.
*
*
* @author Bill Venners
*/
@Finders(Array("org.scalatest.finders.SpecFinder"))
trait RefSpecLike extends TestSuite with Informing with Notifying with Alerting with Documenting { thisSuite =>
private final val engine = new Engine(Resources.concurrentSpecMod, "RefSpecLike")
import engine._
// Sychronized on thisSuite, only accessed from ensureScopesAndTestsRegistered
private var scopesRegistered = false
private def ensureScopesAndTestsRegistered(): Unit = {
thisSuite.synchronized {
if (!scopesRegistered) {
scopesRegistered = true
def getMethod(o: AnyRef, methodName: String) = {
o.getClass.getMethod(
simpleNameForTest(methodName),
new Array[Class[_]](0): _*
)
}
def getMethodTags(o: AnyRef, methodName: String) =
for {
a <- getMethod(o, methodName).getDeclaredAnnotations
annotationClass = a.annotationType
if annotationClass.isAnnotationPresent(classOf[TagAnnotation])
} yield annotationClass.getName
def getScopeClassName(o: AnyRef): String = {
val className = o.getClass.getName
if (className.endsWith("$"))
className
else
className + "$"
}
def isScopeMethod(o: AnyRef, m: Method): Boolean = {
val scopeMethodName = getScopeClassName(o)+ m.getName + "$"
val returnTypeName = m.getReturnType.getName
equalIfRequiredCompactify(scopeMethodName, returnTypeName)
}
def getScopeDesc(m: Method): String = {
val objName = m.getReturnType.getName
val objClassName = decode(objName.substring(0, objName.length - 1))
objClassName.substring(objClassName.lastIndexOf("$") + 1)
}
val testTags = tags
object MethodNameEncodedOrdering extends Ordering[Method] {
def compare(x: Method, y: Method): Int = {
decode(x.getName) compareTo decode(y.getName)
}
}
def register(o: AnyRef): Unit = {
val testMethods = o.getClass.getMethods.filter(isTestMethod(_)).sorted(MethodNameEncodedOrdering)
testMethods.foreach { m =>
val scope = isScopeMethod(o, m)
if (scope) {
val scopeDesc = getScopeDesc(m)
def scopeFun: Unit = {
try {
val scopeObj = m.invoke(o)
register(scopeObj)
}
catch {
case ite: InvocationTargetException if ite.getTargetException != null =>
throw ite.getTargetException
}
}
val scopeLocation = TopOfClass(m.getReturnType.getName)
try {
registerNestedBranch(scopeDesc, None, scopeFun, Resources.registrationAlreadyClosed, sourceFileName, "ensureScopesAndTestsRegistered", 2, 0, Some(scopeLocation), None)
}
catch {
case e: TestFailedException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideDefNotObject, Some(e), posOrElseStackDepthFun(e.position, _ => 8))
case e: TestCanceledException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideDefNotObject, Some(e), posOrElseStackDepthFun(e.position, _ => 8))
case other: Throwable if (!Suite.anExceptionThatShouldCauseAnAbort(other)) =>
if (ScalaTestVersions.BuiltForScalaVersion == "2.12")
throw new NotAllowedException(FailureMessages.exceptionWasThrownInObject(Prettifier.default, UnquotedString(other.getClass.getName), UnquotedString(scopeDesc)), Some(other), Right((_: StackDepthException) => 9))
else if (ScalaTestVersions.BuiltForScalaVersion startsWith "2.13")
throw new NotAllowedException(FailureMessages.exceptionWasThrownInObject(Prettifier.default, UnquotedString(other.getClass.getName), UnquotedString(scopeDesc)), Some(other), Right((_: StackDepthException) => 7))
else
throw new NotAllowedException(FailureMessages.exceptionWasThrownInObject(Prettifier.default, UnquotedString(other.getClass.getName), UnquotedString(scopeDesc)), Some(other), Right((_: StackDepthException) => 8))
case other: Throwable => throw other
}
}
else {
val methodName = m.getName
val testName = decode(methodName)
val methodTags = getMethodTags(o, methodName)
val testFun: () => Unit = () => {
val argsArray: Array[Object] = Array.empty
try m.invoke(o, argsArray: _*)
catch {
case ite: InvocationTargetException =>
throw ite.getTargetException
}
}
val testLocation = TopOfMethod(getScopeClassName(o), m.toGenericString)
val isIgnore = testTags.get(methodName) match {
case Some(tagSet) => tagSet.contains(Suite.IgnoreTagName) || methodTags.contains(Suite.IgnoreTagName)
case None => methodTags.contains(Suite.IgnoreTagName)
}
if (isIgnore)
registerIgnoredTest(testName, Transformer(testFun), Resources.registrationAlreadyClosed, sourceFileName, "ensureScopesAndTestsRegistered", 3, 0, Some(testLocation), None, methodTags.map(new Tag(_)): _*)
else
registerTest(testName, Transformer(testFun), Resources.registrationAlreadyClosed, sourceFileName, "ensureScopesAndTestsRegistered", 2, 1, None, Some(testLocation), None, None, methodTags.map(new Tag(_)): _*)
}
}
}
register(thisSuite)
}
}
}
// TODO: Probably make this private final val sourceFileName in a singleton object so it gets compiled in rather than carried around in each instance
private[scalatest] val sourceFileName = "RefSpecLike.scala"
/**
* Returns an Informer that during test execution will forward strings passed to its
* apply method to the current reporter. If invoked in a constructor, it
* will register the passed string for forwarding later during test execution. If invoked from inside a scope,
* it will forward the information to the current reporter immediately. If invoked from inside a test function,
* it will record the information and forward it to the current reporter only after the test completed, as recordedEvents
* of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output.
* This method can be called safely by any thread.
*/
protected def info: Informer = atomicInformer.get
/**
* Returns a Notifier that during test execution will forward strings (and other objects) passed to its
* apply method to the current reporter. If invoked in a constructor, it
* will register the passed string for forwarding later during test execution. If invoked while this
* RefSpec is being executed, such as from inside a test function, it will forward the information to
* the current reporter immediately. If invoked at any other time, it will
* print to the standard output. This method can be called safely by any thread.
*/
protected def note: Notifier = atomicNotifier.get
/**
* Returns an Alerter that during test execution will forward strings (and other objects) passed to its
* apply method to the current reporter. If invoked in a constructor, it
* will register the passed string for forwarding later during test execution. If invoked while this
* RefSpec is being executed, such as from inside a test function, it will forward the information to
* the current reporter immediately. If invoked at any other time, it will
* print to the standard output. This method can be called safely by any thread.
*/
protected def alert: Alerter = atomicAlerter.get
/**
* Returns a Documenter that during test execution will forward strings passed to its
* apply method to the current reporter. If invoked in a constructor, it
* will register the passed string for forwarding later during test execution. If invoked from inside a scope,
* it will forward the information to the current reporter immediately. If invoked from inside a test function,
* it will record the information and forward it to the current reporter only after the test completed, as recordedEvents
* of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output.
* This method can be called safely by any thread.
*/
protected def markup: Documenter = atomicDocumenter.get
/**
* An immutable Set of test names. If this RefSpec contains no tests, this method returns an
* empty Set.
*
*
* This trait's implementation of this method will return a set that contains the names of all registered tests. The set's
* iterator will return those names in the order in which the tests were registered. Each test's name is composed
* of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the
* example itself, with all components separated by a space. For example, consider this RefSpec:
*
*
*
* import org.scalatest.RefSpec
*
* class StackSpec extends RefSpec {
* object `A Stack` {
* object `(when not empty)` {
* def `must allow me to pop` {}
* }
* object `(when not full)` {
* def `must allow me to push` {}
* }
* }
* }
*
*
*
* Invoking testNames on this RefSpec will yield a set that contains the following
* two test name strings:
*
*
*
* "A Stack (when not empty) must allow me to pop"
* "A Stack (when not full) must allow me to push"
*
*/
override def testNames: Set[String] = {
ensureScopesAndTestsRegistered()
InsertionOrderSet(atomic.get.testNamesList)
}
/**
* Run a test. This trait's implementation runs the test registered with the name specified by
* testName. Each test's name is a concatenation of the text of all describers surrounding a test,
* from outside in, and the test's spec text, with one space placed between each item. (See the documenation
* for testNames for an example.)
*
* @param testName the name of one test to execute.
* @param args the Args for this run
* @return a Status object that indicates when the test started by this method has completed, and whether or not it failed .
*
* @throws NullPointerException if any of testName, reporter, stopper, or configMap
* is null.
*/
protected override def runTest(testName: String, args: Args): Status = {
requireNonNull(testName, args)
ensureScopesAndTestsRegistered()
def invokeWithFixture(theTest: TestLeaf): Outcome = {
val theConfigMap = args.configMap
val testData = testDataFor(testName, theConfigMap)
withFixture(
new NoArgTest {
val name = testData.name
def apply(): Outcome = { theTest.testFun() }
val configMap = testData.configMap
val scopes = testData.scopes
val text = testData.text
val tags = testData.tags
val pos = testData.pos
}
)
}
runTestImpl(thisSuite, testName, args, true, invokeWithFixture)
}
final override def expectedTestCount(filter: Filter): Int = {
ensureScopesAndTestsRegistered()
super.expectedTestCount(filter)
}
/**
* A Map whose keys are String names of tagged tests and whose associated values are
* the Set of tags for the test. If this RefSpec contains no tags, this method returns an empty Map.
*
*
* This trait's implementation of this method uses Java reflection to discover any Java annotations attached to its test methods. The
* fully qualified name of each unique annotation that extends TagAnnotation is considered a tag. This trait's
* implementation of this method, therefore, places one key/value pair into to the
* Map for each test for which a tag annotation is discovered through reflection.
*
*
*
* In addition, this trait's implementation will also auto-tag tests with class level annotations.
* For example, if you annotate @Ignore at the class level, all test methods in the class will be auto-annotated with
* org.scalatest.Ignore.
*
*/
override def tags: Map[String, Set[String]] = {
ensureScopesAndTestsRegistered()
autoTagClassAnnotations(atomic.get.tagsMap, this)
}
/**
* Run zero to many of this RefSpec's tests.
*
* @param testName an optional name of one test to run. If None, all relevant tests should be run.
* I.e., None acts like a wildcard that means run all relevant tests in this Suite.
* @param args the Args for this run
* @return a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
*
* @throws NullPointerException if any of the passed parameters is null.
* @throws IllegalArgumentException if testName is defined, but no test with the specified test name
* exists in this Suite
*/
protected override def runTests(testName: Option[String], args: Args): Status = {
ensureScopesAndTestsRegistered()
runTestsImpl(thisSuite, testName, args, info, true, runTest)
}
override def run(testName: Option[String], args: Args): Status = {
ensureScopesAndTestsRegistered()
runImpl(thisSuite, testName, args, super.run)
}
/**
* The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
*
* This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0
* will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for styleName.
*/
@deprecated("The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.", "3.1.0")
final override val styleName: String = "org.scalatest.refspec.RefSpec"
override def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData = createTestDataFor(testName, theConfigMap, this)
}