Class

org.scalatest

AsyncFunSpec

Related Doc: package scalatest

Permalink

abstract class AsyncFunSpec extends AsyncFunSpecLike

Linear Supertypes
AsyncFunSpecLike, AsyncTestRegistration, AsyncSuite, Suite, Serializable, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AsyncFunSpec
  2. AsyncFunSpecLike
  3. AsyncTestRegistration
  4. AsyncSuite
  5. Suite
  6. Serializable
  7. Serializable
  8. Assertions
  9. TripleEquals
  10. TripleEqualsSupport
  11. AnyRef
  12. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AsyncFunSpec()

    Permalink

Type Members

  1. class AssertionsHelper extends AnyRef

    Permalink
    Definition Classes
    Assertions
  2. class CheckingEqualizer[L] extends AnyRef

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

    Permalink
    Definition Classes
    TripleEqualsSupport
  4. class ItWord extends AnyRef

    Permalink

    Class that, via an instance referenced from the it field, supports test (and shared test) registration in FunSpecs.

    Class that, via an instance referenced from the it field, supports test (and shared test) registration in FunSpecs.

    This class supports syntax such as the following test registration:

    it("should be empty")
    ^
    

    and the following shared test registration:

    it should behave like nonFullStack(stackWithOneItem)
    ^
    

    For more information and examples, see the main documentation for FunSpec.

    Attributes
    protected
    Definition Classes
    AsyncFunSpecLike
  5. trait NoArgAsyncTest extends () ⇒ Future[Outcome] with TestData

    Permalink
    Definition Classes
    AsyncSuite
  6. trait NoArgTest extends () ⇒ Outcome with TestData

    Permalink
    Attributes
    protected
    Definition Classes
    Suite
  7. class TheyWord extends AnyRef

    Permalink

    Class that, via an instance referenced from the they field, supports test (and shared test) registration in FunSpecs.

    Class that, via an instance referenced from the they field, supports test (and shared test) registration in FunSpecs.

    This class supports syntax such as the following test registration:

    they("should be empty")
    ^
    

    and the following shared test registration:

    they should behave like nonFullStack(stackWithOneItem)
    ^
    

    For more information and examples, see the main documentation for FunSpec.

    Attributes
    protected
    Definition Classes
    AsyncFunSpecLike

Abstract Value Members

  1. implicit abstract def executionContext: ExecutionContext

    Permalink
    Definition Classes
    AsyncSuite

