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 main run method that
takes seven parameters, an optional test name, reporter, stopper, filter, configMap, optional distributor,
and tracker) and calls the
beforeAll method, then calls super.run. After the super.run
invocation completes, whether it returns normally or completes abruptly with an exception,
this trait's run method will invoke afterAll.
Trait BeforeAndAfterAll defines two overloaded variants each of beforeAll
and afterAll, one that takes a configMap and another that takes no
arguments. This traits implemention of the variant that takes the configMap
simply invokes the variant that takes no parameters, which does nothing. Thus you can override
whichever variant you want. If you need something from the configMap before
all tests and nested suites are run, override beforeAll(Map[String, Any]). Otherwise,
override beforeAll().
For example, the following MasterSuite mixes in BeforeAndAfterAll and
in beforeAll, creates and writes to a temp file, taking the name of the temp file
from the configMap. This same configMap is then passed to the run
methods of the nested suites, OneSuite, TwoSuite, RedSuite,
and BlueSuite, 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 the configMap and deletes the file:
import org.scalatest.SuperSuite import org.scalatest.BeforeAndAfterAll import java.io.FileReader import java.io.FileWriter import java.io.Fileclass MasterSuite extends Suite with BeforeAndAfterAll {
private val FileNameKeyInGoodies = "tempFileName"
// Set up the temp file needed by the test, taking // a file name from the configMap override def beforeAll(configMap: Map[String, Any]) {
require( configMap.isDefinedAt(FileNameKeyInGoodies), "must place a temp file name in the configMap under the key: " + FileNameKeyInGoodies )
val fileName = configMap(tempFileName)
val writer = new FileWriter(fileName) try { writer.write("Hello, suite of tests!") } finally { writer.close() } }
override def nestedSuites = List(new OneSuite, new TwoSuite, new RedSuite, new BlueSuite)
// Delete the temp file override def afterAll(configMap: Map[String, Any]) { // No need to require that configMap contains the key again because it won't get // here if it didn't contain the key in beforeAll val fileName = configMap(tempFileName)) val file = new File(fileName) file.delete() } }
Because the BeforeAndAfterAll trait invokes super.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, because BeforeAndAfterAll is "super" to FunSuite:
class MySuite extends BeforeAndAfterAll with FunSuite
You'd need to turn it around, so that FunSuite is "super" to BeforeAndAfterAll, like this:
class MySuite extends FunSuite with BeforeAndAfterAll
Note: This trait does not currently ensure that the code in afterAll is executed after
all the tests and nested suites are executed if a Distributor is passed. The
plan is to do that eventually, but in the meantime, be aware that afterAll is
guaranteed to be run after all the tests and nested suites only when they are run
sequentially.
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 Suites. If this Suite contains no nested Suites,
this method returns an empty List.
A List of this Suite object's nested Suites. If this Suite contains no nested Suites,
this method returns an empty List.
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 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 Suites to be executed
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.
a Tracker tracking Ordinals 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. If this Suite contains no tags, this
method returns an empty Map.
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. If this Suite contains no tests, this method returns an empty Set.
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.
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 mainrunmethod that takes seven parameters, an optional test name, reporter, stopper, filter, configMap, optional distributor, and tracker) and calls thebeforeAllmethod, then callssuper.run. After thesuper.runinvocation completes, whether it returns normally or completes abruptly with an exception, this trait'srunmethod will invokeafterAll.Trait
BeforeAndAfterAlldefines two overloaded variants each ofbeforeAllandafterAll, one that takes aconfigMapand another that takes no arguments. This traits implemention of the variant that takes theconfigMapsimply invokes the variant that takes no parameters, which does nothing. Thus you can override whichever variant you want. If you need something from theconfigMapbefore all tests and nested suites are run, overridebeforeAll(Map[String, Any]). Otherwise, overridebeforeAll().For example, the following
MasterSuitemixes inBeforeAndAfterAlland inbeforeAll, creates and writes to a temp file, taking the name of the temp file from theconfigMap. This sameconfigMapis then passed to therunmethods 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,afterAllis invoked, which again grabs the file name from theconfigMapand deletes the file:Because the
BeforeAndAfterAlltrait invokessuper.runto run the suite, you may need to mix this trait in last to get the desired behavior. For example, this won't work, becauseBeforeAndAfterAllis "super" to FunSuite:You'd need to turn it around, so that
FunSuiteis "super" toBeforeAndAfterAll, like this:Note: This trait does not currently ensure that the code in
afterAllis executed after all the tests and nested suites are executed if aDistributoris passed. The plan is to do that eventually, but in the meantime, be aware thatafterAllis guaranteed to be run after all the tests and nested suites only when they are run sequentially.