trait FixtureAsyncFreeSpecLike extends FixtureAsyncTestSuite with FixtureAsyncTestRegistration with Informing with Notifying with Alerting with Documenting
Implementation trait for class FixtureAsyncFreeSpec
, which is
a sister class to org.scalatest.freespec.AsyncFreeSpec
that can pass a
fixture object into its tests.
FixtureAsyncFreeSpec
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 FixtureAsyncFreeSpec
into some other
class, you can use this trait instead, because class
FixtureAsyncFreeSpec
does nothing more than extend this trait and add a nice toString
implementation.
See the documentation of the class for a detailed
overview of FixtureAsyncFreeSpec
.
- Self Type
- FixtureAsyncFreeSpecLike
- Annotations
- @Finders()
- Source
- FixtureAsyncFreeSpecLike.scala
- Alphabetic
- By Inheritance
- FixtureAsyncFreeSpecLike
- Documenting
- Alerting
- Notifying
- Informing
- FixtureAsyncTestRegistration
- FixtureAsyncTestSuite
- AsyncTestSuite
- CompleteLastly
- RecoverMethods
- FixtureSuite
- 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
- abstract type FixtureParam
- Attributes
- protected
- Definition Classes
- FixtureSuite
- final class FreeSpecStringWrapper extends AnyRef
A class that via an implicit conversion (named
convertToFreeSpecStringWrapper
) enables methodswhen
,that
,in
,is
,taggedAs
andignore
to be invoked onString
s.A class that via an implicit conversion (named
convertToFreeSpecStringWrapper
) enables methodswhen
,that
,in
,is
,taggedAs
andignore
to be invoked onString
s.This class provides much of the syntax for
FixtureAsyncFreeSpec
, however, it does not add the verb methods (should
,must
, andcan
) toString
. Instead, these are added via theShouldVerb
,MustVerb
, andCanVerb
traits, whichFixtureAsyncFreeSpec
mixes in, to avoid a conflict with implicit conversions provided inMatchers
andMustMatchers
.- Attributes
- protected
- trait NoArgAsyncTest extends () => FutureOutcome with TestData
- Definition Classes
- AsyncTestSuite
- trait OneArgAsyncTest extends (FixtureAsyncTestSuite.FixtureParam) => FutureOutcome with TestData
- Definition Classes
- FixtureAsyncTestSuite
- class ResultOfCompleteInvocation[T] extends AnyRef
- Definition Classes
- CompleteLastly
- final class ResultOfTaggedAsInvocationOnString extends AnyRef
Class that supports the registration of tagged tests.
Class that supports the registration of tagged tests.
Instances of this class are returned by the
taggedAs
method of classFreeSpecStringWrapper
.- Attributes
- protected
Abstract Value Members
- abstract def withFixture(test: OneArgAsyncTest): FutureOutcome
- Definition Classes
- FixtureAsyncTestSuite
Concrete 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 a
Alerter
that during test execution will forward strings (and other objects) passed to itsapply
method to the current reporter.Returns a
Alerter
that during test execution will forward strings (and other objects) 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 thisFixtureAsyncFreeSpec
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
- FixtureAsyncFreeSpecLike → 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
FixtureAsyncFreeSpec
s.Supports shared test registration in
FixtureAsyncFreeSpec
s.This field enables syntax such as the following:
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 trait
AnyFreeSpec
.- 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
- implicit def convertToFreeSpecStringWrapper(s: String)(implicit pos: Position): FreeSpecStringWrapper
Implicitly converts
String
s toFreeSpecStringWrapper
, which enables methodswhen
,that
,in
,is
,taggedAs
andignore
to be invoked onString
s.Implicitly converts
String
s toFreeSpecStringWrapper
, which enables methodswhen
,that
,in
,is
,taggedAs
andignore
to be invoked onString
s.- Attributes
- protected
- def defaultEquality[A]: Equality[A]
- Definition Classes
- TripleEqualsSupport
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit
- Definition Classes
- Suite
- 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 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
- FixtureAsyncFreeSpecLike → 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
- 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
- FixtureAsyncFreeSpecLike → Documenting
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nestedSuites: IndexedSeq[Suite]
- Definition Classes
- Suite
- def note: Notifier
Returns an
Notifier
that during test execution will forward strings (and other objects) passed to itsapply
method to the current reporter.Returns an
Notifier
that during test execution will forward strings (and other objects) 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 thisFixtureAsyncFreeSpec
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
- FixtureAsyncFreeSpecLike → 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: (FixtureParam) => Future[compatible.Assertion])(implicit pos: Position): Unit
- Definition Classes
- FixtureAsyncFreeSpecLike → FixtureAsyncTestRegistration
- final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Future[compatible.Assertion])(implicit pos: Position): Unit
- Definition Classes
- FixtureAsyncFreeSpecLike → FixtureAsyncTestRegistration
- def rerunner: Option[String]
- Definition Classes
- Suite
- def run(testName: Option[String], args: Args): Status
- Definition Classes
- FixtureAsyncFreeSpecLike → 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
- FixtureAsyncFreeSpecLike → AsyncTestSuite → Suite
- Exceptions thrown
NullArgumentException
iftestName
oris null
.
- def runTests(testName: Option[String], args: Args): Status
Run zero to many of this
FreeSpec
's tests.Run zero to many of this
FreeSpec
's tests.This method takes a
testName
parameter that optionally specifies a test to invoke. IftestName
isSome
, this trait's implementation of this method invokesrunTest
on this object with passedargs
.This method takes an
args
that contains aSet
of tag names that should be included (tagsToInclude
), and aSet
that should be excluded (tagsToExclude
), when deciding which of thisSuite
's tests to execute. IftagsToInclude
is empty, all tests will be executed except those those belonging to tags listed in thetagsToExclude
Set
. IftagsToInclude
is non-empty, only tests belonging to tags mentioned intagsToInclude
, and not mentioned intagsToExclude
will be executed. However, iftestName
isSome
,tagsToInclude
andtagsToExclude
are essentially ignored. Only iftestName
isNone
willtagsToInclude
andtagsToExclude
be consulted to determine which of the tests named in thetestNames
Set
should be run. For more information on trait tags, see the main documentation for this trait.If
testName
isNone
, this trait's implementation of this method invokestestNames
on thisSuite
to get aSet
of names of tests to potentially execute. (AtestNames
value ofNone
essentially acts as a wildcard that means all tests in thisSuite
that are selected bytagsToInclude
andtagsToExclude
should be executed.) For each test in thetestName
Set
, in the order they appear in the iterator obtained by invoking theelements
method on theSet
, this trait's implementation of this method checks whether the test should be run based on thetagsToInclude
andtagsToExclude
Set
s. If so, this implementation invokesrunTest
via passed inargs
.- 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 thisFixtureAsyncFreeSpec
.- 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
- FixtureAsyncFreeSpecLike → Suite
- Exceptions thrown
NullArgumentException
iftestName
orargs
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
tag names to which tests in thisFixtureAsyncFreeSpec
belong, and values theSet
of test names that belong to each tag.A
Map
whose keys areString
tag names to which tests in thisFixtureAsyncFreeSpec
belong, and values theSet
of test names that belong to each tag. If thisFixtureAsyncFreeSpec
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 methodstest
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 with @Ignore.
- Definition Classes
- FixtureAsyncFreeSpecLike → Suite
- def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
- Definition Classes
- FixtureAsyncFreeSpecLike → Suite
- def testNames: Set[String]
An immutable
Set
of test names.An immutable
Set
of test names. If thisFixtureAsyncFreeSpec
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.
- returns
the
Set
of test names
- Definition Classes
- FixtureAsyncFreeSpecLike → Suite
- 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
- FixtureAsyncFreeSpecLike → FixtureSuite → 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.