FixtureAsyncFlatSpec
A sister class to org.scalatest.flatspec.AsyncFlatSpec
that can pass a fixture object into its tests.
Recommended Usage:
Use class FixtureAsyncFlatSpec in situations for which AsyncFlatSpec
would be a good choice, when all or most tests need the same fixture objects
that must be cleaned up afterwards. Note: FixtureAsyncFlatSpec is intended for use in special situations, with class AsyncFlatSpec used for general needs. For
more insight into where FixtureAsyncFlatSpec fits in the big picture, see the withFixture(OneArgAsyncTest) subsection of the Shared fixtures section in the documentation for class AsyncFlatSpec .
|
Class FixtureAsyncFlatSpec
behaves similarly to class org.scalatest.flatspec.AsyncFlatSpec
, 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.flatspec.AsyncFlatSpec
:
-
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.asyncflatspec.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 flatspec.FixtureAsyncFlatSpec { 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!") } } it 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.asyncflatspec.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 flatspec.FixtureAsyncFlatSpec with DbFixture { override def populateDb(db: Db) { // setup the fixture db.append("ScalaTest is ") } "Testing" should "should be easy" in { db => Future { db.append("easy!") assert(db.toString === "ScalaTest is easy!") } } it should "be fun" in { db => Future { db.append("fun!") assert(db.toString === "ScalaTest is fun!") } } // This test doesn't need a Db "Test 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.
Type members
Inherited classlikes
Class that supports the registration of a “subject” being specified and tested via the
instance referenced from FixtureAsyncFlatSpec
's behavior
field.
Class that supports the registration of a “subject” being specified and tested via the
instance referenced from FixtureAsyncFlatSpec
's behavior
field.
This field enables syntax such as the following subject registration:
behavior of "A Stack" ^
For more information and examples of the use of the behavior
field, see the main documentation
for trait AnyFlatSpec
.
- Inherited from:
- FixtureAsyncFlatSpecLike
Class used via an implicit conversion to enable two objects to be compared with
===
and !==
with a Boolean
result and an enforced type constraint between
two object types. For example:
Class used via an implicit conversion to enable two objects to be compared with
===
and !==
with a Boolean
result and an enforced type constraint between
two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
- Value parameters:
- leftSide
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
- Inherited from:
- TripleEqualsSupport
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with a Boolean
result and no enforced type constraint between
two object types. For example:
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with a Boolean
result and no enforced type constraint between
two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
- Value parameters:
- leftSide
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
- Inherited from:
- TripleEqualsSupport
Class that supports registration of ignored tests via the IgnoreWord
instance referenced
from FixtureAsyncFlatSpec
's ignore
field.
Class that supports registration of ignored tests via the IgnoreWord
instance referenced
from FixtureAsyncFlatSpec
's ignore
field.
This class enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
In addition, it enables syntax such as the following registration of an ignored, pending test:
ignore should "pop values in last-in-first-out order" is (pending) ^
Note: the is
method is provided for completeness and design symmetry, given there's no way
to prevent changing is
to ignore
and marking a pending test as ignored that way.
Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
And finally, it also enables syntax such as the following ignored, tagged test registration:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the ignore
field, see the Ignored tests section
in the main documentation for trait AnyFlatSpec
.
- Value parameters:
- name
the name
- verb
the verb
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports registration of ignored, tagged tests via the IgnoreWord
instance referenced
from FixtureAsyncFlatSpec
's ignore
field.
Class that supports registration of ignored, tagged tests via the IgnoreWord
instance referenced
from FixtureAsyncFlatSpec
's ignore
field.
This class enables syntax such as the following registration of an ignored, tagged test:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
In addition, it enables syntax such as the following registration of an ignored, tagged, pending test:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
Note: the is
method is provided for completeness and design symmetry, given there's no way
to prevent changing is
to ignore
and marking a pending test as ignored that way.
Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
For more information and examples of the use of the ignore
field, see
the Ignored tests section
in the main documentation for trait AnyFlatSpec
. For examples of tagged test registration, see
the Tagging tests section in the main documentation for trait AnyFlatSpec
.
- Value parameters:
- name
the name
- tags
the list of tags
- verb
the verb
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports registration of ignored tests via the instance referenced from FixtureAsyncFlatSpec
's ignore
field.
Class that supports registration of ignored tests via the instance referenced from FixtureAsyncFlatSpec
's ignore
field.
This class enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
For more information and examples of the use of the ignore
field, see Ignored tests section
in the main documentation for this trait.
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports test registration in shorthand form.
Class that supports test registration in shorthand form.
For example, this class enables syntax such as the following test registration in shorthand form:
"A Stack (when empty)" should "be empty" in { ... } ^
This class also enables syntax such as the following ignored test registration in shorthand form:
"A Stack (when empty)" should "be empty" ignore { ... } ^
This class is used via an implicit conversion (named convertToInAndIgnoreMethods
)
from ResultOfStringPassedToVerb
. The ResultOfStringPassedToVerb
class
does not declare any methods named in
, because the
type passed to in
differs in a AsyncFlatSpec
and a org.scalatest.flatspec.FixtureAsyncFlatSpec
.
A org.scalatest.flatspec.FixtureAsyncFlatSpec
needs two in
methods, one that takes a no-arg
test function and another that takes a one-arg test function (a test that takes a
FixtureParam
as its parameter). By constrast, a AsyncFlatSpec
needs
only one in
method that takes a by-name parameter. As a result,
AsyncFlatSpec
and org.scalatest.flatspec.FixtureAsyncFlatSpec
each provide an implicit conversion
from ResultOfStringPassedToVerb
to a type that provides the appropriate
in
methods.
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports tagged test registration in shorthand form.
Class that supports tagged test registration in shorthand form.
For example, this class enables syntax such as the following tagged test registration in shorthand form:
"A Stack (when empty)" should "be empty" taggedAs() in { ... } ^
This class also enables syntax such as the following tagged, ignored test registration in shorthand form:
"A Stack (when empty)" should "be empty" taggedAs(SlowTest) ignore { ... } ^
This class is used via an implicit conversion (named convertToInAndIgnoreMethodsAfterTaggedAs
)
from ResultOfTaggedAsInvocation
. The ResultOfTaggedAsInvocation
class
does not declare any methods named in
, because the
type passed to in
differs in a AsyncFlatSpec
and a FixtureAsyncFlatSpec
.
A FixtureAsyncFlatSpec
needs two in
methods, one that takes a no-arg
test function and another that takes a one-arg test function (a test that takes a
FixtureParam
as its parameter). By constrast, a AsyncFlatSpec
needs
only one in
method that takes a by-name parameter. As a result,
AsyncFlatSpec
and FixtureAsyncFlatSpec
each provide an implicit conversion
from ResultOfTaggedAsInvocation
to a type that provides the appropriate
in
methods.
- Value parameters:
- resultOfTaggedAsInvocation
an
ResultOfTaggedAsInvocation
instance
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports test registration via the instance referenced from FixtureAnyFlatSpec
's it
field.
Class that supports test registration via the instance referenced from FixtureAnyFlatSpec
's it
field.
This class enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following registration of an ignored test:
it should "pop values in last-in-first-out order" ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending test:
it should "pop values in last-in-first-out order" is (pending) ^
And finally, it also enables syntax such as the following tagged test registration:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the it
field, see the main documentation
for trait AnyFlatSpec
.
- Value parameters:
- name
the name
- verb
the verb
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports the registration of tagged tests via the ItWord
instance
referenced from FixtureAsyncFlatSpec
's it
field.
Class that supports the registration of tagged tests via the ItWord
instance
referenced from FixtureAsyncFlatSpec
's it
field.
This class enables syntax such as the following tagged test registration:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
It also enables syntax such as the following registration of an ignored, tagged test:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending, tagged test:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
For more information and examples of the use of the it
field to register tagged tests, see
the Tagging tests section in the main documentation for trait AnyFlatSpec
.
- Value parameters:
- name
the name
- tags
the list of tags
- verb
the verb
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec
's it
field.
Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec
's it
field.
This class enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation
for trait AnyFlatSpec
.
- Inherited from:
- FixtureAsyncFlatSpecLike
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
.
- Inherited from:
- AsyncTestSuite
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
.
- Inherited from:
- FixtureAsyncTestSuite
Class that provides the lastly
method of the complete
-lastly
syntax.
Class that provides the lastly
method of the complete
-lastly
syntax.
- Value parameters:
- futuristic
the futuristic typeclass instance
- futuristicBlock
a by-name that produces a futuristic type
- Inherited from:
- CompleteLastly
This class supports the syntax of FlatSpec
, WordSpec
, fixture.FlatSpec
,
and fixture.WordSpec
.
This class supports the syntax of FlatSpec
, WordSpec
, fixture.FlatSpec
,
and fixture.WordSpec
.
This class is used in conjunction with an implicit conversion to enable can
methods to
be invoked on String
s.
- Inherited from:
- CanVerb
This class supports the syntax of FlatSpec
, WordSpec
, fixture.FlatSpec
,
and fixture.WordSpec
.
This class supports the syntax of FlatSpec
, WordSpec
, fixture.FlatSpec
,
and fixture.WordSpec
.
This class is used in conjunction with an implicit conversion to enable must
methods to
be invoked on String
s.
- Inherited from:
- MustVerb
This class supports the syntax of FlatSpec
, WordSpec
, fixture.FlatSpec
,
and fixture.WordSpec
.
This class supports the syntax of FlatSpec
, WordSpec
, fixture.FlatSpec
,
and fixture.WordSpec
.
This class is used in conjunction with an implicit conversion to enable should
methods to
be invoked on String
s.
- Inherited from:
- ShouldVerb
Class that supports test registration via the instance referenced from FixtureAsyncFlatSpec
's it
field.
Class that supports test registration via the instance referenced from FixtureAsyncFlatSpec
's it
field.
This class enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following registration of an ignored test:
they should "pop values in last-in-first-out order" ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending test:
they should "pop values in last-in-first-out order" is (pending) ^
And finally, it also enables syntax such as the following tagged test registration:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the it
field, see the main documentation
for trait AnyFlatSpec
.
- Value parameters:
- name
the name
- verb
the verb
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports the registration of tagged tests via the TheyWord
instance
referenced from FixtureAsyncFlatSpec
's they
field.
Class that supports the registration of tagged tests via the TheyWord
instance
referenced from FixtureAsyncFlatSpec
's they
field.
This class enables syntax such as the following tagged test registration:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
It also enables syntax such as the following registration of an ignored, tagged test:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending, tagged test:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
For more information and examples of the use of the it
field to register tagged tests, see
the Tagging tests section in the main documentation for trait AnyFlatSpec
.
- Value parameters:
- name
the name
- tags
the list of tags
- verb
the verb
- Inherited from:
- FixtureAsyncFlatSpecLike
Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec
's they
field.
Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec
's they
field.
This class enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation
for trait AnyFlatSpec
.
- Inherited from:
- FixtureAsyncFlatSpecLike
Value members
Concrete methods
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
- Any
Inherited methods
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should !== (<pivot> +- <tolerance>)
”
syntax of Matchers
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should !== (<pivot> +- <tolerance>)
”
syntax of Matchers
.
- Value parameters:
- right
the
Spread[T]
against which to compare the left-hand value
- Returns:
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should !== null
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should !== null
” syntax
of Matchers
.
- Value parameters:
- right
a null reference
- Returns:
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should !== <right>
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should !== <right>
” syntax
of Matchers
.
- Value parameters:
- right
the right-hand side value for an equality assertion
- Returns:
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should === (<pivot> +- <tolerance>)
”
syntax of Matchers
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should === (<pivot> +- <tolerance>)
”
syntax of Matchers
.
- Value parameters:
- right
the
Spread[T]
against which to compare the left-hand value
- Returns:
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should === null
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should === null
” syntax
of Matchers
.
- Value parameters:
- right
a null reference
- Returns:
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should === <right>
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should === <right>
” syntax
of Matchers
.
- Value parameters:
- right
the right-hand side value for an equality assertion
- Returns:
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
Returns an Alerter
that during test execution will forward strings (and other objects) passed to its
apply
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 this
FixtureAsyncFlatSpec
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.
Returns an Alerter
that during test execution will forward strings (and other objects) passed to its
apply
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 this
FixtureAsyncFlatSpec
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.
- Inherited from:
- FixtureAsyncFlatSpecLike
Assert that a boolean condition, described in String
message
, is true.
If the condition is true
, this method returns normally.
Else, it throws TestFailedException
with a helpful error message
appended with the String
obtained by invoking toString
on the
specified clue
as the exception's detail message.
Assert that a boolean condition, described in String
message
, is true.
If the condition is true
, this method returns normally.
Else, it throws TestFailedException
with a helpful error message
appended with the String
obtained by invoking toString
on the
specified clue
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 returns Boolean
to be the default in tests. This makes ===
consistent between tests and production
code.
- Value parameters:
- clue
An objects whose
toString
method returns a message to include in a failure report.- condition
the boolean condition to assert
- Throws:
- NullArgumentException
if
message
isnull
.- TestFailedException
if the condition is
false
.
- Inherited from:
- Assertions
Assert that a boolean condition is true.
If the condition is true
, this method returns normally.
Else, it throws TestFailedException
.
Assert that a boolean condition is true.
If the condition is true
, this method returns normally.
Else, it throws TestFailedException
.
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 returns Boolean
to be the default in tests. This makes ===
consistent between tests and production
code.
- Value parameters:
- condition
the boolean condition to assert
- Throws:
- TestFailedException
if the condition is
false
.
- Inherited from:
- Assertions
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.
- Value parameters:
- code
the snippet of code that should compile
- Inherited from:
- Assertions
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
and assertDoesNotCompile
is
that assertDoesNotCompile
will succeed if the given code does not compile for any reason,
whereas assertTypeError
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 but assertTypeError
will throw a TestFailedException
.
- Value parameters:
- code
the snippet of code that should not type check
- Inherited from:
- Assertions
Assert that the value passed as expected
equals the value passed as actual
.
If the actual
value equals the expected
value
(as determined by ==
), assertResult
returns
normally. Else, assertResult
throws a
TestFailedException
whose detail message includes the expected and actual values.
Assert that the value passed as expected
equals the value passed as actual
.
If the actual
value equals the expected
value
(as determined by ==
), assertResult
returns
normally. Else, assertResult
throws a
TestFailedException
whose detail message includes the expected and actual values.
- Value parameters:
- actual
the actual value, which should equal the passed
expected
value- expected
the expected value
- Throws:
- TestFailedException
if the passed
actual
value does not equal the passedexpected
value.
- Inherited from:
- Assertions
Assert that the value passed as expected
equals the value passed as actual
.
If the actual
equals the expected
(as determined by ==
), assertResult
returns
normally. Else, if actual
is not equal to expected
, assertResult
throws a
TestFailedException
whose detail message includes the expected and actual values, as well as the String
obtained by invoking toString
on the passed clue
.
Assert that the value passed as expected
equals the value passed as actual
.
If the actual
equals the expected
(as determined by ==
), assertResult
returns
normally. Else, if actual
is not equal to expected
, assertResult
throws a
TestFailedException
whose detail message includes the expected and actual values, as well as the String
obtained by invoking toString
on the passed clue
.
- Value parameters:
- actual
the actual value, which should equal the passed
expected
value- clue
An object whose
toString
method returns a message to include in a failure report.- expected
the expected value
- Throws:
- TestFailedException
if the passed
actual
value does not equal the passedexpected
value.
- Inherited from:
- Assertions
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 throws TestFailedException
.
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 throws TestFailedException
.
Note that the type specified as this method's type parameter may represent any subtype of
AnyRef
, not just Throwable
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 as String
,
for example), this method will complete abruptly with a TestFailedException
.
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 returns Succeeded
, 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 use assertThrows
by default, intercept
only when you
need to inspect the caught exception further.
- Value parameters:
- classTag
an implicit
ClassTag
representing the type of the specified type parameter.- f
the function value that should throw the expected exception
- Returns:
the
Succeeded
singleton, if an exception of the expected type is thrown- Throws:
- TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type.
- Inherited from:
- Assertions
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
and assertDoesNotCompile
is
that assertDoesNotCompile
will succeed if the given code does not compile for any reason,
whereas assertTypeError
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 but assertTypeError
will throw a TestFailedException
.
- Value parameters:
- code
the snippet of code that should not type check
- Inherited from:
- Assertions
Assume that a boolean condition, described in String
message
, is true.
If the condition is true
, this method returns normally.
Else, it throws TestCanceledException
with a helpful error message
appended with String
obtained by invoking toString
on the
specified clue
as the exception's detail message.
Assume that a boolean condition, described in String
message
, is true.
If the condition is true
, this method returns normally.
Else, it throws TestCanceledException
with a helpful error message
appended with String
obtained by invoking toString
on the
specified clue
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 returns Boolean
to be the default in tests. This makes ===
consistent between tests and production
code.
- Value parameters:
- clue
An objects whose
toString
method returns a message to include in a failure report.- condition
the boolean condition to assume
- Throws:
- NullArgumentException
if
message
isnull
.- TestCanceledException
if the condition is
false
.
- Inherited from:
- Assertions
Assume that a boolean condition is true.
If the condition is true
, this method returns normally.
Else, it throws TestCanceledException
.
Assume that a boolean condition is true.
If the condition is true
, this method returns normally.
Else, it throws TestCanceledException
.
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 returns Boolean
to be the default in tests. This makes ===
consistent between tests and production
code.
- Value parameters:
- condition
the boolean condition to assume
- Throws:
- TestCanceledException
if the condition is
false
.
- Inherited from:
- Assertions
Throws TestCanceledException
, with the passed
Throwable
cause, to indicate a test failed.
The getMessage
method of the thrown TestCanceledException
will return cause.toString
.
Throws TestCanceledException
, with the passed
Throwable
cause, to indicate a test failed.
The getMessage
method of the thrown TestCanceledException
will return cause.toString
.
- Value parameters:
- cause
a
Throwable
that indicates the cause of the cancellation.
- Throws:
- NullArgumentException
if
cause
isnull
- Inherited from:
- Assertions
Throws TestCanceledException
, with the passed
String
message
as the exception's detail
message and Throwable
cause, to indicate a test failed.
Throws TestCanceledException
, with the passed
String
message
as the exception's detail
message and Throwable
cause, to indicate a test failed.
- Value parameters:
- cause
A
Throwable
that indicates the cause of the failure.- message
A message describing the failure.
- Throws:
- NullArgumentException
if
message
orcause
isnull
- Inherited from:
- Assertions
Throws TestCanceledException
, with the passed
String
message
as the exception's detail
message, to indicate a test was canceled.
Throws TestCanceledException
, with the passed
String
message
as the exception's detail
message, to indicate a test was canceled.
- Value parameters:
- message
A message describing the cancellation.
- Throws:
- NullArgumentException
if
message
isnull
- Inherited from:
- Assertions
Throws TestCanceledException
to indicate a test was canceled.
Throws TestCanceledException
to indicate a test was canceled.
- Inherited from:
- Assertions
Registers a block of code that produces any "futuristic" type (any type F
for which
an implicit Futuristic[F]
instance is implicitly available), returning
an object that offers a lastly
method.
Registers a block of code that produces any "futuristic" type (any type F
for which
an implicit Futuristic[F]
instance is implicitly available), returning
an object that offers a lastly
method.
See the main documentation for trait CompleteLastly
for more detail.
- Value parameters:
- completeBlock
cleanup code to execute whether the code passed to
complete
throws an exception or succesfully returns a futuristic value.
- Inherited from:
- CompleteLastly
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
Returns an Equality[A]
for any type A
that determines equality
by first calling .deep
on any Array
(on either the left or right side),
then comparing the resulting objects with ==
.
Returns an Equality[A]
for any type A
that determines equality
by first calling .deep
on any Array
(on either the left or right side),
then comparing the resulting objects with ==
.
- Returns:
a default
Equality
for typeA
- Inherited from:
- TripleEqualsSupport
The total number of tests that are expected to run when this Suite
's run
method is invoked.
The total number of tests that are expected to run when this Suite
's run
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
- Value parameters:
- filter
a
Filter
with which to filter tests to count based on their tags
- Inherited from:
- Suite
Throws TestFailedException
, with the passed
Throwable
cause, to indicate a test failed.
The getMessage
method of the thrown TestFailedException
will return cause.toString
.
Throws TestFailedException
, with the passed
Throwable
cause, to indicate a test failed.
The getMessage
method of the thrown TestFailedException
will return cause.toString
.
- Value parameters:
- cause
a
Throwable
that indicates the cause of the failure.
- Throws:
- NullArgumentException
if
cause
isnull
- Inherited from:
- Assertions
Throws TestFailedException
, with the passed
String
message
as the exception's detail
message and Throwable
cause, to indicate a test failed.
Throws TestFailedException
, with the passed
String
message
as the exception's detail
message and Throwable
cause, to indicate a test failed.
- Value parameters:
- cause
A
Throwable
that indicates the cause of the failure.- message
A message describing the failure.
- Throws:
- NullArgumentException
if
message
orcause
isnull
- Inherited from:
- Assertions
Throws TestFailedException
, with the passed
String
message
as the exception's detail
message, to indicate a test failed.
Throws TestFailedException
, with the passed
String
message
as the exception's detail
message, to indicate a test failed.
- Value parameters:
- message
A message describing the failure.
- Throws:
- NullArgumentException
if
message
isnull
- Inherited from:
- Assertions
Throws TestFailedException
to indicate a test failed.
Throws TestFailedException
to indicate a test failed.
- Inherited from:
- Assertions
Returns an Informer
that during test execution will forward strings passed to its
apply
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, as recordedEvents
of the test completed event, such as TestSucceeded
. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
Returns an Informer
that during test execution will forward strings passed to its
apply
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, as recordedEvents
of the test completed event, such as TestSucceeded
. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
- Inherited from:
- FixtureAsyncFlatSpecLike
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
.
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 just Throwable
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 as String
,
for example), this method will complete abruptly with a TestFailedException
.
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, the assertThrows
method returns Succeeded
, 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 use assertThrows
by default, intercept
only when you
need to inspect the caught exception further.
- Value parameters:
- classTag
an implicit
ClassTag
representing the type of the specified type parameter.- f
the function value that should throw the expected exception
- Returns:
the intercepted exception, if it is of the expected type
- Throws:
- TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type.
- Inherited from:
- Assertions
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
Returns a Documenter
that during test execution will forward strings passed to its
apply
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, as recordedEvents
of the test completed event, such as TestSucceeded
. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
Returns a Documenter
that during test execution will forward strings passed to its
apply
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, as recordedEvents
of the test completed event, such as TestSucceeded
. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
- Inherited from:
- FixtureAsyncFlatSpecLike
An immutable IndexedSeq
of this Suite
object's nested Suite
s. If this Suite
contains no nested Suite
s,
this method returns an empty IndexedSeq
. This trait's implementation of this method returns an empty List
.
An immutable IndexedSeq
of this Suite
object's nested Suite
s. If this Suite
contains no nested Suite
s,
this method returns an empty IndexedSeq
. This trait's implementation of this method returns an empty List
.
- Inherited from:
- Suite
Returns a Notifier
that during test execution will forward strings (and other objects) passed to its
apply
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 this
FixtureAsyncFlatSpec
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.
Returns a Notifier
that during test execution will forward strings (and other objects) passed to its
apply
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 this
FixtureAsyncFlatSpec
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.
- Inherited from:
- FixtureAsyncFlatSpecLike
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 with TestPendingException
.
Because tests in ScalaTest can be designated as pending with TestPendingException
, 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
with TestPendingException
, 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 in pending()
. 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 as FunSuite
or FunSpec
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.
- Inherited from:
- Assertions
Execute the passed block of code, and if it completes abruptly, throw TestPendingException
, else
throw TestFailedException
.
Execute the passed block of code, and if it completes abruptly, throw TestPendingException
, else
throw TestFailedException
.
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, a
pendingUntilFixed
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 remove pendingUntilFixed
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 with pendingUntilFixed
will no longer throw an exception (because the
problem has been fixed). This will in turn cause pendingUntilFixed
to throw TestFailedException
with a detail message explaining you need to go back and remove the pendingUntilFixed
call as the problem orginally
causing your test code to fail has been fixed.
- Value parameters:
- f
a block of code, which if it completes abruptly, should trigger a
TestPendingException
- Throws:
- TestPendingException
if the passed block of code completes abruptly with an
Exception
orAssertionError
- Inherited from:
- Assertions
Transforms a future of any type into a Future[T]
, where T
is a given
expected exception type, which succeeds if the given future
completes with a Failure
containing the specified exception type.
Transforms a future of any type into a Future[T]
, where T
is a given
expected exception type, which succeeds if the given future
completes with a Failure
containing the specified exception type.
See the main documentation for this trait for more detail and examples.
- Value parameters:
- 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
- Inherited from:
- RecoverMethods
Transforms a future of any type into a Future[Assertion]
that succeeds if the future
completes with a Failure
containing the specified exception type.
Transforms a future of any type into a Future[Assertion]
that succeeds if the future
completes with a Failure
containing the specified exception type.
See the main documentation for this trait for more detail and examples.
- Value parameters:
- 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
- Inherited from:
- RecoverMethods
- Inherited from:
- FixtureAsyncFlatSpecLike
- Inherited from:
- FixtureAsyncFlatSpecLike
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.
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.
- Inherited from:
- Suite
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
for testNames
for an example.)
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
for testNames
for an example.)
- Value parameters:
- args
the
Args
for this test- testName
the name of one test to execute.
- Returns:
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .- Throws:
- NullArgumentException
if
testName
orargs
isnull
.
- Definition Classes
- Inherited from:
- FixtureAsyncFlatSpecLike
Run zero to many of this FixtureAsyncFlatSpec
's tests.
Run zero to many of this FixtureAsyncFlatSpec
's tests.
This method takes a testName
parameter that optionally specifies a test to invoke.
If testName
is Some
, this trait's implementation of this method
invokes runTest
on this object with passed args
.
This method takes an args
that contains a Set
of tag names that should be included (tagsToInclude
), and a Set
that should be excluded (tagsToExclude
), when deciding which of this Suite
's tests to execute.
If tagsToInclude
is empty, all tests will be executed
except those those belonging to tags listed in the tagsToExclude
Set
. If tagsToInclude
is non-empty, only tests
belonging to tags mentioned in tagsToInclude
, and not mentioned in tagsToExclude
will be executed. However, if testName
is Some
, tagsToInclude
and tagsToExclude
are essentially ignored.
Only if testName
is None
will tagsToInclude
and tagsToExclude
be consulted to
determine which of the tests named in the testNames
Set
should be run. For more information on trait tags, see the main documentation for this trait.
If testName
is None
, this trait's implementation of this method
invokes testNames
on this Suite
to get a Set
of names of tests to potentially execute.
(A testNames
value of None
essentially acts as a wildcard that means all tests in
this Suite
that are selected by tagsToInclude
and tagsToExclude
should be executed.)
For each test in the testName
Set
, in the order
they appear in the iterator obtained by invoking the elements
method on the Set
, this trait's implementation
of this method checks whether the test should be run based on the tagsToInclude
and tagsToExclude
Set
s.
If so, this implementation invokes runTest
with the passed args
.
- Value parameters:
- args
the
Args
for this run- 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 thisFixtureAsyncFlatSpecLike
.
- Returns:
a
Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.- Throws:
- NullArgumentException
if any of
testName
orargs
isnull
.
- Definition Classes
- FixtureAsyncFlatSpecLike -> Suite
- Inherited from:
- FixtureAsyncFlatSpecLike
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
a Suite
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 your Suite
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.- Inherited from:
- Suite
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 for Report
s to pass to the suiteStarting
, suiteCompleted
,
and suiteAborted
methods of the Reporter
.
- Returns:
this
Suite
object's suite name.- Inherited from:
- Suite
A Map
whose keys are String
tag names to which tests in this FixtureAsyncFlatSpec
belong, and values
the Set
of test names that belong to each tag. If this FixtureAsyncFlatSpec
contains no tags, this method returns an empty Map
.
A Map
whose keys are String
tag names to which tests in this FixtureAsyncFlatSpec
belong, and values
the Set
of test names that belong to each tag. If this FixtureAsyncFlatSpec
contains no tags, this method returns an empty Map
.
This trait's implementation returns tags that were passed as strings contained in Tag
objects passed to
methods test
and ignore
.
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
- FixtureAsyncFlatSpecLike -> Suite
- Inherited from:
- FixtureAsyncFlatSpecLike
An immutable Set
of test names. If this FixtureAsyncFlatSpec
contains no tests, this method returns an
empty Set
.
An immutable Set
of test names. If this FixtureAsyncFlatSpec
contains no tests, this method returns an
empty Set
.
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
- FixtureAsyncFlatSpecLike -> Suite
- Inherited from:
- FixtureAsyncFlatSpecLike
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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).
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
- Throws:
- NullArgumentException
if the passed
clue
isnull
- Inherited from:
- Assertions
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.
- Value parameters:
- test
the
OneArgAsyncTest
to invoke, passing in a fixture
- Returns:
an instance of
FutureOutcome
- Inherited from:
- FixtureAsyncTestSuite
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 the NoArgAsyncTest
function
passed to this method takes no parameters, preparing the fixture will require
side effects, such as reassigning instance var
s in this Suite
or initializing
a globally accessible external database. If you want to avoid reassigning instance var
s
you can use FixtureAsyncTestSuite.
This trait's implementation of runTest
invokes this method for each test, passing
in a NoArgAsyncTest
whose apply
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.
- Value parameters:
- test
the no-arg async test function to run with a fixture
- Inherited from:
- AsyncTestSuite
Deprecated and Inherited methods
- Deprecated
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Deprecated
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Deprecated
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Deprecated
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException
indicating no exception is thrown.
Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException
indicating no exception is thrown.
This method is intended to be used in the Scala interpreter to eliminate large stack traces when trying out ScalaTest assertions and
matcher expressions. It is not intended to be used in regular test code. If you want to ensure that a bit of code throws an expected
exception, use intercept
, not trap
. Here's an example interpreter session without trap
:
scala> import org.scalatest._ import org.scalatest._ scala> import Matchers._ import Matchers._ scala> val x = 12 a: Int = 12 scala> x shouldEqual 13 org.scalatest.exceptions.TestFailedException: 12 did not equal 13 at org.scalatest.Assertions$class.newAssertionFailedException(Assertions.scala:449) at org.scalatest.Assertions$.newAssertionFailedException(Assertions.scala:1203) at org.scalatest.Assertions$AssertionsHelper.macroAssertTrue(Assertions.scala:417) at .<init>(<console>:15) at .<clinit>(<console>) at .<init>(<console>:7) at .<clinit>(<console>) at $print(<console>) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) at java.lang.reflect.Method.invoke(Method.java:597) at scala.tools.nsc.interpreter.IMain$ReadEvalPrint.call(IMain.scala:731) at scala.tools.nsc.interpreter.IMain$Request.loadAndRun(IMain.scala:980) at scala.tools.nsc.interpreter.IMain.loadAndRunReq$1(IMain.scala:570) at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:601) at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:565) at scala.tools.nsc.interpreter.ILoop.reallyInterpret$1(ILoop.scala:745) at scala.tools.nsc.interpreter.ILoop.interpretStartingWith(ILoop.scala:790) at scala.tools.nsc.interpreter.ILoop.command(ILoop.scala:702) at scala.tools.nsc.interpreter.ILoop.processLine$1(ILoop.scala:566) at scala.tools.nsc.interpreter.ILoop.innerLoop$1(ILoop.scala:573) at scala.tools.nsc.interpreter.ILoop.loop(ILoop.scala:576) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply$mcZ$sp(ILoop.scala:867) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822) at scala.tools.nsc.util.ScalaClassLoader$.savingContextLoader(ScalaClassLoader.scala:135) at scala.tools.nsc.interpreter.ILoop.process(ILoop.scala:822) at scala.tools.nsc.MainGenericRunner.runTarget$1(MainGenericRunner.scala:83) at scala.tools.nsc.MainGenericRunner.process(MainGenericRunner.scala:96) at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:105) at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala)
That's a pretty tall stack trace. Here's what it looks like when you use trap
:
scala> trap { x shouldEqual 13 } res1: Throwable = org.scalatest.exceptions.TestFailedException: 12 did not equal 13
Much less clutter. Bear in mind, however, that if no exception is thrown by the
passed block of code, the trap
method will create a new NormalResult
(a subclass of Throwable
made for this purpose only) and return that. If the result was the Unit
value, it
will simply say that no exception was thrown:
scala> trap { x shouldEqual 12 } res2: Throwable = No exception was thrown.
If the passed block of code results in a value other than Unit
, the NormalResult
's toString
will print the value:
scala> trap { "Dude!" } res3: Throwable = No exception was thrown. Instead, result was: "Dude!"
Although you can access the result value from the NormalResult
, its type is Any
and therefore not
very convenient to use. It is not intended that trap
be used in test code. The sole intended use case for trap
is decluttering
Scala interpreter sessions by eliminating stack traces when executing assertion and matcher expressions.
- Deprecated
- Inherited from:
- Assertions
Inherited fields
Supports shared test registration in FixtureAsyncFlatSpec
s.
Supports shared test registration in FixtureAsyncFlatSpec
s.
This field supports syntax such as the following:
it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of behave
, see the Shared tests section
in the main documentation for trait AnyFlatSpec
.
- Inherited from:
- FixtureAsyncFlatSpecLike
Supports the registration of a “subject” being specified and tested.
Supports the registration of a “subject” being specified and tested.
This field enables syntax such as the following subject registration:
behavior of "A Stack" ^
For more information and examples of the use of the behavior
field, see the main documentation
for trait AnyFlatSpec
.
- Inherited from:
- FixtureAsyncFlatSpecLike
Supports registration of ignored tests in FixtureAsyncFlatSpec
s.
Supports registration of ignored tests in FixtureAsyncFlatSpec
s.
This field enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
For more information and examples of the use of the ignore
field, see the
Ignored tests section in the main documentation for trait AnyFlatSpec
.
- Inherited from:
- FixtureAsyncFlatSpecLike
Supports test (and shared test) registration in FixtureAsyncFlatSpec
s.
Supports test (and shared test) registration in FixtureAsyncFlatSpec
s.
This field enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation
for trait AnyFlatSpec
.
- Inherited from:
- FixtureAsyncFlatSpecLike
The Succeeded
singleton.
The Succeeded
singleton.
You can use succeed
to solve a type error when an async test
does not end in either Future[Assertion]
or Assertion
.
Because Assertion
is a type alias for Succeeded.type
,
putting succeed
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.
- Inherited from:
- Assertions
Supports test (and shared test) registration in FixtureAsyncFlatSpec
s.
Supports test (and shared test) registration in FixtureAsyncFlatSpec
s.
This field enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation
for trait AnyFlatSpec
.
- Inherited from:
- FixtureAsyncFlatSpecLike
Deprecated and Inherited fields
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
.
- Deprecated
- Inherited from:
- FixtureAsyncFlatSpecLike
Extensions
Inherited extensions
Implicits
Inherited implicits
Implicitly converts an Assertion
to a Future[Assertion]
.
Implicitly converts an Assertion
to a Future[Assertion]
.
This implicit conversion is used to allow synchronous tests to be included along with
asynchronous tests in an AsyncTestSuite
. It will be
- Value parameters:
- assertion
the
Assertion
to convert
- Returns:
a
Future[Assertion]
that has already completed successfully (containing theSucceeded
singleton).- Inherited from:
- AsyncTestSuite
- Inherited from:
- AsyncTestSuite
Implicitly converts an object of type ResultOfStringPassedToVerb
to an
InAndIgnoreMethods
, to enable in
and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfStringPassedToVerb
to an
InAndIgnoreMethods
, to enable in
and ignore
methods to be invokable on that object.
- Value parameters:
- resultOfStringPassedToVerb
an
ResultOfStringPassedToVerb
instance
- Inherited from:
- FixtureAsyncFlatSpecLike
Implicitly converts an object of type ResultOfTaggedAsInvocation
to an
InAndIgnoreMethodsAfterTaggedAs
, to enable in
and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation
to an
InAndIgnoreMethodsAfterTaggedAs
, to enable in
and ignore
methods to be invokable on that object.
- Value parameters:
- resultOfTaggedAsInvocation
an
ResultOfTaggedAsInvocation
instance
- Inherited from:
- FixtureAsyncFlatSpecLike
Implicitly converts an object of type String
to a StringCanWrapper
,
to enable can
methods to be invokable on that object.
Implicitly converts an object of type String
to a StringCanWrapper
,
to enable can
methods to be invokable on that object.
- Inherited from:
- CanVerb
Implicitly converts an object of type String
to a StringMustWrapper
,
to enable must
methods to be invokable on that object.
Implicitly converts an object of type String
to a StringMustWrapper
,
to enable must
methods to be invokable on that object.
- Inherited from:
- MustVerb
Implicitly converts an object of type String
to a StringShouldWrapperForVerb
,
to enable should
methods to be invokable on that object.
Implicitly converts an object of type String
to a StringShouldWrapperForVerb
,
to enable should
methods to be invokable on that object.
- Inherited from:
- ShouldVerb
Supports the shorthand form of test registration.
Supports the shorthand form of test registration.
For example, this method enables syntax such as the following:
"A Stack (when empty)" should "be empty" in { ... } ^
This function is passed as an implicit parameter to a should
method
provided in ShouldVerb
, a must
method
provided in MustVerb
, and a can
method
provided in CanVerb
. When invoked, this function registers the
subject description (the first parameter to the function) and returns a ResultOfStringPassedToVerb
initialized with the verb and rest parameters (the second and third parameters to
the function, respectively).
- Inherited from:
- FixtureAsyncFlatSpecLike
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals