org.scalatest.flatspec.FixtureAsyncFlatSpecLike.scala Maven / Gradle / Ivy
/*
* Copyright 2001-2013 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.flatspec
import org.scalatest._
import org.scalatest.fixture.{NoArgTestWrapper, AsyncPendingTransformer}
import org.scalactic.source
import scala.concurrent.Future
import org.scalatest.Suite.autoTagClassAnnotations
import verbs.{ResultOfTaggedAsInvocation, ResultOfStringPassedToVerb, BehaveWord, ShouldVerb, MustVerb, CanVerb, StringVerbStringInvocation, StringVerbBehaveLikeInvocation}
import scala.util.Try
/**
* Implementation trait for class FixtureAsyncFlatSpec, which is
* a sister class to org.scalatest.flatspec.FixtureAsyncFlatSpec that can pass a
* fixture object into its tests.
*
*
* FixtureAsyncFlatSpec 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 of FixtureAsyncFlatSpec into some other
* class, you can use this trait instead, because class
* FixtureAsyncFlatSpec does nothing more than extend this trait and add a nice toString implementation.
*
*
*
* See the documentation of the class for a detailed
* overview of FixtureAsyncFlatSpec.
*
*
* @author Bill Venners
*/
//SCALATESTJS-ONLY @scala.scalajs.reflect.annotation.EnableReflectiveInstantiation
@Finders(Array("org.scalatest.finders.FlatSpecFinder"))
trait FixtureAsyncFlatSpecLike extends org.scalatest.FixtureAsyncTestSuite with org.scalatest.FixtureAsyncTestRegistration with ShouldVerb with MustVerb with CanVerb with Informing with Notifying with Alerting with Documenting { thisSuite =>
private final val engine = new AsyncFixtureEngine[FixtureParam](Resources.concurrentFixtureFlatSpecMod, "FixtureFlatSpec")
import engine._
/**
* Returns an 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, as recordedEvents
* of the test completed event, such as TestSucceeded. 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 a Notifier 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
* FixtureAsyncFlatSpec 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 an Alerter 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
* FixtureAsyncFlatSpec 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 a Documenter 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, as recordedEvents
* of the test completed event, such as TestSucceeded. 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 registerAsyncTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
engine.registerAsyncTest(testText, transformToOutcome(testFun), Resources.testCannotBeNestedInsideAnotherTest, None, None, pos, testTags: _*)
}
final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
engine.registerIgnoredAsyncTest(testText, transformToOutcome(testFun), Resources.testCannotBeNestedInsideAnotherTest, None, pos, 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 the execute
* methods. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for testNames for an example.) The resulting test name must not have been registered previously on
* this FixtureAsyncFlatSpec 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 after run has been invoked on this suite
* @throws NullArgumentException if specText or any passed test tag is null
*/
private def registerAsyncTestToRun(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => Future[compatible.Assertion], pos: source.Position): Unit = {
// TODO: This is what was being used before but it is wrong
def testRegistrationClosedMessageFun: String =
methodName match {
case "in" => Resources.inCannotAppearInsideAnotherInOrIs
case "is" => Resources.isCannotAppearInsideAnotherInOrIs
}
engine.registerAsyncTest(specText, transformToOutcome(testFun), testRegistrationClosedMessageFun, None, None, pos, testTags: _*)
}
private def registerPendingTestToRun(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => PendingStatement, pos: source.Position): Unit = {
// TODO: This is what was being used before but it is wrong
def testRegistrationClosedMessageFun: String =
methodName match {
case "in" => Resources.inCannotAppearInsideAnotherInOrIs
case "is" => Resources.isCannotAppearInsideAnotherInOrIs
}
engine.registerAsyncTest(specText, AsyncPendingTransformer(testFun), testRegistrationClosedMessageFun, None, None, pos, testTags: _*)
}
/**
* Class that supports the registration of a “subject” being specified and tested via the
* instance referenced from FixtureAsyncFlatSpec's behavior field.
*
*
* This field enables syntax such as the following subject registration:
*
*
*
* behavior of "A Stack"
* ^
*
*
*
* For more information and examples of the use of the behavior field, see the main documentation
* for trait AnyFlatSpec.
*
*/
protected final class BehaviorWord {
/**
* Supports the registration of a “subject” being specified and tested via the
* instance referenced from FixtureAsyncFlatSpec's behavior field.
*
*
* This method enables syntax such as the following subject registration:
*
*
*
* behavior of "A Stack"
* ^
*
*
*
* For more information and examples of the use of this method, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param description the description text
*/
def of(description: String)(implicit pos: source.Position): Unit = {
registerFlatBranch(description, Resources.behaviorOfCannotAppearInsideAnIn, pos)
}
}
/**
* Supports the registration of a “subject” being specified and tested.
*
*
* This field enables syntax such as the following subject registration:
*
*
*
* behavior of "A Stack"
* ^
*
*
*
* For more information and examples of the use of the behavior field, see the main documentation
* for trait AnyFlatSpec.
*
*/
protected val behavior = new BehaviorWord
// TODO: Do a walk through. Are all these being used. I guess I'll find out when
// I document them.
/**
* Class that supports the registration of tagged tests via the ItWord instance
* referenced from FixtureAsyncFlatSpec's it field.
*
*
* This class enables syntax such as the following tagged test registration:
*
*
*
* it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* It also enables syntax such as the following registration of an ignored, tagged test:
*
*
*
* it should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of a pending, tagged test:
*
*
*
* it should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* For more information and examples of the use of the it field to register tagged tests, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param verb the verb
* @param name the name
* @param tags the list of tags
*/
protected final class ItVerbStringTaggedAs(verb: String, name: String, tags: List[Tag]) {
/**
* Supports the registration of tagged, no-arg tests in a FixtureAnyFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) in { () => ... }
* ^
*
*
*
* For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + name.trim, tags, "in", new NoArgTestWrapper[FixtureParam, Future[compatible.Assertion]](testFun), pos)
}
/**
* Supports the registration of tagged, one-arg tests (tests that take a FixtureParam object as a parameter) in a FixtureAnyFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) in { fixture => ... }
* ^
*
*
*
* For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + name.trim, tags, "in", testFun, pos)
}
/**
* Supports the registration of pending, tagged tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait AnyFlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def is(testFun: => PendingStatement)(implicit pos: source.Position): Unit = {
registerPendingTestToRun(verb.trim + " " + name.trim, tags, "is", unusedFixtureParam => testFun, pos)
}
/**
* Supports the registration of ignored, tagged, no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait AnyFlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, tags, new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of ignored, tagged, one-arg tests (tests that take a FixtureParam object
* as a parameter) in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait AnyFlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, tags, testFun, pos)
}
}
/**
* Class that supports test registration via the instance referenced from FixtureAnyFlatSpec's it field.
*
*
* This class enables syntax such as the following test registration:
*
*
*
* it should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following registration of an ignored test:
*
*
*
* it should "pop values in last-in-first-out order" ignore { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of a pending test:
*
*
*
* it should "pop values in last-in-first-out order" is (pending)
* ^
*
*
*
* And finally, it also enables syntax such as the following tagged test registration:
*
*
*
* it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param verb the verb
* @param name the name
*/
protected final class ItVerbString(verb: String, name: String) {
/**
* Supports the registration of no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" in { () => ... }
* ^
*
*
*
* For examples of no-arg test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + name.trim, List(), "in", new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of one-arg tests (tests that take a FixtureParam object as a parameter) in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" in { fixture => ... }
* ^
*
*
*
* For examples of one-arg test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + name.trim, List(), "in", testFun, pos)
}
/**
* Supports the registration of pending tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" is (pending)
* ^
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def is(testFun: => PendingStatement)(implicit pos: source.Position): Unit = {
registerPendingTestToRun(verb.trim + " " + name.trim, List(), "is", unusedFixtureParam => testFun, pos)
}
/**
* Supports the registration of ignored no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, List(), new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of ignored one-arg tests (tests that take a FixtureParam object as a parameter) in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, List(), testFun, pos)
}
/**
* Supports the registration of tagged tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section in the main documentation
* for trait AnyFlatSpec.
*
*
* @param firstTestTag the first mandatory test tag
* @param otherTestTags the others additional test tags
*/
def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
val tagList = firstTestTag :: otherTestTags.toList
new ItVerbStringTaggedAs(verb, name, tagList)
}
}
/**
* Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec's it field.
*
*
* This class enables syntax such as the following test registration:
*
*
*
* it should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following shared test registration:
*
*
*
* it should behave like nonEmptyStack(lastItemPushed)
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait AnyFlatSpec.
*
*/
protected final class ItWord {
/**
* Supports the registration of tests with should in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def should(string: String) = new ItVerbString("should", string)
/**
* Supports the registration of tests with must in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it must "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def must(string: String) = new ItVerbString("must", string)
/**
* Supports the registration of tests with can in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it can "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def can(string: String) = new ItVerbString("can", string)
/**
* Supports the registration of shared tests with should in a FixtureAnyFlatSpec.
*
*
* 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 AnyFlatSpec.
*
*
* @param behaveWord the BehaveWord
*/
def should(behaveWord: BehaveWord) = behaveWord
/**
* Supports the registration of shared tests with must in a FixtureAsyncFlatSpec.
*
*
* 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 AnyFlatSpec.
*
*
* @param behaveWord the BehaveWord
*/
def must(behaveWord: BehaveWord) = behaveWord
/**
* Supports the registration of shared tests with can in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* it can behave like nonFullStack(stackWithOneItem)
* ^
*
*
*
* For examples of shared tests, see the Shared tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param behaveWord the BehaveWord
*/
def can(behaveWord: BehaveWord) = behaveWord
}
/**
* Supports test (and shared test) registration in FixtureAsyncFlatSpecs.
*
*
* This field enables syntax such as the following test registration:
*
*
*
* it should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following shared test registration:
*
*
*
* it should behave like nonEmptyStack(lastItemPushed)
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait AnyFlatSpec.
*
*/
protected val it = new ItWord
/**
* Class that supports the registration of tagged tests via the TheyWord instance
* referenced from FixtureAsyncFlatSpec's they field.
*
*
* This class enables syntax such as the following tagged test registration:
*
*
*
* they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* It also enables syntax such as the following registration of an ignored, tagged test:
*
*
*
* they should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of a pending, tagged test:
*
*
*
* they should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* For more information and examples of the use of the it field to register tagged tests, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param verb the verb
* @param name the name
* @param tags the list of tags
*/
protected final class TheyVerbStringTaggedAs(verb: String, name: String, tags: List[Tag]) {
/**
* Supports the registration of tagged, no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" taggedAs(SlowTest) in { () => ... }
* ^
*
*
*
* For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + name.trim, tags, "in", new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of tagged, one-arg tests (tests that take a FixtureParam object as a parameter) in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" taggedAs(SlowTest) in { fixture => ... }
* ^
*
*
*
* For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + name.trim, tags, "in", testFun, pos)
}
/**
* Supports the registration of pending, tagged tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait AnyFlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def is(testFun: => PendingStatement)(implicit pos: source.Position): Unit = {
registerPendingTestToRun(verb.trim + " " + name.trim, tags, "is", unusedFixtureParam => testFun, pos)
}
/**
* Supports the registration of ignored, tagged, no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait AnyFlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, tags, new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of ignored, tagged, one-arg tests (tests that take a FixtureParam object
* as a parameter) in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait AnyFlatSpec. And for examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, tags, testFun, pos)
}
}
/**
* Class that supports test registration via the instance referenced from FixtureAsyncFlatSpec's it field.
*
*
* This class enables syntax such as the following test registration:
*
*
*
* they should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following registration of an ignored test:
*
*
*
* they should "pop values in last-in-first-out order" ignore { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of a pending test:
*
*
*
* they should "pop values in last-in-first-out order" is (pending)
* ^
*
*
*
* And finally, it also enables syntax such as the following tagged test registration:
*
*
*
* they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param verb the verb
* @param name the name
*/
protected final class TheyVerbString(verb: String, name: String) {
/**
* Supports the registration of no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" in { () => ... }
* ^
*
*
*
* For examples of no-arg test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + name.trim, List(), "in", new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of one-arg tests (tests that take a FixtureParam object as a parameter) in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" in { fixture => ... }
* ^
*
*
*
* For examples of one-arg test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + name.trim, List(), "in", testFun, pos)
}
/**
* Supports the registration of pending tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" is (pending)
* ^
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def is(testFun: => PendingStatement)(implicit pos: source.Position): Unit = {
registerPendingTestToRun(verb.trim + " " + name.trim, List(), "is", unusedFixtureParam => testFun, pos)
}
/**
* Supports the registration of ignored no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, List(), new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of ignored one-arg tests (tests that take a FixtureParam object as a parameter) in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section in the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
(implicit pos: source.Position)*/
def ignore(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, List(), testFun, pos)
}
/**
* Supports the registration of tagged tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section in the main documentation
* for trait AnyFlatSpec.
*
*
* @param firstTestTag the first mandatory test tag
* @param otherTestTags the others additional test tags
*/
def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
val tagList = firstTestTag :: otherTestTags.toList
new ItVerbStringTaggedAs(verb, name, tagList)
}
}
/**
* Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec's they field.
*
*
* This class enables syntax such as the following test registration:
*
*
*
* they should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following shared test registration:
*
*
*
* they should behave like nonEmptyStack(lastItemPushed)
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait AnyFlatSpec.
*
*/
protected final class TheyWord {
/**
* Supports the registration of tests with should in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def should(string: String) = new ItVerbString("should", string)
/**
* Supports the registration of tests with must in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they must "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def must(string: String) = new ItVerbString("must", string)
/**
* Supports the registration of tests with can in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they can "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def can(string: String) = new ItVerbString("can", string)
/**
* Supports the registration of shared tests with should in a FixtureAsyncFlatSpec.
*
*
* 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 AnyFlatSpec.
*
*
* @param behaveWord the BehaveWord
*/
def should(behaveWord: BehaveWord) = behaveWord
/**
* Supports the registration of shared tests with must in a FixtureAsyncFlatSpec.
*
*
* 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 AnyFlatSpec.
*
*
* @param behaveWord the BehaveWord
*/
def must(behaveWord: BehaveWord) = behaveWord
/**
* Supports the registration of shared tests with can in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* they can behave like nonFullStack(stackWithOneItem)
* ^
*
*
*
* For examples of shared tests, see the Shared tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param behaveWord the BehaveWord
*/
def can(behaveWord: BehaveWord) = behaveWord
}
/**
* Supports test (and shared test) registration in FixtureAsyncFlatSpecs.
*
*
* This field enables syntax such as the following test registration:
*
*
*
* they should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* It also enables syntax such as the following shared test registration:
*
*
*
* they should behave like nonEmptyStack(lastItemPushed)
* ^
*
*
*
* For more information and examples of the use of the it field, see the main documentation
* for trait AnyFlatSpec.
*
*/
protected val they = new TheyWord
/**
* Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced
* from FixtureAsyncFlatSpec's ignore field.
*
*
* This class enables syntax such as the following registration of an ignored, tagged test:
*
*
*
* ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of an ignored, tagged, pending test:
*
*
*
* ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* Note: the is method is provided for completeness and design symmetry, given there's no way
* to prevent changing is to ignore and marking a pending test as ignored that way.
* Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
*
*
*
* For more information and examples of the use of the ignore field, see
* the Ignored tests section
* in the main documentation for trait AnyFlatSpec. For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param verb the verb
* @param name the name
* @param tags the list of tags
*/
protected final class IgnoreVerbStringTaggedAs(verb: String, name: String, tags: List[Tag]) {
/**
* Supports the registration of ignored, tagged, no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { () => ... }
* ^
*
*
*
* For examples of the registration of ignored tests, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec. For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, tags, new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of ignored, tagged, one-arg tests (tests that take a FixtureParam object as a parameter)
* in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { fixture => ... }
* ^
*
*
*
* For examples of the registration of ignored tests, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec. For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, tags, testFun, pos)
}
/**
* Supports the registration of ignored, tagged, pending tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
* ^
*
*
*
* Note: this is method is provided for completeness and design symmetry, given there's no way
* to prevent changing is to ignore and marking a pending test as ignored that way.
* Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait AnyFlatSpec. For examples of the registration of ignored tests,
* see the Ignored tests section
* in the main documentation for trait AnyFlatSpec. For examples of tagged test registration, see
* the Tagging tests section in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def is(testFun: => PendingStatement)(implicit pos: source.Position): Unit = {
registerPendingTestToIgnore(verb.trim + " " + name.trim, tags, unusedFixtureParam => testFun, pos)
}
}
/**
* Class that supports registration of ignored tests via the IgnoreWord instance referenced
* from FixtureAsyncFlatSpec's ignore field.
*
*
* This class enables syntax such as the following registration of an ignored test:
*
*
*
* ignore should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* In addition, it enables syntax such as the following registration of an ignored, pending test:
*
*
*
* ignore should "pop values in last-in-first-out order" is (pending)
* ^
*
*
* Note: the is method is provided for completeness and design symmetry, given there's no way
* to prevent changing is to ignore and marking a pending test as ignored that way.
* Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
*
*
*
* And finally, it also enables syntax such as the following ignored, tagged test registration:
*
*
*
* ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
*
* For more information and examples of the use of the ignore field, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param verb the verb
* @param name the name
*/
protected final class IgnoreVerbString(verb: String, name: String) {
/**
* Supports the registration of ignored, no-arg tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" in { () => ... }
* ^
*
*
*
* For examples of the registration of ignored tests, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, List(), new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of ignored, one-arg tests (tests that take a FixtureParam object
* as a parameter) in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" in { fixture => ... }
* ^
*
*
*
* For examples of the registration of ignored tests, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + name.trim, List(), testFun, pos)
}
/**
* Supports the registration of ignored, pending tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" is (pending)
* ^
*
*
*
* Note: this is method is provided for completeness and design symmetry, given there's no way
* to prevent changing is to ignore and marking a pending test as ignored that way.
* Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
*
*
*
* For examples of pending test registration, see the Pending tests section in the main documentation
* for trait AnyFlatSpec. For examples of the registration of ignored tests,
* see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def is(testFun: => PendingStatement)(implicit pos: source.Position): Unit = {
registerPendingTestToIgnore(verb.trim + " " + name.trim, List(), unusedFixtureParam => testFun, pos)
}
/**
* Supports the registration of ignored, tagged tests in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section in the main documentation
* for trait AnyFlatSpec. For examples of the registration of ignored tests,
* see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param firstTestTag the first mandatory test tag
* @param otherTestTags the others additional test tags
*/
def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
val tagList = firstTestTag :: otherTestTags.toList
new IgnoreVerbStringTaggedAs(verb, name, tagList)
}
}
/**
* Class that supports registration of ignored tests via the instance referenced from FixtureAsyncFlatSpec's ignore field.
*
*
* This class enables syntax such as the following registration of an ignored test:
*
*
*
* ignore should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see Ignored tests section
* in the main documentation for this trait.
*
*/
protected final class IgnoreWord {
/**
* Supports the registration of ignored tests with should in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def should(string: String) = new IgnoreVerbString("should", string)
/**
* Supports the registration of ignored tests with must in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore must "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def must(string: String) = new IgnoreVerbString("must", string)
/**
* Supports the registration of ignored tests with can in a FixtureAsyncFlatSpec.
*
*
* This method supports syntax such as the following:
*
*
*
* ignore can "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param string the string description
*/
def can(string: String) = new IgnoreVerbString("can", string)
}
/**
* Supports registration of ignored tests in FixtureAsyncFlatSpecs.
*
*
* This field enables syntax such as the following registration of an ignored test:
*
*
*
* ignore should "pop values in last-in-first-out order" in { ... }
* ^
*
*
*
* For more information and examples of the use of the ignore field, see the
* Ignored tests section in the main documentation for trait AnyFlatSpec.
*
*/
protected val ignore = new IgnoreWord
/**
* Class that supports test registration in shorthand form.
*
*
* For example, this class enables syntax such as the following test registration
* in shorthand form:
*
*
*
* "A Stack (when empty)" should "be empty" in { ... }
* ^
*
*
*
* This class also enables syntax such as the following ignored test registration
* in shorthand form:
*
*
*
* "A Stack (when empty)" should "be empty" ignore { ... }
* ^
*
*
*
* This class is used via an implicit conversion (named convertToInAndIgnoreMethods)
* from ResultOfStringPassedToVerb. The ResultOfStringPassedToVerb class
* does not declare any methods named in, because the
* type passed to in differs in a AsyncFlatSpec and a org.scalatest.flatspec.FixtureAsyncFlatSpec.
* A org.scalatest.flatspec.FixtureAsyncFlatSpec needs two in methods, one that takes a no-arg
* test function and another that takes a one-arg test function (a test that takes a
* FixtureParam as its parameter). By constrast, a AsyncFlatSpec needs
* only one in method that takes a by-name parameter. As a result,
* AsyncFlatSpec and org.scalatest.flatspec.FixtureAsyncFlatSpec each provide an implicit conversion
* from ResultOfStringPassedToVerb to a type that provides the appropriate
* in methods.
*
*
* @author Bill Venners
*/
protected final class InAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb) {
import resultOfStringPassedToVerb.rest
import resultOfStringPassedToVerb.verb
/**
* Supports the registration of no-arg tests in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" in { () => ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + rest.trim, List(), "in", new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of ignored, no-arg tests in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + rest.trim, List(), new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of one-arg tests (tests that take a FixtureParam parameter) in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" in { fixture => ... }
* ^
*
*
*
* For examples of test registration, see the main documentation
* for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + rest.trim, List(), "in", testFun, pos)
}
/**
* Supports the registration of ignored, one-arg tests (tests that take a FixtureParam parameter) in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + rest.trim, List(), testFun, pos)
}
}
import scala.language.implicitConversions
/**
* Implicitly converts an object of type ResultOfStringPassedToVerb to an
* InAndIgnoreMethods, to enable in and ignore
* methods to be invokable on that object.
*
* @param resultOfStringPassedToVerb an ResultOfStringPassedToVerb instance
*/
protected implicit def convertToInAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb): InAndIgnoreMethods =
new InAndIgnoreMethods(resultOfStringPassedToVerb)
/**
* Class that supports tagged test registration in shorthand form.
*
*
* For example, this class enables syntax such as the following tagged test registration
* in shorthand form:
*
*
*
* "A Stack (when empty)" should "be empty" taggedAs() in { ... }
* ^
*
*
*
* This class also enables syntax such as the following tagged, ignored test registration
* in shorthand form:
*
*
*
* "A Stack (when empty)" should "be empty" taggedAs(SlowTest) ignore { ... }
* ^
*
*
*
* This class is used via an implicit conversion (named convertToInAndIgnoreMethodsAfterTaggedAs)
* from ResultOfTaggedAsInvocation. The ResultOfTaggedAsInvocation class
* does not declare any methods named in, because the
* type passed to in differs in a AsyncFlatSpec and a FixtureAsyncFlatSpec.
* A FixtureAsyncFlatSpec needs two in methods, one that takes a no-arg
* test function and another that takes a one-arg test function (a test that takes a
* FixtureParam as its parameter). By constrast, a AsyncFlatSpec needs
* only one in method that takes a by-name parameter. As a result,
* AsyncFlatSpec and FixtureAsyncFlatSpec each provide an implicit conversion
* from ResultOfTaggedAsInvocation to a type that provides the appropriate
* in methods.
*
*
* @param resultOfTaggedAsInvocation an ResultOfTaggedAsInvocation instance
*
* @author Bill Venners
* @author Chee Seng
*/
protected final class InAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation) {
import resultOfTaggedAsInvocation.verb
import resultOfTaggedAsInvocation.rest
import resultOfTaggedAsInvocation.{tags => tagsList}
/**
* Supports the registration of tagged, no-arg tests in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) in { () => ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + rest.trim, tagsList, "in", new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of tagged, ignored, no-arg tests in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { () => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
* For examples of tagged test registration, see the Tagging tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: () => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + rest.trim, tagsList, new NoArgTestWrapper(testFun), pos)
}
/**
* Supports the registration of tagged, one-arg tests (tests that take a FixtureParam parameter) in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) in { fixture => ... }
* ^
*
*
*
* For examples of tagged test registration, see the Tagging tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def in(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToRun(verb.trim + " " + rest.trim, tagsList, "in", testFun, pos)
}
/**
* Supports the registration of tagged, ignored, one-arg tests (tests that take a FixtureParam parameter) in shorthand form.
*
*
* This method supports syntax such as the following:
*
*
*
* "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { fixture => ... }
* ^
*
*
*
* For examples of ignored test registration, see the Ignored tests section
* in the main documentation for trait AnyFlatSpec.
* For examples of tagged test registration, see the Tagging tests section
* in the main documentation for trait AnyFlatSpec.
*
*
* @param testFun the test function
*/
def ignore(testFun: FixtureParam => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestToIgnore(verb.trim + " " + rest.trim, tagsList, testFun, pos)
}
}
/**
* Implicitly converts an object of type ResultOfTaggedAsInvocation to an
* InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore
* methods to be invokable on that object.
*
* @param resultOfTaggedAsInvocation an ResultOfTaggedAsInvocation instance
*/
protected implicit def convertToInAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation): InAndIgnoreMethodsAfterTaggedAs =
new InAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation)
/**
* Supports the shorthand form of test registration.
*
*
* For example, this method enables syntax such as the following:
*
*
*
* "A Stack (when empty)" should "be empty" in { ... }
* ^
*
*
*
* This function is passed as an implicit parameter to a should method
* provided in ShouldVerb, a must method
* provided in MustVerb, and a can method
* provided in CanVerb. When invoked, this function registers the
* subject description (the first parameter to the function) and returns a ResultOfStringPassedToVerb
* initialized with the verb and rest parameters (the second and third parameters to
* the function, respectively).
*
*/
protected implicit val shorthandTestRegistrationFunction: StringVerbStringInvocation =
new StringVerbStringInvocation {
def apply(subject: String, verb: String, rest: String, pos: source.Position): ResultOfStringPassedToVerb = {
registerFlatBranch(subject, Resources.shouldCannotAppearInsideAnIn, pos)
new ResultOfStringPassedToVerb(verb, rest) {
def is(testFun: => PendingStatement): Unit = {
registerPendingTestToRun(this.verb.trim + " " + this.rest.trim, List(), "is", unusedFixtureParam => testFun, pos)
}
def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
val tagList = firstTestTag :: otherTestTags.toList
new ResultOfTaggedAsInvocation(this.verb, this.rest, tagList) {
// "A Stack" must "test this" taggedAs(mytags.SlowAsMolasses) is (pending)
// ^
def is(testFun: => PendingStatement): Unit = {
registerPendingTestToRun(this.verb.trim + " " + this.rest.trim, this.tags, "is", new NoArgTestWrapper(() => testFun), pos)
}
}
}
}
}
}
// TODO: Get rid of unusedfixture, and use NoArgTestFunction instead
/**
* Supports the shorthand form of shared test registration.
*
*
* For example, this method enables syntax such as the following:
*
*
*
* "A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
* ^
*
*
*
* This function is passed as an implicit parameter to a should method
* provided in ShouldVerb, a must method
* provided in MustVerb, and a can method
* provided in CanVerb. When invoked, this function registers the
* subject description (the parameter to the function) and returns a BehaveWord.
*
*/
protected implicit val shorthandSharedTestRegistrationFunction: StringVerbBehaveLikeInvocation =
new StringVerbBehaveLikeInvocation {
def apply(subject: String, pos: source.Position): BehaveWord = {
registerFlatBranch(subject, Resources.shouldCannotAppearInsideAnIn, pos)
new BehaveWord
}
}
/**
* Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.
* This method will register the test for later ignoring via an invocation of one of the execute
* methods. This method exists to make it easy to ignore an existing test by changing the call to it
* to ignore without deleting or commenting out the actual test code. The test will not be executed, but a
* report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for testNames for an example.) The resulting test name must not have been registered previously on
* this FixtureAsyncFlatSpec 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 after run has been invoked on this suite
* @throws NullArgumentException if specText or any passed test tag is null
*/
private def registerAsyncTestToIgnore(specText: String, testTags: List[Tag], testFun: FixtureParam => Future[compatible.Assertion], pos: source.Position): Unit = {
engine.registerIgnoredAsyncTest(specText, transformToOutcome(testFun), Resources.ignoreCannotAppearInsideAnInOrAnIs, None, pos, testTags: _*)
}
private def registerPendingTestToIgnore(specText: String, testTags: List[Tag], testFun: FixtureParam => PendingStatement, pos: source.Position): Unit = {
engine.registerIgnoredAsyncTest(specText, AsyncPendingTransformer(testFun), Resources.ignoreCannotAppearInsideAnInOrAnIs, None, pos, testTags: _*)
}
/**
* A Map whose keys are String tag names to which tests in this FixtureAsyncFlatSpec belong, and values
* the Set of test names that belong to each tag. If this FixtureAsyncFlatSpec contains no tags, this method returns an empty Map.
*
*
* This trait's implementation returns tags that were passed as strings contained in Tag objects passed to
* methods test and ignore.
*
*
*
* 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
* for testNames for an example.)
*
* @param testName the name of one test to execute.
* @param args the Args for this test
* @return a Status object that indicates when the test started by this method has completed, and whether or not it failed .
* @throws NullArgumentException if testName or args is null.
*/
protected override def runTest(testName: String, args: Args): Status = {
def invokeWithAsyncFixture(theTest: TestLeaf, onCompleteFun: Try[Outcome] => Unit): AsyncOutcome = {
val theConfigMap = args.configMap
val testData = testDataFor(testName, theConfigMap)
FutureAsyncOutcome(
withFixture(
new OneArgAsyncTest {
val name = testData.name
def apply(fixture: FixtureParam): FutureOutcome =
theTest.testFun(fixture).toFutureOutcome
val configMap = testData.configMap
val scopes = testData.scopes
val text = testData.text
val tags = testData.tags
val pos = testData.pos
}
).underlying,
onCompleteFun
)
}
runTestImpl(thisSuite, testName, args, true, parallelAsyncTestExecution, invokeWithAsyncFixture)
}
/**
*
* Run zero to many of this FixtureAsyncFlatSpec's tests.
*
*
*
* This method takes a testName parameter that optionally specifies a test to invoke.
* If testName is Some, this trait's implementation of this method
* invokes runTest on this object with passed args.
*
*
*
* This method takes an args that contains a Set of tag names that should be included (tagsToInclude), and a Set
* that should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute.
* If tagsToInclude is empty, all tests will be executed
* except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is non-empty, only tests
* belonging to tags mentioned in tagsToInclude, and not mentioned in tagsToExclude
* will be executed. However, if testName is Some, tagsToInclude and tagsToExclude are essentially ignored.
* Only if testName is None will tagsToInclude and tagsToExclude be consulted to
* determine which of the tests named in the testNames Set should be run. For more information on trait tags, see the main documentation for this trait.
*
*
*
* If testName is None, this trait's implementation of this method
* invokes testNames on this Suite to get a Set of names of tests to potentially execute.
* (A testNames value of None essentially acts as a wildcard that means all tests in
* this Suite that are selected by tagsToInclude and tagsToExclude should be executed.)
* For each test in the testName Set, in the order
* they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation
* of this method checks whether the test should be run based on the tagsToInclude and tagsToExclude Sets.
* If so, this implementation invokes runTest with the passed args.
*
*
* @param testName an optional name of one test to execute. If None, all relevant tests should be executed.
* I.e., None acts like a wildcard that means execute all relevant tests in this FixtureAsyncFlatSpecLike.
* @param args the Args for this run
* @return a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
* @throws NullArgumentException if any of testName or args is null.
*/
protected override def runTests(testName: Option[String], args: Args): Status = {
runTestsImpl(thisSuite, testName, args, true, parallelAsyncTestExecution, runTest)
}
/**
* An immutable Set of test names. If this FixtureAsyncFlatSpec contains no tests, this method returns an
* empty Set.
*
*
* This trait's implementation of this method will return a set that contains the names of all registered tests. The set's
* iterator will return those names in the order in which the tests were registered. Each test's name is composed
* of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the
* example itself, with all components separated by a space.
*
*
* @return the Set 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, parallelAsyncTestExecution, super.run)
}
/**
* Supports shared test registration in FixtureAsyncFlatSpecs.
*
*
* This field supports syntax such as the following:
*
*
*
* it should behave like nonFullStack(stackWithOneItem)
* ^
*
*
*
* For more information and examples of the use of behave, see the Shared tests section
* in the main documentation for trait AnyFlatSpec.
*
*/
protected val behave = new BehaveWord
/**
* The 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 styleName.
*/
@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.FlatSpec"
override def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData = createTestDataFor(testName, theConfigMap, this)
}