org.scalatest

# BeforeAndAfterEach

#### trait BeforeAndAfterEach extends AbstractSuite

Trait that can be mixed into suites that need methods invoked before and after running each test. This trait facilitates a style of testing in which mutable fixture objects held in instance variables are replaced or reinitialized before each test or suite. Here's an example:

    import org.scalatest._
    import scala.collection.mutable.ListBufferclass MySuite extends BeforeAndAfterEach {  // Fixtures as reassignable variables and mutable objects
      var sb: StringBuilder = _
      val lb = new ListBuffer[String]  override def beforeEach() {
        sb = new StringBuilder("ScalaTest is ")
        lb.clear()
      }  def testEasy() {
        sb.append("easy!")
        assert(sb.toString === "ScalaTest is easy!")
        assert(lb.isEmpty)
        lb += "sweet"
      }  def testFun() {
        sb.append("fun!")
        assert(sb.toString === "ScalaTest is fun!")
        assert(lb.isEmpty)
      }
    }

Because this trait invokes `super.runTest` to run each test, you may need to mix this trait in last to get the desired behavior. For example, this won't work, because `BeforeAndAfterEach` is "super" to FunSuite:

    class MySuite extends BeforeAndAfterEach with FunSuite

You'd need to turn it around, so that `FunSuite` is "super" to `BeforeAndAfterEach`, like this:

    class MySuite extends FunSuite with BeforeAndAfterEach

known subclasses: BeforeAndAfter

authors:

1. Bill Venners

Inherited

1. Hide All
2. Show all

1. AbstractSuite
2. AnyRef
3. Any

Visibility

1. Public
2. All

### Value Members

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

   attributes: final
   definition classes: AnyRef

2. #### def !=(arg0: Any): Boolean

   `o != arg0` is the same as `!(o == (arg0))`.

   `o != arg0` is the same as `!(o == (arg0))`.

   arg0

     the object to compare against this object for dis-equality.

   returns

     `false` if the receiver object is equivalent to the argument; `true` otherwise.

   attributes: final
   definition classes: Any

3. #### def ##(): Int

   attributes: final
   definition classes: AnyRef → Any

4. #### def $asInstanceOf[T0](): T0

   attributes: final
   definition classes: AnyRef

5. #### def $isInstanceOf[T0](): Boolean

   attributes: final
   definition classes: AnyRef

6. #### def ==(arg0: AnyRef): Boolean

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   attributes: final
   definition classes: AnyRef

7. #### def ==(arg0: Any): Boolean

   `o == arg0` is the same as `o.equals(arg0)`.

   `o == arg0` is the same as `o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   attributes: final
   definition classes: Any

8. #### def afterEach(configMap: Map[String, Any]): Unit

   Defines a method (that takes a `configMap`) to be run after each of this suite's tests.

   Defines a method (that takes a `configMap`) to be run after each of this suite's tests.

   This trait's implementation of `runTest` invokes this method after running each test (passing in the `configMap` passed to it), thus this method can be used to tear down a test fixture needed by each test. This trait's implementation of this method invokes the overloaded form of `afterEach` that takes no `configMap`.

   attributes: protected

9. #### def afterEach(): Unit

   Defines a method to be run after each of this suite's tests.

   Defines a method to be run after each of this suite's tests.

   This trait's implementation of `runTest` invokes the overloaded form of this method that takes a `configMap` map after running each test. This trait's implementation of that `afterEach(Map[String, Any])` method simply invokes this`afterEach()` method. Thus this method can be used to tear down a test fixture needed by each test, when you don't need anything from the `configMap`. This trait's implementation of this method does nothing.

   attributes: protected

10. #### def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type `T0`.

    This method is used to cast the receiver object to be of type `T0`.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression`1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression`List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      the receiver object.

    attributes: final
    definition classes: Any

11. #### def beforeEach(configMap: Map[String, Any]): Unit

    Defines a method (that takes a `configMap`) to be run before each of this suite's tests.

    Defines a method (that takes a `configMap`) to be run before each of this suite's tests.

    This trait's implementation of `runTest` invokes this method before running each test (passing in the `configMap` passed to it), thus this method can be used to set up a test fixture needed by each test. This trait's implementation of this method invokes the overloaded form of `beforeEach` that takes no `configMap`.

    attributes: protected

12. #### def beforeEach(): Unit

    Defines a method to be run before each of this suite's tests.

    Defines a method to be run before each of this suite's tests.

    This trait's implementation of `runTest` invokes the overloaded form of this method that takes a `configMap` before running each test. This trait's implementation of that `beforeEach(Map[String, Any])` method simply invokes this`beforeEach()` method. Thus this method can be used to set up a test fixture needed by each test, when you don't need anything from the `configMap`. This trait's implementation of this method does nothing.

    attributes: protected

13. #### def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the `clone` method is platform dependent.

    returns

      a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef

14. #### def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    The `eq` method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of `AnyRef`: * It is reflexive: for any non-null instance `x` of type `AnyRef`, `x.eq(x)` returns `true`. * It is symmetric: for any non-null instances `x` and `y` of type `AnyRef`, `x.eq(y)` returns `true` if and only if `y.eq(x)` returns `true`. * It is transitive: for any non-null instances `x`, `y`, and `z` of type `AnyRef` if `x.eq(y)` returns `true` and `y.eq(z)` returns `true`, then `x.eq(z)` returns `true`.

    Additionally, the `eq` method has three other properties. * It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`. * For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`. * `null.eq(null)` returns `true`.

    When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

    arg0

      the object to compare against this object for reference equality.

    returns

      `true` if the argument is a reference to the receiver object; `false` otherwise.

    attributes: final
    definition classes: AnyRef

15. #### def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (`this`) with the argument object (`arg0`) for equivalence.

    This method is used to compare the receiver object (`this`) with the argument object (`arg0`) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance `x` of type `Any`, `x.equals(x)` should return `true`. * It is symmetric: for any instances `x` and `y` of type `Any`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. * It is transitive: for any instances `x`, `y`, and `z` of type `AnyRef` if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override `hashCode` to ensure that objects that are "equal" (`o1.equals(o2)` returns `true`) hash to the same scala.Int (`o1.hashCode.equals(o2.hashCode)`).

    arg0

      the object to compare against this object for equality.

    returns

      `true` if the receiver object is equivalent to the argument; `false` otherwise.

    definition classes: AnyRef → Any

16. #### 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: AbstractSuite

17. #### def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the `finalize` method are invoked, as well as the interaction between `finalize`and non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef

18. #### def getClass(): java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

      a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef

19. #### def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (`o1.hashCode.equals(o2.hashCode)`) yet not be equal (`o1.equals(o2)` returns `false`). A degenerate implementation could always return `0`. However, it is required that if two objects are equal (`o1.equals(o2)` returns `true`) that they have identical hash codes (`o1.hashCode.equals(o2.hashCode)`). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the `equals` method.

    returns

      the hash code value for the object.

    definition classes: AnyRef → Any

20. #### def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression`1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    attributes: final
    definition classes: Any

21. #### def ne(arg0: AnyRef): Boolean

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    arg0

      the object to compare against this object for reference dis-equality.

    returns

      `false` if the argument is not a reference to the receiver object; `true` otherwise.

    attributes: final
    definition classes: AnyRef

22. #### def nestedSuites: List[Suite]

    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`.

    attributes: abstract
    definition classes: AbstractSuite

23. #### def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

24. #### def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

25. #### def run(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

    Runs this suite of tests.

    Runs this suite of tests.

    testName

      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`.

    reporter

      the `Reporter` to which results will be reported

    stopper

      the `Stopper` that will be consulted to determine whether to stop execution early.

    filter

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

    configMap

      a `Map` of key-value pairs that can be used by the executing `Suite` of tests.

    distributor

      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.

    tracker

      a `Tracker` tracking `Ordinal`s being fired by the current thread.

    attributes: abstract
    definition classes: AbstractSuite

26. #### def runNestedSuites(reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

    Runs zero to many of this suite's nested suites.

    Runs zero to many of this suite's nested suites.

    reporter

      the `Reporter` to which results will be reported

    stopper

      the `Stopper` that will be consulted to determine whether to stop execution early.

    filter

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

    configMap

      a `Map` of key-value pairs that can be used by the executing `Suite` of tests.

    distributor

      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.

    tracker

      a `Tracker` tracking `Ordinal`s being fired by the current thread.

    attributes: protected abstract
    definition classes: AbstractSuite

27. #### def runTest(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], tracker: Tracker): Unit

    Run a test surrounded by calls to `beforeEach` and `afterEach`.

    Run a test surrounded by calls to `beforeEach` and `afterEach`.

    This trait's implementation of this method ("this method") invokes`beforeEach(configMap)`before running each test and `afterEach(configMap)`after running each test. It runs each test by invoking `super.runTest`, passing along the five parameters passed to it.

    If any invocation of `beforeEach` completes abruptly with an exception, this method will complete abruptly with the same exception. If any call to`super.runTest` completes abruptly with an exception, this method will complete abruptly with the same exception, however, before doing so, it will invoke `afterEach`. If <cod>afterEach also completes abruptly with an exception, this method will nevertheless complete abruptly with the exception previously thrown by `super.runTest`. If `super.runTest` returns normally, but `afterEach` completes abruptly with an exception, this method will complete abruptly with the exception thrown by `afterEach`.

    testName

      the name of one test to execute.

    reporter

      the `Reporter` to which results will be reported

    stopper

      the `Stopper` that will be consulted to determine whether to stop execution early.

    configMap

      a `Map` of key-value pairs that can be used by the executing `Suite` of tests.

    tracker

      a `Tracker` tracking `Ordinal`s being fired by the current thread.

    attributes: protected
    definition classes: BeforeAndAfterEach → AbstractSuite

28. #### def runTests(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

    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`.

    reporter

      the `Reporter` to which results will be reported

    stopper

      the `Stopper` that will be consulted to determine whether to stop execution early.

    filter

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

    configMap

      a `Map` of key-value pairs that can be used by the executing `Suite` of tests.

    distributor

      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.

    tracker

      a `Tracker` tracking `Ordinal`s being fired by the current thread.

    attributes: protected abstract
    definition classes: AbstractSuite

29. #### def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef

30. #### 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: AbstractSuite

31. #### def testNames: Set[String]

    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.

    attributes: abstract
    definition classes: AbstractSuite

32. #### def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    definition classes: AnyRef → Any

33. #### def wait(): Unit

    attributes: final
    definition classes: AnyRef

34. #### def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef

35. #### def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef

36. #### 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 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 FixtureSuite.

    test

      the no-arg test function to run with a fixture

    attributes: protected abstract
    definition classes: AbstractSuite