org.scalatest

BeforeAndAfterAll

trait BeforeAndAfterAll extends SuiteMixin

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 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 trait's 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 ExampleSpec 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, 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.beforeandafterall

import org.scalatest._ import java.io._
trait TempFileExistsSpec extends fixture.FlatSpec {
type FixtureParam = File override def withFixture(test: OneArgTest) { val fileName = test.configMap("tempFileName").asInstanceOf[String] 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 Specs( new OneSpec, new TwoSpec, new RedSpec, new BlueSpec ) with TempFileExistsSpec with BeforeAndAfterAll {
private val tempFileName = "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(tempFileName), "must place a temp file name in the configMap under the key: " + tempFileName )
val fileName = configMap(tempFileName).asInstanceOf[String]
val writer = new FileWriter(fileName) try writer.write("Hello, suite of tests!") finally writer.close() }
// 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").asInstanceOf[String] 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> new ExampleSpec execute
ExampleSpec:
Exception encountered when invoking run on a suite. *** ABORTED ***
  java.lang.IllegalArgumentException: requirement failed: must place a temp file name in the configMap under the key: tempFileName
  ...
*** RUN ABORTED ***
  java.lang.IllegalArgumentException: requirement failed: must place a temp file name in the configMap under the key: tempFileName
  ...

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 = Map("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: 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 (in fact, in a soon-to-be-released 2.0 milestone), 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.

Self Type
BeforeAndAfterAll with Suite
Linear Supertypes
SuiteMixin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. BeforeAndAfterAll
  2. SuiteMixin
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. def expectedTestCount (filter: Filter): Int

    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.

    filter

    a Filter with which to filter tests to count based on their tags

    Attributes
    abstract
    Definition Classes
    SuiteMixin
  2. def nestedSuites : IndexedSeq[Suite]

    An immutable IndexedSeq of this SuiteMixin object's nested Suites.

    An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites, this method returns an empty IndexedSeq.

    Attributes
    abstract
    Definition Classes
    SuiteMixin
  3. 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.

    Attributes
    abstract
    Definition Classes
    SuiteMixin
  4. 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 abstract
    Definition Classes
    SuiteMixin
  5. 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 abstract
    Definition Classes
    SuiteMixin
  6. 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 this Suite.

    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 abstract
    Definition Classes
    SuiteMixin
  7. 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.

    Attributes
    abstract
    Definition Classes
    SuiteMixin
  8. def tags : Map[String, Set[String]]

    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.

    Attributes
    abstract
    Definition Classes
    SuiteMixin
  9. def testNames : Set[String]

    A Set of test names.

    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.

    Attributes
    abstract
    Definition Classes
    SuiteMixin
  10. def withFixture (test: NoArgTest): Unit

    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 initializing an external database.

    test

    the no-arg test function to run with a fixture

    Attributes
    protected abstract
    Definition Classes
    SuiteMixin

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def afterAll (configMap: Map[String, Any]): 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 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.

    Attributes
    protected
  7. def afterAll (): Unit

    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.

    Attributes
    protected
  8. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  9. def beforeAll (configMap: Map[String, Any]): 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 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.

    Attributes
    protected
  10. def beforeAll (): Unit

    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.

    Attributes
    protected
  11. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  13. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef
  16. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  17. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  18. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  19. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  20. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  21. def run (testName: Option[String], args: Args): Status

    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.

    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 this Suite.

    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
    BeforeAndAfterAllSuiteMixin
  22. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  23. def toString (): String

    Definition Classes
    AnyRef → Any
  24. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  25. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  26. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any