o != arg0 is the same as !(o == (arg0)).
o != arg0 is the same as !(o == (arg0)).
the object to compare against this object for dis-equality.
false if the receiver object is equivalent to the argument; true otherwise.
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).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
o == arg0 is the same as o.equals(arg0).
o == arg0 is the same as o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
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.
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 thisafterAll() 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.
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.
the receiver object.
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.
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.
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.
a copy of the receiver object.
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).
the object to compare against this object for reference equality.
true if the argument is a reference to the receiver object; false otherwise.
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)).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
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.
a Filter with which to filter tests to count based on their tags
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.
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.
a representation that corresponds to the dynamic class of the receiver object.
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.
the hash code value for the object.
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.
true if the receiver object is an instance of erasure of type T0; false otherwise.
o.ne(arg0) is the same as !(o.eq(arg0)).
o.ne(arg0) is the same as !(o.eq(arg0)).
the object to compare against this object for reference dis-equality.
false if the argument is not a reference to the receiver object; true otherwise.
A List of this Suite object's nested Suites.
A List of this Suite object's nested Suites. If this Suite contains no nested Suites,
this method returns an empty List.
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.
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.
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 tosuper.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.
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.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be executed
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.
a Tracker tracking Ordinals being fired by the current thread.
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
a Tracker tracking Ordinals being fired by the current thread.
Runs a test.
Runs a test.
the name of one test to execute.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Map of key-value pairs that can be used by the executing Suite of tests.
a Tracker tracking Ordinals being fired by the current thread.
Runs zero to many of this suite's tests.
Runs zero to many of this suite's 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.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
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.
a Tracker tracking Ordinals being fired by the current thread.
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.
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.
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.
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.
the no-arg test function to run with a fixture
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(the mainrunmethod that takes seven parameters, an optional test name, reporter, stopper, filter, configMap, optional distributor, and tracker) and calls thebeforeAllmethod, then callssuper.run. After thesuper.runinvocation completes, whether it returns normally or completes abruptly with an exception, this trait'srunmethod will invokeafterAll.Trait
BeforeAndAfterAlldefines two overloaded variants each ofbeforeAllandafterAll, one that takes aconfigMapand another that takes no arguments. This traits implemention of the variant that takes theconfigMapsimply invokes the variant that takes no parameters, which does nothing. Thus you can override whichever variant you want. If you need something from theconfigMapbefore all tests and nested suites are run, overridebeforeAll(Map[String, Any]). Otherwise, overridebeforeAll().For example, the following
MasterSuitemixes inBeforeAndAfterAlland inbeforeAll, creates and writes to a temp file, taking the name of the temp file from theconfigMap. This sameconfigMapis then passed to therunmethods of the nested suites,OneSuite,TwoSuite,RedSuite, andBlueSuite, so those suites can access the filename and, therefore, the file's contents. After all of the nested suites have executed,afterAllis invoked, which again grabs the file name from theconfigMapand deletes the file:Because the
BeforeAndAfterAlltrait invokessuper.runto run the suite, you may need to mix this trait in last to get the desired behavior. For example, this won't work, becauseBeforeAndAfterAllis "super" to FunSuite:You'd need to turn it around, so that
FunSuiteis "super" toBeforeAndAfterAll, like this:Note: This trait does not currently ensure that the code in
afterAllis executed after all the tests and nested suites are executed if aDistributoris passed. The plan is to do that eventually, but in the meantime, be aware thatafterAllis guaranteed to be run after all the tests and nested suites only when they are run sequentially.authors:
Bill Venners