Concrete 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. macro def assert(condition: Boolean, clue: Any): Assertion

    Permalink
    Definition Classes
    Assertions
  12. macro def assert(condition: Boolean): Assertion

    Permalink
    Definition Classes
    Assertions
  13. macro def assertCompiles(code: String): Assertion

    Permalink
    Definition Classes
    Assertions
  14. macro def assertDoesNotCompile(code: String): Assertion

    Permalink
    Definition Classes
    Assertions
  15. def assertResult(expected: Any)(actual: Any): Assertion

    Permalink
    Definition Classes
    Assertions
  16. def assertResult(expected: Any, clue: Any)(actual: Any): Assertion

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

    Permalink
    Definition Classes
    Assertions
  18. macro def assertTypeError(code: String): Assertion

    Permalink
    Definition Classes
    Assertions
  19. val assertionsHelper: AssertionsHelper

    Permalink
    Definition Classes
    Assertions
  20. macro def assume(condition: Boolean, clue: Any): Assertion

    Permalink
    Definition Classes
    Assertions
  21. macro def assume(condition: Boolean): Assertion

    Permalink
    Definition Classes
    Assertions
  22. val behave: BehaveWord

    Permalink

    Supports shared test registration in FunSpecs.

    Supports shared test registration in FunSpecs.

    This field supports syntax such as the following:

    it should behave like nonFullStack(stackWithOneItem)
              ^
    

    For more information and examples of the use of <cod>behave, see the Shared tests section in the main documentation for this trait.

    Attributes
    protected
    Definition Classes
    AsyncFunSpecLike
  23. def cancel(cause: Throwable): Nothing

    Permalink
    Definition Classes
    Assertions
  24. def cancel(message: String, cause: Throwable): Nothing

    Permalink
    Definition Classes
    Assertions
  25. def cancel(message: String): Nothing

    Permalink
    Definition Classes
    Assertions
  26. def cancel(): Nothing

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  29. implicit def convertAssertionToFutureAssertion(assertion: Assertion): Future[Assertion]

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

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  31. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): CanEqual[A, B]

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

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  33. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): CanEqual[A, B]

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

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

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

    Permalink
    Definition Classes
    TripleEqualsSupport
  37. def describe(description: String)(fun: ⇒ Unit): Unit

    Permalink

    Describe a “subject” being specified and tested by the passed function value.

    Describe a “subject” being specified and tested by the passed function value. The passed function value may contain more describers (defined with describe) and/or tests (defined with it). This trait's implementation of this method will register the description string and immediately invoke the passed function.

    Attributes
    protected
    Definition Classes
    AsyncFunSpecLike
  38. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  40. def expectedTestCount(filter: Filter): Int

    Permalink
    Definition Classes
    Suite
  41. def fail(cause: Throwable): Nothing

    Permalink
    Definition Classes
    Assertions
  42. def fail(message: String, cause: Throwable): Nothing

    Permalink
    Definition Classes
    Assertions
  43. def fail(message: String): Nothing

    Permalink
    Definition Classes
    Assertions
  44. def fail(): Nothing

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  48. def ignore(testText: String, testTags: Tag*)(testFun: ⇒ Future[Assertion]): Unit

    Permalink

    Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.

    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 FunSpec instance.

    testText

    the specification text, which will be combined with the descText of any surrounding describers to form the test name

    testTags

    the optional list of tags for this test

    testFun

    the test function

    Attributes
    protected
    Definition Classes
    AsyncFunSpecLike
    Exceptions thrown

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

    NullArgumentException if specText or any passed test tag is null

    TestRegistrationClosedException if invoked after run has been invoked on this suite

  49. def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T]): T

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

    Permalink
    Definition Classes
    Any
  51. val it: ItWord

    Permalink

    Supports test (and shared test) registration in FunSpecs.

    Supports test (and shared test) registration in FunSpecs.

    This field supports syntax such as the following:

    it("should be empty")
    ^
    

     class="stExamples"
    it should behave like nonFullStack(stackWithOneItem)
    ^
    

    For more information and examples of the use of the it field, see the main documentation for this trait.

    Attributes
    protected
    Definition Classes
    AsyncFunSpecLike
  52. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  53. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  54. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    Suite
  56. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  58. def parallelAsyncTestExecution: Boolean

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

    Permalink
    Definition Classes
    Assertions
  60. def pendingUntilFixed(f: ⇒ Unit): Assertion with PendingStatement

    Permalink
    Definition Classes
    Assertions
  61. final def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: ⇒ Future[Assertion]): Unit

    Permalink
    Definition Classes
    AsyncFunSpecLike → AsyncTestRegistration
  62. final def registerTest(testText: String, testTags: Tag*)(testFun: ⇒ Future[Assertion]): Unit

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

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

    Permalink
    Definition Classes
    AsyncFunSpecLike → 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. 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
    AsyncFunSpecLike → Suite
    Exceptions thrown

    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 FunSpec's tests.

    Run zero to many of this FunSpec'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
    AsyncFunSpecLike → 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 styleName: String

    Permalink

    Suite style name.

    Suite style name.

    Definition Classes
    AsyncFunSpecLike → Suite
  69. final val succeed: Succeeded.type

    Permalink
    Definition Classes
    Assertions
  70. def suiteId: String

    Permalink
    Definition Classes
    Suite
  71. def suiteName: String

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

    Permalink
    Definition Classes
    AnyRef
  73. 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 FunSpec 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 it 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
    AsyncFunSpecLike → Suite
  74. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData

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

    Permalink

    An immutable Set of test names.

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

    import org.scalatest.FunSpec
    
    class StackSpec extends FunSpec {
      describe("A Stack") {
        describe("(when not empty)") {
          it("must allow me to pop") {}
        }
        describe("(when not full)") {
          it("must allow me to push") {}
        }
      }
    }
    

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

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

    Definition Classes
    AsyncFunSpecLike → Suite
  76. val they: TheyWord

    Permalink

    Supports test (and shared test) registration in FunSpecs.

    Supports test (and shared test) registration in FunSpecs.

    This field supports syntax such as the following:

    they("should be empty")
    ^
    

     class="stExamples"
    it should behave like nonFullStack(stackWithOneItem)
    ^
    

    For more information and examples of the use of the it field, see the main documentation for this trait.

    Attributes
    protected
    Definition Classes
    AsyncFunSpecLike
  77. def toString(): String

    Permalink

    Returns a user friendly string for this suite, composed of the simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite contains nested suites, the result of invoking toString on each of the nested suites, separated by commas and surrounded by parentheses.

    Returns a user friendly string for this suite, composed of the simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite contains nested suites, the result of invoking toString on each of the nested suites, separated by commas and surrounded by parentheses.

    returns

    a user-friendly string for this suite

    Definition Classes
    AsyncFunSpec → AnyRef → Any
  78. def trap[T](f: ⇒ T): Throwable

    Permalink
    Definition Classes
    Assertions
  79. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. def withAsyncFixture(test: NoArgAsyncTest): Future[Outcome]

    Permalink
    Definition Classes
    AsyncSuite
  85. def withClue[T](clue: Any)(fun: ⇒ T): T

    Permalink
    Definition Classes
    Assertions
  86. final def withFixture(test: NoArgTest): Outcome

    Permalink
    Definition Classes
    AsyncSuite → Suite

Inherited from AsyncFunSpecLike

Inherited from AsyncTestRegistration

Inherited from AsyncSuite

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