org.scalatest.fixture.Spec.scala Maven / Gradle / Ivy
/*
* Copyright 2001-2008 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.fixture
import scala.collection.immutable.ListSet
import org.scalatest.Suite.{IgnoreAnnotation, autoTagClassAnnotations}
import org.scalatest._
import Spec._
import Suite._
import org.scalatest.events.{TopOfClass, TopOfMethod}
import scala.reflect.NameTransformer._
import java.lang.reflect.{Method, Modifier, InvocationTargetException}
/**
* A sister trait to org.scalatest.Spec that can pass a fixture object into its tests.
*
*
* Recommended Usage:
* Use trait fixture.Spec in situations for which Spec
* would be a good choice, when all or most tests need the same fixture objects
* that must be cleaned up afterwords. Note: fixture.Spec is intended for use in special situations, with trait Spec used for general needs. For
* more insight into where fixture.Spec fits in the big picture, see the withFixture(OneArgTest) subsection of the Shared fixtures section in the documentation for trait Spec.
*
*
*
* Trait fixture.Spec behaves similarly to trait org.scalatest.Spec, except that tests may have a
* fixture parameter. The type of the
* fixture parameter is defined by the abstract FixtureParam type, which is declared as a member of this trait.
* This trait also declares an abstract withFixture method. This withFixture method
* takes a OneArgTest, which is a nested trait defined as a member of this trait.
* OneArgTest has an apply method that takes a FixtureParam.
* This apply method is responsible for running a test.
* This trait's runTest method delegates the actual running of each test to withFixture(OneArgTest), passing
* in the test code to run via the OneArgTest argument. The withFixture(OneArgTest) method (abstract in this trait) is responsible
* for creating the fixture argument and passing it to the test function.
*
*
*
* Subclasses of this trait must, therefore, do three things differently from a plain old org.scalatest.Spec:
*
*
*
* - define the type of the fixture parameter by specifying type
FixtureParam
* - define the
withFixture(OneArgTest) method
* - write tests that take a fixture parameter
* - (You can also define tests that don't take a fixture parameter.)
*
*
*
* If the fixture you want to pass into your tests consists of multiple objects, you will need to combine
* them into one object to use this trait. One good approach to passing multiple fixture objects is
* to encapsulate them in a case class. Here's an example:
*
*
*
* case class F(file: File, writer: FileWriter)
* type FixtureParam = F
*
*
*
* To enable the stacking of traits that define withFixture(NoArgTest), it is a good idea to let
* withFixture(NoArgTest) invoke the test function instead of invoking the test
* function directly. To do so, you'll need to convert the OneArgTest to a NoArgTest. You can do that by passing
* the fixture object to the toNoArgTest method of OneArgTest. In other words, instead of
* writing “test(theFixture)”, you'd delegate responsibility for
* invoking the test function to the withFixture(NoArgTest) method of the same instance by writing:
*
*
*
* withFixture(test.toNoArgTest(theFixture))
*
*
*
* Here's a complete example:
*
*
*
* package org.scalatest.examples.spec.oneargtest
*
* import org.scalatest.fixture
* import java.io._
*
* class ExampleSpec extends fixture.Spec {
*
* case class F(file: File, writer: FileWriter)
* type FixtureParam = F
*
* def withFixture(test: OneArgTest) {
*
* // create the fixture
* val file = File.createTempFile("hello", "world")
* val writer = new FileWriter(file)
* val theFixture = F(file, writer)
*
* try {
* writer.write("ScalaTest is ") // set up the fixture
* withFixture(test.toNoArgTest(theFixture)) // "loan" the fixture to the test
* }
* finally writer.close() // clean up the fixture
* }
*
* object `Testing ` {
* def `should be easy` (f: F) {
* f.writer.write("easy!")
* f.writer.flush()
* assert(f.file.length === 18)
* }
*
* def `should be fun` (f: F) {
* f.writer.write("fun!")
* f.writer.flush()
* assert(f.file.length === 17)
* }
* }
* }
*
*
*
* If a test fails, the OneArgTest function will complete abruptly with an exception describing the failure.
* To ensure clean up happens even if a test fails, you should invoke the test function from inside a try block and do the cleanup in a
* finally clause, as shown in the previous example.
*
*
* Sharing fixtures across classes
*
*
* If multiple test classes need the same fixture, you can define the FixtureParam and withFixture(OneArgTest) implementations
* in a trait, then mix that trait into the test classes that need it. For example, if your application requires a database and your integration tests
* use that database, you will likely have many test classes that need a database fixture. You can create a "database fixture" trait that creates a
* database with a unique name, passes the connector into the test, then removes the database once the test completes. This is shown in the following example:
*
*
*
* package org.scalatest.examples.fixture.spec.sharing
*
* import java.util.concurrent.ConcurrentHashMap
* import org.scalatest.fixture
* import DbServer._
* import java.util.UUID.randomUUID
*
* object DbServer { // Simulating a database server
* type Db = StringBuffer
* private val databases = new ConcurrentHashMap[String, Db]
* def createDb(name: String): Db = {
* val db = new StringBuffer
* databases.put(name, db)
* db
* }
* def removeDb(name: String) {
* databases.remove(name)
* }
* }
*
* trait DbFixture { this: fixture.Suite =>
*
* type FixtureParam = Db
*
* // Allow clients to populate the database after
* // it is created
* def populateDb(db: Db) {}
*
* def withFixture(test: OneArgTest) {
* val dbName = randomUUID.toString
* val db = createDb(dbName) // create the fixture
* try {
* populateDb(db) // setup the fixture
* withFixture(test.toNoArgTest(db)) // "loan" the fixture to the test
* }
* finally removeDb(dbName) // clean up the fixture
* }
* }
*
* class ExampleSpec extends fixture.Spec with DbFixture {
*
* override def populateDb(db: Db) { // setup the fixture
* db.append("ScalaTest is ")
* }
*
* object `Testing ` {
* def `should be easy` (db: Db) {
* db.append("easy!")
* assert(db.toString === "ScalaTest is easy!")
* }
*
* def `should be fun` (db: Db) {
* db.append("fun!")
* assert(db.toString === "ScalaTest is fun!")
* }
* }
*
* // This test doesn't need a Db
* object `Test code` {
* def `should be clear` {
* val buf = new StringBuffer
* buf.append("ScalaTest code is ")
* buf.append("clear!")
* assert(buf.toString === "ScalaTest code is clear!")
* }
* }
* }
*
*
*
* Often when you create fixtures in a trait like DbFixture, you'll still need to enable individual test classes
* to "setup" a newly created fixture before it gets passed into the tests. A good way to accomplish this is to pass the newly
* created fixture into a setup method, like populateDb in the previous example, before passing it to the test
* function. Classes that need to perform such setup can override the method, as does ExampleSpec.
*
*
*
* If a test doesn't need the fixture, you can indicate that by leaving off the fixture parameter, as is done in the
* third test in the previous example, “Test code should be clear”. For such methods, runTest
* will not invoke withFixture(OneArgTest). It will instead directly invoke withFixture(NoArgTest).
*
*
*
* Both examples shown above demonstrate the technique of giving each test its own "fixture sandbox" to play in. When your fixtures
* involve external side-effects, like creating files or databases, it is a good idea to give each file or database a unique name as is
* done in these examples. This keeps tests completely isolated, allowing you to run them in parallel if desired. You could mix
* ParallelTestExecution into either of these ExampleSpec classes, and the tests would run in parallel just fine.
*
*
* @author Bill Venners
*/
@Finders(Array("org.scalatest.finders.SpecFinder"))
trait Spec extends Suite { thisSuite =>
private final val engine = new FixtureEngine[FixtureParam]("concurrentSpecMod", "Spec")
import engine._
// Sychronized on thisSuite, only accessed from ensureScopesAndTestsRegistered
private var scopesRegistered = false
private def ensureScopesAndTestsRegistered() {
thisSuite.synchronized {
if (!scopesRegistered) {
scopesRegistered = true
def getMethod(o: AnyRef, testName: String) = {
val methodName = encode(simpleNameForTest(testName))
val candidateMethods = o.getClass.getMethods.filter(_.getName == methodName)
if (candidateMethods.size == 0)
throw new IllegalArgumentException(Resources("testNotFound", testName))
candidateMethods(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) {
val testMethods = o.getClass.getMethods.filter(isTestMethod(_)).sorted(MethodNameEncodedOrdering)
// TODO: Detect duplicate test names, one with fixture param and one without.
testMethods.foreach { m =>
val scope = isScopeMethod(o, m)
if (scope) {
val scopeDesc = getScopeDesc(m)
def scopeFun =
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)
registerNestedBranch(scopeDesc, None, scopeFun, "registrationAlreadyClosed", sourceFileName, "ensureScopesAndTestsRegistered", 2, 0, Some(scopeLocation))
}
else {
val methodName = m.getName
val testName =
// if (m.getParameterTypes.length == 0)
decode(methodName)
// else
// decode(methodName) + FixtureInParens
val methodTags = getMethodTags(o, testName)
val testFun: FixtureParam => Unit = (fixture: FixtureParam) => {
val anyRefFixture: AnyRef = fixture.asInstanceOf[AnyRef] // TODO zap this cast
val argsArray: Array[Object] =
if (m.getParameterTypes.length == 0)
Array.empty
else
Array(anyRefFixture)
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(IgnoreAnnotation) || methodTags.contains(IgnoreAnnotation)
case None => methodTags.contains(IgnoreAnnotation)
}
if (isIgnore)
registerIgnoredTest(testName, testFun, "registrationAlreadyClosed", sourceFileName, "ensureScopesAndTestsRegistered", 3, 0, Some(testLocation), methodTags.map(new Tag(_)): _*)
else
registerTest(testName, testFun, "registrationAlreadyClosed", sourceFileName, "ensureScopesAndTestsRegistered", 2, 1, None, Some(testLocation), 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 = "Spec.scala"
/**
* Returns an Informer 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
* Spec 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
* throw an exception. This method can be called safely by any thread.
*/
implicit protected def info: Informer = atomicInformer.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 while this
* Spec 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
* throw an exception. This method can be called safely by any thread.
*/
implicit protected def markup: Documenter = atomicDocumenter.get
/**
* An immutable Set of test names. If this Spec 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 name of each surrounding scope object, in order from outside in, and the name of the
* test method itself, with all components separated by a space. For example, consider this Spec:
*
*
*
* import org.scalatest.Spec
*
* class StackSpec extends Spec {
* 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 Spec 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"
*
*
*
* This trait's implementation of this method will first ensure that the discovery of scope objects and test methods
* has been performed.
*
*/
override def testNames: Set[String] = {
ensureScopesAndTestsRegistered()
// I'm returning a ListSet here so that they tests will be run in registration order
ListSet(atomic.get.testNamesList.toArray: _*)
}
/**
* 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 scope objects surrounding a test,
* from outside in, and the test method's name, with one space placed between each item. (See the documentation
* for testNames for an example.)
*
*
* This trait's implementation of this method will first ensure that the discovery of scope objects and test methods
* has been performed.
*
*
* @param testName the name of one test to execute.
* @param args the Args for this run
*
* @throws NullPointerException if any of testName, reporter, stopper, or configMap
* is null.
*/
protected override def runTest(testName: String, args: Args): Status = {
ensureScopesAndTestsRegistered()
def invokeWithFixture(theTest: TestLeaf) {
val theConfigMap = args.configMap
val testData = testDataFor(testName, theConfigMap)
withFixture(
new OneArgTest {
val name = testData.name
def apply(fixture: FixtureParam) { theTest.testFun(fixture) }
val configMap = testData.configMap
val scopes = testData.scopes
val text = testData.text
val tags = testData.tags
}
//new TestFunAndConfigMap(testName, theTest.testFun, theConfigMap)
)
}
runTestImpl(thisSuite, testName, args, true, invokeWithFixture)
}
/**
* The total number of tests that are expected to run when this Spec's run method is invoked.
*
*
* This trait's implementation of this method returns the sum of:
*
*
*
* - the size of the
testNames List, minus the number of tests marked as ignored and
* any tests that are exluded by the passed Filter
* - the sum of the values obtained by invoking
*
expectedTestCount on every nested Suite contained in
* nestedSuites
*
*
*
* This trait's implementation of this method will first ensure that the discovery of scope objects and test methods
* has been performed.
*
*
* @param filter a Filter with which to filter tests to count based on their tags
*/
final override def expectedTestCount(filter: Filter): Int = {
ensureScopesAndTestsRegistered()
super.expectedTestCount(filter)
}
/**
* A Map whose keys are String tag names to which tests in this Spec belong, and values
* the Set of test names that belong to each tag. If this Spec contains no tags, this method returns an empty Map.
*
*
* This trait's implementation returns tags that were passed as strings contained in Tag objects passed to
* methods test and ignore.
*
*
*
* 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 @Ignore.
*
*
*
* This trait's implementation of this method will first ensure that the discovery of scope objects and test methods
* has been performed.
*
*/
override def tags: Map[String, Set[String]] = {
ensureScopesAndTestsRegistered()
autoTagClassAnnotations(atomic.get.tagsMap, this)
}
/**
* Run zero to many of this Spec'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 Spec.
* @param args the Args for this run
*
* @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 Spec
*/
protected override def runTests(testName: Option[String], args: Args): Status = {
ensureScopesAndTestsRegistered()
runTestsImpl(thisSuite, testName, args, info, true, runTest)
}
/**
* Runs this fixture.Spec.
*
* If testName is None, this trait's implementation of this method
* calls these two methods on this object in this order:
*
*
* runNestedSuites(report, stopper, tagsToInclude, tagsToExclude, configMap, distributor)runTests(testName, report, stopper, tagsToInclude, tagsToExclude, configMap)
*
*
* If testName is defined, then this trait's implementation of this method
* calls runTests, but does not call runNestedSuites. This behavior
* is part of the contract of this method. Subclasses that override run must take
* care not to call runNestedSuites if testName is defined. (The
* OneInstancePerTest trait depends on this behavior, for example.)
*
*
*
* This trait's implementation of this method will first ensure that the discovery of scope objects and test methods
* has been performed.
*
*
*
* @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
*
* @throws NullPointerException if any passed parameter is null.
* @throws IllegalArgumentException if testName is defined, but no test with the specified test name
* exists in this Suite
*/
override def run(testName: Option[String], args: Args): Status = {
ensureScopesAndTestsRegistered()
runImpl(thisSuite, testName, args, super.run)
}
/**
* Suite style name.
*/
final override val styleName: String = "org.scalatest.fixture.Spec"
override def testDataFor(testName: String, theConfigMap: Map[String, Any] = Map.empty): TestData = createTestDataFor(testName, theConfigMap, this)
}
private[scalatest] object Spec {
def isTestMethod(m: Method): Boolean = {
val isInstanceMethod = !Modifier.isStatic(m.getModifiers())
val paramTypes = m.getParameterTypes
val hasNoParamOrFixtureParam = paramTypes.isEmpty || paramTypes.length == 1
// name must have at least one encoded space: "$u0220"
val includesEncodedSpace = m.getName.indexOf("$u0020") >= 0
val isOuterMethod = m.getName.endsWith("$$outer")
val isNestedMethod = m.getName.matches(".+\\$\\$.+\\$[1-9]+")
// def maybe(b: Boolean) = if (b) "" else "!"
// println("m.getName: " + m.getName + ": " + maybe(isInstanceMethod) + "isInstanceMethod, " + maybe(hasNoParams) + "hasNoParams, " + maybe(includesEncodedSpace) + "includesEncodedSpace")
isInstanceMethod && hasNoParamOrFixtureParam && includesEncodedSpace && !isOuterMethod && !isNestedMethod
}
import java.security.MessageDigest
import scala.io.Codec
// The following compactify code is written based on scala compiler source code at:-
// https://github.com/scala/scala/blob/master/src/reflect/scala/reflect/internal/StdNames.scala#L47
private val compactifiedMarker = "$$$$"
def equalIfRequiredCompactify(value: String, compactified: String): Boolean = {
if (compactified.matches(".+\\$\\$\\$\\$.+\\$\\$\\$\\$.+")) {
val firstDolarIdx = compactified.indexOf("$$$$")
val lastDolarIdx = compactified.lastIndexOf("$$$$")
val prefix = compactified.substring(0, firstDolarIdx)
val suffix = compactified.substring(lastDolarIdx + 4)
val lastIndexOfDot = value.lastIndexOf(".")
val toHash =
if (lastIndexOfDot >= 0)
value.substring(0, value.length - 1).substring(value.lastIndexOf(".") + 1)
else
value
val bytes = Codec.toUTF8(toHash.toArray)
val md5 = MessageDigest.getInstance("MD5")
md5.update(bytes)
val md5chars = (md5.digest() map (b => (b & 0xFF).toHexString)).mkString
(prefix + compactifiedMarker + md5chars + compactifiedMarker + suffix) == compactified
}
else
value == compactified
}
}