org.scalatest.funspec.PathAnyFunSpecLike.scala Maven / Gradle / Ivy
/* * Copyright 2001-2019 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.funspec import org.scalatest._ import org.scalatest.exceptions._ import org.scalactic.{source, Prettifier} import org.scalatest.verbs.BehaveWord import Suite.autoTagClassAnnotations import org.scalatest.PathEngine.isInTargetPath /** * Implementation trait for class
, see the * Shared tests section in the main documentation for sister * traitPath.FunSpec
, which is * a sister class toorg.scalatest.funspec.AnyFunSpec
that isolates * tests by running each test in its own instance of the test class, * and for each test, only executing the path leading to that test. * **
* *PathAnyFunSpec
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 ofPathAnyFunSpec
into some other class, you can use this * trait instead, because classPathAnyFunSpec
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 */ @Finders(Array("org.scalatest.finders.FunSpecFinder")) //SCALATESTJS-ONLY @scala.scalajs.reflect.annotation.EnableReflectiveInstantiation //SCALATESTNATIVE-ONLY @scala.scalanative.reflect.annotation.EnableReflectiveInstantiation trait PathAnyFunSpecLike extends org.scalatest.Suite with OneInstancePerTest with Informing with Notifying with Alerting with Documenting { thisSuite => private final val engine = PathEngine.getEngine() import engine._ // SKIP-SCALATESTJS,NATIVE-START override def newInstance: org.scalatest.funspec.PathAnyFunSpecLike = this.getClass.newInstance.asInstanceOf[PathAnyFunSpecLike] // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY override def newInstance: org.scalatest.funspec.PathAnyFunSpecLike /** * Returns anPathAnyFunSpec
. *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 (including within a test, since * those are invoked during construction in aPathAnyFunSpec
, it * will register the passed string for forwarding later whenrun
is invoked. 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 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 *PathAnyFunSpec
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 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 *PathAnyFunSpec
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 (and other objects) passed to its *apply
method to the current reporter. If invoked in a constructor (including within a test, since * those are invoked during construction in aPathAnyFunSpec
, it * will register the passed string for forwarding later whenrun
is invoked. 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 /** * Class that, via an instance referenced from theit
field, * supports test (and shared test) registration inPathAnyFunSpec
s. * ** This class supports syntax such as the following test registration: *
* ** it("should be empty") * ^ ** ** and the following shared test registration: *
* ** it should behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples, see the main documentation for
*/ protected class ItWord { private final def applyImpl(testText: String, testTags: Tag*)(testFun: => Unit /* Assertion */, pos: source.Position): Unit = { // SKIP-SCALATESTJS,NATIVE-START val stackDepth = 3 val stackDepthAdjustment = -2 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepth = 5 //SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -4 handleTest(thisSuite, testText, Transformer(() => testFun), Resources.itCannotAppearInsideAnotherItOrThey, "PathAnyFunSpecLike.scala", "apply", stackDepth, stackDepthAdjustment, None, Some(pos), testTags: _*) } /** * Supports test registration. * *PathAnyFunSpec
. ** This trait's implementation of this method will decide whether to register the text and invoke the passed function * based on whether or not this is part of the current "test path." For the details on this process, see * the How it executes section of the main documentation for * trait
* * @param testText the test 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 afterorg.scalatest.funspec.PathAnyFunSpec
. *run
has been invoked on this suite * @throws NullArgumentException ifspecText
or any passed test tag isnull
*/ inline def apply(testText: String, testTags: Tag*)(testFun: => Unit /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => applyImpl(testText, testTags: _*)(testFun, pos) }) } } /** * 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
*/ infix def should(behaveWord: BehaveWord) = behaveWord /** * Supports the registration of shared tests. * *org.scalatest.funspec.PathAnyFunSpec
. ** 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
*/ infix def must(behaveWord: BehaveWord) = behaveWord } /** * Supports test (and shared test) registration inorg.scalatest.funspec.PathAnyFunSpec
. *PathAnyFunSpec
s. * ** This field supports syntax such as the following: *
* ** it("should be empty") * ^ ** *class="stExamples" * 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 for this trait. *they
field, * supports test (and shared test) registration inPathAnyFunSpec
s. * ** This class supports syntax such as the following test registration: *
* ** they("should be empty") * ^ ** ** and the following shared test registration: *
* ** they should behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples, see the main documentation for
*/ protected class TheyWord { private def applyImpl(testText: String, testTags: Tag*)(testFun: => Unit /* Assertion */, pos: source.Position): Unit = { handleTest(thisSuite, testText, Transformer(() => testFun), Resources.theyCannotAppearInsideAnotherItOrThey, "PathAnyFunSpecLike.scala", "apply", 3, -2, None, Some(pos), testTags: _*) } /** * Supports test registration. * *PathAnyFunSpec
. ** This trait's implementation of this method will decide whether to register the text and invoke the passed function * based on whether or not this is part of the current "test path." For the details on this process, see * the How it executes section of the main documentation for * trait
* * @param testText the test 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 afterorg.scalatest.funspec.PathAnyFunSpec
. *run
has been invoked on this suite * @throws NullArgumentException ifspecText
or any passed test tag isnull
*/ inline def apply(testText: String, testTags: Tag*)(testFun: => Unit /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => applyImpl(testText, testTags: _*)(testFun, pos) }) } } /** * 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
*/ infix def should(behaveWord: BehaveWord) = behaveWord /** * Supports the registration of shared tests. * *org.scalatest.funspec.PathAnyFunSpec
. ** 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
*/ infix def must(behaveWord: BehaveWord) = behaveWord } /** * Supports test (and shared test) registration inorg.scalatest.funspec.PathAnyFunSpec
. *PathAnyFunSpec
s. * ** This field supports syntax such as the following: *
* ** it("should be empty") * ^ ** *class="stExamples" * it should behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples of the use of the
*/ protected val they = new TheyWord private final def ignoreImpl(testText: String, testTags: Tag*)(testFun: => Unit /* Assertion */, pos: source.Position): Unit = { // SKIP-SCALATESTJS,NATIVE-START val stackDepth = 4 val stackDepthAdjustment = -2 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepth = 6 //SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -4 // Might not actually register it. Only will register it if it is its turn. handleIgnoredTest(testText, Transformer(() => testFun), Resources.ignoreCannotAppearInsideAnItOrAThey, "PathAnyFunSpecLike.scala", "ignore", stackDepth, stackDepthAdjustment, None, Some(pos), testTags: _*) } /** * Supports registration of a test to ignore. * *it
field, see the main documentation for this trait. ** For more information and examples of this method's use, see the * Ignored tests section in the main documentation for sister * trait
* * @param testText 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 afterorg.scalatest.funspec.AnyFunSpec
. Note that a separate instance will be created for an ignored test, * and the path to the ignored test will be executed in that instance, but the test function itself will not * be executed. Instead, aTestIgnored
event will be fired. *run
has been invoked on this suite * @throws NullArgumentException ifspecText
or any passed test tag isnull
*/ inline def ignore(testText: String, testTags: Tag*)(testFun: => Unit /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => ignoreImpl(testText, testTags: _*)(testFun, pos) }) } } private final def describeImpl(description: String)(fun: => Unit, pos: source.Position): Unit = { // SKIP-SCALATESTJS,NATIVE-START val stackDepth = 4 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepth = 6 try { handleNestedBranch(description, None, fun, Resources.describeCannotAppearInsideAnIt, "PathAnyFunSpecLike.scala", "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 } } /** * 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 class's implementation of this method will decide whether to * register the description text and invoke the passed function * based on whether or not this is part of the current "test path." For the details on this process, see * the How it executes section of the main documentation for trait *
*/ inline def describe(description: String)(fun: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => describeImpl(description)(fun, pos) }) } } /** * Supports shared test registration inorg.scalatest.funspec.PathAnyFunSpec
. *PathAnyFunSpec
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 org.scalatest.funspec.AnyFunSpec
. * */ protected val behave = new BehaveWord /** * An immutableSet
of test names. If thisPathAnyFunSpec
contains no tests, this method returns an * emptySet
. * ** This trait's implementation of this method will first ensure that the results of all tests, each run its its * own instance executing only the path to the test, are registered. For details on this process see the * How it executes section in the main documentation for this trait. *
* ** This trait's implementation of this method will return a set that contains the names of all registered tests. The set's * iterator will return those names in the order in which the tests were registered. Each test's name is composed * of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the * example itself, with all components separated by a space. For example, consider this
* *PathAnyFunSpec
: ** import org.scalatest.funspec * * class StackSpec extends funspec.PathAnyFunSpec { * describe("A Stack") { * describe("when not empty") { * "must allow me to pop" in {} * } * describe("when not full") { * "must allow me to push" in {} * } * } * } ** ** Invoking
* *testNames
on thisPathAnyFunSpec
will yield a set that contains the following * two test name strings: ** "A Stack when not empty must allow me to pop" * "A Stack when not full must allow me to push" ** ** This trait's implementation of this method is marked as final. For insight onto why, see the * Shared fixtures section in the main documentation for this trait. *
*/ final override def testNames: Set[String] = { ensureTestResultsRegistered(thisSuite) InsertionOrderSet(atomic.get.testNamesList) } /** * The total number of tests that are expected to run when thisPathAnyFunSpec
'srun
method * is invoked. * ** This trait's implementation of this method will first ensure that the results of all tests, each run its its * own instance executing only the path to the test, are registered. For details on this process see the * How it executes section in the main documentation for this trait. *
* ** This trait's implementation of this method returns the size of the
* *testNames
List
, minus * the number of tests marked as ignored as well as any tests excluded by the passedFilter
. ** This trait's implementation of this method is marked as final. For insight onto why, see the * Shared fixtures section in the main documentation for this trait. *
* * @param filter aFilter
with which to filter tests to count based on their tags */ final override def expectedTestCount(filter: Filter): Int = { ensureTestResultsRegistered(thisSuite) super.expectedTestCount(filter) } /** * Runs a test. * ** This trait's implementation of this method will first ensure that the results of all tests, each run its its * own instance executing only the path to the test, are registered. For details on this process see the * How it executes section in the main documentation for this trait. *
* ** This trait's implementation reports the test results 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 documentation * fortestNames
for an example.) * ** This trait's implementation of this method is marked as final. For insight onto why, see the * Shared fixtures section in the main documentation for this trait. *
* * @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 thisFreeSpec
's executing tests. * @throws NullArgumentException if any oftestName
,reporter
,stopper
, orconfigMap
* isnull
. */ final protected override def runTest(testName: String, args: Args): Status = { ensureTestResultsRegistered(thisSuite) def dontInvokeWithFixture(theTest: TestLeaf): Outcome = { theTest.testFun() } runTestImpl(thisSuite, testName, args, true, dontInvokeWithFixture) } /** * AMap
whose keys areString
tag names to which tests in thispath.FreeSpec
* belong, and values theSet
of test names that belong to each tag. If thispath.FreeSpec
* contains no tags, this method returns an emptyMap
. * ** This trait's implementation of this method will first ensure that the results of all tests, each run its its * own instance executing only the path to the test, are registered. For details on this process see the * How it executes section in the main documentation for this trait. *
* ** This trait's implementation returns tags that were passed as strings contained in
* *Tag
objects passed * to methodsit
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. *
* ** This trait's implementation of this method is marked as final. For insight onto why, see the * Shared fixtures section in the main documentation for this trait. *
*/ final override def tags: Map[String, Set[String]] = { ensureTestResultsRegistered(thisSuite) autoTagClassAnnotations(atomic.get.tagsMap, this) } /** * Runs thisPathAnyFunSpec
, reporting test results that were registered when the tests * were run, each during the construction of its own instance. * ** This trait's implementation of this method will first ensure that the results of all tests, each run its its * own instance executing only the path to the test, are registered. For details on this process see the * How it executes section in the main documentation for this trait. *
* *If
* *testName
isNone
, this trait's implementation of this method * will report the registered results for all tests except any excluded by the passedFilter
. * IftestName
is defined, it will report the results of only that named test. Because a *PathAnyFunSpec
is not allowed to contain nested suites, this trait's implementation of * this method does not callrunNestedSuites
. ** This trait's implementation of this method is marked as final. For insight onto why, see the * Shared fixtures section in the main documentation for this trait. *
* * @param testName an optional name of one test to run. IfNone
, all relevant tests should be run. * I.e.,None
acts like a wildcard that means run all relevant tests in thisSuite
. * @param args theArgs
for this run * *@throws NullArgumentException if any passed parameter isnull
. * @throws IllegalArgumentException iftestName
is defined, but no test with the specified test name * exists in thisSuite
*/ final override def run(testName: Option[String], args: Args): Status = { ensureTestResultsRegistered(thisSuite) runPathTestsImpl(thisSuite, testName, args, info, true, runTest) } /** * This lifecycle method is unused by this trait, and will complete abruptly with *UnsupportedOperationException
if invoked. * ** This trait's implementation of this method is marked as final. For insight onto why, see the * Shared fixtures section in the main documentation for this trait. *
*/ final protected override def runTests(testName: Option[String], args: Args): Status = { throw new UnsupportedOperationException // ensureTestResultsRegistered(isAnInitialInstance, this) // runTestsImpl(thisSuite, testName, reporter, stopper, filter, configMap, distributor, tracker, info, true, runTest) } /** * This lifecycle method is unused by this trait, and is implemented to do nothing. If invoked, it will * just return immediately. * ** Nested suites are not allowed in a
* *PathAnyFunSpec
. Because * aPathAnyFunSpec
executes tests eagerly at construction time, registering the results of * those test runs and reporting them later, the order of nested suites versus test runs would be different * in aorg.scalatest.funspec.PathAnyFunSpec
than in anorg.scalatest.funspec.PathAnyFunSpec
. In an *org.scalatest.funspec.AnyFunSpec
, nested suites are executed then tests are executed. In an *org.scalatest.funspec.PathAnyFunSpec
it would be the opposite. To make the code easy to reason about, * therefore, this is just not allowed. If you want to add nested suites to aPathAnyFunSpec
, you can * instead wrap them all in aSuites
* object and put them in whatever order you wish. ** This trait's implementation of this method is marked as final. For insight onto why, see the * Shared fixtures section in the main documentation for this trait. *
*/ final protected override def runNestedSuites(args: Args): Status = SucceededStatus /** * Returns an empty list. * ** This lifecycle method is unused by this trait. If invoked, it will return an empty list, because * nested suites are not allowed in a
* *PathAnyFunSpec
. Because * aPathAnyFunSpec
executes tests eagerly at construction time, registering the results of * those test runs and reporting them later, the order of nested suites versus test runs would be different * in aorg.scalatest.funspec.PathAnyFunSpec
than in anorg.scalatest.funspec.AnyFunSpec
. In an *org.scalatest.funspec.PathAnyFunSpec
, nested suites are executed then tests are executed. In an *org.scalatest.funspec.PathAnyFunSpec
it would be the opposite. To make the code easy to reason about, * therefore, this is just not allowed. If you want to add nested suites to aPathAnyFunSpec
, you can * instead wrap them all in aSuites
* object and put them in whatever order you wish. ** This trait's implementation of this method is marked as final. For insight onto why, see the * Shared fixtures section in the main documentation for this trait. *
*/ final override def nestedSuites: collection.immutable.IndexedSeq[Suite] = Vector.empty /** * ThestyleName
lifecycle method has been deprecated and will be removed in a future version of ScalaTest. * *This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0 * will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for
*/ @deprecated("The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.", "3.1.0") final override val styleName: String = "org.scalatest.path.FunSpec" override def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData = { ensureTestResultsRegistered(thisSuite) createTestDataFor(testName, theConfigMap, this) } }styleName
.