Packages

t

org.scalatest.flatspec

AsyncFlatSpecLike

trait AsyncFlatSpecLike extends AsyncTestSuite with AsyncTestRegistration with ShouldVerb with MustVerb with CanVerb with Informing with Notifying with Alerting with Documenting

Implementation trait for class AsyncFlatSpec, which facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.

AsyncFlatSpec 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 AsyncFlatSpec into some other class, you can use this trait instead, because class AsyncFlatSpec does nothing more than extend this trait and add a nice toString implementation.

See the documentation of the class for a detailed overview of AsyncFlatSpec.

Self Type
AsyncFlatSpecLike
Annotations
@Finders()
Source
AsyncFlatSpecLike.scala
Linear Supertypes
Documenting, Alerting, Notifying, Informing, CanVerb, MustVerb, ShouldVerb, AsyncTestRegistration, AsyncTestSuite, CompleteLastly, RecoverMethods, Suite, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Known Subclasses
AsyncFlatSpec
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncFlatSpecLike
  2. Documenting
  3. Alerting
  4. Notifying
  5. Informing
  6. CanVerb
  7. MustVerb
  8. ShouldVerb
  9. AsyncTestRegistration
  10. AsyncTestSuite
  11. CompleteLastly
  12. RecoverMethods
  13. Suite
  14. Serializable
  15. Assertions
  16. TripleEquals
  17. TripleEqualsSupport
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class BehaviorWord extends AnyRef

    Class that supports the registration of a “subject” being specified and tested via the instance referenced from AsyncFlatSpec's behavior field.

    Class that supports the registration of a “subject” being specified and tested via the instance referenced from AsyncFlatSpec'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 AsyncFlatSpec.

    Attributes
    protected
  2. class CheckingEqualizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  3. class Equalizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  4. final class IgnoreVerbString extends AnyRef

    Class that supports registration of ignored tests via the IgnoreWord instance referenced from AsyncFlatSpec's ignore field.

    Class that supports registration of ignored tests via the IgnoreWord instance referenced from AsyncFlatSpec'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 AsyncFlatSpec.

    Attributes
    protected
  5. final class IgnoreVerbStringTaggedAs extends AnyRef

    Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced from AsyncFlatSpec's ignore field.

    Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced from AsyncFlatSpec'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 AsyncFlatSpec. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AsyncFlatSpec.

    Attributes
    protected
  6. final class IgnoreWord extends AnyRef

    Class that supports registration of ignored tests via the ItWord instance referenced from AsyncFlatSpec's ignore field.

    Class that supports registration of ignored tests via the ItWord instance referenced from AsyncFlatSpec'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.

    Attributes
    protected
  7. final class InAndIgnoreMethods extends AnyRef

    Class that supports test registration in shorthand form.

    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 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 Fixture 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 ResultOfStringPassedToVerb to a type that provides the appropriate in methods.

    Attributes
    protected
  8. final class InAndIgnoreMethodsAfterTaggedAs extends AnyRef

    Class that supports tagged test registration in shorthand form.

    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 Fixture 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.

    Attributes
    protected
  9. final class ItVerbString extends AnyRef

    Class that supports test registration via the ItWord instance referenced from AsyncFlatSpec's it field.

    Class that supports test registration via the ItWord instance referenced from AsyncFlatSpec'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 AsyncFlatSpec.

    Attributes
    protected
  10. final class ItVerbStringTaggedAs extends AnyRef

    Class that supports the registration of tagged tests via the ItWord instance referenced from AsyncFlatSpec's it field.

    Class that supports the registration of tagged tests via the ItWord instance referenced from AsyncFlatSpec'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 AsyncFlatSpec. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AsyncFlatSpec.

    Attributes
    protected
  11. final class ItWord extends AnyRef

    Class that supports test (and shared test) registration via the instance referenced from AsyncFlatSpec's it field.

    Class that supports test (and shared test) registration via the instance referenced from AsyncFlatSpec'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 this trait.

    Attributes
    protected
  12. trait NoArgAsyncTest extends () => FutureOutcome with TestData
    Definition Classes
    AsyncTestSuite
  13. class ResultOfCompleteInvocation[T] extends AnyRef
    Definition Classes
    CompleteLastly
  14. trait StringCanWrapperForVerb extends AnyRef
    Definition Classes
    CanVerb
  15. trait StringMustWrapperForVerb extends AnyRef
    Definition Classes
    MustVerb
  16. trait StringShouldWrapperForVerb extends AnyRef
    Definition Classes
    ShouldVerb
  17. final class TheyVerbString extends AnyRef

    Class that supports test registration via the TheyWord instance referenced from AsyncFlatSpec's they field.

    Class that supports test registration via the TheyWord instance referenced from AsyncFlatSpec'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 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 AsyncFlatSpec.

    Attributes
    protected
  18. final class TheyVerbStringTaggedAs extends AnyRef

    Class that supports the registration of tagged tests via the TheyWord instance referenced from AsyncFlatSpec's they field.

    Class that supports the registration of tagged tests via the TheyWord instance referenced from AsyncFlatSpec'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 they field to register tagged tests, see the Tagging tests section in the main documentation for trait AsyncFlatSpec. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AsyncFlatSpec.

    Attributes
    protected
  19. final class TheyWord extends AnyRef

    Class that supports test (and shared test) registration via the instance referenced from AsyncFlatSpec's it field.

    Class that supports test (and shared test) registration via the instance referenced from AsyncFlatSpec'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 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 this trait.

    Attributes
    protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
    Definition Classes
    TripleEqualsSupport
  3. def !==(right: Null): TripleEqualsInvocation[Null]
    Definition Classes
    TripleEqualsSupport
  4. def !==[T](right: T): TripleEqualsInvocation[T]
    Definition Classes
    TripleEqualsSupport
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
    Definition Classes
    TripleEqualsSupport
  8. def ===(right: Null): TripleEqualsInvocation[Null]
    Definition Classes
    TripleEqualsSupport
  9. def ===[T](right: T): TripleEqualsInvocation[T]
    Definition Classes
    TripleEqualsSupport
  10. def alert: Alerter

    Returns an Alerter that during test execution will forward strings passed to its apply method to the current reporter.

    Returns an Alerter that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this AsyncFlatSpec 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.

    Attributes
    protected
    Definition Classes
    AsyncFlatSpecLike → Alerting
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  13. macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  14. macro def assertCompiles(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  15. macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  16. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  17. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  18. def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
    Definition Classes
    Assertions
  19. macro def assertTypeError(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  20. macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  21. macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  22. val behave: BehaveWord

    Supports shared test registration in AsyncFlatSpecs.

    Supports shared test registration in AsyncFlatSpecs.

    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 this trait.

    Attributes
    protected
  23. val behavior: BehaviorWord

    Supports the registration of a “subject” being specified and tested.

    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 this trait.

    Attributes
    protected
  24. def cancel(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  25. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  26. def cancel(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  27. def cancel()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  28. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  29. def complete[T](completeBlock: => T)(implicit futuristic: Futuristic[T]): ResultOfCompleteInvocation[T]
    Definition Classes
    CompleteLastly
  30. implicit def convertAssertionToFutureAssertion(assertion: compatible.Assertion): Future[compatible.Assertion]
    Definition Classes
    AsyncTestSuite
  31. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  32. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  33. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  34. implicit def convertToEqualizer[T](left: T): Equalizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  35. implicit def convertToInAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb): InAndIgnoreMethods

    Implicitly converts an object of type ResultOfStringPassedToVerb to an InAndIgnoreMethods, to enable in and ignore methods to be invokable on that object.

    Implicitly converts an object of type ResultOfStringPassedToVerb to an InAndIgnoreMethods, to enable in and ignore methods to be invokable on that object.

    Attributes
    protected
  36. implicit def convertToInAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation): InAndIgnoreMethodsAfterTaggedAs

    Implicitly converts an object of type ResultOfTaggedAsInvocation to an InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore methods to be invokable on that object.

    Implicitly converts an object of type ResultOfTaggedAsInvocation to an InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore methods to be invokable on that object.

    Attributes
    protected
  37. implicit def convertToStringCanWrapper(o: String)(implicit position: Position): StringCanWrapperForVerb
    Definition Classes
    CanVerb
  38. implicit def convertToStringMustWrapperForVerb(o: String)(implicit position: Position): StringMustWrapperForVerb
    Definition Classes
    MustVerb
  39. implicit def convertToStringShouldWrapperForVerb(o: String)(implicit position: Position): StringShouldWrapperForVerb
    Definition Classes
    ShouldVerb
  40. def defaultEquality[A]: Equality[A]
    Definition Classes
    TripleEqualsSupport
  41. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  43. final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit
    Definition Classes
    Suite
  44. implicit def executionContext: ExecutionContext
    Definition Classes
    AsyncTestSuite
  45. def expectedTestCount(filter: Filter): Int
    Definition Classes
    Suite
  46. def fail(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  47. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  48. def fail(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  49. def fail()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  50. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  51. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  52. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  53. val ignore: IgnoreWord

    Supports registration of ignored tests in AsyncFlatSpecs.

    Supports registration of ignored tests in AsyncFlatSpecs.

    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 this trait.

    Attributes
    protected
  54. def info: Informer

    Returns an Informer that during test execution will forward strings passed to its apply method to the current reporter.

    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.

    Attributes
    protected
    Definition Classes
    AsyncFlatSpecLike → Informing
  55. def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): T
    Definition Classes
    Assertions
  56. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  57. val it: ItWord

    Supports test (and shared test) registration in AsyncFlatSpecs.

    Supports test (and shared test) registration in AsyncFlatSpecs.

    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 this trait.

    Attributes
    protected
  58. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  59. def markup: Documenter

    Returns a Documenter that during test execution will forward strings passed to its apply method to the current reporter.

    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.

    Attributes
    protected
    Definition Classes
    AsyncFlatSpecLike → Documenting
  60. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    Suite
  62. def note: Notifier

    Returns a Notifier that during test execution will forward strings passed to its apply method to the current reporter.

    Returns a Notifier that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this AsyncFlatSpec 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.

    Attributes
    protected
    Definition Classes
    AsyncFlatSpecLike → Notifying
  63. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  65. def parallelAsyncTestExecution: Boolean
    Attributes
    protected[scalatest]
    Definition Classes
    AsyncTestSuite
  66. def pending: Assertion with PendingStatement
    Definition Classes
    Assertions
  67. def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
    Definition Classes
    Assertions
  68. def recoverToExceptionIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[T]
    Definition Classes
    RecoverMethods
  69. def recoverToSucceededIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[compatible.Assertion]
    Definition Classes
    RecoverMethods
  70. final def registerAsyncTest(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: Position): Unit
    Definition Classes
    AsyncFlatSpecLike → AsyncTestRegistration
  71. final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: Position): Unit
    Definition Classes
    AsyncFlatSpecLike → AsyncTestRegistration
  72. def rerunner: Option[String]
    Definition Classes
    Suite
  73. def run(testName: Option[String], args: Args): Status
    Definition Classes
    AsyncFlatSpecLike → Suite
  74. def runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    Suite
  75. def runTest(testName: String, args: Args): Status

    Run a test.

    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.)

    testName

    the name of one test to execute.

    args

    the Args for this run

    returns

    a Status object that indicates when the test started by this method has completed, and whether or not it failed .

    Attributes
    protected
    Definition Classes
    AsyncFlatSpecLike → AsyncTestSuite → Suite
    Exceptions thrown

    NullArgumentException if any of testName, reporter, stopper, or configMap is null.

  76. def runTests(testName: Option[String], args: Args): Status

    Run zero to many of this AsyncFlatSpec's tests.

    Run zero to many of this AsyncFlatSpec'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, passing in:

    • testName - the String value of the testName Option passed to this method
    • reporter - the Reporter passed to this method, or one that wraps and delegates to it
    • stopper - the Stopper passed to this method, or one that wraps and delegates to it
    • configMap - the configMap passed to this method, or one that wraps and delegates to it

    This method takes a Set of tag names that should be included (tagsToInclude), and a Set that should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute. If tagsToInclude is empty, all tests will be executed except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is non-empty, only tests belonging to tags mentioned in tagsToInclude, and not mentioned in tagsToExclude will be executed. However, if testName is Some, tagsToInclude and tagsToExclude are essentially ignored. Only if testName is None will tagsToInclude and tagsToExclude be consulted to determine which of the tests named in the testNames Set should be run. For more information on trait tags, see the main documentation for this trait.

    If testName is None, this trait's implementation of this method invokes testNames on this Suite to get a Set of names of tests to potentially execute. (A testNames value of None essentially acts as a wildcard that means all tests in this Suite that are selected by tagsToInclude and tagsToExclude should be executed.) For each test in the testName Set, in the order they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation of this method checks whether the test should be run based on the tagsToInclude and tagsToExclude Sets. If so, this implementation invokes runTest, passing in:

    • testName - the String name of the test to run (which will be one of the names in the testNames Set)
    • reporter - the Reporter passed to this method, or one that wraps and delegates to it
    • stopper - the Stopper passed to this method, or one that wraps and delegates to it
    • configMap - the configMap passed to this method, or one that wraps and delegates to it
    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 AsyncFlatSpec.

    args

    the Args for this run

    returns

    a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.

    Attributes
    protected
    Definition Classes
    AsyncFlatSpecLike → Suite
    Exceptions thrown

    NullArgumentException if any of testName, reporter, stopper, tagsToInclude, tagsToExclude, or configMap is null.

  77. implicit val shorthandSharedTestRegistrationFunction: StringVerbBehaveLikeInvocation

    Supports the shorthand form of shared test registration.

    Supports the shorthand form of shared test registration.

    For example, this method enables syntax such as the following in:

    "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.

    Attributes
    protected
  78. implicit val shorthandTestRegistrationFunction: StringVerbStringInvocation

    Supports the shorthand form of test registration.

    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).

    Attributes
    protected
  79. final val succeed: Assertion
    Definition Classes
    Assertions
  80. def suiteId: String
    Definition Classes
    Suite
  81. def suiteName: String
    Definition Classes
    Suite
  82. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  83. def tags: Map[String, Set[String]]

    A Map whose keys are String names of tagged tests and whose associated values are the Set of tags for the test.

    A Map whose keys are String names of tagged tests and whose associated values are the Set of tags for the test. If this AsyncFlatSpec 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 taggedAs.

    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 org.scalatest.Ignore.

    Definition Classes
    AsyncFlatSpecLike → Suite
  84. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
    Definition Classes
    AsyncFlatSpecLike → Suite
  85. def testNames: Set[String]

    An immutable Set of test names.

    An immutable Set of test names. If this AsyncFlatSpec 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. For example, consider this AsyncFlatSpec:

    import org.scalatest.flatspec.AsyncFlatSpec

