org.scalatest.wordspec.FixtureAnyWordSpecLike.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.wordspec 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 verbs.{CanVerb, ResultOfAfterWordApplication, ShouldVerb, BehaveWord, MustVerb, StringVerbBlockRegistration, SubjectWithAfterWordRegistration} /** * Implementation trait for class
for traitFixtureAnyWordSpec
, which is * a sister class toorg.scalatest.wordspec.AnyWordSpec
that can pass a * fixture object into its tests. * **
* *FixtureAnyWordSpec
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 ofFixtureAnyWordSpec
into some other * class, you can use this trait instead, because class *FixtureAnyWordSpec
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.reflect.annotation.EnableReflectiveInstantiation //SCALATESTNATIVE-ONLY @scala.scalanative.reflect.annotation.EnableReflectiveInstantiation @Finders(Array("org.scalatest.finders.WordSpecFinder")) trait FixtureAnyWordSpecLike extends org.scalatest.FixtureTestSuite with org.scalatest.FixtureTestRegistration with ShouldVerb with MustVerb with CanVerb with Informing with Notifying with Alerting with Documenting { thisSuite => private final val engine = new FixtureEngine[FixtureParam](Resources.concurrentFixtureWordSpecMod, "FixtureWordSpec") import engine._ private[scalatest] val sourceFileName = "FixtureAnyWordSpecLike.scala" /** * Returns anFixtureAnyWordSpec
. *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 *FixtureAnyWordSpec
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 *FixtureAnyWordSpec
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 private final def registerTestImpl(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = { // SKIP-SCALATESTJS,NATIVE-START val stackDepthAdjustment = -1 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -4 engine.registerTest(testText, org.scalatest.fixture.Transformer(testFun), Resources.testCannotBeNestedInsideAnotherTest, sourceFileName, "registerTest", 4, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*) } inline def registerTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = { // Note: we can't remove the implicit pos here because it is the signature of registerTest in TestRegistration. ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestImpl(testText, testTags: _*)(testFun, pos) }) } } private final def registerIgnoredTestImpl(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = { // SKIP-SCALATESTJS,NATIVE-START val stackDepthAdjustment = -3 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -5 engine.registerIgnoredTest(testText, org.scalatest.fixture.Transformer(testFun), Resources.testCannotBeNestedInsideAnotherTest, sourceFileName, "registerIgnoredTest", 4, stackDepthAdjustment, None, Some(pos), testTags: _*) } inline def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = { // Note: we can't remove the implicit pos here because it is the signature of registerTest in TestRegistration. ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerIgnoredTestImpl(testText, testTags: _*)(testFun, pos) }) } } /** * 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 * thisFixtureAnyWordSpec
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 NullArgumentException ifspecText
or any passed test tag isnull
*/ private def registerTestToRun(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = { // SKIP-SCALATESTJS,NATIVE-START val stackDepth = 4 val stackDepthAdjustment = -3 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepth = 6 //SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -6 engine.registerTest(specText, org.scalatest.fixture.Transformer(testFun), Resources.inCannotAppearInsideAnotherIn, sourceFileName, methodName, stackDepth, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*) } private def registerPendingTestToRun(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => PendingStatement, pos: source.Position): Unit = { engine.registerTest(specText, org.scalatest.fixture.Transformer(testFun), Resources.inCannotAppearInsideAnotherIn, sourceFileName, methodName, 4, -3, None, None, Some(pos), 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 * thisFixtureAnyWordSpec
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 NullArgumentException ifspecText
or any passed test tag isnull
*/ private def registerTestToIgnore(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = { // SKIP-SCALATESTJS,NATIVE-START val stackDepth = 4 val stackDepthAdjustment = -4 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepth = 6 //SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -7 engine.registerIgnoredTest(specText, org.scalatest.fixture.Transformer(testFun), Resources.ignoreCannotAppearInsideAnIn, sourceFileName, methodName, stackDepth, stackDepthAdjustment, None, Some(pos), testTags: _*) } private def registerPendingTestToIgnore(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => PendingStatement, pos: source.Position): Unit = { engine.registerIgnoredTest(specText, org.scalatest.fixture.Transformer(testFun), Resources.ignoreCannotAppearInsideAnIn, sourceFileName, methodName, 4, -4, None, Some(pos), testTags: _*) } private def exceptionWasThrownInClauseMessageFun(verb: String, className: UnquotedString, description: String, errorMessage: String): String = verb match { case "when" => FailureMessages.exceptionWasThrownInWhenClause(Prettifier.default, className, description, errorMessage) case "which" => FailureMessages.exceptionWasThrownInWhichClause(Prettifier.default, className, description, errorMessage) case "that" => FailureMessages.exceptionWasThrownInThatClause(Prettifier.default, className, description, errorMessage) case "should" => FailureMessages.exceptionWasThrownInShouldClause(Prettifier.default, className, description, errorMessage) case "must" => FailureMessages.exceptionWasThrownInMustClause(Prettifier.default, className, description, errorMessage) case "can" => FailureMessages.exceptionWasThrownInCanClause(Prettifier.default, className, description, errorMessage) } private def rethrowIfCauseIsNAEOrDTNE(e: StackDepthException, pos: source.Position): Unit = e.cause match { case Some(c) if c.isInstanceOf[NotAllowedException] || c.isInstanceOf[DuplicateTestNameException] => throw c case _ => throw new NotAllowedException( FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotShouldMustWhenThatWhichOrCanClause, Some(e), e.position.getOrElse(pos) ) } private def registerBranch(description: String, childPrefix: Option[String], verb: String, methodName: String, stackDepth: Int, adjustment: Int, pos: source.Position, fun: () => Unit): Unit = { def registrationClosedMessageFun: String = verb match { case "should" => Resources.shouldCannotAppearInsideAnIn case "when" => Resources.whenCannotAppearInsideAnIn case "which" => Resources.whichCannotAppearInsideAnIn case "that" => Resources.thatCannotAppearInsideAnIn case "must" => Resources.mustCannotAppearInsideAnIn case "can" => Resources.canCannotAppearInsideAnIn } try { registerNestedBranch(description, childPrefix, fun(), registrationClosedMessageFun, sourceFileName, methodName, stackDepth, adjustment, None, Some(pos)) } catch { case e: TestFailedException => rethrowIfCauseIsNAEOrDTNE(e, pos) case e: TestCanceledException => rethrowIfCauseIsNAEOrDTNE(e, pos) case nae: NotAllowedException => throw nae case trce: TestRegistrationClosedException => throw trce case e: DuplicateTestNameException => throw new NotAllowedException(exceptionWasThrownInClauseMessageFun(verb, UnquotedString(e.getClass.getName), description, e.getMessage), Some(e), e.position.getOrElse(pos)) case other: Throwable if (!Suite.anExceptionThatShouldCauseAnAbort(other)) => throw new NotAllowedException(exceptionWasThrownInClauseMessageFun(verb, UnquotedString(other.getClass.getName), if (description.endsWith(" " + verb)) description.substring(0, description.length - (" " + verb).length) else description, other.getMessage), Some(other), pos) case other: Throwable => throw other } } private def registerShorthandBranch(childPrefix: Option[String], notAllowMessageFun: => String, methodName:String, stackDepth: Int, adjustment: Int, pos: source.Position, fun: () => Unit): Unit = { // Shorthand syntax only allow at top level, and only after "..." when, "..." should/can/must, or it should/can/must if (engine.currentBranchIsTrunk) { val currentBranch = engine.atomic.get.currentBranch // headOption because subNodes are in reverse order currentBranch.subNodes.headOption match { case Some(last) => last match { case DescriptionBranch(_, descriptionText, _, _) => def registrationClosedMessageFun: String = methodName match { case "when" => Resources.whenCannotAppearInsideAnIn case "which" => Resources.whichCannotAppearInsideAnIn case "that" => Resources.thatCannotAppearInsideAnIn case "should" => Resources.shouldCannotAppearInsideAnIn case "must" => Resources.mustCannotAppearInsideAnIn case "can" => Resources.canCannotAppearInsideAnIn } try { registerNestedBranch(descriptionText, childPrefix, fun(), registrationClosedMessageFun, "WordSpecLike.scala", methodName, stackDepth, adjustment, None, Some(pos)) } catch { case e: TestFailedException => rethrowIfCauseIsNAEOrDTNE(e, pos) case e: TestCanceledException => rethrowIfCauseIsNAEOrDTNE(e, pos) case nae: NotAllowedException => throw nae case trce: TestRegistrationClosedException => throw trce case e: DuplicateTestNameException => throw new NotAllowedException(exceptionWasThrownInClauseMessageFun(methodName, UnquotedString(e.getClass.getName), descriptionText, e.getMessage), Some(e), e.position.getOrElse(pos)) case other: Throwable if (!Suite.anExceptionThatShouldCauseAnAbort(other)) => throw new NotAllowedException(exceptionWasThrownInClauseMessageFun(methodName, UnquotedString(other.getClass.getName), if (descriptionText.endsWith(" " + methodName)) descriptionText.substring(0, descriptionText.length - (" " + methodName).length) else descriptionText, other.getMessage), Some(other), pos) case other: Throwable => throw other } case _ => throw new NotAllowedException(notAllowMessageFun, pos) } case None => throw new NotAllowedException(notAllowMessageFun, pos) } } else throw new NotAllowedException(notAllowMessageFun, pos) } /** * 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
* * @param testFun the test function */ inline infix def in(testFun: FixtureParam => Any /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToRun(specText, tags, "in", testFun, pos) }) } } /** * Supports tagged test registration, for tests that don't take a fixture. * *FixtureAnyWordSpec
. ** 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
* * @param testFun the test function */ inline infix def in(testFun: () => Any /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToRun(specText, tags, "in", new org.scalatest.fixture.NoArgTestWrapper(testFun), pos) }) } } /** * Supports registration of tagged, pending tests. * *FixtureAnyWordSpec
. ** 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
* * @param testFun the test function */ inline infix def is(testFun: => PendingStatement): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerPendingTestToRun(specText, tags, "is", unusedFixtureParam => testFun, pos)}) } } /** * Supports registration of tagged, ignored tests. * *FixtureAnyWordSpec
. ** 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
* * @param testFun the test function */ inline infix def ignore(testFun: FixtureParam => Any /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToIgnore(specText, tags, "ignore", testFun, pos)}) } } private final def ignoreImpl(testFun: () => Any /* Assertion */, pos: source.Position): Unit = { registerTestToIgnore(specText, tags, "ignore", new org.scalatest.fixture.NoArgTestWrapper(testFun), pos) } /** * Supports registration of tagged, ignored tests that take no fixture parameter. * *FixtureAnyWordSpec
. ** 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
* * @param testFun the test function */ inline infix def ignore(testFun: () => Any /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => ignoreImpl(testFun, pos) }) } } } /** * A class that via an implicit conversion (namedFixtureAnyWordSpec
. *convertToWordSpecStringWrapper
) enables * methodswhen
,which
,in
,is
,taggedAs
* andignore
to be invoked onString
s. * ** This class provides much of the syntax for
* * @param string the string that is wrapped * * @author Bill Venners */ protected final class WordSpecStringWrapper(string: String) { /** * Supports test registration. * *FixtureAnyWordSpec
, however, it does not add * the verb methods (should
,must
, andcan
) toString
. * Instead, these are added via theShouldVerb
,MustVerb
, andCanVerb
* traits, whichFixtureAnyWordSpec
mixes in, to avoid a conflict with implicit conversions provided * inMatchers
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
* * @param testFun the test function */ inline infix def in(testFun: FixtureParam => Any /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToRun(string, List(), "in", testFun, pos)}) } } private final def inImpl(testFun: () => Any /* Assertion */, pos: source.Position): Unit = { registerTestToRun(string, List(), "in", new org.scalatest.fixture.NoArgTestWrapper(testFun), pos) } /** * Supports registration of tests that take no fixture. * *FixtureAnyWordSpec
. ** 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
* * @param testFun the test function */ inline infix def in(testFun: () => Any /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => inImpl(testFun, pos) }) } } /** * Supports pending test registration. * *FixtureAnyWordSpec
. ** 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
* * @param testFun the test function */ inline infix def is(testFun: => PendingStatement): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerPendingTestToRun(string, List(), "is", unusedFixtureParam => testFun, pos)}) } } /** * Supports ignored test registration. * *FixtureAnyWordSpec
. ** 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
* * @param testFun the test function */ inline infix def ignore(testFun: FixtureParam => Any /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToIgnore(string, List(), "ignore", testFun, pos)}) } } private final def ignoreImpl(testFun: () => Any /* Assertion */, pos: source.Position): Unit = { registerTestToIgnore(string, List(), "ignore", new org.scalatest.fixture.NoArgTestWrapper(testFun), pos) } /** * Supports registration of ignored tests that take no fixture. * *FixtureAnyWordSpec
. ** 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
* * @param testFun the test function */ inline infix def ignore(testFun: () => Any /* Assertion */): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => ignoreImpl(testFun, pos) }) } } /** * Supports tagged test registration. * *FixtureAnyWordSpec
. ** 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
* * @param firstTestTag the first mandatory test tag * @param otherTestTags the others additional test tags * @return an new instance ofFixtureAnyWordSpec
. *ResultOfTaggedAsInvocationOnString
*/ infix def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = { val tagList = firstTestTag :: otherTestTags.toList new ResultOfTaggedAsInvocationOnString(string, tagList) } /** * Registers awhen
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
* * @param f the function which is the body of the scope */ inline infix def when(f: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string, Some("when"), "when", "when", 4, -2, pos, () => f)}) } } /** * Registers aFixtureAnyWordSpec
. *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
* * @param resultOfAfterWordApplication aFixtureAnyWordSpec
. *ResultOfAfterWordApplication
*/ inline infix def when(resultOfAfterWordApplication: ResultOfAfterWordApplication): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string, Some("when " + resultOfAfterWordApplication.text), "when", "when", 4, -2, pos, resultOfAfterWordApplication.f)}) } } /** * Registers athat
clause. * ** For example, this method supports syntax such as the following: *
* ** "a rerun button" that { * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
* * @param f the function which is the body of the scope */ inline infix def that(f: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string.trim + " that", None, "that", "that", stackDepth, -2, pos, () => f)}) } } /** * Registers aFixtureAnyWordSpec
. *which
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
* * @param f the function which is the body of the scope */ inline infix def which(f: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string.trim + " which", None, "which", "which", stackDepth, -2, pos, () => f)}) } } /** * Registers aFixtureAnyWordSpec
. *that
clause. * ** For example, this method supports syntax such as the following: *
* ** "a rerun button," that { * ^ ** ** For more information and examples of this method's use, see the main documentation for trait
* * @param resultOfAfterWordApplication aFixtureAnyWordSpec
. *ResultOfAfterWordApplication
*/ inline infix def that(resultOfAfterWordApplication: ResultOfAfterWordApplication): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string.trim + " that " + resultOfAfterWordApplication.text.trim, None, "that", "that", 4, -2, pos, 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
* * @param resultOfAfterWordApplication aFixtureAnyWordSpec
. *ResultOfAfterWordApplication
*/ inline infix def which(resultOfAfterWordApplication: ResultOfAfterWordApplication): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string.trim + " which " + resultOfAfterWordApplication.text.trim, None, "which", "which", 4, -2, pos, resultOfAfterWordApplication.f)}) } } } /** * Class whose instances are after words, which can 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._ * import ConfigMapFixture * * class ScalaTestGUISpec extends wordspec.FixtureAnyWordSpec 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
* *FixtureAnyWordSpec
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 *
* * @param text the afterword text */ 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.AnyWordSpec
. * * * @param f the function to be transformed intoResultOfAfterWordApplication
* @return an new instance ofResultOfAfterWordApplication
*/ 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._ * import ConfigMapFixture * * class ScalaTestGUISpec extends wordspec.FixtureAnyWordSpec 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
* *FixtureAnyWordSpec
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 *
* * @param text the after word text * @return an instance ofAfterWord
*/ protected def afterWord(text: String) = new AfterWord(text) // SKIP-SCALATESTJS,NATIVE-START private[scalatest] val stackDepth = 3 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY private[scalatest] val stackDepth: Int = 10 /** * Class that supports shorthand scope registration via the instance referenced fromFixtureAnyWordSpecLike
'sit
field. * ** This class enables syntax such as the following test registration: *
* ** "A Stack" when { ... } * * it should { ... } * ^ ** ** For more information and examples of the use of the
*/ protected final class ItWord { private final def shouldImpl(right: => Unit, pos: source.Position): Unit = { registerShorthandBranch(Some("should"), Resources.itMustAppearAfterTopLevelSubject, "should", stackDepth, -2, pos, () => right) } /** * Supports the registration of scope withit
field, see the main documentation * forFixtureAnyWordSpec
. *should
in aFixtureAnyWordSpecLike
. * ** This method supports syntax such as the following: *
* ** "A Stack" when { ... } * * it should { ... } * ^ ** ** For examples of scope registration, see the main documentation * for
* * @param right the body function */ inline infix def should(right: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => shouldImpl(right, pos) }) } } private final def mustImpl(right: => Unit, pos: source.Position): Unit = { registerShorthandBranch(Some("must"), Resources.itMustAppearAfterTopLevelSubject, "must", stackDepth, -2, pos, () => right) } /** * Supports the registration of scope withAnyWordSpec
. *must
in aFixtureAnyWordSpecLike
. * ** This method supports syntax such as the following: *
* ** "A Stack" when { ... } * * it must { ... } * ^ ** ** For examples of scope registration, see the main documentation * for
* * @param right the body function */ inline infix def must(right: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => mustImpl(right, pos) }) } } private final def canImpl(right: => Unit, pos: source.Position): Unit = { registerShorthandBranch(Some("can"), Resources.itMustAppearAfterTopLevelSubject, "can", stackDepth, -2, pos, () => right) } /** * Supports the registration of scope withAnyWordSpec
. *can
in aFixtureAnyWordSpecLike
. * ** This method supports syntax such as the following: *
* ** "A Stack" when { ... } * * it can { ... } * ^ ** ** For examples of scope registration, see the main documentation * for
* * @param right the body function */ inline infix def can(right: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => canImpl(right, pos) }) } } private final def whenImpl(right: => Unit, pos: source.Position): Unit = { registerShorthandBranch(Some("when"), Resources.itMustAppearAfterTopLevelSubject, "when", stackDepth, -2, pos, () => right) } /** * Supports the registration of scope withAnyWordSpec
. *when
in aFixtureAnyWordSpecLike
. * ** This method supports syntax such as the following: *
* ** "A Stack" should { ... } * * it when { ... } * ^ ** ** For examples of scope registration, see the main documentation * for
* * @param right the body function */ inline infix def when(right: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => whenImpl(right, pos) }) } } } /** * Supports shorthand scope registration inAnyWordSpec
. *FixtureAnyWordSpecLike
s. * ** This field enables syntax such as the following test registration: *
* ** "A Stack" when { ... } * * it should { ... } * ^ ** ** For more information and examples of the use of the
*/ protected val it = new ItWord /** * Class that supports shorthand scope registration via the instance referenced fromit
field, see the main documentation * forAnyWordSpec
. *FixtureAnyWordSpecLike
'sthey
field. * ** This class enables syntax such as the following test registration: *
* ** "Basketball players" when { ... } * * they should { ... } * ^ ** ** For more information and examples of the use of the
*/ protected final class TheyWord { private final def shouldImpl(right: => Unit, pos: source.Position): Unit = { registerShorthandBranch(Some("should"), Resources.theyMustAppearAfterTopLevelSubject, "should", stackDepth, -2, pos, () => right) } /** * Supports the registration of scope withthey
field, see the main documentation * forAnyWordSpec
. *should
in aFixtureAnyWordSpecLike
. * ** This method supports syntax such as the following: *
* ** "Basketball players" when { ... } * * they should { ... } * ^ ** ** For examples of scope registration, see the main documentation * for
* * @param right the body function */ inline infix def should(right: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => shouldImpl(right, pos) }) } } private final def mustImpl(right: => Unit, pos: source.Position): Unit = { registerShorthandBranch(Some("must"), Resources.theyMustAppearAfterTopLevelSubject, "must", stackDepth, -2, pos, () => right) } /** * Supports the registration of scope withAnyWordSpec
. *must
in aFixtureAnyWordSpecLike
. * ** This method supports syntax such as the following: *
* ** "Basketball players" when { ... } * * they must { ... } * ^ ** ** For examples of scope registration, see the main documentation * for
* * @param right the body function */ inline infix def must(right: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => mustImpl(right, pos) }) } } private final def canImpl(right: => Unit, pos: source.Position): Unit = { registerShorthandBranch(Some("can"), Resources.theyMustAppearAfterTopLevelSubject, "can", stackDepth, -2, pos, () => right) } /** * Supports the registration of scope withAnyWordSpec
. *can
in aFixtureAnyWordSpecLike
. * ** This method supports syntax such as the following: *
* ** "Basketball players" when { ... } * * they can { ... } * ^ ** ** For examples of scope registration, see the main documentation * for
* * @param right the body function */ inline infix def can(right: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => canImpl(right, pos) }) } } private final def whenImpl(right: => Unit, pos: source.Position): Unit = { registerShorthandBranch(Some("when"), Resources.theyMustAppearAfterTopLevelSubject, "when", stackDepth, -2, pos, () => right) } /** * Supports the registration of scope withAnyWordSpec
. *when
in aFixtureAnyWordSpecLike
. * ** This method supports syntax such as the following: *
* ** "Basketball players" should { ... } * * they when { ... } * ^ ** ** For examples of scope registration, see the main documentation * for
* * @param right the body function */ inline infix def when(right: => Unit): Unit = { ${ source.Position.withPosition[Unit]('{(pos: source.Position) => whenImpl(right, pos) }) } } } /** * Supports shorthand scope registration inAnyWordSpec
. *FixtureAnyWordSpecLike
s. * ** This field enables syntax such as the following test registration: *
* ** "A Stack" when { ... } * * they should { ... } * ^ ** ** For more information and examples of the use of the
*/ protected val they = new TheyWord import scala.language.implicitConversions /** * Implicitly convertsthey
field, see the main documentation * forAnyWordSpec
. *String
s toWordSpecStringWrapper
, which enables * methodswhen
,which
,in
,is
,taggedAs
* andignore
to be invoked onString
s. * * @param sString
to be wrapped * @return an instance ofWordSpecStringWrapper
*/ protected implicit def convertToWordSpecStringWrapper(s: String): WordSpecStringWrapper = 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, pos: source.Position, f: () => Unit): Unit = registerBranch(left, Some(verb), verb, "apply", 6, -2, pos, 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: SubjectWithAfterWordRegistration = new SubjectWithAfterWordRegistration { def apply(left: String, verb: String, resultOfAfterWordApplication: ResultOfAfterWordApplication, pos: source.Position): Unit = { val afterWordFunction = () => { // SKIP-SCALATESTJS,NATIVE-START val stackDepth = 10 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepth = 15 registerBranch(resultOfAfterWordApplication.text, None, verb, "apply", stackDepth, -2, pos, resultOfAfterWordApplication.f) } // SKIP-SCALATESTJS,NATIVE-START val stackDepth = 7 // SKIP-SCALATESTJS,NATIVE-END //SCALATESTJS,NATIVE-ONLY val stackDepth = 9 registerBranch(left, Some(verb), verb, "apply", stackDepth, -2, pos, 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 thisFixtureAnyWordSpec
belong, and values * theSet
of test names that belong to each tag. If thisFixtureAnyWordSpec
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 if any oftestName
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: org.scalatest.fixture.NoArgTestWrapper[_, _] => withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, args.configMap)) case fun => withFixture(new TestFunAndConfigMap(testName, fun, args.configMap)) } case other => other match { case wrapper: org.scalatest.fixture.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
* *FixtureAnyWordSpec
'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 thisFixtureAnyWordSpec
. * @param args theArgs
for this run * @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 thisFixtureAnyWordSpec
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 inFixtureAnyWordSpec
s. * ** This field enables syntax such as the following: *
* ** behave like nonFullStack(stackWithOneItem) * ^ ** ** For more information and examples of the use of
*/ protected val behave = new BehaveWord /** * Thebehave, see the Shared tests section * in the main documentation for trait org.scalatest.wordspec.AnyWordSpec
. *styleName
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.fixture.WordSpec" override def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData = createTestDataFor(testName, theConfigMap, this) }styleName
.