trait BeforeAndAfterAllConfigMap extends SuiteMixin
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.
- Self Type
- BeforeAndAfterAllConfigMap with Suite
- Source
- BeforeAndAfterAllConfigMap.scala
- Alphabetic
- By Inheritance
- BeforeAndAfterAllConfigMap
- SuiteMixin
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
expectedTestCount(filter: Filter): Int
The total number of tests that are expected to run when this
Suite
'srun
method is invoked.The total number of tests that are expected to run when this
Suite
'srun
method is invoked.- filter
a
Filter
with which to filter tests to count based on their tags
- Definition Classes
- SuiteMixin
-
abstract
def
nestedSuites: IndexedSeq[Suite]
An immutable
IndexedSeq
of thisSuiteMixin
object's nestedSuite
s.An immutable
IndexedSeq
of thisSuiteMixin
object's nestedSuite
s. If thisSuiteMixin
contains no nestedSuite
s, this method returns an emptyIndexedSeq
.- Definition Classes
- SuiteMixin
-
abstract
def
rerunner: Option[String]
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.
- Definition Classes
- SuiteMixin
-
abstract
def
runNestedSuites(args: Args): Status
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
- 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.
- Attributes
- protected
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
ifargs
isnull
.
-
abstract
def
runTest(testName: String, args: Args): Status
Runs a test.
Runs a test.
- testName
the name of one test to execute.
- args
the
Args
for this run- returns
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .
- Attributes
- protected
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
if any oftestName
orargs
isnull
.
-
abstract
def
runTests(testName: Option[String], args: Args): Status
Runs zero to many of this suite's tests.
Runs zero to many of this suite's tests.
- 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
.- args
the
Args
for this run- returns
a
Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
if eithertestName
orargs
isnull
.
-
abstract
val
styleName: String
This suite's style name.
This suite's style name.
This lifecycle method provides a string that is used to determine whether this suite object's style is one of the chosen styles for the project.
- Definition Classes
- SuiteMixin
-
abstract
def
suiteId: String
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.
- Definition Classes
- SuiteMixin
-
abstract
def
suiteName: String
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 forReport
s to pass to thesuiteStarting
,suiteCompleted
, andsuiteAborted
methods of theReporter
.- returns
this
Suite
object's suite name.
- Definition Classes
- SuiteMixin
-
abstract
def
tags: Map[String, Set[String]]
A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tag names for the test.A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tag names for the test. If a test has no associated tags, its name does not appear as a key in the returnedMap
. If thisSuite
contains no tests with tags, this method returns an emptyMap
.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 returnedMap
.- Definition Classes
- SuiteMixin
-
abstract
def
testDataFor(testName: String, theConfigMap: ConfigMap): TestData
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 towithFixture(NoArgTest)
andwithFixture(OneArgTest)
and thebeforeEach
andafterEach
methods of traitBeforeAndAfterEach
.- 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
- Definition Classes
- SuiteMixin
-
abstract
def
testNames: Set[String]
A
Set
of test names.A
Set
of test names. If thisSuite
contains no tests, this method returns an emptySet
.Although subclass and subtrait implementations of this method may return a
Set
whose iterator producesString
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.- Definition Classes
- SuiteMixin
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
afterAll(configMap: ConfigMap): Unit
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 theconfigMap
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.- Attributes
- protected
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
beforeAll(configMap: ConfigMap): Unit
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 theconfigMap
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.- Attributes
- protected
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
val
invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected: Boolean
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 invokingexpectedTestCount
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 inbeforeAll
orafterAll
if no tests will ultimately be executed anyway. If you always want to see the side effects even if no tests are expected, override thisval
and set it to true. -
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
run(testName: Option[String], args: Args): Status
Execute a suite surrounded by calls to
beforeAll
andafterAll
.Execute a suite surrounded by calls to
beforeAll
andafterAll
.This trait's implementation of this method ("this method") invokes
beforeAll(ConfigMap)
before executing any tests or nested suites andafterAll(ConfigMap)
after executing all tests and nested suites. It runs the suite by invokingsuper.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 tosuper.run
completes abruptly with an exception, this method will complete abruptly with the same exception, however, before doing so, it will invokeafterAll
. IfafterAll
also completes abruptly with an exception, this method will nevertheless complete abruptly with the exception previously thrown bysuper.run
. Ifsuper.run
returns normally, butafterAll
completes abruptly with an exception, this method will complete abruptly with the same exception.This method does not invoke either
beforeAll
orafterAll
ifrunTestsInNewInstance
is true so that any side effects only happen once per test ifOneInstancePerTest
is being used. In addition, if no tests are expected, thenbeforeAll
andafterAll
will be invoked only if theinvokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected
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.- 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
.- args
the
Args
for this run- returns
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .
- Definition Classes
- BeforeAndAfterAllConfigMap → SuiteMixin
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )