org.scalatest.fixture.WordSpec.scala Maven / Gradle / Ivy
Show all versions of scalatest_2.11.0-M3 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.{CanVerb, ResultOfAfterWordApplication, ShouldVerb, BehaveWord, MustVerb, StringVerbBlockRegistration} import scala.collection.immutable.ListSet import org.scalatest.exceptions.StackDepthExceptionHelper.getStackDepth import java.util.concurrent.atomic.AtomicReference import java.util.ConcurrentModificationException import org.scalatest.events._ import org.scalatest.Suite.anErrorThatShouldCauseAnAbort /** * A sister trait to
for traitorg.scalatest.WordSpec
that can pass a fixture object into its tests. * ** The purpose of
* *fixture.Suite
and its subtraits is to facilitate writing tests in * a functional style. Some users may prefer writing tests in a functional style in general, but one * particular use case is parallel test execution (See ParallelTestExecution). To run * tests in parallel, your test class must * be thread safe, and a good way to make it thread safe is to make it functional. A good way to * write tests that need common fixtures in a functional style is to pass the fixture objects into the tests, * the style enabled by thefixture.Suite
family of traits. ** Trait
* *org.scalatest.fixture.WordSpec
behaves similarly to traitorg.scalatest.WordSpec
, except that tests may have a * fixture parameter. The type of the * fixture parameter is defined by the abstractFixtureParam
type, which is declared as a member of this trait. * This trait also declares an abstractwithFixture
method. ThiswithFixture
method * takes aOneArgTest
, which is a nested trait defined as a member of this trait. *OneArgTest
has anapply
method that takes aFixtureParam
. * Thisapply
method is responsible for running a test. * This trait'srunTest
method delegates the actual running of each test towithFixture
, passing * in the test code to run via theOneArgTest
argument. ThewithFixture
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.WordSpec
: **
* *- 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.)
** Here's an example: *
* ** import org.scalatest.fixture * import collection.mutable.Stack * import java.util.NoSuchElementException * * class StackSpec extends fixture.WordSpec { * * // 1. define type FixtureParam * type FixtureParam = Stack[Int] * * // 2. define the withFixture method * def withFixture(test: OneArgTest) { * val stack = new Stack[Int] * stack.push(1) * stack.push(2) * test(stack) // "loan" the fixture to the test * } * * "A Stack" can { * * // 3. write tests that take a fixture parameter * "pop a value" in { stack => * val top = stack.pop() * assert(top === 2) * assert(stack.size === 1) * } * * "push a value" in { stack => * stack.push(9) * assert(stack.size === 3) * assert(stack.head === 9) * } * * // 4. You can also write tests that don't take a fixture parameter. * "complain if popped while empty" in { () => * intercept[NoSuchElementException] { * (new Stack[Int]).pop() * } * } * } * } ** ** In the previous example,
* *withFixture
creates and initializes a stack, then invokes the test function, passing in * the stack. In addition to setting up a fixture before a test, thewithFixture
method also allows you to * clean it up afterwards, if necessary. If you need to do some clean up that must happen even if a test * fails, you should invoke the test function from inside atry
block and do the cleanup in a *finally
clause, like this: ** def withFixture(test: OneArgTest) { * val resource = someResource.open() // set up the fixture * try { * test(resource) // if the test fails, test(...) will throw an exception * } * finally { * // clean up the fixture no matter whether the test succeeds or fails * resource.close() * } * } ** ** The reason you must perform cleanup in a
* *finally
clause is thatwithFixture
is called by *runTest
, which expects an exception to be thrown to indicate a failed test. Thus when you invoke * thetest
function, it may complete abruptly with an exception. Thefinally
clause will * ensure the fixture cleanup happens as that exception propagates back up the call stack torunTest
. ** 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: *
* ** import org.scalatest.fixture * import scala.collection.mutable.ListBuffer * * class ExampleSpec extends fixture.WordSpec { * * case class F(builder: StringBuilder, buffer: ListBuffer[String]) * type FixtureParam = F * * 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(F(stringBuilder, listBuffer)) * } * * "Testing" should { * * "be easy" in { f => * f.builder.append("easy!") * assert(f.builder.toString === "ScalaTest is easy!") * assert(f.buffer.isEmpty) * f.buffer += "sweet" * } * * "be fun" in { f => * f.builder.append("fun!") * assert(f.builder.toString === "ScalaTest is fun!") * assert(f.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 aconfigMap
* method, which will return aMap[String, Any]
from which configuration information may be obtained. * TherunTest
method of this trait will pass aOneArgTest
towithFixture
* whoseconfigMap
method returns theconfigMap
passed torunTest
. * Here's an example in which the name of a temp file is taken from the passedconfigMap
: ** import org.scalatest.fixture * import java.io.FileReader * import java.io.FileWriter * import java.io.File * * class ExampleSpec extends fixture.WordSpec { * * 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").asInstanceOf[String] * * // 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() * } * } * * "A file" can { * "be read" 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!") * } * } * * "The first char of a file" can { * "be read" in { reader => * assert(reader.read() === 'H') * } * } * } ** ** If you want to pass into each test the entire
* *configMap
that was passed torunTest
, you * can mix in traitConfigMapFixture
. See the documentation * forConfigMapFixture
for the details, but here's a quick * example of how it looks: ** import org.scalatest.fixture * import org.scalatest.fixture.ConfigMapFixture * * class ExampleSpec extends fixture.WordSpec with ConfigMapFixture { * * def testHello { configMap => * // Use the configMap passed to runTest in the test * assert(configMap.contains("hello")) * } * * def testWorld { configMap => * assert(configMap.contains("world")) * } * } ** *Providing multiple fixtures
* ** If different tests in the same
* *WordSpec
need different shared fixtures, you can use the loan pattern to supply to * each test just the fixture or fixtures it needs. First select the most commonly used fixture objects and pass them in via the *FixtureParam
. Then for each remaining fixture needed by multiple tests, create a with<fixture name> * method that takes a function you will use to pass the fixture to the test. Lasty, use the appropriate * with<fixture name> method or methods in each test. ** In the following example, the
* *FixtureParam
is set toMap[String, Any]
by mixing inConfigMapFixture
. * ThewithFixture
method in traitConfigMapFixture
will pass the config map to any test that needs it. * In addition, some tests in the following example need aStack[Int]
and others aStack[String]
. * ThewithIntStack
method takes * care of supplying theStack[Int]
to those tests that need it, and thewithStringStack
method takes care * of supplying theStack[String]
fixture. Here's how it looks: ** import org.scalatest.fixture * import org.scalatest.fixture.ConfigMapFixture * import collection.mutable.Stack * * class StackSpec extends fixture.WordSpec with ConfigMapFixture { * * def withIntStack(test: Stack[Int] => Any) { * val stack = new Stack[Int] * stack.push(1) * stack.push(2) * test(stack) // "loan" the Stack[Int] fixture to the test * } * * def withStringStack(test: Stack[String] => Any) { * val stack = new Stack[String] * stack.push("one") * stack.push("two") * test(stack) // "loan" the Stack[String] fixture to the test * } * * "A Stack" can { * * "pop an Int value" in { () => // This test doesn't need the configMap fixture, ... * withIntStack { stack => * val top = stack.pop() // But it needs the Stack[Int] fixture. * assert(top === 2) * assert(stack.size === 1) * } * } * * "push an Int value" in { configMap => * withIntStack { stack => * val iToPush = // This test uses the configMap fixture... * configMap("IntToPush").toString.toInt * stack.push(iToPush) // And also uses the Stack[Int] fixture. * assert(stack.size === 3) * assert(stack.head === iToPush) * } * } * * "pop a String value" in { () => // This test doesn't need the configMap fixture, ... * withStringStack { stack => * val top = stack.pop() // But it needs the Stack[String] fixture. * assert(top === "two") * assert(stack.size === 1) * } * } * * "push a String value" in { configMap => * withStringStack { stack => * val sToPush = // This test uses the configMap fixture... * configMap("StringToPush").toString * stack.push(sToPush) // And also uses the Stack[Int] fixture. * assert(stack.size === 3) * assert(stack.head === sToPush) * } * } * } * } ** ** If you run the previous class in the Scala interpreter, you'll see: *
* ** scala> import org.scalatest._ * import org.scalatest._ * * scala> run(new StackSpec, configMap = Map("IntToPush" -> 9, "StringToPush" -> "nine")) * StackSpec: * A Stack * - can pop an Int value * - can push an Int value * - can pop a String value * - can push a String value *
* * @author Bill Venners */ trait WordSpec extends Suite with ShouldVerb with MustVerb with CanVerb { thisSuite => private final val engine = new FixtureEngine[FixtureParam]("concurrentFixtureWordSpecMod", "FixtureWordSpec") import engine._ private[scalatest] val sourceFileName = "WordSpec.scala" /** * Returns anInformer
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 *fixture.WordSpec
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 /** * 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 theexecute
* 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 * fortestNames
for an example.) The resulting test name must not have been registered previously on * thisWordSpec
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 methodName Caller's method name * @param testFun the test function * @throws DuplicateTestNameException if a test with the same name has been registered previously * @throws TestRegistrationClosedException if invoked afterrun
has been invoked on this suite * @throws NullPointerException ifspecText
or any passed test tag isnull
*/ private def registerTestToRun(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => Any) { registerTest(specText, testFun, "itCannotAppearInsideAnotherIt", sourceFileName, methodName, 1, None, None, testTags: _*) } /** * 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 theexecute
* methods. This method exists to make it easy to ignore an existing test by changing the call toit
* toignore
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 * fortestNames
for an example.) The resulting test name must not have been registered previously on * thisWordSpec
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 methodName Caller's method name * @param testFun the test function * @throws DuplicateTestNameException if a test with the same name has been registered previously * @throws TestRegistrationClosedException if invoked afterrun
has been invoked on this suite * @throws NullPointerException ifspecText
or any passed test tag isnull
*/ private def registerTestToIgnore(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => Any) { // TODO: This is how these were, but it needs attention. Mentions "it". registerIgnoredTest(specText, testFun, "ignoreCannotAppearInsideAnIt", sourceFileName, methodName, 1, testTags: _*) } private def registerBranch(description: String, childPrefix: Option[String], methodName: String, fun: () => Unit) { // TODO: Fix the resource name and method name registerNestedBranch(description, childPrefix, fun(), "describeCannotAppearInsideAnIt", sourceFileName, methodName, 1) } /** * Class that supports the registration of tagged tests. * ** Instances of this class are returned by the
* * @author Bill Venners */ protected final class ResultOfTaggedAsInvocationOnString(specText: String, tags: List[Tag]) { /** * Supports tagged test registration. * *taggedAs
method of * classWordSpecStringWrapper
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" taggedAs(SlowTest) in { fixture => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def in(testFun: FixtureParam => Any) { registerTestToRun(specText, tags, "in", testFun) } /** * Supports tagged test registration, for tests that don't take a fixture. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" taggedAs(SlowTest) in { () => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def in(testFun: () => Any) { registerTestToRun(specText, tags, "in", new NoArgTestWrapper(testFun)) } /** * Supports registration of tagged, pending tests. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" taggedAs(SlowTest) is (pending) * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def is(testFun: => PendingNothing) { registerTestToRun(specText, tags, "is", unusedFixtureParam => testFun) } /** * Supports registration of tagged, ignored tests. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" taggedAs(SlowTest) ignore { fixture => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def ignore(testFun: FixtureParam => Any) { registerTestToIgnore(specText, tags, "ignore", testFun) } /** * Supports registration of tagged, ignored tests that take no fixture parameter. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" taggedAs(SlowTest) ignore { () => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def ignore(testFun: () => Any) { registerTestToIgnore(specText, tags, "ignore", new NoArgTestWrapper(testFun)) } } /** * A class that via an implicit conversion (namedfixture.WordSpec
. *convertToWordSpecStringWrapper
) enables * methodswhen
,which
,in
,is
,taggedAs
* andignore
to be invoked onString
s. * ** This class provides much of the syntax for
* * @author Bill Venners */ protected final class WordSpecStringWrapper(string: String) { /** * Supports test registration. * *fixture.WordSpec
, however, it does not add * the verb methods (should
,must
, andcan
) toString
. * Instead, these are added via theShouldVerb
,MustVerb
, andCanVerb
* traits, whichfixture.WordSpec
mixes in, to avoid a conflict with implicit conversions provided * inShouldMatchers
andMustMatchers
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" in { fixture => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def in(testFun: FixtureParam => Any) { registerTestToRun(string, List(), "in", testFun) } /** * Supports registration of tests that take no fixture. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" in { () => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def in(testFun: () => Any) { registerTestToRun(string, List(), "in", new NoArgTestWrapper(testFun)) } /** * Supports pending test registration. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" is (pending) * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def is(testFun: => PendingNothing) { registerTestToRun(string, List(), "is", unusedFixtureParam => testFun) } /** * Supports ignored test registration. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" ignore { fixture => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def ignore(testFun: FixtureParam => Any) { registerTestToIgnore(string, List(), "ignore", testFun) } /** * Supports registration of ignored tests that take no fixture. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" ignore { () => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def ignore(testFun: () => Any) { registerTestToIgnore(string, List(), "ignore", new NoArgTestWrapper(testFun)) } /** * Supports tagged test registration. * *fixture.WordSpec
. ** For example, this method supports syntax such as the following: *
* ** "complain on peek" taggedAs(SlowTest) in { fixture => ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = { val tagList = firstTestTag :: otherTestTags.toList new ResultOfTaggedAsInvocationOnString(string, tagList) } /** * Registers afixture.WordSpec
. *when
clause. * ** For example, this method supports syntax such as the following: *
* ** "A Stack" when { ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def when(f: => Unit) { registerBranch(string, Some("when"), "when", f _) } /** * Registers afixture.WordSpec
. *when
clause that is followed by an after word. * ** For example, this method supports syntax such as the following: *
* ** val theUser = afterWord("the user") * * "A Stack" when theUser { ... } * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def when(resultOfAfterWordApplication: ResultOfAfterWordApplication) { registerBranch(string, Some("when " + resultOfAfterWordApplication.text), "when", resultOfAfterWordApplication.f) } /** *fixture.WordSpec
. *that
has been deprecated and will be used for a different purpose in a future version of ScalaTest. Please * usewhich
instead. (Warning: this change will likely have a shorter than usual deprecation cycle: less than a year.) */ @deprecated("Please use \"which\" instead of \"that\".") def that(f: => Unit) { registerBranch(string + " that", None, "that", f _) } /** * Registers awhich
clause. * ** For example, this method supports syntax such as the following: *
* ** "a rerun button" which { * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def which(f: => Unit) { registerBranch(string + " which", None, "which", f _) } /** *fixture.WordSpec
. *that
has been deprecated and will be used for a different purpose in a future version of ScalaTest. Please * usewhich
instead. (Warning: this change will likely have a shorter than usual deprecation cycle: less than a year.) */ @deprecated("Please use \"which\" instead of \"that\".") def that(resultOfAfterWordApplication: ResultOfAfterWordApplication) { registerBranch(string + " that " + resultOfAfterWordApplication.text, None, "that", resultOfAfterWordApplication.f) } /** * Registers awhich
clause. * ** For example, this method supports syntax such as the following: *
* ** "a rerun button" which { * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
*/ def which(resultOfAfterWordApplication: ResultOfAfterWordApplication) { registerBranch(string + " which " + resultOfAfterWordApplication.text, None, "which", resultOfAfterWordApplication.f) } } /** * Class whose instances are after words, which can be used to reduce text duplication. * *fixture.WordSpec
. ** If you are repeating a word or phrase at the beginning of each string inside * a block, you can "move the word or phrase" out of the block with an after word. * You create an after word by passing the repeated word or phrase to the
* *afterWord
method. * Once created, you can place the after word afterwhen
, a verb * (should
,must
, orcan
), or *which
. (You can't place one afterin
oris
, the * words that introduce a test.) Here's an example that has after words used in all three * places: ** import org.scalatest.fixture * import ConfigMapFixture * * class ScalaTestGUISpec extends fixture.WordSpec with ConfigMapFixture { * * def theUser = afterWord("the user") * def display = afterWord("display") * def is = afterWord("is") * * "The ScalaTest GUI" when theUser { * "clicks on an event report in the list box" should display { * "a blue background in the clicked-on row in the list box" in { cm => } * "the details for the event in the details area" in { cm => } * "a rerun button," which is { * "enabled if the clicked-on event is rerunnable" in { cm => } * "disabled if the clicked-on event is not rerunnable" in { cm => } * } * } * } * } ** ** Running the previous
* *fixture.WordSpec
in the Scala interpreter would yield: ** scala> (new ScalaTestGUISpec).run() * The ScalaTest GUI (when the user clicks on an event report in the list box) * - should display a blue background in the clicked-on row in the list box * - should display the details for the event in the details area * - should display a rerun button, which is enabled if the clicked-on event is rerunnable * - should display a rerun button, which is disabled if the clicked-on event is not rerunnable *
*/ protected final class AfterWord(text: String) { /** * Supports the use of after words. * ** This method transforms a block of code into a
ResultOfAfterWordApplication
, which * is accepted bywhen
,should
,must
,can
, andwhich
* methods. For more information, see the main documentationorg.scalatest.WordSpec
. * */ def apply(f: => Unit) = new ResultOfAfterWordApplication(text, f _) } /** * Creates an after word that an be used to reduce text duplication. * ** If you are repeating a word or phrase at the beginning of each string inside * a block, you can "move the word or phrase" out of the block with an after word. * You create an after word by passing the repeated word or phrase to the
* *afterWord
method. * Once created, you can place the after word afterwhen
, a verb * (should
,must
, orcan
), or *which
. (You can't place one afterin
oris
, the * words that introduce a test.) Here's an example that has after words used in all three * places: ** import org.scalatest.fixture * import ConfigMapFixture * * class ScalaTestGUISpec extends fixture.WordSpec with ConfigMapFixture { * * def theUser = afterWord("the user") * def display = afterWord("display") * def is = afterWord("is") * * "The ScalaTest GUI" when theUser { * "clicks on an event report in the list box" should display { * "a blue background in the clicked-on row in the list box" in { cm => } * "the details for the event in the details area" in { cm => } * "a rerun button," which is { * "enabled if the clicked-on event is rerunnable" in { cm => } * "disabled if the clicked-on event is not rerunnable" in { cm => } * } * } * } * } ** ** Running the previous
* *fixture.WordSpec
in the Scala interpreter would yield: ** scala> (new ScalaTestGUISpec).run() * The ScalaTest GUI (when the user clicks on an event report in the list box) * - should display a blue background in the clicked-on row in the list box * - should display the details for the event in the details area * - should display a rerun button, which is enabled if the clicked-on event is rerunnable * - should display a rerun button, which is disabled if the clicked-on event is not rerunnable *
*/ protected def afterWord(text: String) = new AfterWord(text) /** * Implicitly convertsString
s toWordSpecStringWrapper
, which enables * methodswhen
,which
,in
,is
,taggedAs
* andignore
to be invoked onString
s. */ protected implicit def convertToWordSpecStringWrapper(s: String) = new WordSpecStringWrapper(s) /** * Supports the registration of subjects. * ** For example, this method enables syntax such as the following: *
* ** "A Stack" should { ... * ^ ** ** This function is passed as an implicit parameter to a
*/ protected implicit val subjectRegistrationFunction: StringVerbBlockRegistration = new StringVerbBlockRegistration { def apply(left: String, verb: String, f: () => Unit) = registerBranch(left, Some(verb), "subjectRegistrationFunction", f) } /** * Supports the registration of subject descriptions with after words. * *should
method * provided inShouldVerb
, amust
method * provided inMustVerb
, and acan
method * provided inCanVerb
. When invoked, this function registers the * subject and executes the block. ** For example, this method enables syntax such as the following: *
* ** def provide = afterWord("provide") * * "The ScalaTest Matchers DSL" can provide { ... } * ^ ** ** This function is passed as an implicit parameter to a
*/ protected implicit val subjectWithAfterWordRegistrationFunction: (String, String, ResultOfAfterWordApplication) => Unit = { (left, verb, resultOfAfterWordApplication) => { val afterWordFunction = () => { registerBranch(resultOfAfterWordApplication.text, None, "subjectWithAfterWordRegistrationFunction", resultOfAfterWordApplication.f) } registerBranch(left, Some(verb), "subjectWithAfterWordRegistrationFunction", afterWordFunction) } } /** * Ashould
method * provided inShouldVerb
, amust
method * provided inMustVerb
, and acan
method * provided inCanVerb
. When invoked, this function registers the * subject and executes the block. *Map
whose keys areString
tag names to which tests in thisWordSpec
belong, and values * theSet
of test names that belong to each tag. If thisfixture.WordSpec
contains no tags, this method returns an emptyMap
. * ** This trait's implementation returns tags that were passed as strings contained in
*/ override def tags: Map[String, Set[String]] = atomic.get.tagsMap /** * Run a test. This trait's implementation runs the test registered with the name specified by *Tag
objects passed to * methodstest
andignore
. *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 * fortestNames
for an example.) * * @param testName the name of one test to execute. * @param reporter theReporter
to which results will be reported * @param stopper theStopper
that will be consulted to determine whether to stop execution early. * @param configMap aMap
of properties that can be used by thisWordSpec
's executing tests. * @throws NullPointerException if any oftestName
,reporter
,stopper
, orconfigMap
* isnull
. */ protected override def runTest(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], tracker: Tracker) { def invokeWithFixture(theTest: TestLeaf) { theTest.testFun match { case wrapper: NoArgTestWrapper[_] => withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, configMap)) case fun => withFixture(new TestFunAndConfigMap(testName, fun, configMap)) } } runTestImpl(thisSuite, testName, reporter, stopper, configMap, tracker, true, invokeWithFixture) } /** ** Run zero to many of this
* *WordSpec
's tests. ** This method takes a
* *testName
parameter that optionally specifies a test to invoke. * IftestName
isSome
, this trait's implementation of this method * invokesrunTest
on this object, passing in: *
-
*
testName
- theString
value of thetestName
Option
passed * to this method
* reporter
- theReporter
passed to this method, or one that wraps and delegates to it
* stopper
- theStopper
passed to this method, or one that wraps and delegates to it
* configMap
- theconfigMap
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
Set
s.
* If so, this implementation invokes runTest
, passing in:
*
-
*
testName
- theString
name of the test to run (which will be one of the names in thetestNames
Set
)
* reporter
- theReporter
passed to this method, or one that wraps and delegates to it
* stopper
- theStopper
passed to this method, or one that wraps and delegates to it
* configMap
- theconfigMap
passed to this method, or one that wraps and delegates to it
*
None
, all relevant tests should be executed.
* I.e., None
acts like a wildcard that means execute all relevant tests in this WordSpec
.
* @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 WordSpec
* @param tagsToExclude a Set
of String
tag names to exclude in the execution of this WordSpec
* @param configMap a Map
of key-value pairs that can be used by this WordSpec
'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) {
runTestsImpl(thisSuite, testName, reporter, stopper, filter, configMap, distributor, tracker, info, true, runTest)
}
/**
* An immutable Set
of test names. If this fixture.WordSpec
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] = { // I'm returning a ListSet here so that they tests will be run in registration order ListSet(atomic.get.testNamesList.toArray: _*) } override def run(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker) { runImpl(thisSuite, testName, reporter, stopper, filter, configMap, distributor, tracker, super.run) } /** * Supports shared test registration infixture.WordSpec
s.
*
* * This field enables syntax such as the following: *
* ** behave like nonFullStack(stackWithOneItem) * ^ ** *
* For more information and examples of the use of org.scalatest.WordSpec
.
*