abstract class FixtureAsyncWordSpec extends FixtureAsyncWordSpecLike
A sister class to org.scalatest.wordspec.AsyncWordSpec
that can pass a fixture object into its tests.
Recommended Usage:
Use class FixtureAsyncWordSpec in situations for which AsyncWordSpec
would be a good choice, when all or most tests need the same fixture objects
that must be cleaned up afterwards. Note: FixtureAsyncWordSpec is intended for use in special situations, with class AsyncWordSpec used for general needs. For
more insight into where FixtureAsyncWordSpec fits in the big picture, see the withFixture(OneArgAsyncTest) subsection of the Shared fixtures section in the documentation for class AsyncWordSpec .
|
Class FixtureAsyncWordSpec
behaves similarly to class org.scalatest.wordspec.AsyncWordSpec
, except that tests may have a
fixture parameter. The type of the
fixture parameter is defined by the abstract FixtureParam
type, which is a member of this class.
This class also contains an abstract withFixture
method. This withFixture
method
takes a OneArgAsyncTest
, which is a nested trait defined as a member of this class.
OneArgAsyncTest
has an apply
method that takes a FixtureParam
.
This apply
method is responsible for running a test.
This class's runTest
method delegates the actual running of each test to withFixture(OneArgAsyncTest)
, passing
in the test code to run via the OneArgAsyncTest
argument. The withFixture(OneArgAsyncTest)
method (abstract in this class) is responsible
for creating the fixture argument and passing it to the test function.
Subclasses of this class must, therefore, do three things differently from a plain old org.scalatest.wordspec.AsyncWordSpec
:
- define the type of the fixture parameter by specifying type
FixtureParam
- define the
withFixture(OneArgAsyncTest)
method - write tests that take a fixture parameter
- (You can also define tests that don't take a fixture parameter.)
If the fixture you want to pass into your tests consists of multiple objects, you will need to combine them into one object to use this class. One good approach to passing multiple fixture objects is to encapsulate them in a case class. Here's an example:
case class FixtureParam(file: File, writer: FileWriter)
To enable the stacking of traits that define withFixture(NoArgAsyncTest)
, it is a good idea to let
withFixture(NoArgAsyncTest)
invoke the test function instead of invoking the test
function directly. To do so, you'll need to convert the OneArgAsyncTest
to a NoArgAsyncTest
. You can do that by passing
the fixture object to the toNoArgAsyncTest
method of OneArgAsyncTest
. In other words, instead of
writing “test(theFixture)
”, you'd delegate responsibility for
invoking the test function to the withFixture(NoArgAsyncTest)
method of the same instance by writing:
withFixture(test.toNoArgAsyncTest(theFixture))
Here's a complete example:
package org.scalatest.examples.asyncwordspec.oneargasynctest import org.scalatest._ import scala.concurrent.Future import scala.concurrent.ExecutionContext // Defining actor messages sealed abstract class StringOp case object Clear extends StringOp case class Append(value: String) extends StringOp case object GetValue class StringActor { // Simulating an actor private final val sb = new StringBuilder def !(op: StringOp): Unit = synchronized { op match { case Append(value) => sb.append(value) case Clear => sb.clear() } } def ?(get: GetValue.type)(implicit c: ExecutionContext): Future[String] = Future { synchronized { sb.toString } } } class ExampleSpec extends wordspec.FixtureAsyncWordSpec { type FixtureParam = StringActor def withFixture(test: OneArgAsyncTest): FutureOutcome = { val actor = new StringActor complete { actor ! Append("ScalaTest is ") // set up the fixture withFixture(test.toNoArgAsyncTest(actor)) } lastly { actor ! Clear // ensure the fixture will be cleaned up } } "Testing" should { "be easy" in { actor => actor ! Append("easy!") val futureString = actor ? GetValue futureString map { s => assert(s == "ScalaTest is easy!") } } "be fun" in { actor => actor ! Append("fun!") val futureString = actor ? GetValue futureString map { s => assert(s == "ScalaTest is fun!") } } } }
If a test fails, the future returned by the OneArgAsyncTest
function will result in
an org.scalatest.Failed wrapping the exception describing
the failure. To ensure clean up happens even if a test fails, you should invoke the test function and do the cleanup using
complete
-lastly
, as shown in the previous example. The complete
-lastly
syntax, defined in CompleteLastly
, which is extended by AsyncTestSuite
, ensures
the second, cleanup block of code is executed, whether the the first block throws an exception or returns a future. If it returns a
future, the cleanup will be executed when the future completes.
Sharing fixtures across classes
If multiple test classes need the same fixture, you can define the FixtureParam
and withFixture(OneArgAsyncTest)
implementations in a trait, then mix that trait into the test classes that need it. For example, if your application requires a database and your
integration tests use that database, you will likely have many test classes that need a database fixture. You can create a "database fixture" trait
that creates a database with a unique name, passes the connector into the test, then removes the database once the test completes. This is shown in
the following example:
package org.scalatest.examples.fixture.asyncwordspec.sharing import java.util.concurrent.ConcurrentHashMap import org.scalatest._ import DbServer._ import java.util.UUID.randomUUID import scala.concurrent.Future object DbServer { // Simulating a database server type Db = StringBuffer private val databases = new ConcurrentHashMap[String, Db] def createDb(name: String): Db = { val db = new StringBuffer databases.put(name, db) db } def removeDb(name: String) { databases.remove(name) } } trait DbFixture { this: FixtureAsyncTestSuite => type FixtureParam = Db // Allow clients to populate the database after // it is created def populateDb(db: Db) {} def withFixture(test: OneArgAsyncTest): FutureOutcome = { val dbName = randomUUID.toString val db = createDb(dbName) // create the fixture complete { populateDb(db) // setup the fixture withFixture(test.toNoArgAsyncTest(db)) // "loan" the fixture to the test } lastly { removeDb(dbName) // ensure the fixture will be cleaned up } } } class ExampleSpec extends wordspec.FixtureAsyncWordSpec with DbFixture { override def populateDb(db: Db) { // setup the fixture db.append("ScalaTest is ") } "Testing" should { "be easy" in { db => Future { db.append("easy!") assert(db.toString === "ScalaTest is easy!") } } "be fun" in { db => Future { db.append("fun!") assert(db.toString === "ScalaTest is fun!") } } } "Testing code" should { // This test doesn't need a Db "be clear" in { () => Future { val buf = new StringBuffer buf.append("ScalaTest code is ") buf.append("clear!") assert(buf.toString === "ScalaTest code is clear!") } } } }
Often when you create fixtures in a trait like DbFixture
, you'll still need to enable individual test classes
to "setup" a newly created fixture before it gets passed into the tests. A good way to accomplish this is to pass the newly
created fixture into a setup method, like populateDb
in the previous example, before passing it to the test
function. Classes that need to perform such setup can override the method, as does ExampleSuite
.
If a test doesn't need the fixture, you can indicate that by providing a no-arg instead of a one-arg function, as is done in the
third test in the previous example, “test code should be clear
”. In other words, instead of starting your function literal
with something like “db =>
”, you'd start it with “() =>
”. For such tests, runTest
will not invoke withFixture(OneArgAsyncTest)
. It will instead directly invoke withFixture(NoArgAsyncTest)
.
Both examples shown above demonstrate the technique of giving each test its own "fixture sandbox" to play in. When your fixtures
involve external side-effects, like creating files or databases, it is a good idea to give each file or database a unique name as is
done in these examples. This keeps tests completely isolated, allowing you to run them in parallel if desired. You could mix
ParallelTestExecution
into either of these ExampleSuite
classes, and the tests would run in parallel just fine.
- Alphabetic
- By Inheritance
- FixtureAsyncWordSpec
- FixtureAsyncWordSpecLike
- Documenting
- Alerting
- Notifying
- Informing
- CanVerb
- MustVerb
- ShouldVerb
- FixtureAsyncTestRegistration
- FixtureAsyncTestSuite
- AsyncTestSuite
- CompleteLastly
- RecoverMethods
- FixtureSuite
- Suite
- Serializable
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new FixtureAsyncWordSpec()
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
- 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
- trait StringCanWrapperForVerb extends AnyRef
- Definition Classes
- CanVerb
- trait StringMustWrapperForVerb extends AnyRef
- Definition Classes
- MustVerb
- trait StringShouldWrapperForVerb extends AnyRef
- Definition Classes
- ShouldVerb
- final class AfterWord extends AnyRef
Class whose instances are after words, which can be used to reduce text duplication.
Class whose instances are after words, which can be used to reduce text duplication.
If you are repeating a word or phrase at the beginning of each string inside a block, you can "move the word or phrase" out of the block with an after word. You create an after word by passing the repeated word or phrase to the
afterWord
method. Once created, you can place the after word afterwhen
, a verb (should
,must
, orcan
), orwhich
. (You can't place one afterin
oris
, the words that introduce a test.) Here's an example that has after words used in all three places:import org.scalatest._ import ConfigMapFixture class ScalaTestGUISpec extends wordspec.FixtureAnyWordSpec with ConfigMapFixture { def theUser = afterWord("the user") def display = afterWord("display") def is = afterWord("is") "The ScalaTest GUI" when theUser { "clicks on an event report in the list box" should display { "a blue background in the clicked-on row in the list box" in { cm => } "the details for the event in the details area" in { cm => } "a rerun button," which is { "enabled if the clicked-on event is rerunnable" in { cm => } "disabled if the clicked-on event is not rerunnable" in { cm => } } } } }
Running the previous
FixtureAnyWordSpec
in the Scala interpreter would yield:scala> (new ScalaTestGUISpec).run() The ScalaTest GUI (when the user clicks on an event report in the list box) - should display a blue background in the clicked-on row in the list box - should display the details for the event in the details area - should display a rerun button, which is enabled if the clicked-on event is rerunnable - should display a rerun button, which is disabled if the clicked-on event is not rerunnable
- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- final class ItWord extends AnyRef
Class that supports shorthand scope registration via the instance referenced from
FixtureAsyncWordSpecLike
'sit
field.Class that supports shorthand scope registration via the instance referenced from
FixtureAsyncWordSpecLike
'sit
field.This class enables syntax such as the following test registration:
"A Stack" when { ... } it should { ... } ^
For more information and examples of the use of the
it
field, see the main documentation forFixtureAsyncWordSpec
.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- 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 classWordSpecStringWrapper
.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- final class TheyWord extends AnyRef
Class that supports shorthand scope registration via the instance referenced from
FixtureAsyncWordSpecLike
'sthey
field.Class that supports shorthand scope registration via the instance referenced from
FixtureAsyncWordSpecLike
'sthey
field.This class enables syntax such as the following test registration:
"Basketball players" when { ... } they should { ... } ^
For more information and examples of the use of the
they
field, see the main documentation forAnyWordSpec
.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- final class WordSpecStringWrapper extends AnyRef
A class that via an implicit conversion (named
convertToWordSpecStringWrapper
) enables methodswhen
,which
,in
,is
,taggedAs
andignore
to be invoked onString
s.A class that via an implicit conversion (named
convertToWordSpecStringWrapper
) enables methodswhen
,which
,in
,is
,taggedAs
andignore
to be invoked onString
s.This class provides much of the syntax for
FixtureAsyncWordSpec
, however, it does not add the verb methods (should
,must
, andcan
) toString
. Instead, these are added via theShouldVerb
,MustVerb
, andCanVerb
traits, whichFixtureAsyncWordSpec
mixes in, to avoid a conflict with implicit conversions provided inMatchers
andMustMatchers
.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
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 afterWord(text: String): AfterWord
Creates an after word that an be used to reduce text duplication.
Creates an after word that an be used to reduce text duplication.
If you are repeating a word or phrase at the beginning of each string inside a block, you can "move the word or phrase" out of the block with an after word. You create an after word by passing the repeated word or phrase to the
afterWord
method. Once created, you can place the after word afterwhen
, a verb (should
,must
, orcan
), orwhich
. (You can't place one afterin
oris
, the words that introduce a test.) Here's an example that has after words used in all three places:import org.scalatest._ import ConfigMapFixture class ScalaTestGUISpec extends wordspec.FixtureAnyWordSpec with ConfigMapFixture { def theUser = afterWord("the user") def display = afterWord("display") def is = afterWord("is") "The ScalaTest GUI" when theUser { "clicks on an event report in the list box" should display { "a blue background in the clicked-on row in the list box" in { cm => } "the details for the event in the details area" in { cm => } "a rerun button," which is { "enabled if the clicked-on event is rerunnable" in { cm => } "disabled if the clicked-on event is not rerunnable" in { cm => } } } } }
Running the previous
FixtureAnyWordSpec
in the Scala interpreter would yield:scala> (new ScalaTestGUISpec).run() The ScalaTest GUI (when the user clicks on an event report in the list box) - should display a blue background in the clicked-on row in the list box - should display the details for the event in the details area - should display a rerun button, which is enabled if the clicked-on event is rerunnable - should display a rerun button, which is disabled if the clicked-on event is not rerunnable
- text
the after word text
- returns
an instance of
AfterWord
- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- def alert: Alerter
Returns an
Alerter
that during test execution will forward strings (and other objects) passed to itsapply
method to the current reporter.Returns an
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 thisFixtureAnyWordSpec
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
- FixtureAsyncWordSpecLike → 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
FixtureAnyWordSpec
s.Supports shared test registration in
FixtureAnyWordSpec
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
org.scalatest.wordspec.AnyWordSpec
.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- 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 convertToStringCanWrapper(o: String)(implicit position: Position): StringCanWrapperForVerb
- Definition Classes
- CanVerb
- implicit def convertToStringMustWrapperForVerb(o: String)(implicit position: Position): StringMustWrapperForVerb
- Definition Classes
- MustVerb
- implicit def convertToStringShouldWrapperForVerb(o: String)(implicit position: Position): StringShouldWrapperForVerb
- Definition Classes
- ShouldVerb
- implicit def convertToWordSpecStringWrapper(s: String): WordSpecStringWrapper
Implicitly converts
String
s toWordSpecStringWrapper
, which enables methodswhen
,which
,in
,is
,taggedAs
andignore
to be invoked onString
s.Implicitly converts
String
s toWordSpecStringWrapper
, which enables methodswhen
,which
,in
,is
,taggedAs
andignore
to be invoked onString
s.- s
String
to be wrapped- returns
an instance of
WordSpecStringWrapper
- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- 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
- def exceptionWasThrownInClauseMessageFun(verb: String, className: UnquotedString, description: String, errorMessage: String): String
- Definition Classes
- FixtureAsyncWordSpecLike
- 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
- FixtureAsyncWordSpecLike → 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 shorthand scope registration in
FixtureAsyncWordSpecLike
s.Supports shorthand scope registration in
FixtureAsyncWordSpecLike
s.This field enables syntax such as the following test registration:
"A Stack" when { ... } it should { ... } ^
For more information and examples of the use of the
it
field, see the main documentation forAnyWordSpec
.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- 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
- FixtureAsyncWordSpecLike → 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 (and other objects) passed to itsapply
method to the current reporter.Returns a
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 thisFixtureAsyncWordSpec
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
- FixtureAsyncWordSpecLike → 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
- FixtureAsyncWordSpecLike → FixtureAsyncTestRegistration
- final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Future[compatible.Assertion])(implicit pos: Position): Unit
- Definition Classes
- FixtureAsyncWordSpecLike → FixtureAsyncTestRegistration
- def rerunner: Option[String]
- Definition Classes
- Suite
- def run(testName: Option[String], args: Args): Status
- Definition Classes
- FixtureAsyncWordSpecLike → 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
- FixtureAsyncWordSpecLike → AsyncTestSuite → Suite
- Exceptions thrown
NullArgumentException
if any oftestName
orargs
isnull
.
- def runTests(testName: Option[String], args: Args): Status
Run zero to many of this
FixtureAsyncWordSpec
's tests.Run zero to many of this
FixtureAsyncWordSpec
'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
with passedargs
.- 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 thisFixtureAsyncWordSpec
.- 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
- FixtureAsyncWordSpecLike → Suite
- Exceptions thrown
NullArgumentException
if any oftestName
orargs
isnull
.
- implicit val subjectRegistrationFunction: StringVerbBlockRegistration
Supports the registration of subjects.
Supports the registration of subjects.
For example, this method enables syntax such as the following:
"A Stack" should { ... ^
This function is passed as an implicit parameter to a
should
method provided inShouldVerb
, amust
method provided inMustVerb
, and acan
method provided inCanVerb
. When invoked, this function registers the subject and executes the block.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- implicit val subjectWithAfterWordRegistrationFunction: SubjectWithAfterWordRegistration
Supports the registration of subject descriptions with after words.
Supports the registration of subject descriptions with after words.
For example, this method enables syntax such as the following:
def provide = afterWord("provide") "The ScalaTest Matchers DSL" can provide { ... } ^
This function is passed as an implicit parameter to a
should
method provided inShouldVerb
, amust
method provided inMustVerb
, and acan
method provided inCanVerb
. When invoked, this function registers the subject and executes the block.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- 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 thisFixtureAsyncWordSpec
belong, and values theSet
of test names that belong to each tag.A
Map
whose keys areString
tag names to which tests in thisFixtureAsyncWordSpec
belong, and values theSet
of test names that belong to each tag. If thisFixtureAsyncWordSpec
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
- FixtureAsyncWordSpecLike → Suite
- def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
- Definition Classes
- FixtureAsyncWordSpecLike → Suite
- def testNames: Set[String]
An immutable
Set
of test names.An immutable
Set
of test names. If thisFixtureAnyWordSpec
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
- FixtureAsyncWordSpecLike → Suite
- val they: TheyWord
Supports shorthand scope registration in
FixtureAsyncWordSpecLike
s.Supports shorthand scope registration in
FixtureAsyncWordSpecLike
s.This field enables syntax such as the following test registration:
"A Stack" when { ... } they should { ... } ^
For more information and examples of the use of the
they
field, see the main documentation forAnyWordSpec
.- Attributes
- protected
- Definition Classes
- FixtureAsyncWordSpecLike
- def toString(): String
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
- FixtureAsyncWordSpec → 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
- FixtureAsyncWordSpecLike → 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.