Trait

org.scalatest.funsuite

AsyncFunSuiteLike

Related Doc: package funsuite

Permalink

trait AsyncFunSuiteLike extends AsyncTestSuite with AsyncTestRegistration with Informing with Notifying with Alerting with Documenting

Implementation trait for class AsyncFunSuite, which represents a suite of tests in which each test is represented as a function value.

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

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

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

Type Members

  1. class CheckingEqualizer[L] extends AnyRef

    Permalink
    Definition Classes
    TripleEqualsSupport
  2. class Equalizer[L] extends AnyRef

    Permalink
    Definition Classes
    TripleEqualsSupport
  3. trait NoArgAsyncTest extends () ⇒ FutureOutcome with TestData

    Permalink
    Definition Classes
    AsyncTestSuite
  4. class ResultOfCompleteInvocation[T] extends AnyRef

    Permalink
    Definition Classes
    CompleteLastly

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  3. def !==(right: Null): TripleEqualsInvocation[Null]

    Permalink
    Definition Classes
    TripleEqualsSupport
  4. def !==[T](right: T): TripleEqualsInvocation[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  5. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  8. def ===(right: Null): TripleEqualsInvocation[Null]

    Permalink
    Definition Classes
    TripleEqualsSupport
  9. def ===[T](right: T): TripleEqualsInvocation[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  10. def alert: Alerter

    Permalink

    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 AsyncFunSuite 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
    AsyncFunSuiteLike → Alerting
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  13. macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  14. macro def assertCompiles(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  15. macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  16. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  17. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  18. def assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  19. macro def assertTypeError(code: String)(implicit pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  20. macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  21. macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Permalink
    Definition Classes
    Assertions
  22. def cancel(cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  23. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  24. def cancel(message: String)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  25. def cancel()(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  26. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def complete[T](completeBlock: ⇒ T)(implicit futuristic: Futuristic[T]): ResultOfCompleteInvocation[T]

    Permalink
    Definition Classes
    CompleteLastly
  28. implicit def convertAssertionToFutureAssertion(assertion: compatible.Assertion): Future[compatible.Assertion]

    Permalink
    Definition Classes
    AsyncTestSuite
  29. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  30. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  31. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  32. implicit def convertToEqualizer[T](left: T): Equalizer[T]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  33. def defaultEquality[A]: Equality[A]

    Permalink
    Definition Classes
    TripleEqualsSupport
  34. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  35. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  36. implicit def executionContext: ExecutionContext

    Permalink
    Definition Classes
    AsyncTestSuite
  37. def expectedTestCount(filter: Filter): Int

    Permalink
    Definition Classes
    Suite
  38. def fail(cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  39. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  40. def fail(message: String)(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  41. def fail()(implicit pos: Position): Nothing

    Permalink
    Definition Classes
    Assertions
  42. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  43. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  44. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  45. def ignore(testName: String, testTags: Tag*)(testFun: ⇒ Future[compatible.Assertion])(implicit pos: Position): Unit

    Permalink

    Register a test to ignore, which has the specified name, optional tags, and function value that takes no arguments.

    Register a test to ignore, which has the specified name, optional tags, and function value that takes no arguments. This method will register the test for later ignoring via an invocation of one of the run methods. This method exists to make it easy to ignore an existing test by changing the call to test to ignore without deleting or commenting out the actual test code. The test will not be run, but a report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on this AsyncFunSuite instance.

    testName

    the name of the test

    testTags

    the optional list of tags for this test

    testFun

    the test function

    Attributes
    protected
    Exceptions thrown

    DuplicateTestNameException if a test with the same name has been registered previously

    NotAllowedException if testName had been registered previously

    TestRegistrationClosedException if invoked after run has been invoked on this suite

  46. def info: Informer

    Permalink

    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
    AsyncFunSuiteLike → Informing
  47. def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): T

    Permalink
    Definition Classes
    Assertions
  48. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  49. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  50. def markup: Documenter

    Permalink

    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
    AsyncFunSuiteLike → Documenting
  51. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  52. def nestedSuites: IndexedSeq[Suite]

    Permalink
    Definition Classes
    Suite
  53. def note: Notifier

    Permalink

    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 AsyncFunSuite 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
    AsyncFunSuiteLike → Notifying
  54. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  55. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  56. def parallelAsyncTestExecution: Boolean

    Permalink
    Attributes
    protected[org.scalatest]
    Definition Classes
    AsyncTestSuite
  57. def pending: Assertion with PendingStatement

    Permalink
    Definition Classes
    Assertions
  58. def pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement

    Permalink
    Definition Classes
    Assertions
  59. def recoverToExceptionIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[T]

    Permalink
    Definition Classes
    RecoverMethods
  60. def recoverToSucceededIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[Assertion]

    Permalink
    Definition Classes
    RecoverMethods
  61. final def registerAsyncTest(testText: String, testTags: Tag*)(testFun: ⇒ Future[compatible.Assertion])(implicit pos: Position): Unit

    Permalink
    Definition Classes
    AsyncFunSuiteLike → AsyncTestRegistration
  62. final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: ⇒ Future[compatible.Assertion])(implicit pos: Position): Unit

    Permalink
    Definition Classes
    AsyncFunSuiteLike → AsyncTestRegistration
  63. def rerunner: Option[String]

    Permalink
    Definition Classes
    Suite
  64. def run(testName: Option[String], args: Args): Status

    Permalink
    Definition Classes
    AsyncFunSuiteLike → Suite
  65. def runNestedSuites(args: Args): Status

    Permalink
    Attributes
    protected
    Definition Classes
    Suite
  66. def runTest(testName: String, args: Args): Status

    Permalink

    Run a test.

    Run a test. This trait's implementation runs the test registered with the name specified by testName.

    testName

    the name of one test to run.

    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
    AsyncFunSuiteLike → AsyncTestSuite → Suite
    Exceptions thrown

    IllegalArgumentException if testName is defined but a test with that name does not exist on this AsyncFunSuite

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

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

    Permalink

    Run zero to many of this AsyncFunSuite's tests.

    Run zero to many of this AsyncFunSuite's tests.

    testName

    an optional name of one test to run. If None, all relevant tests should be run. I.e., None acts like a wildcard that means run all relevant tests in this Suite.

    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
    AsyncFunSuiteLike → Suite
    Exceptions thrown

    IllegalArgumentException if testName is defined, but no test with the specified test name exists in this Suite

    NullArgumentException if any of the passed parameters is null.

  68. final val succeed: Assertion

    Permalink
    Definition Classes
    Assertions
  69. def suiteId: String

    Permalink
    Definition Classes
    Suite
  70. def suiteName: String

    Permalink
    Definition Classes
    Suite
  71. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  72. def tags: Map[String, Set[String]]

    Permalink

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

    Definition Classes
    AsyncFunSuiteLike → Suite
  73. def test(testName: String, testTags: Tag*)(testFun: ⇒ Future[compatible.Assertion])(implicit pos: Position): Unit

    Permalink

    Register a test with the specified name, optional tags, and function value that takes no arguments.

    Register a test with the specified name, optional tags, and function value that takes no arguments. This method will register the test for later execution via an invocation of one of the run methods. The passed test name must not have been registered previously on this AsyncFunSuite instance.

    testName

    the name of the test

    testTags

    the optional list of tags for this test

    testFun

    the test function

    Attributes
    protected
    Exceptions thrown

    DuplicateTestNameException if a test with the same name has been registered previously

    NotAllowedException if testName had been registered previously

    NullArgumentException if testName or any passed test tag is null

    TestRegistrationClosedException if invoked after run has been invoked on this suite

  74. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData

    Permalink
    Definition Classes
    AsyncFunSuiteLike → Suite
  75. def testNames: Set[String]

    Permalink

    An immutable Set of test names.

    An immutable Set of test names. If this AsyncFunSuite 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.

    Definition Classes
    AsyncFunSuiteLike → Suite
  76. def testsFor(unit: Unit): Unit

    Permalink

    Registers shared tests.

    Registers shared tests.

    This method enables the following syntax for shared tests in a AsyncFunSuite:

    testsFor(nonEmptyStack(lastValuePushed))
    

    This method just provides syntax sugar intended to make the intent of the code clearer. Because the parameter passed to it is type Unit, the expression will be evaluated before being passed, which is sufficient to register the shared tests. For examples of shared tests, see the Shared tests section in the main documentation for this trait.

    Attributes
    protected
  77. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  78. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  79. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  80. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. def withClue[T](clue: Any)(fun: ⇒ T): T

    Permalink
    Definition Classes
    Assertions
  84. def withFixture(test: NoArgAsyncTest): FutureOutcome

    Permalink
    Definition Classes
    AsyncTestSuite

Deprecated Value Members

  1. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]

    Permalink
    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]

    Permalink
    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]

    Permalink
    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]

    Permalink
    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

    Permalink

    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
    AsyncFunSuiteLike → 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 AsyncTestRegistration

Inherited from AsyncTestSuite

Inherited from CompleteLastly

Inherited from RecoverMethods

Inherited from Suite

Inherited from Serializable

Inherited from Serializable

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped