BeforeAndAfterAllConfigMap
Trait that can be mixed into suites that need methods that make use of the config map invoked before and/or 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
and calls the
beforeAll(ConfigMap)
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(ConfigMap)
.
Note that this trait differs from BeforeAndAfterAll
in that it gives
the beforeAll
and afterAll
code access to the config map. If you don't need
the config map, use BeforeAndAfterAll
instead.
Trait BeforeAndAfterAllConfigMap
defines beforeAll
and afterAll
methods that take a configMap
.
This trait's implemention of each method does nothing.
For example, the following ExampleSpec
mixes in BeforeAndAfterAllConfigMap
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, OneSpec
, TwoSpec
, RedSpec
,
and BlueSpec
, 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. Each of these five
test classes extend trait TempFileExistsSpec
, which defines a test that ensures the temp file exists.
(Note: if you're unfamiliar with the withFixture(OneArgTest)
approach to shared fixtures, check out
the documentation for trait fixture.FlatSpec
.)
package org.scalatest.examples.beforeandafterallconfigmap import org.scalatest._ import java.io._ trait TempFileExistsSpec extends fixture.FlatSpec { type FixtureParam = File override def withFixture(test: OneArgTest) = { val fileName = test.configMap.getRequired[String]("tempFileName") val file = new File(fileName) withFixture(test.toNoArgTest(file)) // loan the fixture to the test } "The temp file" should ("exist in " + suiteName) in { file => assert(file.exists) } } class OneSpec extends TempFileExistsSpec class TwoSpec extends TempFileExistsSpec class RedSpec extends TempFileExistsSpec class BlueSpec extends TempFileExistsSpec class ExampleSpec extends Suites( new OneSpec, new TwoSpec, new RedSpec, new BlueSpec ) with TempFileExistsSpec with BeforeAndAfterAllConfigMap { private val tempFileName = "tempFileName" // Set up the temp file needed by the test, taking // a file name from the config map override def beforeAll(cm: ConfigMap) { assume( cm.isDefinedAt(tempFileName), "must place a temp file name in the config map under the key: " + tempFileName ) val fileName = cm.getRequired[String](tempFileName) val writer = new FileWriter(fileName) try writer.write("Hello, suite of tests!") finally writer.close() } // Delete the temp file override def afterAll(cm: ConfigMap) { val fileName = cm.getRequired[String]("tempFileName") val file = new File(fileName) file.delete() } }
Running the above class in the interpreter will give an error if you don't supply a mapping for "tempFileName"
in the config map:
scala> org.scalatest.run(new ExampleSpec) ExampleSpec: Exception encountered when invoking run on a suite. *** ABORTED *** Exception encountered when invoking run on a suite. (:30) *** RUN ABORTED *** An exception or error caused a run to abort: must place a temp file name in the config map under the key: tempFileName ( :30)
If you do supply a mapping for "tempFileName"
in the config map, you'll see that the temp file is available to all the tests:
scala> (new ExampleSpec).execute(configMap = ConfigMap("tempFileName" -> "tmp.txt"))
ExampleSpec:
OneSpec:
The temp file
- should exist in OneSpec
TwoSpec:
The temp file
- should exist in TwoSpec
RedSpec:
The temp file
- should exist in RedSpec
BlueSpec:
The temp file
- should exist in BlueSpec
The temp file
- should exist in ExampleSpec
Note: As of 2.0.M5, this trait uses the newly added Status
result of Suite
's "run" methods
to ensure that the code in afterAll
is executed after
all the tests and nested suites are executed even if a Distributor
is passed.
Note that it is not guaranteed that afterAll
is invoked from the same thread as beforeAll
,
so if there's any shared state between beforeAll
and afterAll
you'll need to make sure they are
synchronized correctly.
Value members
Concrete methods
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 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 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(ConfigMap)
before executing any tests or nested suites and afterAll(ConfigMap)
after executing all tests and nested suites. It runs the suite by invoking super.run
, passing along
the 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 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.
This method does not invoke either beforeAll
or afterAll
if runTestsInNewInstance
is true so
that any side effects only happen once per test if OneInstancePerTest
is being used. In addition, if no tests
are expected, then beforeAll
and afterAll
will be invoked only if the
invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected
flag is true. By default, this flag is false, so that if
all tests are excluded (such as if the entire suite class has been marked with @Ignore
), then side effects
would happen only if at least one test will ultimately be executed in this suite or its nested suites.
- Value parameters:
- args
the
Args
for this run- testName
an optional name of one test to run. If
None
, all relevant tests should be run. I.e.,None
acts like a wildcard that means run all relevant tests in thisSuite
.
- Returns:
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .
Inherited methods
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.
- Value parameters:
- filter
a
Filter
with which to filter tests to count based on their tags
- Inherited from:
- SuiteMixin
An immutable IndexedSeq
of this SuiteMixin
object's nested Suite
s. If this SuiteMixin
contains no nested Suite
s,
this method returns an empty IndexedSeq
.
An immutable IndexedSeq
of this SuiteMixin
object's nested Suite
s. If this SuiteMixin
contains no nested Suite
s,
this method returns an empty IndexedSeq
.
- Inherited from:
- SuiteMixin
The fully qualified name of the class that can be used to rerun this suite.
The fully qualified name of the class that can be used to rerun this suite.
- Inherited from:
- SuiteMixin
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
- Value parameters:
- args
the
Args
for this run
- Returns:
a
Status
object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.- Throws:
- NullArgumentException
if
args
isnull
.
- Inherited from:
- SuiteMixin
Runs a test.
Runs a test.
- Value parameters:
- args
the
Args
for this run- 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 any of
testName
orargs
isnull
.
- Inherited from:
- SuiteMixin
Runs zero to many of this suite's tests.
Runs zero to many of this suite's tests.
- Value parameters:
- args
the
Args
for this run- testName
an optional name of one test to run. If
None
, all relevant tests should be run. I.e.,None
acts like a wildcard that means run all relevant tests in thisSuite
.
- 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 either
testName
orargs
isnull
.
- Inherited from:
- SuiteMixin
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.
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:
- SuiteMixin
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:
- SuiteMixin
A Map
whose keys are String
names of tagged tests and
whose associated values are the Set
of tag names for the test. If a test has no associated tags, its name
does not appear as a key in the returned Map
. If this Suite
contains no tests with tags, this
method returns an empty Map
.
A Map
whose keys are String
names of tagged tests and
whose associated values are the Set
of tag names for the test. If a test has no associated tags, its name
does not appear as a key in the returned Map
. If this Suite
contains no tests with tags, this
method returns an empty Map
.
Subclasses may override 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 test has no tags, its name should not appear as a key in the
returned Map
.
- Inherited from:
- SuiteMixin
Provides a TestData
instance for the passed test name, given the passed config map.
Provides a TestData
instance for the passed test name, given the passed config map.
This method is used to obtain a TestData
instance to pass to withFixture(NoArgTest)
and withFixture(OneArgTest)
and the beforeEach
and afterEach
methods
of trait BeforeAndAfterEach
.
- Value parameters:
- testName
the name of the test for which to return a
TestData
instance- theConfigMap
the config map to include in the returned
TestData
- Returns:
a
TestData
instance for the specified test, which includes the specified config map- Inherited from:
- SuiteMixin
A Set
of test names. If this Suite
contains no tests, this method returns an empty Set
.
A 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.
- Inherited from:
- SuiteMixin
Concrete fields
Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.
Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.
The default value is false
, which means beforeAll and afterAll will not be invoked
if there are no tests expected. Whether tests are expected is determined by invoking expectedTestCount
passing in
the passed filter. Because this count does not include tests excluded based on tags, such as ignored tests, this prevents
any side effects in beforeAll
or afterAll
if no tests will ultimately be executed anyway.
If you always want to see the side effects even if no tests are expected, override this val
and set it to true.
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:
- SuiteMixin