class StackSpec extends AsyncFlatSpec {

  "A Stack (when not empty)" must "allow me to pop" in {}
  it must "not be empty" in {}

  "A Stack (when not full)" must "allow me to push" in {}
  it must "not be full" in {}
}

    Invoking testNames on this AsyncFlatSpec will yield a set that contains the following two test name strings:

    "A Stack (when not empty) must allow me to pop"
"A Stack (when not empty) must not be empty"
"A Stack (when not full) must allow me to push"
"A Stack (when not full) must not be full"

    Definition Classes
    AsyncFlatSpecLike → Suite
  86. val they: TheyWord

    Supports test (and shared test) registration in AsyncFlatSpecs.

    Supports test (and shared test) registration in AsyncFlatSpecs.

    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 this trait.

    Attributes
    protected
  87. def toString(): String
    Definition Classes
    AnyRef → Any
  88. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  89. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  90. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  91. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  92. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  93. def withClue[T](clue: Any)(fun: => T): T
    Definition Classes
    Assertions
  94. def withFixture(test: NoArgAsyncTest): FutureOutcome
    Definition Classes
    AsyncTestSuite

Deprecated Value Members

  1. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) => A): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  2. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) => B): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  3. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) => A): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  4. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) => B): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  5. final val styleName: String

    The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.

    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.

    Definition Classes
    AsyncFlatSpecLike → Suite
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.

Inherited from Documenting

Inherited from Alerting

Inherited from Notifying

Inherited from Informing

Inherited from CanVerb

Inherited from MustVerb

Inherited from ShouldVerb

Inherited from AsyncTestRegistration

Inherited from AsyncTestSuite

Inherited from CompleteLastly

Inherited from RecoverMethods

Inherited from Suite

Inherited from Serializable

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped