org.scalatest.fixture.FixtureFlatSpec.scala Maven / Gradle / Ivy
Show all versions of scalatest_2.8.0 Show documentation
/*
* Copyright 2001-2009 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 org.scalatest._
import FixtureNodeFamily._
import verb.{ResultOfTaggedAsInvocation, ResultOfStringPassedToVerb, BehaveWord, ShouldVerb, MustVerb, CanVerb}
import scala.collection.immutable.ListSet
import org.scalatest.StackDepthExceptionHelper.getStackDepth
import java.util.concurrent.atomic.AtomicReference
import java.util.ConcurrentModificationException
import org.scalatest.events._
import Suite.anErrorThatShouldCauseAnAbort
/**
* A sister trait to org.scalatest.FlatSpec that can pass a fixture object into its tests.
*
*
* This trait behaves similarly to trait org.scalatest.FlatSpec, except that tests may take a fixture object. The type of the
* fixture object passed is defined by the abstract Fixture type, which is declared as a member of this trait (inherited
* from supertrait FixtureSuite).
* This trait also inherits the abstract method withFixture from supertrait FixtureSuite. The withFixture method
* takes a OneArgTest, which is a nested trait defined as a member of supertrait FixtureSuite.
* OneArgTest has an apply method that takes a Fixture.
* This apply method is responsible for running a test.
* This trait's runTest method delegates the actual running of each test to withFixture, passing
* in the test code to run via the OneArgTest argument. The withFixture method (abstract in this trait) is responsible
* for creating the fixture and passing it to the test function.
*
*
*
* Subclasses of this trait must, therefore, do three things differently from a plain old org.scalatest.FlatSpec:
*
*
*
* - define the type of the fixture object by specifying type
Fixture
* - define the
withFixture method
* - write tests that take a
Fixture (You can also define tests that don't take a Fixture.)
*
*
*
* Here's an example:
*
*
*
* import org.scalatest.fixture.FixtureFlatSpec
* import java.io.FileReader
* import java.io.FileWriter
* import java.io.File
*
* class MyFlatSpec extends FixtureFlatSpec {
*
* // 1. define type FixtureParam
* type FixtureParam = FileReader
*
* // 2. define the withFixture method
* def withFixture(test: OneArgTest) {
*
* val FileName = "TempFile.txt"
*
* // Set up the temp file needed by the test
* val writer = new FileWriter(FileName)
* try {
* writer.write("Hello, test!")
* }
* finally {
* writer.close()
* }
*
* // Create the reader needed by the test
* val reader = new FileReader(FileName)
*
* try {
* // Run the test using the temp file
* test(reader)
* }
* finally {
* // Close and delete the temp file
* reader.close()
* val file = new File(FileName)
* file.delete()
* }
* }
*
* // 3. write tests that take a fixture parameter
* it should "read from the temp file" in { reader =>
* var builder = new StringBuilder
* var c = reader.read()
* while (c != -1) {
* builder.append(c.toChar)
* c = reader.read()
* }
* assert(builder.toString === "Hello, test!")
* }
*
* it should "read the first char of the temp file" in { reader =>
* assert(reader.read() === 'H')
* }
*
* // (You can also write tests that don't take a fixture parameter.)
* it should "work without a fixture" in { () =>
* assert(1 + 1 === 2)
* }
* }
*
*
*
* 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 tuple. Here's an example that takes the tuple approach:
*
*
*
* import org.scalatest.fixture.FixtureFlatSpec
* import scala.collection.mutable.ListBuffer
*
* class MyFlatSpec extends FixtureFlatSpec {
*
* type FixtureParam = (StringBuilder, ListBuffer[String])
*
* def withFixture(test: OneArgTest) {
*
* // Create needed mutable objects
* val stringBuilder = new StringBuilder("ScalaTest is ")
* val listBuffer = new ListBuffer[String]
*
* // Invoke the test function, passing in the mutable objects
* test(stringBuilder, listBuffer)
* }
*
* it should "mutate shared fixture objects" in { fixture =>
* val (builder, buffer) = fixture
* builder.append("easy!")
* assert(builder.toString === "ScalaTest is easy!")
* assert(buffer.isEmpty)
* buffer += "sweet"
* }
*
* it should "get a fresh set of mutable fixture objects" in { fixture =>
* val (builder, buffer) = fixture
* builder.append("fun!")
* assert(builder.toString === "ScalaTest is fun!")
* assert(buffer.isEmpty)
* }
* }
*
*
*
* When using a tuple to pass multiple fixture objects, it is usually helpful to give names to each
* individual object in the tuple with a pattern-match assignment, as is done at the beginning
* of each test here with:
*
*
*
* val (builder, buffer) = fixture
*
*
*
* Another good approach to passing multiple fixture objects is
* to encapsulate them in a case class. Here's an example that takes the case class approach:
*
*
*
* import org.scalatest.fixture.FixtureFlatSpec
* import scala.collection.mutable.ListBuffer
*
* class MyFlatSpec extends FixtureFlatSpec {
*
* case class FixtureHolder(builder: StringBuilder, buffer: ListBuffer[String])
*
* type FixtureParam = FixtureHolder
*
* def withFixture(test: OneArgTest) {
*
* // Create needed mutable objects
* val stringBuilder = new StringBuilder("ScalaTest is ")
* val listBuffer = new ListBuffer[String]
*
* // Invoke the test function, passing in the mutable objects
* test(FixtureHolder(stringBuilder, listBuffer))
* }
*
* it should "mutate shared fixture objects" in { fixture =>
* import fixture._
* builder.append("easy!")
* assert(builder.toString === "ScalaTest is easy!")
* assert(buffer.isEmpty)
* buffer += "sweet"
* }
*
* it should "get a fresh set of mutable fixture objects" in { fixture =>
* fixture.builder.append("fun!")
* assert(fixture.builder.toString === "ScalaTest is fun!")
* assert(fixture.buffer.isEmpty)
* }
* }
*
*
*
* When using a case class to pass multiple fixture objects, it can be helpful to make the names of each
* individual object available as a single identifier with an import statement. This is the approach
* taken by the testEasy method in the previous example. Because it imports the members
* of the fixture object, the test code can just use them as unqualified identifiers:
*
*
*
* it should "mutate shared fixture objects" in { fixture =>
* import fixture._
* builder.append("easy!")
* assert(builder.toString === "ScalaTest is easy!")
* assert(buffer.isEmpty)
* buffer += "sweet"
* }
*
*
*
* Alternatively, you may sometimes prefer to qualify each use of a fixture object with the name
* of the fixture parameter. This approach, taken by the testFun method in the previous
* example, makes it more obvious which variables in your test
* are part of the passed-in fixture:
*
*
*
* it should "get a fresh set of mutable fixture objects" in { fixture =>
* fixture.builder.append("fun!")
* assert(fixture.builder.toString === "ScalaTest is fun!")
* assert(fixture.buffer.isEmpty)
* }
*
*
* Configuring fixtures and tests
*
*
* Sometimes you may want to write tests that are configurable. For example, you may want to write
* a suite of tests that each take an open temp file as a fixture, but whose file name is specified
* externally so that the file name can be can be changed from run to run. To accomplish this
* the OneArgTest trait has a configMap
* method, which will return a Map[String, Any] from which configuration information may be obtained.
* The runTest method of this trait will pass a OneArgTest to withFixture
* whose configMap method returns the configMap passed to runTest.
* Here's an example in which the name of a temp file is taken from the passed configMap:
*
*
*
* import org.scalatest.fixture.FixtureFlatSpec
* import java.io.FileReader
* import java.io.FileWriter
* import java.io.File
*
* class MyFlatSpec extends FixtureFlatSpec {
*
* type FixtureParam = FileReader
*
* def withFixture(test: OneArgTest) {
*
* require(
* test.configMap.contains("TempFileName"),
* "This suite requires a TempFileName to be passed in the configMap"
* )
*
* // Grab the file name from the configMap
* val FileName = test.configMap("TempFileName")
*
* // Set up the temp file needed by the test
* val writer = new FileWriter(FileName)
* try {
* writer.write("Hello, test!")
* }
* finally {
* writer.close()
* }
*
* // Create the reader needed by the test
* val reader = new FileReader(FileName)
*
* try {
* // Run the test using the temp file
* test(reader)
* }
* finally {
* // Close and delete the temp file
* reader.close()
* val file = new File(FileName)
* file.delete()
* }
* }
*
* it should "read from the temp file" in { reader =>
* var builder = new StringBuilder
* var c = reader.read()
* while (c != -1) {
* builder.append(c.toChar)
* c = reader.read()
* }
* assert(builder.toString === "Hello, test!")
* }
*
* it should "read the first char of the temp file" in { reader =>
* assert(reader.read() === 'H')
* }
* }
*
*
*
* If you want to pass into each test the entire configMap that was passed to runTest, you
* can mix in trait ConfigMapFixture. See the documentation
* for ConfigMapFixture for the details, but here's a quick
* example of how it looks:
*
*
*
* import org.scalatest.fixture.FixtureFlatSpec
* import org.scalatest.fixture.ConfigMapFixture
*
* class MyFlatSpec extends FixtureFlatSpec with ConfigMapFixture {
*
* it should "contain hello" in { configMap =>
* // Use the configMap passed to runTest in the test
* assert(configMap.contains("hello")
* }
*
* it should "contain world" in { configMap =>
* assert(configMap.contains("world")
* }
* }
*
*
*
* ConfigMapFixture can also be used to facilitate writing FixtureFlatSpecs that include tests
* that take different fixture types. See the documentation for MultipleFixtureFlatSpec for more information.
*
*
* @author Bill Venners
*/
trait FixtureFlatSpec extends FixtureSuite with ShouldVerb with MustVerb with CanVerb { thisSuite =>
private val IgnoreTagName = "org.scalatest.Ignore"
private class Bundle private(
val trunk: Trunk,
val currentBranch: Branch,
val tagsMap: Map[String, Set[String]],
// All tests, in reverse order of registration
val testsList: List[FixtureTestLeaf[FixtureParam]],
// Used to detect at runtime that they've stuck a describe or an it inside an it,
// which should result in a TestRegistrationClosedException
val registrationClosed: Boolean
) {
def unpack = (trunk, currentBranch, tagsMap, testsList, registrationClosed)
}
private object Bundle {
def apply(
trunk: Trunk,
currentBranch: Branch,
tagsMap: Map[String, Set[String]],
testsList: List[FixtureTestLeaf[FixtureParam]],
registrationClosed: Boolean
): Bundle =
new Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed)
def initialize(
trunk: Trunk,
tagsMap: Map[String, Set[String]],
testsList: List[FixtureTestLeaf[FixtureParam]],
registrationClosed: Boolean
): Bundle =
new Bundle(trunk, trunk, tagsMap, testsList, registrationClosed)
}
private val atomic =
new AtomicReference[Bundle](
Bundle.initialize(new Trunk, Map(), List[FixtureTestLeaf[FixtureParam]](), false)
)
private def updateAtomic(oldBundle: Bundle, newBundle: Bundle) {
val shouldBeOldBundle = atomic.getAndSet(newBundle)
if (!(shouldBeOldBundle eq oldBundle))
throw new ConcurrentModificationException(Resources("concurrentFixtureFlatSpecBundleMod"))
}
private def registerTest(specText: String, f: FixtureParam => Any) = {
val oldBundle = atomic.get
var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack
val testName = getTestName(specText, currentBranch)
if (testsList.exists(_.testName == testName)) {
throw new DuplicateTestNameException(testName, getStackDepth("FlatSpec.scala", "it"))
}
val testShortName = specText
val test = FixtureTestLeaf(currentBranch, testName, specText, f)
currentBranch.subNodes ::= test
testsList ::= test
updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed))
testName
}
private class RegistrationInformer extends Informer {
def apply(message: String) {
if (message == null)
throw new NullPointerException
val oldBundle = atomic.get
var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack
currentBranch.subNodes ::= InfoLeaf(currentBranch, message)
updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed))
}
}
// The informer will be a registration informer until run is called for the first time. (This
// is the registration phase of a FixtureFlatSpec's lifecycle.)
private final val atomicInformer = new AtomicReference[Informer](new RegistrationInformer)
/**
* 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
* FixtureFlatSpec 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
private val zombieInformer =
new Informer {
private val complaint = Resources("cantCallInfoNow", "FixtureFlatSpec")
def apply(message: String) {
if (message == null)
throw new NullPointerException
throw new IllegalStateException(complaint)
}
}
/**
* Register a test with the given spec text, optional tags, and test function value that takes no arguments.
* An invocation of this method is called an “example.”
*
* This method will register the test for later execution via an invocation of one of the execute
* methods. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for testNames for an example.) The resulting test name must not have been registered previously on
* this Spec instance.
*
* @param specText the specification text, which will be combined with the descText of any surrounding describers
* to form the test name
* @param testTags the optional list of tags for this test
* @param testFun the test function
* @throws DuplicateTestNameException if a test with the same name has been registered previously
* @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
* @throws NullPointerException if specText or any passed test tag is null
*/
private def registerTestToRun(specText: String, testTags: List[Tag], testFun: FixtureParam => Any) {
if (atomic.get.registrationClosed)
throw new TestRegistrationClosedException(Resources("itCannotAppearInsideAnotherIt"), getStackDepth("FlatSpec.scala", "it"))
if (specText == null)
throw new NullPointerException("specText was null")
if (testTags.exists(_ == null))
throw new NullPointerException("a test tag was null")
val testName = registerTest(specText, testFun)
val oldBundle = atomic.get
var (trunk, currentBranch, tagsMap, testsList, registrationClosed2) = oldBundle.unpack
val tagNames = Set[String]() ++ testTags.map(_.name)
if (!tagNames.isEmpty)
tagsMap += (testName -> tagNames)
updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed2))
}
/**
* Class that supports the registration of a “subject” being specified and tested via the
* instance referenced from FixtureFlatSpec's behavior field.
*
*
* This field enables syntax such as the following subject registration:
*
*
*
* behavior of "A Stack"
* ^
*
*
*
* For more information and examples of the use of the behavior field, see the main documentation
* for trait FlatSpec.
*
*/
protected final class BehaviorWord {
/**
* Supports the registration of a “subject” being specified and tested via the
* instance referenced from FixtureFlatSpec's behavior field.
*
*
* This method enables syntax such as the following subject registration:
*
*
*
* behavior of "A Stack"
* ^
*
*
*
* For more information and examples of the use of this method, see the main documentation
* for trait FlatSpec.
*
*/
def of(description: String) {
if (atomic.get.registrationClosed)
throw new TestRegistrationClosedException(Resources("describeCannotAppearInsideAnIt"), getStackDepth("FlatSpec.scala", "describe"))
val oldBundle = atomic.get
var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack
val newBranch = DescriptionBranch(trunk, description)
trunk.subNodes ::= newBranch
currentBranch = newBranch
updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed))
}
}
/**
* Supports the registration of a “subject” being specified and tested.
*
*
* This field enables syntax such as the following subject registration:
*
*
*
* behavior of "A Stack"
* ^
*
*
*
* For more information and examples of the use of the behavior field, see the main documentation
* for trait FlatSpec.
*
*/
protected val behavior = new BehaviorWord
// TODO: Do a walk through. Are all these being used. I guess I'll find out when
// I document them.
/**
* Class that supports the registration of tagged tests via the ItWord instance
* referenced from FixtureFlatSpec's it field.
*
*
* This class enables syntax such as the following tagged test registration:
*
*
*
* it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* It also enables syntax such as the following registration of an ignored, tagged test:
*
*
*
* it should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of a pending, tagged test:
*
*
*
* it should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* For more information and examples of the use of the it field to register tagged tests, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
protected final class ItVerbStringTaggedAs(verb: String, name: String, tags: List[Tag]) {
/**
* Supports the registration of tagged, no-arg tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) in { () => ... }
* ^
*
*
*
* For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
def in(testFun: () => Any) {
registerTestToRun(verb + " " + name, tags, new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of tagged, one-arg tests (tests that take a Fixture object as a parameter) in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) in { fixture => ... }
* ^
*
*
*
* For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
def in(testFun: FixtureParam => Any) {
registerTestToRun(verb + " " + name, tags, testFun)
}
/**
* Supports the registration of pending, tagged tests in a FlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait FlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
def is(testFun: => PendingNothing) {
registerTestToRun(verb + " " + name, tags, unusedFixtureParam => testFun)
}
/**
* Supports the registration of ignored, tagged, no-arg tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait FlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
def ignore(testFun: () => Any) {
registerTestToIgnore(verb + " " + name, tags, new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of ignored, tagged, one-arg tests (tests that take a Fixture object
* as a parameter) in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait FlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
def ignore(testFun: FixtureParam => Any) {
registerTestToIgnore(verb + " " + name, tags, testFun)
}
}
/**
* Class that supports test registration via the instance referenced from FixtureFlatSpec's it field.
*
*
* This class enables syntax such as the following test registration:
*
*
*
* it should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following registration of an ignored test:
*
*
*
* it should "pop values in last-in-first-out order" ignore { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of a pending test:
*
*
*
* it should "pop values in last-in-first-out order" is (pending)
* ^
*
*
*
* And finally, it also enables syntax such as the following tagged test registration:
*
*
*
* it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait FixtureFlatSpec.
*
*/
protected final class ItVerbString(verb: String, name: String) {
/**
* Supports the registration of no-arg tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" in { () => ... }
* ^
*
*
*
* For examples of no-arg test registration, see the main documentation
* for trait FixtureFlatSpec.
*
*/
def in(testFun: () => Any) {
registerTestToRun(verb + " " + name, List(), new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of one-arg tests (tests that take a Fixture object as a parameter) in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" in { fixture => ... }
* ^
*
*
*
* For examples of one-arg test registration, see the main documentation
* for trait FixtureFlatSpec.
*
*/
def in(testFun: FixtureParam => Any) {
registerTestToRun(verb + " " + name, List(), testFun)
}
/**
* Supports the registration of pending tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" is (pending)
* ^
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait FlatSpec.
*
*/
def is(testFun: => PendingNothing) {
registerTestToRun(verb + " " + name, List(), unusedFixtureParam => testFun)
}
/**
* Supports the registration of ignored no-arg tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait FlatSpec.
*
*/
def ignore(testFun: () => Any) {
registerTestToIgnore(verb + " " + name, List(), new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of ignored one-arg tests (tests that take a Fixture object as a parameter) in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait FlatSpec.
*
*/
def ignore(testFun: FixtureParam => Any) {
registerTestToIgnore(verb + " " + name, List(), testFun)
}
/**
* Supports the registration of tagged tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section in the main documentation
* for trait FlatSpec.
*
*/
def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
val tagList = firstTestTag :: otherTestTags.toList
new ItVerbStringTaggedAs(verb, name, tagList)
}
}
/**
* Class that supports test (and shared test) registration via the instance referenced from FixtureFlatSpec's it field.
*
*
* This class enables syntax such as the following test registration:
*
*
*
* it should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following shared test registration:
*
*
*
* it should behave like nonEmptyStack(lastItemPushed)
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait FlatSpec.
*
*/
protected final class ItWord {
/**
* Supports the registration of tests with should in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait FlatSpec.
*
*/
def should(string: String) = new ItVerbString("should", string)
/**
* Supports the registration of tests with must in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait FlatSpec.
*
*/
def must(string: String) = new ItVerbString("must", string)
/**
* Supports the registration of tests with can in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it can "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait FlatSpec.
*
*/
def can(string: String) = new ItVerbString("can", string)
/**
* Supports the registration of shared tests with should in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it should behave like nonFullStack(stackWithOneItem)
* ^
*
*
*
* For examples of shared tests, see the Shared tests section
* in the main documentation for trait FlatSpec.
*
*/
def should(behaveWord: BehaveWord) = behaveWord
/**
* Supports the registration of shared tests with must in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must behave like nonFullStack(stackWithOneItem)
* ^
*
*
*
* For examples of shared tests, see the Shared tests section
* in the main documentation for trait FlatSpec.
*
*/
def must(behaveWord: BehaveWord) = behaveWord
/**
* Supports the registration of shared tests with can in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it can behave like nonFullStack(stackWithOneItem)
* ^
*
*
*
* For examples of shared tests, see the Shared tests section
* in the main documentation for trait FlatSpec.
*
*/
def can(behaveWord: BehaveWord) = behaveWord
}
/**
* Supports test (and shared test) registration in FixtureFlatSpecs.
*
*
* This field enables syntax such as the following test registration:
*
*
*
* it should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following shared test registration:
*
*
*
* it should behave like nonEmptyStack(lastItemPushed)
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait FlatSpec.
*
*/
protected val it = new ItWord
/**
* Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced
* from FixtureFlatSpec's ignore field.
*
*
* This class enables syntax such as the following registration of an ignored, tagged test:
*
*
*
* ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of an ignored, tagged, pending test:
*
*
*
* ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* Note: the is method is provided for completeness and design symmetry, given there's no way
* to prevent changing is to ignore and marking a pending test as ignored that way.
* Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
*
*
*
* For more information and examples of the use of the ignore field, see
* the Ignored tests section
* in the main documentation for trait FlatSpec. For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
protected final class IgnoreVerbStringTaggedAs(verb: String, name: String, tags: List[Tag]) {
/**
* Supports the registration of ignored, tagged, no-arg tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { () => ... }
* ^
*
*
*
* For examples of the registration of ignored tests, see the Ignored tests section
* in the main documentation for trait FlatSpec. For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
def in(testFun: () => Any) {
registerTestToIgnore(verb + " " + name, tags, new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of ignored, tagged, one-arg tests (tests that take a Fixture object as a parameter)
* in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { fixture => ... }
* ^
*
*
*
* For examples of the registration of ignored tests, see the Ignored tests section
* in the main documentation for trait FlatSpec. For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
def in(testFun: FixtureParam => Any) {
registerTestToIgnore(verb + " " + name, tags, testFun)
}
/**
* Supports the registration of ignored, tagged, pending tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* Note: this is method is provided for completeness and design symmetry, given there's no way
* to prevent changing is to ignore and marking a pending test as ignored that way.
* Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait FlatSpec. For examples of the registration of ignored tests,
* see the Ignored tests section
* in the main documentation for trait FlatSpec. For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait FlatSpec.
*
*/
def is(testFun: => PendingNothing) {
registerTestToIgnore(verb + " " + name, tags, unusedFixtureParam => testFun)
}
}
/**
* Class that supports registration of ignored tests via the IgnoreWord instance referenced
* from FixtureFlatSpec's ignore field.
*
*
* This class enables syntax such as the following registration of an ignored test:
*
*
*
* ignore should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of an ignored, pending test:
*
*
*
* ignore should "pop values in last-in-first-out order" is (pending)
* ^
*
*
* Note: the is method is provided for completeness and design symmetry, given there's no way
* to prevent changing is to ignore and marking a pending test as ignored that way.
* Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
*
*
*
* And finally, it also enables syntax such as the following ignored, tagged test registration:
*
*
*
* ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
*
* For more information and examples of the use of the ignore field, see the Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
protected final class IgnoreVerbString(verb: String, name: String) {
/**
* Supports the registration of ignored, no-arg tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" in { () => ... }
* ^
*
*
*
* For examples of the registration of ignored tests, see the Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def in(testFun: () => Any) {
registerTestToIgnore(verb + " " + name, List(), new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of ignored, one-arg tests (tests that take a Fixture object
* as a parameter) in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" in { fixture => ... }
* ^
*
*
*
* For examples of the registration of ignored tests, see the Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def in(testFun: FixtureParam => Any) {
registerTestToIgnore(verb + " " + name, List(), testFun)
}
/**
* Supports the registration of ignored, pending tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" is (pending)
* ^
*
*
*
* Note: this is method is provided for completeness and design symmetry, given there's no way
* to prevent changing is to ignore and marking a pending test as ignored that way.
* Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait FlatSpec. For examples of the registration of ignored tests,
* see the Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def is(testFun: => PendingNothing) {
registerTestToIgnore(verb + " " + name, List(), unusedFixtureParam => testFun)
}
/**
* Supports the registration of ignored, tagged tests in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section in the main documentation
* for trait FlatSpec. For examples of the registration of ignored tests,
* see the Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
val tagList = firstTestTag :: otherTestTags.toList
new IgnoreVerbStringTaggedAs(verb, name, tagList)
}
}
/**
* Class that supports registration of ignored tests via the instance referenced from FixtureFlatSpec's ignore field.
*
*
* This class enables syntax such as the following registration of an ignored test:
*
*
*
* ignore should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see Ignored tests section
* in the main documentation for this trait.
*
*/
protected final class IgnoreWord {
/**
* Supports the registration of ignored tests with should in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def should(string: String) = new IgnoreVerbString("should", string)
/**
* Supports the registration of ignored tests with must in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def must(string: String) = new IgnoreVerbString("must", string)
/**
* Supports the registration of ignored tests with can in a FixtureFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore can "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def can(string: String) = new IgnoreVerbString("can", string)
}
/**
* Supports registration of ignored tests in FixtureFlatSpecs.
*
*
* This field enables syntax such as the following registration of an ignored test:
*
*
*
* ignore should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see the
* Ignored tests section in the main documentation for trait FlatSpec.
*
*/
protected val ignore = new IgnoreWord
/**
* Class that supports test registration in shorthand form.
*
*
* For example, this class enables syntax such as the following test registration
* in shorthand form:
*
*
*
* "A Stack (when empty)" should "be empty" in { ... }
* ^
*
*
*
* This class also enables syntax such as the following ignored test registration
* in shorthand form:
*
*
*
* "A Stack (when empty)" should "be empty" ignore { ... }
* ^
*
*
*
* This class is used via an implicit conversion (named convertToInAndIgnoreMethods)
* from ResultOfStringPassedToVerb. The ResultOfStringPassedToVerb class
* does not declare any methods named in, because the
* type passed to in differs in a FlatSpec and a FixtureFlatSpec.
* A FixtureFlatSpec needs two in methods, one that takes a no-arg
* test function and another that takes a one-arg test function (a test that takes a
* Fixture as its parameter). By constrast, a FlatSpec needs
* only one in method that takes a by-name parameter. As a result,
* FlatSpec and FixtureFlatSpec each provide an implicit conversion
* from ResultOfStringPassedToVerb to a type that provides the appropriate
* in methods.
*
*
* @author Bill Venners
*/
protected final class InAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb) {
import resultOfStringPassedToVerb.verb
import resultOfStringPassedToVerb.rest
/**
* Supports the registration of no-arg tests in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" in { () => ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait FixtureFlatSpec.
*
*/
def in(testFun: () => Any) {
registerTestToRun(verb + " " + rest, List(), new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of ignored, no-arg tests in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def ignore(testFun: () => Any) {
registerTestToIgnore(verb + " " + rest, List(), new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of one-arg tests (tests that take a Fixture parameter) in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" in { fixture => ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait FixtureFlatSpec.
*
*/
def in(testFun: FixtureParam => Any) {
registerTestToRun(verb + " " + rest, List(), testFun)
}
/**
* Supports the registration of ignored, one-arg tests (tests that take a Fixture parameter) in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section
* in the main documentation for trait FlatSpec.
*
*/
def ignore(testFun: FixtureParam => Any) {
registerTestToIgnore(verb + " " + rest, List(), testFun)
}
}
/**
* Implicitly converts an object of type ResultOfStringPassedToVerb to an
* InAndIgnoreMethods, to enable in and ignore
* methods to be invokable on that object.
*/
protected implicit def convertToInAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb) =
new InAndIgnoreMethods(resultOfStringPassedToVerb)
/**
* Class that supports tagged test registration in shorthand form.
*
*
* For example, this class enables syntax such as the following tagged test registration
* in shorthand form:
*
*
*
* "A Stack (when empty)" should "be empty" taggedAs() in { ... }
* ^
*
*
*
* This class also enables syntax such as the following tagged, ignored test registration
* in shorthand form:
*
*
*
* "A Stack (when empty)" should "be empty" taggedAs(SlowTest) ignore { ... }
* ^
*
*
*
* This class is used via an implicit conversion (named convertToInAndIgnoreMethodsAfterTaggedAs)
* from ResultOfTaggedAsInvocation. The ResultOfTaggedAsInvocation class
* does not declare any methods named in, because the
* type passed to in differs in a FlatSpec and a FixtureFlatSpec.
* A FixtureFlatSpec needs two in methods, one that takes a no-arg
* test function and another that takes a one-arg test function (a test that takes a
* Fixture as its parameter). By constrast, a FlatSpec needs
* only one in method that takes a by-name parameter. As a result,
* FlatSpec and FixtureFlatSpec each provide an implicit conversion
* from ResultOfTaggedAsInvocation to a type that provides the appropriate
* in methods.
*
*
* @author Bill Venners
*/
protected final class InAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation) {
import resultOfTaggedAsInvocation.verb
import resultOfTaggedAsInvocation.rest
import resultOfTaggedAsInvocation.{tags => tagsList}
/**
* Supports the registration of tagged, no-arg tests in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) in { () => ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section
* in the main documentation for trait FlatSpec.
*
*/
def in(testFun: () => Any) {
registerTestToRun(verb + " " + rest, tagsList, new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of tagged, ignored, no-arg tests in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section
* in the main documentation for trait FlatSpec.
* For examples of tagged test registration, see the Tagging tests section
* in the main documentation for trait FlatSpec.
*
*/
def ignore(testFun: () => Any) {
registerTestToIgnore(verb + " " + rest, tagsList, new NoArgTestWrapper(testFun))
}
/**
* Supports the registration of tagged, one-arg tests (tests that take a Fixture parameter) in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) in { fixture => ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section
* in the main documentation for trait FlatSpec.
*
*/
def in(testFun: FixtureParam => Any) {
registerTestToRun(verb + " " + rest, tagsList, testFun)
}
/**
* Supports the registration of tagged, ignored, one-arg tests (tests that take a Fixture parameter) in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section
* in the main documentation for trait FlatSpec.
* For examples of tagged test registration, see the Tagging tests section
* in the main documentation for trait FlatSpec.
*
*/
def ignore(testFun: FixtureParam => Any) {
registerTestToIgnore(verb + " " + rest, tagsList, testFun)
}
}
/**
* Implicitly converts an object of type ResultOfTaggedAsInvocation to an
* InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore
* methods to be invokable on that object.
*/
protected implicit def convertToInAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation) =
new InAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation)
/**
* Supports the shorthand form of test registration.
*
*
* For example, this method enables syntax such as the following:
*
*
*
* "A Stack (when empty)" should "be empty" in { ... }
* ^
*
*
*
* This function is passed as an implicit parameter to a should method
* provided in ShouldVerb, a must method
* provided in MustVerb, and a can method
* provided in CanVerb. When invoked, this function registers the
* subject description (the first parameter to the function) and returns a ResultOfStringPassedToVerb
* initialized with the verb and rest parameters (the second and third parameters to
* the function, respectively).
*
*/
protected implicit val shorthandTestRegistrationFunction: (String, String, String) => ResultOfStringPassedToVerb = {
(subject, verb, rest) => {
behavior.of(subject)
new ResultOfStringPassedToVerb(verb, rest) {
def is(testFun: => PendingNothing) {
registerTestToRun(verb + " " + rest, List(), unusedFixtureParam => testFun)
}
def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
val tagList = firstTestTag :: otherTestTags.toList
new ResultOfTaggedAsInvocation(verb, rest, tagList) {
// "A Stack" must "test this" taggedAs(mytags.SlowAsMolasses) is (pending)
// ^
def is(testFun: => PendingNothing) {
registerTestToRun(verb + " " + rest, tags, new NoArgTestWrapper(testFun _))
}
}
}
}
}
}
// TODO: Get rid of unusedfixture, and use NoArgTestFunction instead
/**
* Supports the shorthand form of shared test registration.
*
*
* For example, this method enables syntax such as the following:
*
*
*
* "A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
* ^
*
*
*
* This function is passed as an implicit parameter to a should method
* provided in ShouldVerb, a must method
* provided in MustVerb, and a can method
* provided in CanVerb. When invoked, this function registers the
* subject description (the parameter to the function) and returns a BehaveWord.
*
*/
protected implicit val shorthandSharedTestRegistrationFunction: (String) => BehaveWord = {
(left) => {
behavior.of(left)
new BehaveWord
}
}
/**
* Register a test with the given spec text and test function value that takes no arguments.
*
* This method will register the test for later execution via an invocation of one of the execute
* methods. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for testNames for an example.) The resulting test name must not have been registered previously on
* this Spec instance.
*
* @param specText the specification text, which will be combined with the descText of any surrounding describers
* to form the test name
* @param testFun the test function
* @throws DuplicateTestNameException if a test with the same name has been registered previously
* @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
* @throws NullPointerException if specText or any passed test tag is null
*/
/* private def oldIt(specText: String)(testFun: => Unit) {
if (atomic.get.registrationClosed)
throw new TestRegistrationClosedException(Resources("itCannotAppearInsideAnotherIt"), getStackDepth("FlatSpec.scala", "it"))
oldIt(specText, Array[Tag](): _*)(testFun)
} */
/**
* Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.
* This method will register the test for later ignoring via an invocation of one of the execute
* methods. This method exists to make it easy to ignore an existing test by changing the call to it
* to ignore without deleting or commenting out the actual test code. The test will not be executed, but a
* report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for testNames for an example.) The resulting test name must not have been registered previously on
* this Spec instance.
*
* @param specText the specification text, which will be combined with the descText of any surrounding describers
* to form the test name
* @param testTags the optional list of tags for this test
* @param testFun the test function
* @throws DuplicateTestNameException if a test with the same name has been registered previously
* @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
* @throws NullPointerException if specText or any passed test tag is null
*/
private def registerTestToIgnore(specText: String, testTags: List[Tag], testFun: FixtureParam => Any) {
if (atomic.get.registrationClosed)
throw new TestRegistrationClosedException(Resources("ignoreCannotAppearInsideAnIt"), getStackDepth("FlatSpec.scala", "ignore"))
if (specText == null)
throw new NullPointerException("specText was null")
if (testTags.exists(_ == null))
throw new NullPointerException("a test tag was null")
val testName = registerTest(specText, testFun)
val tagNames = Set[String]() ++ testTags.map(_.name)
val oldBundle = atomic.get
var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack
tagsMap += (testName -> (tagNames + IgnoreTagName))
updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed))
}
/**
* Register a test to ignore, which has the given spec text and test function value that takes no arguments.
* This method will register the test for later ignoring via an invocation of one of the execute
* methods. This method exists to make it easy to ignore an existing test by changing the call to it
* to ignore without deleting or commenting out the actual test code. The test will not be executed, but a
* report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for testNames for an example.) The resulting test name must not have been registered previously on
* this Spec instance.
*
* @param specText the specification text, which will be combined with the descText of any surrounding describers
* to form the test name
* @param testFun the test function
* @throws DuplicateTestNameException if a test with the same name has been registered previously
* @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
* @throws NullPointerException if specText or any passed test tag is null
*/
/* protected def oldIgnore(specText: String)(testFun: => Unit) {
if (atomic.get.registrationClosed)
throw new TestRegistrationClosedException(Resources("ignoreCannotAppearInsideAnIt"), getStackDepth("FlatSpec.scala", "ignore"))
oldIgnore(specText, Array[Tag](): _*)(testFun)
} */
/**
* 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 FlatSpec 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.
*
*/
override def tags: Map[String, Set[String]] = atomic.get.tagsMap
private def runTestsInBranch(branch: Branch, reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], tracker: Tracker) {
val stopRequested = stopper
// Wrap any non-DispatchReporter, non-CatchReporter in a CatchReporter,
// so that exceptions are caught and transformed
// into error messages on the standard error stream.
val report = wrapReporterIfNecessary(reporter)
branch match {
case desc @ DescriptionBranch(_, descriptionName) =>
def sendInfoProvidedMessage() {
// Need to use the full name of the description, which includes all the descriptions it is nested inside
// Call getPrefix and pass in this Desc, to get the full name
val descriptionFullName = getPrefix(desc).trim
report(InfoProvided(tracker.nextOrdinal(), descriptionFullName, Some(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), None)), None, None, Some(IndentedText(descriptionFullName, descriptionFullName, 0))))
}
// Only send an infoProvided message if the first thing in the subNodes is *not* sub-description, i.e.,
// it is a test, because otherwise we get a lame description that doesn't have any tests under it.
// But send it if the list is empty.
if (desc.subNodes.isEmpty)
sendInfoProvidedMessage()
else
desc.subNodes.reverse.head match {
case ex: FixtureTestLeaf[_] => sendInfoProvidedMessage()
case _ => // Do nothing in this case
}
case _ =>
}
branch.subNodes.reverse.foreach(
_ match {
case FixtureTestLeaf(_, tn, specText, _) =>
if (!stopRequested()) { // TODO: Seems odd to me to check for stop here but still fire infos
val (filterTest, ignoreTest) = filter(tn, tags)
if (!filterTest)
if (ignoreTest) {
val testSucceededIcon = Resources("testSucceededIconChar")
val formattedSpecText = Resources("iconPlusShortName", testSucceededIcon, specText)
report(TestIgnored(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), tn, Some(IndentedText(formattedSpecText, specText, 1))))
}
else
runTest(tn, report, stopRequested, configMap, tracker)
}
case InfoLeaf(_, message) =>
val infoProvidedIcon = Resources("infoProvidedIconChar")
val formattedText = Resources("iconPlusShortName", infoProvidedIcon, message)
report(InfoProvided(tracker.nextOrdinal(), message,
Some(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), None)), None,
None, Some(IndentedText(formattedText, message, 1))))
case branch: Branch => runTestsInBranch(branch, reporter, stopRequested, filter, configMap, tracker)
}
)
}
/**
* 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 reporter the Reporter to which results will be reported
* @param stopper the Stopper that will be consulted to determine whether to stop execution early.
* @param configMap a Map of properties that can be used by this Spec's executing tests.
* @throws NullPointerException if any of testName, reporter, stopper, or configMap
* is null.
*/
protected override def runTest(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], tracker: Tracker) {
if (testName == null || reporter == null || stopper == null || configMap == null)
throw new NullPointerException
atomic.get.testsList.find(_.testName == testName) match {
case None => throw new IllegalArgumentException("Requested test doesn't exist: " + testName)
case Some(test) => {
val report = wrapReporterIfNecessary(reporter)
val testSucceededIcon = Resources("testSucceededIconChar")
val formattedSpecText = Resources("iconPlusShortName", testSucceededIcon, test.specText)
// Create a Rerunner if the Spec has a no-arg constructor
val hasPublicNoArgConstructor = org.scalatest.Suite.checkForPublicNoArgConstructor(getClass)
val rerunnable =
if (hasPublicNoArgConstructor)
Some(new TestRerunner(getClass.getName, testName))
else
None
val testStartTime = System.currentTimeMillis
// A TestStarting event won't normally show up in a specification-style output, but
// will show up in a test-style output.
report(TestStarting(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), test.testName, Some(MotionToSuppress), rerunnable))
val formatter = IndentedText(formattedSpecText, test.specText, 1)
val informerForThisTest =
new MessageRecordingInformer(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), Some(testName))) {
def apply(message: String) {
if (message == null)
throw new NullPointerException
if (shouldRecord)
record(message)
else {
val infoProvidedIcon = Resources("infoProvidedIconChar")
val formattedText = " " + Resources("iconPlusShortName", infoProvidedIcon, message)
report(InfoProvided(tracker.nextOrdinal(), message, nameInfoForCurrentThread, None, None, Some(IndentedText(formattedText, message, 2))))
}
}
}
val oldInformer = atomicInformer.getAndSet(informerForThisTest)
var testWasPending = false
var swapAndCompareSucceeded = false
try {
test.f match {
case wrapper: NoArgTestWrapper[_] =>
withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, configMap))
case f => withFixture(new TestFunAndConfigMap(testName, f, configMap))
}
val duration = System.currentTimeMillis - testStartTime
report(TestSucceeded(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), test.testName, Some(duration), Some(formatter), rerunnable))
}
catch {
case _: TestPendingException =>
report(TestPending(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), test.testName, Some(formatter)))
testWasPending = true
case e if !anErrorThatShouldCauseAnAbort(e) =>
val duration = System.currentTimeMillis - testStartTime
handleFailedTest(e, false, test.testName, test.specText, formattedSpecText, rerunnable, report, tracker, duration)
case e => throw e
}
finally {
// send out any recorded messages
for (message <- informerForThisTest.recordedMessages) {
val infoProvidedIcon = Resources("infoProvidedIconChar")
val formattedText = " " + Resources("iconPlusShortName", infoProvidedIcon, message)
report(InfoProvided(tracker.nextOrdinal(), message, informerForThisTest.nameInfoForCurrentThread, Some(testWasPending), None, Some(IndentedText(formattedText, message, 2))))
}
val shouldBeInformerForThisTest = atomicInformer.getAndSet(oldInformer)
swapAndCompareSucceeded = shouldBeInformerForThisTest eq informerForThisTest
}
if (!swapAndCompareSucceeded) // Do outside finally to workaround Scala compiler bug
throw new ConcurrentModificationException(Resources("concurrentInformerMod", thisSuite.getClass.getName))
}
}
}
private def handleFailedTest(throwable: Throwable, hasPublicNoArgConstructor: Boolean, testName: String,
specText: String, formattedSpecText: String, rerunnable: Option[Rerunner], report: Reporter, tracker: Tracker, duration: Long) {
val message =
if (throwable.getMessage != null) // [bv: this could be factored out into a helper method]
throwable.getMessage
else
throwable.toString
val formatter = IndentedText(formattedSpecText, specText, 1)
report(TestFailed(tracker.nextOrdinal(), message, thisSuite.suiteName, Some(thisSuite.getClass.getName), testName, Some(throwable), Some(duration), Some(formatter), rerunnable))
}
/**
*
* Run zero to many of this Spec's tests.
*
*
*
* This method takes a testName parameter that optionally specifies a test to invoke.
* If testName is Some, this trait's implementation of this method
* invokes runTest on this object, passing in:
*
*
*
* testName - the String value of the testName Option passed
* to this methodreporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to it
*
*
* This method takes a Set of tag names that should be included (tagsToInclude), and a Set
* that should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute.
* If tagsToInclude is empty, all tests will be executed
* except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is non-empty, only tests
* belonging to tags mentioned in tagsToInclude, and not mentioned in tagsToExclude
* will be executed. However, if testName is Some, tagsToInclude and tagsToExclude are essentially ignored.
* Only if testName is None will tagsToInclude and tagsToExclude be consulted to
* determine which of the tests named in the testNames Set should be run. For more information on trait tags, see the main documentation for this trait.
*
*
*
* If testName is None, this trait's implementation of this method
* invokes testNames on this Suite to get a Set of names of tests to potentially execute.
* (A testNames value of None essentially acts as a wildcard that means all tests in
* this Suite that are selected by tagsToInclude and tagsToExclude should be executed.)
* For each test in the testName Set, in the order
* they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation
* of this method checks whether the test should be run based on the tagsToInclude and tagsToExclude Sets.
* If so, this implementation invokes runTest, passing in:
*
*
*
* testName - the String name of the test to run (which will be one of the names in the testNames Set)reporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to it
*
* @param testName an optional name of one test to execute. If None, all relevant tests should be executed.
* I.e., None acts like a wildcard that means execute all relevant tests in this Spec.
* @param reporter the Reporter to which results will be reported
* @param stopper the Stopper that will be consulted to determine whether to stop execution early.
* @param tagsToInclude a Set of String tag names to include in the execution of this Spec
* @param tagsToExclude a Set of String tag names to exclude in the execution of this Spec
* @param configMap a Map of key-value pairs that can be used by this Spec's executing tests.
* @throws NullPointerException if any of testName, reporter, stopper, tagsToInclude,
* tagsToExclude, or configMap is null.
*/
protected override def runTests(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter,
configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker) {
if (testName == null)
throw new NullPointerException("testName was null")
if (reporter == null)
throw new NullPointerException("reporter was null")
if (stopper == null)
throw new NullPointerException("stopper was null")
if (filter == null)
throw new NullPointerException("filter was null")
if (configMap == null)
throw new NullPointerException("configMap was null")
if (distributor == null)
throw new NullPointerException("distributor was null")
if (tracker == null)
throw new NullPointerException("tracker was null")
val stopRequested = stopper
testName match {
case None => runTestsInBranch(atomic.get.trunk, reporter, stopRequested, filter, configMap, tracker)
case Some(tn) => runTest(tn, reporter, stopRequested, configMap, tracker)
}
}
/**
* An immutable Set of test names. If this FixtureFlatSpec 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.
*
*/
override def testNames: Set[String] = ListSet(atomic.get.testsList.map(_.testName): _*)
override def run(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter,
configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker) {
val stopRequested = stopper
// Set the flag that indicates registration is closed (because run has now been invoked),
// which will disallow any further invocations of "describe", it", or "ignore" with
// an RegistrationClosedException.
val oldBundle = atomic.get
var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack
if (!registrationClosed)
updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, true))
val report = wrapReporterIfNecessary(reporter)
val informerForThisSuite =
new ConcurrentInformer(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), None)) {
def apply(message: String) {
if (message == null)
throw new NullPointerException
report(InfoProvided(tracker.nextOrdinal(), message, nameInfoForCurrentThread))
}
}
atomicInformer.set(informerForThisSuite)
var swapAndCompareSucceeded = false
try {
super.run(testName, report, stopRequested, filter, configMap, distributor, tracker)
}
finally {
val shouldBeInformerForThisSuite = atomicInformer.getAndSet(zombieInformer)
swapAndCompareSucceeded = shouldBeInformerForThisSuite eq informerForThisSuite
}
if (!swapAndCompareSucceeded) // Do outside finally to workaround Scala compiler bug
throw new ConcurrentModificationException(Resources("concurrentInformerMod", thisSuite.getClass.getName))
}
/**
* Supports shared test registration in FixtureFlatSpecs.
*
*
* This field supports syntax such as the following:
*
*
*
* it should behave like nonFullStack(stackWithOneItem)
* ^
*
*
*
* For more information and examples of the use of behave, see the Shared tests section
* in the main documentation for trait FlatSpec.
*
*/
protected val behave = new BehaveWord
}