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.
a Filter
with which to filter tests to count based on their tags
A List
of this Suite
object's nested Suite
s.
A List
of this Suite
object's nested Suite
s. If this Suite
contains no nested Suite
s,
this method returns an empty List
.
Runs this suite of tests.
Runs this suite of tests.
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 this Suite
.
the Reporter
to which results will be reported
the Stopper
that will be consulted to determine whether to stop execution early.
a Filter
with which to filter tests based on their tags
a Map
of key-value pairs that can be used by the executing Suite
of tests.
an optional Distributor
, into which to put nested Suite
s to be executed
by another entity, such as concurrently by a pool of threads. If None
, nested Suite
s will be executed sequentially.
a Tracker
tracking Ordinal
s being fired by the current thread.
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
the Reporter
to which results will be reported
the Stopper
that will be consulted to determine whether to stop execution early.
a Filter
with which to filter tests based on their tags
a Map
of key-value pairs that can be used by the executing Suite
of tests.
an optional Distributor
, into which to put nested Suite
s to be run
by another entity, such as concurrently by a pool of threads. If None
, nested Suite
s will be run sequentially.
a Tracker
tracking Ordinal
s being fired by the current thread.
Runs zero to many of this suite's tests.
Runs zero to many of this suite's tests.
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 this Suite
.
the Reporter
to which results will be reported
the Stopper
that will be consulted to determine whether to stop execution early.
a Filter
with which to filter tests based on their tags
a Map
of key-value pairs that can be used by the executing Suite
of tests.
an optional Distributor
, into which instances of this Suite
class
that are responsible for executing individual tests contained in this Suite, or groups of this Suite
's
tests, may be placed so as to be run
by another entity, such as concurrently by a pool of threads.
a Tracker
tracking Ordinal
s being fired by the current thread.
A Map
whose keys are String
tag names with which tests in this Suite
are marked, and
whose values are the Set
of test names marked with each tag.
A Map
whose keys are String
tag names with which tests in this Suite
are marked, and
whose values are the Set
of test names marked with each tag. If this Suite
contains no tags, this
method returns an empty Map
.
Subclasses may implement this method to define and/or discover tags in a custom manner, but overriding method implementations
should never return an empty Set
as a value. If a tag has no tests, its name should not appear as a key in the
returned Map
.
An Set
of test names.
An Set
of test names. If this Suite
contains no tests, this method returns an empty Set
.
Although subclass and subtrait implementations of this method may return a Set
whose iterator produces String
test names in a well-defined order, the contract of this method does not required a defined order. Subclasses are free to
implement this method and return test names in either a defined or undefined order.
Runs the passed test function with a fixture established by this method.
Runs the passed test function with 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, perform any clean
up needed after the test completes. Because the NoArgTest
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 fixture.Suite.
the no-arg test function to run with a fixture
Defines a method (that takes a configMap
) to be run after
each of this suite's tests.
Defines a method (that takes a configMap
) to be run after
each of this suite's tests.
This trait's implementation
of runTest
invokes this method after running
each test (passing in the configMap
passed to it), thus this
method can be used to tear down a test fixture
needed by each test. This trait's implementation of this method invokes the
overloaded form of afterEach
that takes no configMap
.
Defines a method to be run after each of this suite's tests.
Defines a method to be run after each of this suite's tests.
This trait's implementation
of runTest
invokes the overloaded form of this method that
takes a configMap
map after running
each test. This trait's implementation of that afterEach(Map[String, Any])
method simply invokes this
afterEach()
method. Thus this method can be used to tear down a test fixture
needed by each test, when you don't need anything from the configMap
.
This trait's implementation of this method does nothing.
Defines a method (that takes a configMap
) to be run before
each of this suite's tests.
Defines a method (that takes a configMap
) to be run before
each of this suite's tests.
This trait's implementation
of runTest
invokes this method before running
each test (passing in the configMap
passed to it), thus this
method can be used to set up a test fixture
needed by each test. This trait's implementation of this method invokes the
overloaded form of beforeEach
that takes no configMap
.
Defines a method to be run before each of this suite's tests.
Defines a method to be run before each of this suite's tests.
This trait's implementation
of runTest
invokes the overloaded form of this method that
takes a configMap
before running
each test. This trait's implementation of that beforeEach(Map[String, Any])
method simply invokes this
beforeEach()
method. Thus this method can be used to set up a test fixture
needed by each test, when you don't need anything from the configMap
.
This trait's implementation of this method does nothing.
Run a test surrounded by calls to beforeEach
and afterEach
.
Run a test surrounded by calls to beforeEach
and afterEach
.
This trait's implementation of this method ("this method") invokes
beforeEach(configMap)
before running each test and afterEach(configMap)
after running each test. It runs each test by invoking super.runTest
, passing along
the five parameters passed to it.
If any invocation of beforeEach
completes abruptly with an exception, this
method will complete abruptly with the same exception. If any call to
super.runTest
completes abruptly with an exception, this method
will complete abruptly with the same exception, however, before doing so, it will
invoke afterEach
. If <cod>afterEach also completes abruptly with an exception, this
method will nevertheless complete abruptly with the exception previously thrown by super.runTest
.
If super.runTest
returns normally, but afterEach
completes abruptly with an
exception, this method will complete abruptly with the exception thrown by afterEach
.
the name of one test to execute.
the Reporter
to which results will be reported
the Stopper
that will be consulted to determine whether to stop execution early.
a Map
of key-value pairs that can be used by the executing Suite
of tests.
a Tracker
tracking Ordinal
s being fired by the current thread.
Trait that can be mixed into suites that need methods invoked before and after running each test. This trait facilitates a style of testing in which mutable fixture objects held in instance variables are replaced or reinitialized before each test or suite. Here's an example:
Because this trait invokes
super.runTest
to run each test, you may need to mix this trait in last to get the desired behavior. For example, this won't work, becauseBeforeAndAfterEach
is "super" to FunSuite:You'd need to turn it around, so that
FunSuite
is "super" toBeforeAndAfterEach
, like this: