BeforeAndAfterEach

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:

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:

def!=(arg0: Any): Boolean

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

attributes: final

definition classes: Any

def##(): Int

attributes: final

definition classes: AnyRef → Any

def$asInstanceOf[T0](): T0

attributes: final

definition classes: AnyRef

def$isInstanceOf[T0](): Boolean

attributes: final

definition classes: AnyRef

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

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

defafterEach(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

defafterEach(): 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 thisafterEach() 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

defasInstanceOf[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 expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(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

defbeforeEach(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

defbeforeEach(): 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 thisbeforeEach() 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

defclone(): 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

defeq(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

defequals(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.

deffinalize(): 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 finalizeand non-local returns and exceptions, are all platform dependent.

attributes: protected

definition classes: AnyRef

defgetClass(): java.lang.Class[_]

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

defhashCode(): 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

defisInstanceOf[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 expression1.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

defne(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.

This trait's implementation of this method ("this method") invokesbeforeEach(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 tosuper.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.

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.

defsynchronized[T0](arg0: T0): T0

deftags: 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.

deftestNames: 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 Stringtest 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.

defwait(arg0: Long, arg1: Int): Unit

defwait(arg0: Long): 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 vars in this Suite or initializing
a globally accessible external database. If you want to avoid reassigning instance vars
you can use FixtureSuite.