trait AsyncFunSpecLike extends AsyncTestSuite with AsyncTestRegistration with Informing with Notifying with Alerting with Documenting
Implementation trait for class AsyncFunSpec
, which
facilitates a “behavior-driven” style of development (BDD),
in which tests are combined with text that specifies the behavior the tests
verify.
AsyncFunSpec
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 AsyncFunSpec
into some other class, you can use this
trait instead, because class AsyncFunSpec
does nothing more than
extend this trait and add a nice toString
implementation.
See the documentation of the class for a detailed
overview of AsyncFunSpec
.
- Self Type
- AsyncFunSpecLike
- Annotations
- @EnableReflectiveInstantiation() @Finders()
- Alphabetic
- By Inheritance
- AsyncFunSpecLike
- Documenting
- Alerting
- Notifying
- Informing
- AsyncTestRegistration
- AsyncTestSuite
- CompleteLastly
- RecoverMethods
- Suite
- Serializable
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- class CheckingEqualizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- class Equalizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- class ItWord extends AnyRef
Class that, via an instance referenced from the
it
field, supports test (and shared test) registration inAsyncFunSpec
s.Class that, via an instance referenced from the
it
field, supports test (and shared test) registration inAsyncFunSpec
s.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
AsyncFunSpec
.- Attributes
- protected
- trait NoArgAsyncTest extends () => FutureOutcome with TestData
- Definition Classes
- AsyncTestSuite
- class ResultOfCompleteInvocation[T] extends AnyRef
- Definition Classes
- CompleteLastly
- class TheyWord extends AnyRef
Class that, via an instance referenced from the
they
field, supports test (and shared test) registration inAsyncFunSpec
s.Class that, via an instance referenced from the
they
field, supports test (and shared test) registration inAsyncFunSpec
s.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
AsyncFunSpec
.- Attributes
- protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
- def !==(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
- def !==[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
- def ===(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
- def ===[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
- def alert: Alerter
Returns an
Alerter
that during test execution will forward strings passed to itsapply
method to the current reporter.Returns an
Alerter
that during test execution will forward strings passed to itsapply
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 thisFreeSpec
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
- AsyncFunSpecLike → Alerting
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertCompiles(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertTypeError(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- val behave: BehaveWord
Supports shared test registration in
AsyncFunSpec
s.Supports shared test registration in
AsyncFunSpec
s.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
- def cancel(cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel(message: String)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel()(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def complete[T](completeBlock: => T)(implicit futuristic: Futuristic[T]): ResultOfCompleteInvocation[T]
- Definition Classes
- CompleteLastly
- implicit def convertAssertionToFutureAssertion(assertion: compatible.Assertion): Future[compatible.Assertion]
- Definition Classes
- AsyncTestSuite
- def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- implicit def convertToEqualizer[T](left: T): Equalizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def defaultEquality[A]: Equality[A]
- Definition Classes
- TripleEqualsSupport
- def describe(description: String)(fun: => Unit)(implicit pos: Position): Unit
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 withit
). This trait's implementation of this method will register the description string and immediately invoke the passed function.- Attributes
- protected
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def executionContext: ExecutionContext
- Definition Classes
- AsyncTestSuite
- def expectedTestCount(filter: Filter): Int
- Definition Classes
- Suite
- def fail(cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail(message: String)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail()(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def ignore(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: Position): Unit
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 toit
toignore
without deleting or commenting out the actual test code. The test will not be executed, but a report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers, from outside in, and the passed spec text, with one space placed between each item. (See the documenation fortestNames
for an example.) The resulting test name must not have been registered previously on thisAsyncFunSpec
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
- Exceptions thrown
DuplicateTestNameException
if a test with the same name has been registered previouslyNullArgumentException
ifspecText
or any passed test tag isnull
TestRegistrationClosedException
if invoked afterrun
has been invoked on this suite
- def info: Informer
Returns an
Informer
that during test execution will forward strings passed to itsapply
method to the current reporter.Returns an
Informer
that during test execution will forward strings passed to itsapply
method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, asrecordedEvents
of the test completed event, such asTestSucceeded
. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.- Attributes
- protected
- Definition Classes
- AsyncFunSpecLike → Informing
- def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): T
- Definition Classes
- Assertions
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val it: ItWord
Supports test (and shared test) registration in
AsyncFunSpec
s.Supports test (and shared test) registration in
AsyncFunSpec
s.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
- def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def markup: Documenter
Returns a
Documenter
that during test execution will forward strings passed to itsapply
method to the current reporter.Returns a
Documenter
that during test execution will forward strings passed to itsapply
method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, asrecordedEvents
of the test completed event, such asTestSucceeded
. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.- Attributes
- protected
- Definition Classes
- AsyncFunSpecLike → Documenting
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nestedSuites: IndexedSeq[Suite]
- Definition Classes
- Suite
- def note: Notifier
Returns a
Notifier
that during test execution will forward strings passed to itsapply
method to the current reporter.Returns a
Notifier
that during test execution will forward strings passed to itsapply
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 thisFreeSpec
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
- AsyncFunSpecLike → Notifying
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parallelAsyncTestExecution: Boolean
- Attributes
- protected[scalatest]
- Definition Classes
- AsyncTestSuite
- def pending: Assertion with PendingStatement
- Definition Classes
- Assertions
- def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
- Definition Classes
- Assertions
- def recoverToExceptionIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[T]
- Definition Classes
- RecoverMethods
- def recoverToSucceededIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[compatible.Assertion]
- Definition Classes
- RecoverMethods
- final def registerAsyncTest(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: Position): Unit
- Definition Classes
- AsyncFunSpecLike → AsyncTestRegistration
- final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: Position): Unit
- Definition Classes
- AsyncFunSpecLike → AsyncTestRegistration
- def rerunner: Option[String]
- Definition Classes
- Suite
- def run(testName: Option[String], args: Args): Status
- Definition Classes
- AsyncFunSpecLike → Suite
- def runNestedSuites(args: Args): Status
- Attributes
- protected
- Definition Classes
- Suite
- 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 fortestNames
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 → AsyncTestSuite → Suite
- Exceptions thrown
NullArgumentException
if any oftestName
,reporter
,stopper
, orconfigMap
isnull
.
- def runTests(testName: Option[String], args: Args): Status
Run zero to many of this
AsyncFunSpec
's tests.Run zero to many of this
AsyncFunSpec
'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 thisSuite
.- 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
iftestName
is defined, but no test with the specified test name exists in thisSuite
NullArgumentException
if any of the passed parameters isnull
.
- final val succeed: Assertion
- Definition Classes
- Assertions
- def suiteId: String
- Definition Classes
- Suite
- def suiteName: String
- Definition Classes
- Suite
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tags: Map[String, Set[String]]
A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tags for the test.A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tags for the test. If thisAsyncFunSpec
contains no tags, this method returns an emptyMap
.This trait's implementation returns tags that were passed as strings contained in
Tag
objects passed to methodsit
andignore
.In addition, this trait's implementation will also auto-tag tests with class level annotations. For example, if you annotate
@Ignore
at the class level, all test methods in the class will be auto-annotated withorg.scalatest.Ignore
.- Definition Classes
- AsyncFunSpecLike → Suite
- def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
- Definition Classes
- AsyncFunSpecLike → Suite
- def testNames: Set[String]
An immutable
Set
of test names.An immutable
Set
of test names. If thisAsyncFunSpec
contains no tests, this method returns an emptySet
.This trait's implementation of this method will return a set that contains the names of all registered tests. The set's iterator will return those names in the order in which the tests were registered. Each test's name is composed of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the example itself, with all components separated by a space. For example, consider this
AsyncFunSpec
:import org.scalatest.funspec.AsyncFunSpec class StackSpec extends AsyncFunSpec { 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 thisAsyncFunSpec
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
- val they: TheyWord
Supports test (and shared test) registration in
AsyncFunSpec
s.Supports test (and shared test) registration in
AsyncFunSpec
s.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
- def toString(): String
- Definition Classes
- AnyRef → Any
- def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withClue[T](clue: Any)(fun: => T): T
- Definition Classes
- Assertions
- def withFixture(test: NoArgAsyncTest): FutureOutcome
- Definition Classes
- AsyncTestSuite
Deprecated Value Members
- 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.
- 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.
- 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.
- 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.
- 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
- AsyncFunSpecLike → 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.