abstract class FixtureAsyncFreeSpec extends FixtureAsyncFreeSpecLike
A sister class to org.scalatest.freespec.AsyncFreeSpec
that can pass a fixture object into its tests.
Recommended Usage:
Use class FixtureAsyncFunSpec in situations for which AsyncFreeSpec
would be a good choice, when all or most tests need the same fixture objects
that must be cleaned up afterwards. Note: FixtureAsyncFreeSpec is intended for use in special situations, with class AsyncFreeSpec used for general needs. For
more insight into where FixtureAsyncFreeSpec fits in the big picture, see the withFixture(OneArgAsyncTest) subsection of the Shared fixtures section in the documentation for class AsyncFunSpec .
|
Class FixtureAsyncFreeSpec
behaves similarly to class org.scalatest.freespec.AsyncFreeSpec
, 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.freespec.AsyncFunSpec
:
- 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.asyncfreespec.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 freespec.FixtureAsyncFreeSpec {
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!") } }
"should 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.asyncfreespec.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 freespec.FixtureAsyncFreeSpec 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!") } }
"should be fun" in { db => Future { db.append("fun!") assert(db.toString === "ScalaTest is fun!") } }
// This test doesn't need a Db "code should 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
- FixtureAsyncFreeSpec
- FixtureAsyncFreeSpecLike
- Documenting
- Alerting
- Notifying
- Informing
- FixtureAsyncTestRegistration
- FixtureAsyncTestSuite
- AsyncTestSuite
- CompleteLastly
- RecoverMethods
- FixtureSuite
- Suite
- Serializable
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new FixtureAsyncFreeSpec()
Type Members
- trait NoArgAsyncTest extends () => FutureOutcome with TestData
A test function taking no arguments and returning a
FutureOutcome
.A test function taking no arguments and returning a
FutureOutcome
.For more detail and examples, see the relevant section in the documentation for trait
AsyncFlatSpec
.- Definition Classes
- AsyncTestSuite
- class ResultOfCompleteInvocation[T] extends AnyRef
Class that provides the
lastly
method of thecomplete
-lastly
syntax.Class that provides the
lastly
method of thecomplete
-lastly
syntax.- Definition Classes
- CompleteLastly
- trait OneArgAsyncTest extends (FixtureParam) => FutureOutcome with TestData
A test function taking no arguments and returning an
FutureOutcome
.A test function taking no arguments and returning an
FutureOutcome
.For more detail and examples, see the relevant section in the documentation for trait
fixture.AsyncFlatSpec
.- Definition Classes
- FixtureAsyncTestSuite
- class CheckingEqualizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- class Equalizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- abstract type FixtureParam
The type of the fixture parameter that can be passed into tests in this suite.
The type of the fixture parameter that can be passed into tests in this suite.
- 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
- Definition Classes
- FixtureAsyncFreeSpecLike
- 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
- Definition Classes
- FixtureAsyncFreeSpecLike
Abstract Value Members
- abstract def withFixture(test: OneArgAsyncTest): FutureOutcome
Run the passed test function with a fixture created by this method.
Run the passed test function with a fixture created by this method.
This method should create the fixture object needed by the tests of the current suite, invoke the test function (passing in the fixture object), and if needed, register any clean up needed after the test completes as a callback on the
FutureOutcome
returned by the test function. For more detail and examples, see the main documentation for this trait.- test
the
OneArgAsyncTest
to invoke, passing in a fixture- returns
an instance of
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
Assert that a boolean condition, described in
String
message
, is true.Assert that a boolean condition, described in
String
message
, is true. If the condition istrue
, this method returns normally. Else, it throwsTestFailedException
with a helpful error message appended with theString
obtained by invokingtoString
on the specifiedclue
as the exception's detail message.This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
- assert(a == b, "a good clue")
- assert(a != b, "a good clue")
- assert(a === b, "a good clue")
- assert(a !== b, "a good clue")
- assert(a > b, "a good clue")
- assert(a >= b, "a good clue")
- assert(a < b, "a good clue")
- assert(a <= b, "a good clue")
- assert(a startsWith "prefix", "a good clue")
- assert(a endsWith "postfix", "a good clue")
- assert(a contains "something", "a good clue")
- assert(a eq b, "a good clue")
- assert(a ne b, "a good clue")
- assert(a > 0 && b > 5, "a good clue")
- assert(a > 0 || b > 5, "a good clue")
- assert(a.isEmpty, "a good clue")
- assert(!a.isEmpty, "a good clue")
- assert(a.isInstanceOf[String], "a good clue")
- assert(a.length == 8, "a good clue")
- assert(a.size == 8, "a good clue")
- assert(a.exists(_ == 8), "a good clue")
At this time, any other form of expression will just get a
TestFailedException
with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the===
that returnsBoolean
to be the default in tests. This makes===
consistent between tests and production code.- condition
the boolean condition to assert
- clue
An objects whose
toString
method returns a message to include in a failure report.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
ifmessage
isnull
.TestFailedException
if the condition isfalse
.
- macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
Assert that a boolean condition is true.
Assert that a boolean condition is true. If the condition is
true
, this method returns normally. Else, it throwsTestFailedException
.This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
- assert(a == b)
- assert(a != b)
- assert(a === b)
- assert(a !== b)
- assert(a > b)
- assert(a >= b)
- assert(a < b)
- assert(a <= b)
- assert(a startsWith "prefix")
- assert(a endsWith "postfix")
- assert(a contains "something")
- assert(a eq b)
- assert(a ne b)
- assert(a > 0 && b > 5)
- assert(a > 0 || b > 5)
- assert(a.isEmpty)
- assert(!a.isEmpty)
- assert(a.isInstanceOf[String])
- assert(a.length == 8)
- assert(a.size == 8)
- assert(a.exists(_ == 8))
At this time, any other form of expression will get a
TestFailedException
with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the===
that returnsBoolean
to be the default in tests. This makes===
consistent between tests and production code.- condition
the boolean condition to assert
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedException
if the condition isfalse
.
- macro def assertCompiles(code: String)(implicit pos: Position): Assertion
Asserts that a given string snippet of code passes both the Scala parser and type checker.
Asserts that a given string snippet of code passes both the Scala parser and type checker.
You can use this to make sure a snippet of code compiles:
assertCompiles("val a: Int = 1")
Although
assertCompiles
is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string compiles, errors (i.e., snippets of code that do not compile) are reported as test failures at runtime.- code
the snippet of code that should compile
- Definition Classes
- Assertions
- macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
Asserts that a given string snippet of code does not pass either the Scala parser or type checker.
Asserts that a given string snippet of code does not pass either the Scala parser or type checker.
Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's
Assertions
trait includes the following syntax for that purpose:assertDoesNotCompile("val a: String = \"a string")
Although
assertDoesNotCompile
is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string doesn't compile, errors (i.e., snippets of code that do compile) are reported as test failures at runtime.Note that the difference between
assertTypeError
andassertDoesNotCompile
is thatassertDoesNotCompile
will succeed if the given code does not compile for any reason, whereasassertTypeError
will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example,assertDoesNotCompile
will return normally butassertTypeError
will throw aTestFailedException
.- code
the snippet of code that should not type check
- Definition Classes
- Assertions
- def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Assert that the value passed as
expected
equals the value passed asactual
.Assert that the value passed as
expected
equals the value passed asactual
. If theactual
value equals theexpected
value (as determined by==
),assertResult
returns normally. Else,assertResult
throws aTestFailedException
whose detail message includes the expected and actual values.- expected
the expected value
- actual
the actual value, which should equal the passed
expected
value
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedException
if the passedactual
value does not equal the passedexpected
value.
- def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Assert that the value passed as
expected
equals the value passed asactual
.Assert that the value passed as
expected
equals the value passed asactual
. If theactual
equals theexpected
(as determined by==
),assertResult
returns normally. Else, ifactual
is not equal toexpected
,assertResult
throws aTestFailedException
whose detail message includes the expected and actual values, as well as theString
obtained by invokingtoString
on the passedclue
.- expected
the expected value
- clue
An object whose
toString
method returns a message to include in a failure report.- actual
the actual value, which should equal the passed
expected
value
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedException
if the passedactual
value does not equal the passedexpected
value.
- def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
Ensure that an expected exception is thrown by the passed function value.
Ensure that an expected exception is thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns
Succeeded
. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throwsTestFailedException
.Note that the type specified as this method's type parameter may represent any subtype of
AnyRef
, not justThrowable
or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such asString
, for example), this method will complete abruptly with aTestFailedException
.Also note that the difference between this method and
intercept
is that this method does not return the expected exception, so it does not let you perform further assertions on that exception. Instead, this method returnsSucceeded
, which means it can serve as the last statement in an async- or safe-style suite. It also indicates to the reader of the code that nothing further is expected about the thrown exception other than its type. The recommended usage is to useassertThrows
by default,intercept
only when you need to inspect the caught exception further.- f
the function value that should throw the expected exception
- classTag
an implicit
ClassTag
representing the type of the specified type parameter.- returns
the
Succeeded
singleton, if an exception of the expected type is thrown
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type.
- macro def assertTypeError(code: String)(implicit pos: Position): Assertion
Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.
Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.
Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's
Assertions
trait includes the following syntax for that purpose:assertTypeError("val a: String = 1")
Although
assertTypeError
is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string type checks, errors (i.e., snippets of code that do type check) are reported as test failures at runtime.Note that the difference between
assertTypeError
andassertDoesNotCompile
is thatassertDoesNotCompile
will succeed if the given code does not compile for any reason, whereasassertTypeError
will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example,assertDoesNotCompile
will return normally butassertTypeError
will throw aTestFailedException
.- code
the snippet of code that should not type check
- Definition Classes
- Assertions
- macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Assume that a boolean condition, described in
String
message
, is true.Assume that a boolean condition, described in
String
message
, is true. If the condition istrue
, this method returns normally. Else, it throwsTestCanceledException
with a helpful error message appended withString
obtained by invokingtoString
on the specifiedclue
as the exception's detail message.This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
- assume(a == b, "a good clue")
- assume(a != b, "a good clue")
- assume(a === b, "a good clue")
- assume(a !== b, "a good clue")
- assume(a > b, "a good clue")
- assume(a >= b, "a good clue")
- assume(a < b, "a good clue")
- assume(a <= b, "a good clue")
- assume(a startsWith "prefix", "a good clue")
- assume(a endsWith "postfix", "a good clue")
- assume(a contains "something", "a good clue")
- assume(a eq b, "a good clue")
- assume(a ne b, "a good clue")
- assume(a > 0 && b > 5, "a good clue")
- assume(a > 0 || b > 5, "a good clue")
- assume(a.isEmpty, "a good clue")
- assume(!a.isEmpty, "a good clue")
- assume(a.isInstanceOf[String], "a good clue")
- assume(a.length == 8, "a good clue")
- assume(a.size == 8, "a good clue")
- assume(a.exists(_ == 8), "a good clue")
At this time, any other form of expression will just get a
TestCanceledException
with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the===
that returnsBoolean
to be the default in tests. This makes===
consistent between tests and production code.- condition
the boolean condition to assume
- clue
An objects whose
toString
method returns a message to include in a failure report.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
ifmessage
isnull
.TestCanceledException
if the condition isfalse
.
- macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
Assume that a boolean condition is true.
Assume that a boolean condition is true. If the condition is
true
, this method returns normally. Else, it throwsTestCanceledException
.This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
- assume(a == b)
- assume(a != b)
- assume(a === b)
- assume(a !== b)
- assume(a > b)
- assume(a >= b)
- assume(a < b)
- assume(a <= b)
- assume(a startsWith "prefix")
- assume(a endsWith "postfix")
- assume(a contains "something")
- assume(a eq b)
- assume(a ne b)
- assume(a > 0 && b > 5)
- assume(a > 0 || b > 5)
- assume(a.isEmpty)
- assume(!a.isEmpty)
- assume(a.isInstanceOf[String])
- assume(a.length == 8)
- assume(a.size == 8)
- assume(a.exists(_ == 8))
At this time, any other form of expression will just get a
TestCanceledException
with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the===
that returnsBoolean
to be the default in tests. This makes===
consistent between tests and production code.- condition
the boolean condition to assume
- Definition Classes
- Assertions
- Exceptions thrown
TestCanceledException
if the condition isfalse
.
- 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
- Definition Classes
- FixtureAsyncFreeSpecLike
- def cancel(cause: Throwable)(implicit pos: Position): Nothing
Throws
TestCanceledException
, with the passedThrowable
cause, to indicate a test failed.Throws
TestCanceledException
, with the passedThrowable
cause, to indicate a test failed. ThegetMessage
method of the thrownTestCanceledException
will returncause.toString
.- cause
a
Throwable
that indicates the cause of the cancellation.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
ifcause
isnull
- def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
Throws
TestCanceledException
, with the passedString
message
as the exception's detail message andThrowable
cause, to indicate a test failed.Throws
TestCanceledException
, with the passedString
message
as the exception's detail message andThrowable
cause, to indicate a test failed.- message
A message describing the failure.
- cause
A
Throwable
that indicates the cause of the failure.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
ifmessage
orcause
isnull
- def cancel(message: String)(implicit pos: Position): Nothing
Throws
TestCanceledException
, with the passedString
message
as the exception's detail message, to indicate a test was canceled.Throws
TestCanceledException
, with the passedString
message
as the exception's detail message, to indicate a test was canceled.- message
A message describing the cancellation.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
ifmessage
isnull
- def cancel()(implicit pos: Position): Nothing
Throws
TestCanceledException
to indicate a test was canceled.Throws
TestCanceledException
to indicate a test was canceled.- 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]
Registers a block of code that produces any "futuristic" type (any type
F
for which an implicitFuturistic[F]
instance is implicitly available), returning an object that offers alastly
method.Registers a block of code that produces any "futuristic" type (any type
F
for which an implicitFuturistic[F]
instance is implicitly available), returning an object that offers alastly
method.See the main documentation for trait
CompleteLastly
for more detail.- completeBlock
cleanup code to execute whether the code passed to
complete
throws an exception or succesfully returns a futuristic value.
- Definition Classes
- CompleteLastly
- implicit def convertAssertionToFutureAssertion(assertion: compatible.Assertion): Future[compatible.Assertion]
Implicitly converts an
Assertion
to aFuture[Assertion]
.Implicitly converts an
Assertion
to aFuture[Assertion]
.This implicit conversion is used to allow synchronous tests to be included along with asynchronous tests in an
AsyncTestSuite
. It will be- assertion
the
Assertion
to convert- returns
a
Future[Assertion]
that has already completed successfully (containing theSucceeded
singleton).
- 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
- Definition Classes
- FixtureAsyncFreeSpecLike
- 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 = null, configMap: ConfigMap = ConfigMap.empty, color: Boolean = true, durations: Boolean = false, shortstacks: Boolean = false, fullstacks: Boolean = false, stats: Boolean = false): Unit
Executes one or more tests in this
Suite
, printing results to the standard output.Executes one or more tests in this
Suite
, printing results to the standard output.This method invokes
run
on itself, passing in values that can be configured via the parameters to this method, all of which have default values. This behavior is convenient when working with ScalaTest in the Scala interpreter. Here's a summary of this method's parameters and how you can use them:The
testName
parameterIf you leave
testName
at its default value (ofnull
), this method will passNone
to thetestName
parameter ofrun
, and as a result all the tests in this suite will be executed. If you specify atestName
, this method will passSome(testName)
torun
, and only that test will be run. Thus to run all tests in a suite from the Scala interpreter, you can write:scala> (new ExampleSuite).execute()
(The above syntax actually invokes the overloaded parameterless form of
execute
, which calls this form with its default parameter values.) To run just the test named"my favorite test"
in a suite from the Scala interpreter, you would write:scala> (new ExampleSuite).execute("my favorite test")
Or:
scala> (new ExampleSuite).execute(testName = "my favorite test")
The
configMap
parameterIf you provide a value for the
configMap
parameter, this method will pass it torun
. If not, the default value of an emptyMap
will be passed. For more information on how to use a config map to configure your test suites, see the config map section in the main documentation for this trait. Here's an example in which you configure a run with the name of an input file:scala> (new ExampleSuite).execute(configMap = Map("inputFileName" -> "in.txt")
The
color
parameterIf you leave the
color
parameter unspecified, this method will configure the reporter it passes torun
to print to the standard output in color (via ansi escape characters). If you don't want color output, specify false forcolor
, like this:scala> (new ExampleSuite).execute(color = false)
The
durations
parameterIf you leave the
durations
parameter unspecified, this method will configure the reporter it passes torun
to not print durations for tests and suites to the standard output. If you want durations printed, specify true fordurations
, like this:scala> (new ExampleSuite).execute(durations = true)
The
shortstacks
andfullstacks
parametersIf you leave both the
shortstacks
andfullstacks
parameters unspecified, this method will configure the reporter it passes torun
to not print stack traces for failed tests if it has a stack depth that identifies the offending line of test code. If you prefer a short stack trace (10 to 15 stack frames) to be printed with any test failure, specify true forshortstacks
:scala> (new ExampleSuite).execute(shortstacks = true)
For full stack traces, set
fullstacks
to true:scala> (new ExampleSuite).execute(fullstacks = true)
If you specify true for both
shortstacks
andfullstacks
, you'll get full stack traces.The
stats
parameterIf you leave the
stats
parameter unspecified, this method will not fireRunStarting
and eitherRunCompleted
orRunAborted
events to the reporter it passes torun
. If you specify true forstats
, this method will fire the run events to the reporter, and the reporter will print the expected test count before the run, and various statistics after, including the number of suites completed and number of tests that succeeded, failed, were ignored or marked pending. Here's how you get the stats:scala> (new ExampleSuite).execute(stats = true)
To summarize, this method will pass to
run
:testName
-None
if this method'stestName
parameter is left at its default value ofnull
, elseSome(testName)
.reporter
- a reporter that prints to the standard outputstopper
- aStopper
whoseapply
method always returnsfalse
filter
- aFilter
constructed withNone
fortagsToInclude
andSet()
fortagsToExclude
configMap
- theconfigMap
passed to this methoddistributor
-None
tracker
- a newTracker
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and can be used interchangably. The reason this method isn't named
run
is that it takes advantage of default arguments, and you can't mix overloaded methods and default arguments in Scala. (If namedrun
, this method would have the same name but different arguments than the mainrun
method that takes seven arguments. Thus it would overload and couldn't be used with default argument values.)Design note: This method has two "features" that may seem unidiomatic. First, the default value of
testName
isnull
. Normally in Scala the type oftestName
would beOption[String]
and the default value would beNone
, as it is in this trait'srun
method. Thenull
value is used here for two reasons. First, in ScalaTest 1.5,execute
was changed from four overloaded methods to one method with default values, taking advantage of the default and named parameters feature introduced in Scala 2.8. To not break existing source code,testName
needed to have typeString
, as it did in two of the overloadedexecute
methods prior to 1.5. The other reason is thatexecute
has always been designed to be called primarily from an interpeter environment, such as the Scala REPL (Read-Evaluate-Print-Loop). In an interpreter environment, minimizing keystrokes is king. AString
type with anull
default value lets users typesuite.execute("my test name")
rather thansuite.execute(Some("my test name"))
, saving several keystrokes.The second non-idiomatic feature is that
shortstacks
andfullstacks
are all lower case rather than camel case. This is done to be consistent with theShell
, which also uses those forms. The reason lower case is used in theShell
is to save keystrokes in an interpreter environment. Most Unix commands, for example, are all lower case, making them easier and quicker to type. In the ScalaTestShell
, methods likeshortstacks
,fullstacks
, andnostats
, etc., are designed to be all lower case so they feel more like shell commands than methods.- testName
the name of one test to run.
- configMap
a
Map
of key-value pairs that can be used by the executingSuite
of tests.- color
a boolean that configures whether output is printed in color
- durations
a boolean that configures whether test and suite durations are printed to the standard output
- shortstacks
a boolean that configures whether short stack traces should be printed for test failures
- fullstacks
a boolean that configures whether full stack traces should be printed for test failures
- stats
a boolean that configures whether test and suite statistics are printed to the standard output
- Definition Classes
- Suite
- Exceptions thrown
IllegalArgumentException
iftestName
is defined, but no test with the specified test name exists in thisSuite
NullArgumentException
if the passedconfigMap
parameter isnull
.
- implicit def executionContext: ExecutionContext
- Definition Classes
- AsyncTestSuite
- def expectedTestCount(filter: Filter): Int
The total number of tests that are expected to run when this
Suite
'srun
method is invoked.The total number of tests that are expected to run when this
Suite
'srun
method is invoked.This trait's implementation of this method returns the sum of:
- the size of the
testNames
List
, minus the number of tests marked as ignored and any tests that are exluded by the passedFilter
- the sum of the values obtained by invoking
expectedTestCount
on every nestedSuite
contained innestedSuites
- filter
a
Filter
with which to filter tests to count based on their tags
- Definition Classes
- Suite
- the size of the
- def fail(cause: Throwable)(implicit pos: Position): Nothing
Throws
TestFailedException
, with the passedThrowable
cause, to indicate a test failed.Throws
TestFailedException
, with the passedThrowable
cause, to indicate a test failed. ThegetMessage
method of the thrownTestFailedException
will returncause.toString
.- cause
a
Throwable
that indicates the cause of the failure.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
ifcause
isnull
- def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
Throws
TestFailedException
, with the passedString
message
as the exception's detail message andThrowable
cause, to indicate a test failed.Throws
TestFailedException
, with the passedString
message
as the exception's detail message andThrowable
cause, to indicate a test failed.- message
A message describing the failure.
- cause
A
Throwable
that indicates the cause of the failure.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
ifmessage
orcause
isnull
- def fail(message: String)(implicit pos: Position): Nothing
Throws
TestFailedException
, with the passedString
message
as the exception's detail message, to indicate a test failed.Throws
TestFailedException
, with the passedString
message
as the exception's detail message, to indicate a test failed.- message
A message describing the failure.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
ifmessage
isnull
- def fail()(implicit pos: Position): Nothing
Throws
TestFailedException
to indicate a test failed.Throws
TestFailedException
to indicate a test failed.- 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
Intercept and return an exception that's expected to be thrown by the passed function value.
Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws
TestFailedException
.Note that the type specified as this method's type parameter may represent any subtype of
AnyRef
, not justThrowable
or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such asString
, for example), this method will complete abruptly with aTestFailedException
.Also note that the difference between this method and
assertThrows
is that this method returns the expected exception, so it lets you perform further assertions on that exception. By contrast, theassertThrows
method returnsSucceeded
, which means it can serve as the last statement in an async- or safe-style suite.assertThrows
also indicates to the reader of the code that nothing further is expected about the thrown exception other than its type. The recommended usage is to useassertThrows
by default,intercept
only when you need to inspect the caught exception further.- f
the function value that should throw the expected exception
- classTag
an implicit
ClassTag
representing the type of the specified type parameter.- returns
the intercepted exception, if it is of the expected type
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type.
- 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]
An immutable
IndexedSeq
of thisSuite
object's nestedSuite
s.An immutable
IndexedSeq
of thisSuite
object's nestedSuite
s. If thisSuite
contains no nestedSuite
s, this method returns an emptyIndexedSeq
. This trait's implementation of this method returns an emptyList
.- 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
Throws
TestPendingException
to indicate a test is pending.Throws
TestPendingException
to indicate a test is pending.A pending test is one that has been given a name but is not yet implemented. The purpose of pending tests is to facilitate a style of testing in which documentation of behavior is sketched out before tests are written to verify that behavior (and often, the before the behavior of the system being tested is itself implemented). Such sketches form a kind of specification of what tests and functionality to implement later.
To support this style of testing, a test can be given a name that specifies one bit of behavior required by the system being tested. The test can also include some code that sends more information about the behavior to the reporter when the tests run. At the end of the test, it can call method
pending
, which will cause it to complete abruptly withTestPendingException
. Because tests in ScalaTest can be designated as pending withTestPendingException
, both the test name and any information sent to the reporter when running the test can appear in the report of a test run. (In other words, the code of a pending test is executed just like any other test.) However, because the test completes abruptly withTestPendingException
, the test will be reported as pending, to indicate the actual test, and possibly the functionality it is intended to test, has not yet been implemented.Note: This method always completes abruptly with a
TestPendingException
. Thus it always has a side effect. Methods with side effects are usually invoked with parentheses, as inpending()
. This method is defined as a parameterless method, in flagrant contradiction to recommended Scala style, because it forms a kind of DSL for pending tests. It enables tests in suites such asFunSuite
orFunSpec
to be denoted by placing "(pending)
" after the test name, as in:test("that style rules are not laws") (pending)
Readers of the code see "pending" in parentheses, which looks like a little note attached to the test name to indicate it is pending. Whereas "
(pending())
looks more like a method call, "(pending)
" lets readers stay at a higher level, forgetting how it is implemented and just focusing on the intent of the programmer who wrote the code.- Definition Classes
- Assertions
- def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
Execute the passed block of code, and if it completes abruptly, throw
TestPendingException
, else throwTestFailedException
.Execute the passed block of code, and if it completes abruptly, throw
TestPendingException
, else throwTestFailedException
.This method can be used to temporarily change a failing test into a pending test in such a way that it will automatically turn back into a failing test once the problem originally causing the test to fail has been fixed. At that point, you need only remove the
pendingUntilFixed
call. In other words, apendingUntilFixed
surrounding a block of code that isn't broken is treated as a test failure. The motivation for this behavior is to encourage people to removependingUntilFixed
calls when there are no longer needed.This method facilitates a style of testing in which tests are written before the code they test. Sometimes you may encounter a test failure that requires more functionality than you want to tackle without writing more tests. In this case you can mark the bit of test code causing the failure with
pendingUntilFixed
. You can then write more tests and functionality that eventually will get your production code to a point where the original test won't fail anymore. At this point the code block marked withpendingUntilFixed
will no longer throw an exception (because the problem has been fixed). This will in turn causependingUntilFixed
to throwTestFailedException
with a detail message explaining you need to go back and remove thependingUntilFixed
call as the problem orginally causing your test code to fail has been fixed.- f
a block of code, which if it completes abruptly, should trigger a
TestPendingException
- Definition Classes
- Assertions
- Exceptions thrown
TestPendingException
if the passed block of code completes abruptly with anException
orAssertionError
- def recoverToExceptionIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[T]
Transforms a future of any type into a
Future[T]
, whereT
is a given expected exception type, which succeeds if the given future completes with aFailure
containing the specified exception type.Transforms a future of any type into a
Future[T]
, whereT
is a given expected exception type, which succeeds if the given future completes with aFailure
containing the specified exception type.See the main documentation for this trait for more detail and examples.
- future
A future of any type, which you expect to fail with an exception of the specified type T
- returns
a Future[T] containing on success the expected exception, or containing on failure a
TestFailedException
- Definition Classes
- RecoverMethods
- def recoverToSucceededIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[compatible.Assertion]
Transforms a future of any type into a
Future[Assertion]
that succeeds if the future completes with aFailure
containing the specified exception type.Transforms a future of any type into a
Future[Assertion]
that succeeds if the future completes with aFailure
containing the specified exception type.See the main documentation for this trait for more detail and examples.
- future
A future of any type, which you expect to fail with an exception of the specified type T
- returns
a Future[Assertion] containing on success the
Succeeded
singleton, or containing on failure aTestFailedException
- Definition Classes
- RecoverMethods
- final def registerAsyncTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Future[compatible.Assertion])(implicit pos: Position): Unit
Registers a test.
Registers a test.
- testText
the test text
- testTags
the test tags
- testFun
the test function
- Definition Classes
- FixtureAsyncFreeSpecLike → FixtureAsyncTestRegistration
- final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Future[compatible.Assertion])(implicit pos: Position): Unit
Registers an ignored test.
Registers an ignored test.
- testText
the test text
- testTags
the test tags
- testFun
the test function
- Definition Classes
- FixtureAsyncFreeSpecLike → FixtureAsyncTestRegistration
- def rerunner: Option[String]
The fully qualified class name of the rerunner to rerun this suite.
The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.
- Definition Classes
- Suite
- def run(testName: Option[String], args: Args): Status
Runs this suite of tests.
Runs this suite of tests.
If
testName
isNone
, this trait's implementation of this method calls these two methods on this object in this order:runNestedSuites
runTests
If
testName
is defined, then this trait's implementation of this method callsrunTests
, but does not callrunNestedSuites
. This behavior is part of the contract of this method. Subclasses that overriderun
must take care not to callrunNestedSuites
iftestName
is defined. (TheOneInstancePerTest
trait depends on this behavior, for example.)Subclasses and subtraits that override this
run
method can implement them without invoking either therunTests
orrunNestedSuites
methods, which are invoked by this trait's implementation of this method. It is recommended, but not required, that subclasses and subtraits that overriderun
in a way that does not invokerunNestedSuites
also overriderunNestedSuites
and make it final. Similarly it is recommended, but not required, that subclasses and subtraits that overriderun
in a way that does not invokerunTests
also overriderunTests
(andrunTest
, which this trait's implementation ofrunTests
calls) and make it final. The implementation of these final methods can either invoke the superclass implementation of the method, or throw anUnsupportedOperationException
if appropriate. The reason for this recommendation is that ScalaTest includes several traits that override these methods to allow behavior to be mixed into aSuite
. For example, traitBeforeAndAfterEach
overridesrunTests
s. In aSuite
subclass that no longer invokesrunTests
fromrun
, theBeforeAndAfterEach
trait is not applicable. Mixing it in would have no effect. By makingrunTests
final in such aSuite
subtrait, you make the attempt to mixBeforeAndAfterEach
into a subclass of your subtrait a compiler error. (It would fail to compile with a complaint thatBeforeAndAfterEach
is trying to overriderunTests
, which is a final method in your trait.)- 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 and nested suites started by this method have completed, and whether or not a failure occurred.
- Definition Classes
- FixtureAsyncFreeSpecLike → Suite
- Exceptions thrown
IllegalArgumentException
iftestName
is defined, but no test with the specified test name exists in thisSuite
NullArgumentException
if any passed parameter isnull
.
- def runNestedSuites(args: Args): Status
Run zero to many of this
Suite
's nestedSuite
s.Run zero to many of this
Suite
's nestedSuite
s.If the passed
distributor
isNone
, this trait's implementation of this method invokesrun
on each nestedSuite
in theList
obtained by invokingnestedSuites
. If a nestedSuite
'srun
method completes abruptly with an exception, this trait's implementation of this method reports that theSuite
aborted and attempts to run the next nestedSuite
. If the passeddistributor
is defined, this trait's implementation puts each nestedSuite
into theDistributor
contained in theSome
, in the order in which theSuite
s appear in theList
returned bynestedSuites
, passing in a newTracker
obtained by invokingnextTracker
on theTracker
passed to this method.Implementations of this method are responsible for ensuring
SuiteStarting
events are fired to theReporter
before executing any nestedSuite
, and eitherSuiteCompleted
orSuiteAborted
after executing any nestedSuite
.- args
the
Args
for this run- returns
a
Status
object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Definition Classes
- Suite
- Exceptions thrown
NullArgumentException
if any passed parameter isnull
.
- 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
The
Succeeded
singleton.The
Succeeded
singleton.You can use
succeed
to solve a type error when an async test does not end in eitherFuture[Assertion]
orAssertion
. BecauseAssertion
is a type alias forSucceeded.type
, puttingsucceed
at the end of a test body (or at the end of a function being used to map the final future of a test body) will solve the type error.- Definition Classes
- Assertions
- def suiteId: String
A string ID for this
Suite
that is intended to be unique among all suites reported during a run.A string ID for this
Suite
that is intended to be unique among all suites reported during a run.This trait's implementation of this method returns the fully qualified name of this object's class. Each suite reported during a run will commonly be an instance of a different
Suite
class, and in such cases, this default implementation of this method will suffice. However, in special cases you may need to override this method to ensure it is unique for each reported suite. For example, if you write aSuite
subclass that reads in a file whose name is passed to its constructor and dynamically creates a suite of tests based on the information in that file, you will likely need to override this method in yourSuite
subclass, perhaps by appending the pathname of the file to the fully qualified class name. That way if you run a suite of tests based on a directory full of these files, you'll have unique suite IDs for each reported suite.The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
- returns
this
Suite
object's ID.
- Definition Classes
- Suite
- def suiteName: String
A user-friendly suite name for this
Suite
.A user-friendly suite name for this
Suite
.This trait's implementation of this method returns the simple name of this object's class. This trait's implementation of
runNestedSuites
calls this method to obtain a name forReport
s to pass to thesuiteStarting
,suiteCompleted
, andsuiteAborted
methods of theReporter
.- returns
this
Suite
object's suite name.
- 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
Provides a
TestData
instance for the passed test name, given the passed config map.Provides a
TestData
instance for the passed test name, given the passed config map.This method is used to obtain a
TestData
instance to pass towithFixture(NoArgTest)
andwithFixture(OneArgTest)
and thebeforeEach
andafterEach
methods of traitBeforeAndAfterEach
.- testName
the name of the test for which to return a
TestData
instance- theConfigMap
the config map to include in the returned
TestData
- returns
a
TestData
instance for the specified test, which includes the specified config map
- 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
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
- FixtureAsyncFreeSpec → 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
Executes the block of code passed as the second parameter, and, if it completes abruptly with a
ModifiableMessage
exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it.Executes the block of code passed as the second parameter, and, if it completes abruptly with a
ModifiableMessage
exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:
withClue("(Employee's name was: " + employee.name + ")") { intercept[IllegalArgumentException] { employee.getTask(-1) } }
If an invocation of
intercept
completed abruptly with an exception, the resulting message would be something like:(Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentException
if the passedclue
isnull
- def withFixture(test: NoArgAsyncTest): FutureOutcome
Run the passed test function in the context of a fixture established by this method.
Run the passed test function in the context of a fixture established by this method.
This method should set up the fixture needed by the tests of the current suite, invoke the test function, and if needed, register a callback on the resulting
FutureOutcome
to perform any clean up needed after the test completes. Because theNoArgAsyncTest
function passed to this method takes no parameters, preparing the fixture will require side effects, such as reassigning instancevar
s in thisSuite
or initializing a globally accessible external database. If you want to avoid reassigning instancevar
s you can use FixtureAsyncTestSuite.This trait's implementation of
runTest
invokes this method for each test, passing in aNoArgAsyncTest
whoseapply
method will execute the code of the test and returns its result.This trait's implementation of this method simply invokes the passed
NoArgAsyncTest
function.- test
the no-arg async test function to run with a fixture
- 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.