trait AsyncFreeSpecLike extends AsyncTestSuite with AsyncTestRegistration with Informing with Notifying with Alerting with Documenting
Implementation trait for class AsyncFreeSpec, which
facilitates a “behavior-driven” style of development (BDD),
in which tests are nested inside text clauses denoted with the dash
operator (-).
AsyncFreeSpec 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 AsyncFreeSpec into some other class, you can use this
trait instead, because class AsyncFreeSpec does nothing more than
extend this trait and add a nice toString implementation.
See the documentation of the class for a detailed
overview of AsyncFreeSpec.
- Self Type
- AsyncFreeSpecLike
- Annotations
- @Finders()
- Source
- AsyncFreeSpecLike.scala
- Alphabetic
- By Inheritance
- AsyncFreeSpecLike
- Documenting
- Alerting
- Notifying
- Informing
- AsyncTestRegistration
- AsyncTestSuite
- CompleteLastly
- RecoverMethods
- Suite
- Serializable
- Serializable
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
CheckingEqualizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
-
class
Equalizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
-
final
class
FreeSpecStringWrapper extends AnyRef
A class that via an implicit conversion (named
convertToFreeSpecStringWrapper) enables methodsin,is,taggedAsandignore, as well as the dash operator (-), to be invoked onStrings.A class that via an implicit conversion (named
convertToFreeSpecStringWrapper) enables methodsin,is,taggedAsandignore, as well as the dash operator (-), to be invoked onStrings.- Attributes
- protected
-
trait
NoArgAsyncTest extends () ⇒ FutureOutcome with TestData
- Definition Classes
- AsyncTestSuite
-
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
taggedAsmethod of classFreeSpecStringWrapper.- 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
Alerterthat during test execution will forward strings passed to itsapplymethod to the current reporter.Returns an
Alerterthat during test execution will forward strings passed to itsapplymethod to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while thisAsyncFreeSpecis 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
- AsyncFreeSpecLike → 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
AsyncFreeSpecs.Supports shared test registration in
AsyncFreeSpecs.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 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( ... ) @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
Strings toFreeSpecStringWrapper, which enables methodsin,is,taggedAsandignore, as well as the dash operator (-), to be invoked onStrings.Implicitly converts
Strings toFreeSpecStringWrapper, which enables methodsin,is,taggedAsandignore, as well as the dash operator (-), to be invoked onStrings.- Attributes
- protected
-
def
defaultEquality[A]: Equality[A]
- Definition Classes
- TripleEqualsSupport
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): 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[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
info: Informer
Returns an
Informerthat during test execution will forward strings passed to itsapplymethod to the current reporter.Returns an
Informerthat during test execution will forward strings passed to itsapplymethod 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, asrecordedEventsof 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
- AsyncFreeSpecLike → 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
Documenterthat during test execution will forward strings passed to itsapplymethod to the current reporter.Returns a
Documenterthat during test execution will forward strings passed to itsapplymethod 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, asrecordedEventsof 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
- AsyncFreeSpecLike → Documenting
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nestedSuites: IndexedSeq[Suite]
- Definition Classes
- Suite
-
def
note: Notifier
Returns a
Notifierthat during test execution will forward strings passed to itsapplymethod to the current reporter.Returns a
Notifierthat during test execution will forward strings passed to itsapplymethod to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while thisAsyncFreeSpecis 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
- AsyncFreeSpecLike → 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[Assertion]
- Definition Classes
- RecoverMethods
-
final
def
registerAsyncTest(testText: String, testTags: Tag*)(testFun: ⇒ Future[compatible.Assertion])(implicit pos: Position): Unit
- Definition Classes
- AsyncFreeSpecLike → AsyncTestRegistration
-
final
def
registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: ⇒ Future[compatible.Assertion])(implicit pos: Position): Unit
- Definition Classes
- AsyncFreeSpecLike → AsyncTestRegistration
-
def
rerunner: Option[String]
- Definition Classes
- Suite
-
def
run(testName: Option[String], args: Args): Status
- Definition Classes
- AsyncFreeSpecLike → 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 documentation fortestNamesfor an example.)- testName
the name of one test to execute.
- args
the
Argsfor this run- returns
a
Statusobject that indicates when the test started by this method has completed, and whether or not it failed .
- Attributes
- protected
- Definition Classes
- AsyncFreeSpecLike → AsyncTestSuite → Suite
- Exceptions thrown
NullArgumentExceptionif any oftestName,reporter,stopper, orconfigMapisnull.
-
def
runTests(testName: Option[String], args: Args): Status
Run zero to many of this
AsyncFreeSpec's tests.Run zero to many of this
AsyncFreeSpec's tests.This method takes a
testNameparameter that optionally specifies a test to invoke. IftestNameisSome, this trait's implementation of this method invokesrunTeston this object, passing in:testName- theStringvalue of thetestNameOptionpassed to this methodreporter- theReporterpassed to this method, or one that wraps and delegates to itstopper- theStopperpassed to this method, or one that wraps and delegates to itconfigMap- theconfigMappassed to this method, or one that wraps and delegates to it
This method takes a
Setof tag names that should be included (tagsToInclude), and aSetthat should be excluded (tagsToExclude), when deciding which of thisSuite's tests to execute. IftagsToIncludeis empty, all tests will be executed except those those belonging to tags listed in thetagsToExcludeSet. IftagsToIncludeis non-empty, only tests belonging to tags mentioned intagsToInclude, and not mentioned intagsToExcludewill be executed. However, iftestNameisSome,tagsToIncludeandtagsToExcludeare essentially ignored. Only iftestNameisNonewilltagsToIncludeandtagsToExcludebe consulted to determine which of the tests named in thetestNamesSetshould be run. For more information on trait tags, see the main documentation for this trait.If
testNameisNone, this trait's implementation of this method invokestestNameson thisSuiteto get aSetof names of tests to potentially execute. (AtestNamesvalue ofNoneessentially acts as a wildcard that means all tests in thisSuitethat are selected bytagsToIncludeandtagsToExcludeshould be executed.) For each test in thetestNameSet, in the order they appear in the iterator obtained by invoking theelementsmethod on theSet, this trait's implementation of this method checks whether the test should be run based on thetagsToIncludeandtagsToExcludeSets. If so, this implementation invokesrunTest, passing in:testName- theStringname of the test to run (which will be one of the names in thetestNamesSet)reporter- theReporterpassed to this method, or one that wraps and delegates to itstopper- theStopperpassed to this method, or one that wraps and delegates to itconfigMap- theconfigMappassed to this method, or one that wraps and delegates to it
- testName
an optional name of one test to run. If
None, all relevant tests should be run. I.e.,Noneacts like a wildcard that means run all relevant tests in thisSuite.- args
the
Argsfor this run- returns
a
Statusobject that indicates when all tests started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Definition Classes
- AsyncFreeSpecLike → Suite
- Exceptions thrown
IllegalArgumentExceptioniftestNameis defined, but no test with the specified test name exists in thisSuiteNullArgumentExceptionif 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
Mapwhose keys areStringnames of tagged tests and whose associated values are theSetof tags for the test.A
Mapwhose keys areStringnames of tagged tests and whose associated values are theSetof tags for the test. If thisAsyncFreeSpeccontains no tags, this method returns an emptyMap.This trait's implementation returns tags that were passed as strings contained in
Tagobjects passed totaggedAs.In addition, this trait's implementation will also auto-tag tests with class level annotations. For example, if you annotate
@Ignoreat the class level, all test methods in the class will be auto-annotated withorg.scalatest.Ignore.- Definition Classes
- AsyncFreeSpecLike → Suite
-
def
testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
- Definition Classes
- AsyncFreeSpecLike → Suite
-
def
testNames: Set[String]
An immutable
Setof test names.An immutable
Setof test names. If thisAsyncFreeSpeccontains 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
AsyncFreeSpec:import org.scalatest.freespec.AsyncFreeSpec class StackSpec extends AsyncFreeSpec { "A Stack" - { "when not empty" - { "must allow me to pop" in {} } "when not full" - { "must allow me to push" in {} } } }Invoking
testNameson thisAsyncFreeSpecwill 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
- AsyncFreeSpecLike → 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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @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
styleNamelifecycle method has been deprecated and will be removed in a future version of ScalaTest.The
styleNamelifecycle 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
- AsyncFreeSpecLike → 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.