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 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 a test.
Runs a test.
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.
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
all of this suite's tests and nested suites have been run.
Defines a method (that takes a configMap
) to be run after
all of this suite's tests and nested suites have been run.
This trait's implementation
of run
invokes this method after executing all tests
and nested suites (passing in the configMap
passed to it), thus this
method can be used to tear down a test fixture
needed by the entire suite. This trait's implementation of this method invokes the
overloaded form of afterAll
that takes no configMap
.
Defines a method to be run after all of this suite's tests and nested suites have been run.
Defines a method to be run after all of this suite's tests and nested suites have been run.
This trait's implementation
of run
invokes the overloaded form of this method that
takes a configMap
after executing
all tests and nested suites. This trait's implementation of that afterAll(Map[String, Any])
method simply invokes this
afterAll()
method. Thus this method can be used to tear down a test fixture
needed by the entire suite, 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 any
of this suite's tests or nested suites are run.
Defines a method (that takes a configMap
) to be run before any
of this suite's tests or nested suites are run.
This trait's implementation
of run
invokes this method before executing
any tests or nested suites (passing in the configMap
passed to it), thus this
method can be used to set up a test fixture
needed by the entire suite. This trait's implementation of this method invokes the
overloaded form of beforeAll
that takes no configMap
.
Defines a method to be run before any of this suite's tests or nested suites are run.
Defines a method to be run before any of this suite's tests or nested suites are run.
This trait's implementation
of run
invokes the overloaded form of this method that
takes a configMap
before executing
any tests or nested suites. This trait's implementation of that beforeAll(Map[String, Any])
method simply invokes this beforeAll()
method. Thus this method can be used to set up a test fixture
needed by the entire suite, when you don't need anything from the configMap
.
This trait's implementation of this method does nothing.
Execute a suite surrounded by calls to beforeAll
and afterAll
.
Execute a suite surrounded by calls to beforeAll
and afterAll
.
This trait's implementation of this method ("this method") invokes beforeAll(Map[String, Any])
before executing any tests or nested suites and afterAll(Map[String, Any])
after executing all tests and nested suites. It runs the suite by invoking super.run
, passing along
the seven parameters passed to it.
If any invocation of beforeAll
completes abruptly with an exception, this
method will complete abruptly with the same exception. If any call to
super.run
completes abruptly with an exception, this method
will complete abruptly with the same exception, however, before doing so, it will
invoke afterAll
. If <cod>afterAll also completes abruptly with an exception, this
method will nevertheless complete abruptly with the exception previously thrown by super.run
.
If super.run
returns normally, but afterAll
completes abruptly with an
exception, this method will complete abruptly with the same exception.
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.
Trait that can be mixed into suites that need methods invoked before and after executing the suite. This trait allows code to be executed before and/or after all the tests and nested suites of a suite are run. This trait overrides
run
(the mainrun
method that takes seven parameters, an optional test name, reporter, stopper, filter, configMap, optional distributor, and tracker) and calls thebeforeAll
method, then callssuper.run
. After thesuper.run
invocation completes, whether it returns normally or completes abruptly with an exception, this trait'srun
method will invokeafterAll
.Trait
BeforeAndAfterAll
defines two overloaded variants each ofbeforeAll
andafterAll
, one that takes aconfigMap
and another that takes no arguments. This traits implemention of the variant that takes theconfigMap
simply invokes the variant that takes no parameters, which does nothing. Thus you can override whichever variant you want. If you need something from theconfigMap
before all tests and nested suites are run, overridebeforeAll(Map[String, Any])
. Otherwise, overridebeforeAll()
.For example, the following
MasterSuite
mixes inBeforeAndAfterAll
and inbeforeAll
, creates and writes to a temp file, taking the name of the temp file from theconfigMap
. This sameconfigMap
is then passed to therun
methods of the nested suites,OneSuite
,TwoSuite
,RedSuite
, andBlueSuite
, so those suites can access the filename and, therefore, the file's contents. After all of the nested suites have executed,afterAll
is invoked, which again grabs the file name from theconfigMap
and deletes the file:Because the
BeforeAndAfterAll
trait invokessuper.run
to run the suite, you may need to mix this trait in last to get the desired behavior. For example, this won't work, becauseBeforeAndAfterAll
is "super" to FunSuite:You'd need to turn it around, so that
FunSuite
is "super" toBeforeAndAfterAll
, like this:Note: This trait does not currently ensure that the code in
afterAll
is executed after all the tests and nested suites are executed if aDistributor
is passed. The plan is to do that eventually, but in the meantime, be aware thatafterAll
is guaranteed to be run after all the tests and nested suites only when they are run sequentially.