org.scalatest.fixture.FunSpecLike.scala Maven / Gradle / Ivy
/* * Copyright 2001-2014 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 org.scalatest.exceptions._ import org.scalactic.{source, Prettifier} import java.util.ConcurrentModificationException import java.util.concurrent.atomic.AtomicReference import org.scalatest.Suite.anExceptionThatShouldCauseAnAbort import org.scalatest.Suite.autoTagClassAnnotations import words.BehaveWord /** * Implementation trait for class
, see the Shared tests section * in the main documentation for traitfixture.FunSpec
, which is * a sister class toorg.scalatest.FunSpec
that can pass a * fixture object into its tests. * **
* *fixture.FunSpec
is a class, * not a trait, to minimize compile time given there is a slight compiler * overhead to mixing in traits compared to extending classes. If you need * to mix the behavior offixture.FunSpec
into some other * class, you can use this trait instead, because class *fixture.FunSpec
does nothing more than extend this trait and add a nicetoString
implementation. ** See the documentation of the class for a detailed * overview of
* * @author Bill Venners */ //SCALATESTJS-ONLY @scala.scalajs.js.annotation.JSExportDescendentClasses(ignoreInvalidDescendants = true) @Finders(Array("org.scalatest.finders.FunSpecFinder")) trait FunSpecLike extends TestSuite with TestRegistration with Informing with Notifying with Alerting with Documenting { thisSuite => private final val engine = new FixtureEngine[FixtureParam](Resources.concurrentFixtureSpecMod, "FixtureFunSpec") import engine._ private[scalatest] val sourceFileName = "FunSpecLike.scala" /** * Returns anfixture.FunSpec
. *Informer
that during test execution will forward strings passed to its *apply
method to the current reporter. If invoked in a constructor, it * will register the passed string for forwarding later during test execution. If invoked from inside a scope, * it will forward the information to the current reporter immediately. If invoked from inside a test function, * it will record the information and forward it to the current reporter only after the test completed, asrecordedEvents
* of the test completed event, such asTestSucceeded
. If invoked at any other time, it will print to the standard output. * This method can be called safely by any thread. */ protected def info: Informer = atomicInformer.get /** * Returns aNotifier
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 *FunSpec
is being executed, such as from inside a test function, it will forward the information to * the current reporter immediately. If invoked at any other time, it will * print to the standard output. This method can be called safely by any thread. */ protected def note: Notifier = atomicNotifier.get /** * Returns anAlerter
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 *FunSpec
is being executed, such as from inside a test function, it will forward the information to * the current reporter immediately. If invoked at any other time, it will * print to the standard output. This method can be called safely by any thread. */ protected def alert: Alerter = atomicAlerter.get /** * Returns aDocumenter
that during test execution will forward strings passed to its *apply
method to the current reporter. If invoked in a constructor, it * will register the passed string for forwarding later during test execution. If invoked from inside a scope, * it will forward the information to the current reporter immediately. If invoked from inside a test function, * it will record the information and forward it to the current reporter only after the test completed, asrecordedEvents
* of the test completed event, such asTestSucceeded
. If invoked at any other time, it will print to the standard output. * This method can be called safely by any thread. */ protected def markup: Documenter = atomicDocumenter.get final def registerTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepthAdjustment = -2 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepthAdjustment = -5 engine.registerTest(testText, Transformer(testFun), Resources.testCannotBeNestedInsideAnotherTest, sourceFileName, "registerTest", 5, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*) } final def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepthAdjustment = 0 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepthAdjustment = -2 engine.registerIgnoredTest(testText, Transformer(testFun), Resources.testCannotBeNestedInsideAnotherTest, sourceFileName, "registerIgnoredTest", 1, stackDepthAdjustment, None, Some(pos), testTags: _*) } /** * Class that, via an instance referenced from theit
field, * supports test (and shared test) registration inFunSpec
s. * ** This class supports syntax such as the following: *
* ** it("should be empty") * ^ ** ** it should behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples, see the main documentation for
*/ protected final class ItWord { class ResultOfItWordApplication(specText: String, testTags: Tag*) { def apply(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepth = 3 val stackDepthAdjustment = -2 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepth = 5 //SCALATESTJS-ONLY val stackDepthAdjustment = -5 engine.registerTest(specText, Transformer(testFun), Resources.itCannotAppearInsideAnotherItOrThey, sourceFileName, "apply", stackDepth, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*) } def apply(testFun: () => Any /* Assertion */)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepth = 3 val stackDepthAdjustment = -2 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepth = 5 //SCALATESTJS-ONLY val stackDepthAdjustment = -5 engine.registerTest(specText, Transformer(new NoArgTestWrapper(testFun)), Resources.itCannotAppearInsideAnotherItOrThey, sourceFileName, "apply", stackDepth, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*) } } /** * 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 theFunSpec
. *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 * fortestNames
for an example.) The resulting test name must not have been registered previously on * thisFunSpec
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 afterrun
has been invoked on this suite * @throws NullArgumentException ifspecText
or any passed test tag isnull
*/ def apply(specText: String, testTags: Tag*): ResultOfItWordApplication = new ResultOfItWordApplication(specText, testTags: _*) /** * Supports the registration of shared tests. * ** 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
* * @param behaveWord theFunSpec
. *BehaveWord
*/ def should(behaveWord: BehaveWord) = behaveWord /** * Supports the registration of shared tests. * ** 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
* * @param behaveWord theFunSpec
. *BehaveWord
*/ def must(behaveWord: BehaveWord) = behaveWord } /** * Supports test (and shared test) registration inFunSpec
s. * ** This field supports syntax such as the following: *
* ** it("should be empty") * ^ ** ** it should behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples of the use of the
*/ protected val it = new ItWord /** * Class that, via an instance referenced from theit
field, see * the main documentation forFunSpec
. *they
field, * supports test (and shared test) registration inFunSpec
s. * ** This class supports syntax such as the following: *
* ** they("should be empty") * ^ ** ** they should behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples, see the main documentation for
*/ protected final class TheyWord { class ResultOfTheyWordApplication(specText: String, testTags: Tag*)(implicit pos: source.Position) { def apply(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepthAdjustment = -2 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepthAdjustment = -3 engine.registerTest(specText, Transformer(testFun), Resources.theyCannotAppearInsideAnotherItOrThey, sourceFileName, "apply", 3, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*) } def apply(testFun: () => Any /* Assertion */)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepthAdjustment = -2 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepthAdjustment = -3 engine.registerTest(specText, Transformer(new NoArgTestWrapper(testFun)), Resources.theyCannotAppearInsideAnotherItOrThey, sourceFileName, "apply", 3, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*) } } /** * 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 theFunSpec
. *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 * fortestNames
for an example.) The resulting test name must not have been registered previously on * thisFunSpec
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 afterrun
has been invoked on this suite * @throws NullArgumentException ifspecText
or any passed test tag isnull
*/ def apply(specText: String, testTags: Tag*): ResultOfTheyWordApplication = new ResultOfTheyWordApplication(specText, testTags: _*) /** * Supports the registration of shared tests. * ** This method supports syntax such as the following: *
* ** they should behave like nonFullStack(stackWithOneItem) * ^ ** ** For examples of shared tests, see the Shared tests section * in the main documentation for trait
* * @param behaveWord theFunSpec
. *BehaveWord
*/ def should(behaveWord: BehaveWord) = behaveWord /** * Supports the registration of shared tests. * ** This method supports syntax such as the following: *
* ** they must behave like nonFullStack(stackWithOneItem) * ^ ** ** For examples of shared tests, see the Shared tests section * in the main documentation for trait
* * @param behaveWord theFunSpec
. *BehaveWord
*/ def must(behaveWord: BehaveWord) = behaveWord } /** * Supports test (and shared test) registration inFunSpec
s. * ** This field supports syntax such as the following: *
* ** they("should be empty") * ^ ** ** they should behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples of the use of the
*/ protected val they = new TheyWord class ResultOfIgnoreInvocation(specText: String, testTags: Tag*) { def apply(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepth = 3 val stackDepthAdjustment = -3 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepth = 5 //SCALATESTJS-ONLY val stackDepthAdjustment = -6 engine.registerIgnoredTest(specText, Transformer(testFun), Resources.ignoreCannotAppearInsideAnItOrAThey, sourceFileName, "apply", stackDepth, stackDepthAdjustment, None, Some(pos), testTags: _*) } def apply(testFun: () => Any /* Assertion */)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepth = 3 val stackDepthAdjustment = -3 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepth = 5 //SCALATESTJS-ONLY val stackDepthAdjustment = -6 engine.registerIgnoredTest(specText, Transformer(new NoArgTestWrapper(testFun)), Resources.ignoreCannotAppearInsideAnItOrAThey, sourceFileName, "apply", stackDepth, stackDepthAdjustment, None, Some(pos), 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 theit
field, see * the main documentation forFunSpec
. *execute
* 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 * thisFunSpec
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 afterrun
has been invoked on this suite * @throws NullArgumentException ifspecText
or any passed test tag isnull
*/ protected def ignore(specText: String, testTags: Tag*): ResultOfIgnoreInvocation = new ResultOfIgnoreInvocation(specText, testTags: _*) /** * 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 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 * thisFunSpec
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 afterrun
has been invoked on this suite * @throws NullArgumentException ifspecText
or any passed test tag isnull
*/ /** * Describe a “subject” being specified and tested by the passed function value. The * passed function value may contain more describers (defined withdescribe
) and/or tests * (defined withit
). This trait's implementation of this method will register the * description string and immediately invoke the passed function. * * @param description the description text * @param fun the function which makes up the body for the description */ protected def describe(description: String)(fun: => Unit)(implicit pos: source.Position): Unit = { // SKIP-SCALATESTJS-START val stackDepth = 4 // SKIP-SCALATESTJS-END //SCALATESTJS-ONLY val stackDepth = 6 try { registerNestedBranch(description, None, fun, Resources.describeCannotAppearInsideAnIt, sourceFileName, "describe", stackDepth, -2, None, Some(pos)) } catch { case e: TestFailedException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotDescribeClause, Some(e), e.position.getOrElse(pos)) case e: TestCanceledException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotDescribeClause, Some(e), e.position.getOrElse(pos)) case e: DuplicateTestNameException => throw new NotAllowedException(FailureMessages.exceptionWasThrownInDescribeClause(Prettifier.default, UnquotedString(e.getClass.getName), description, e.getMessage), Some(e), e.position.getOrElse(pos)) case other: Throwable if (!Suite.anExceptionThatShouldCauseAnAbort(other)) => throw new NotAllowedException(FailureMessages.exceptionWasThrownInDescribeClause(Prettifier.default, UnquotedString(other.getClass.getName), description, other.getMessage), Some(other), pos) case other: Throwable => throw other } } /** * AMap
whose keys areString
tag names to which tests in thisFunSpec
belong, and values * theSet
of test names that belong to each tag. If thisFunSpec
contains no tags, this method returns an emptyMap
. * ** This trait's implementation returns tags that were passed as strings contained in
* *Tag
objects passed to * methodstest
andignore
. ** In addition, this trait's implementation will also auto-tag tests with class level annotations. * For example, if you annotate @Ignore at the class level, all test methods in the class will be auto-annotated with @Ignore. *
*/ override def tags: Map[String, Set[String]] = autoTagClassAnnotations(atomic.get.tagsMap, this) /** * 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 * fortestNames
for an example.) * * @param testName the name of one test to execute. * @param args theArgs
for this run * @return aStatus
object that indicates when the test started by this method has completed, and whether or not it failed . * @throws NullArgumentException iftestName
orargs
isnull
. */ protected override def runTest(testName: String, args: Args): Status = { def invokeWithFixture(theTest: TestLeaf): Outcome = { theTest.testFun match { case transformer: org.scalatest.fixture.Transformer[_] => transformer.exceptionalTestFun match { case wrapper: NoArgTestWrapper[_, _] => withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, args.configMap)) case fun => withFixture(new TestFunAndConfigMap(testName, fun, args.configMap)) } case other => other match { case wrapper: NoArgTestWrapper[_, _] => withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, args.configMap)) case fun => withFixture(new TestFunAndConfigMap(testName, fun, args.configMap)) } } } runTestImpl(thisSuite, testName, args, true, invokeWithFixture) } /** ** Run zero to many of this
* *FunSpec
'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 with passedargs
. ** This method takes an
* *args
that contains aSet
of tag names that should be included (tagsToInclude
), and aSet
* that should be excluded (tagsToExclude
), when deciding which of thisSuite
's tests to execute. * IftagsToInclude
is empty, all tests will be executed * except those those belonging to tags listed in thetagsToExclude
Set
. IftagsToInclude
is non-empty, only tests * belonging to tags mentioned intagsToInclude
, and not mentioned intagsToExclude
* will be executed. However, iftestName
isSome
,tagsToInclude
andtagsToExclude
are essentially ignored. * Only iftestName
isNone
willtagsToInclude
andtagsToExclude
be consulted to * determine which of the tests named in thetestNames
Set
should be run. For more information on trait tags, see the main documentation for this trait. ** If
* * @param testName an optional name of one test to execute. IftestName
isNone
, this trait's implementation of this method * invokestestNames
on thisSuite
to get aSet
of names of tests to potentially execute. * (AtestNames
value ofNone
essentially acts as a wildcard that means all tests in * thisSuite
that are selected bytagsToInclude
andtagsToExclude
should be executed.) * For each test in thetestName
Set
, in the order * they appear in the iterator obtained by invoking theelements
method on theSet
, this trait's implementation * of this method checks whether the test should be run based on thetagsToInclude
andtagsToExclude
Set
s. * If so, this implementation invokesrunTest
with passedargs
. *None
, all relevant tests should be executed. * I.e.,None
acts like a wildcard that means execute all relevant tests in thisFunSpec
. * @param args theArgs
to which results will be reported * @return aStatus
object that indicates when all tests started by this method have completed, and whether or not a failure occurred. * @throws NullArgumentException if any oftestName
orargs
isnull
. */ protected override def runTests(testName: Option[String], args: Args): Status = { runTestsImpl(thisSuite, testName, args, info, true, runTest) } /** * An immutableSet
of test names. If thisFunSpec
contains no tests, this method returns an * emptySet
. * ** 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. *
* * @return theSet
of test names */ override def testNames: Set[String] = { InsertionOrderSet(atomic.get.testNamesList) } override def run(testName: Option[String], args: Args): Status = { runImpl(thisSuite, testName, args, super.run) } /** * Supports shared test registration inFunSpec
s. * ** This field supports syntax such as the following: *
* ** it should behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples of the use of
behave FunSpec
. * */ protected val behave = new BehaveWord import scala.language.implicitConversions /** * Implicitly converts a function that takes no parameters and results inPendingStatement
to * a function fromFixtureParam
toAny
, to enable pending tests to registered as by-name parameters * by methods that require a test function that takes aFixtureParam
. * ** This method makes it possible to write pending tests as simply
* * @param f a function * @return a function of(pending)
, without needing * to write(fixture => pending)
. *FixtureParam => Any
*/ protected implicit def convertPendingToFixtureFunction(f: => PendingStatement): FixtureParam => Any /* Assertion */ = { fixture => { f; Succeeded } } /** * Implicitly converts a function that takes no parameters and results inAny
to * a function fromFixtureParam
toAny
, to enable no-arg tests to registered * by methods that require a test function that takes aFixtureParam
. * * @param fun a function * @return a function ofFixtureParam => Any
*/ /* protected implicit def convertNoArgToFixtureFunction(fun: () => Any /* Assertion */): (FixtureParam => Any /* Assertion */) = new NoArgTestWrapper(fun) */ /** * Suite style name. * * @returnorg.scalatest.fixture.FunSpec
*/ final override val styleName: String = "org.scalatest.fixture.FunSpec" override def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData = createTestDataFor(testName, theConfigMap, this) }