A suite of tests that can be run with either JUnit or ScalaTest. This trait allows you to write JUnit 4 tests
with ScalaTest's more concise assertion syntax as well as JUnit's assertions (assertEquals, etc.).
You create tests by defining methods that are annotated with Test, and can create fixtures with
methods annotated with Before and After. For example:
BECAUSE OF A SCALADOC BUG IN SCALA 2.8, I HAD TO PUT A SPACE AFTER THE AT SIGN IN ANNOTATION EXAMPLES. IF YOU WANT TO COPY AND PASTE FROM THESE EXAMPLES, YOU'LL NEED TO REMOVE THE SPACE BY HAND, OR COPY FROM THE JUNITSUITE SCALADOC FOR VERSION 1.1 INSTEAD, WHICH IS ALSO VALID FOR 1.3. - Bill Venners
import org.scalatest.junit.JUnitSuite import scala.collection.mutable.ListBuffer import _root_.org.junit.Test import _root_.org.junit.Beforeclass TwoSuite extends JUnitSuite {
var sb: StringBuilder = _ var lb: ListBuffer[String] = _
@ Before def initialize() { sb = new StringBuilder("ScalaTest is ") lb = new ListBuffer[String] }
@ Test def verifyEasy() { sb.append("easy!") assert(sb.toString === "ScalaTest is easy!") assert(lb.isEmpty) lb += "sweet" }
@ Test def verifyFun() { sb.append("fun!") assert(sb.toString === "ScalaTest is fun!") assert(lb.isEmpty) } }
To execute JUnitSuites with ScalaTest's Runner, you must include JUnit's jar file on the class path or runpath.
This version of JUnitSuite was tested with JUnit version 4.4.
Instances of this trait are not thread safe.
Class used via an implicit conversion to enable any two objects to be compared with
=== in assertions in tests.
A test function taking no arguments, which also provides a test name and config map.
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.
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.
the receiver object.
Assert that an Option[String] is None.
Assert that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestFailedException with the String
value of the Some included in the TestFailedException's
detail message.
This form of assert is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b)
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
Assert that an Option[String] is None.
Assert that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestFailedException with the String
value of the Some, as well as the
String obtained by invoking toString on the
specified message,
included in the TestFailedException's detail message.
This form of assert is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b, "extra info reported if assertion fails")
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
An objects whose toString method returns a message to include in a failure report.
Assert that a boolean condition, described in String
message, is true.
Assert that a boolean condition, described in String
message, is true.
If the condition is true, this method returns normally.
Else, it throws TestFailedException with the
String obtained by invoking toString on the
specified message as the exception's detail message.
the boolean condition to assert
An objects whose toString method returns a message to include in a failure report.
Assert that a boolean condition is true.
Assert that a boolean condition is true.
If the condition is true, this method returns normally.
Else, it throws TestFailedException.
the boolean condition to assert
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.
Implicit conversion from Any to Equalizer, used to enable
assertions with === comparisons.
Implicit conversion from Any to Equalizer, used to enable
assertions with === comparisons.
For more information on this mechanism, see the documentation for </code>Equalizer</code>.
Because trait Suite mixes in Assertions, this implicit conversion will always be
available by default in ScalaTest Suites. This is the only implicit conversion that is in scope by default in every
ScalaTest Suite. Other implicit conversions offered by ScalaTest, such as those that support the matchers DSL
or invokePrivate, must be explicitly invited into your test code, either by mixing in a trait or importing the
members of its companion object. The reason ScalaTest requires you to invite in implicit conversions (with the exception of the
implicit conversion for === operator) is because if one of ScalaTest's implicit conversions clashes with an
implicit conversion used in the code you are trying to test, your program won't compile. Thus there is a chance that if you
are ever trying to use a library or test some code that also offers an implicit conversion involving a === operator,
you could run into the problem of a compiler error due to an ambiguous implicit conversion. If that happens, you can turn off
the implicit conversion offered by this convertToEqualizer method simply by overriding the method in your
Suite subclass, but not marking it as implicit:
// In your Suite subclass override def convertToEqualizer(left: Any) = new Equalizer(left)
the object whose type to convert to Equalizer.
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.
Executes the test specified as testName in this Suite with the specified configMap, printing
results to the standard output.
Executes the test specified as testName in this Suite with the specified configMap, printing
results to the standard output.
This method implementation calls run on this Suite, passing in:
testName - Some(testName)reporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set()
for tagsToExcludeconfigMap - the specified configMap Map[String, Any]distributor - Nonetracker - a new TrackerThis method serves as a convenient way to execute a single test, passing in some objects via the configMap, especially from
within the Scala interpreter.
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().
the name of one test to run.
a Map of key-value pairs that can be used by the executing Suite of tests.
Executes the test specified as testName in this Suite, printing results to the standard output.
Executes the test specified as testName in this Suite, printing results to the standard output.
This method implementation calls run on this Suite, passing in:
testName - Some(testName)reporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set()
for tagsToExcludeconfigMap - an empty Map[String, Any]distributor - Nonetracker - a new TrackerThis method serves as a convenient way to run a single test, especially from within the Scala interpreter.
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().
the name of one test to run.
Executes this Suite with the specified configMap, printing results to the standard output.
Executes this Suite with the specified configMap, printing results to the standard output.
This method implementation calls run on this Suite, passing in:
testName - Nonereporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set()
for tagsToExcludeconfigMap - the specified configMap Map[String, Any]distributor - Nonetracker - a new TrackerThis method serves as a convenient way to execute a Suite, passing in some objects via the configMap, especially from within the Scala interpreter.
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().
a Map of key-value pairs that can be used by the executing Suite of tests.
Executes this Suite, printing results to the standard output.
Executes this Suite, printing results to the standard output.
This method implementation calls run on this Suite, passing in:
testName - Nonereporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set()
for tagsToExcludeconfigMap - an empty Map[String, Any]distributor - Nonetracker - a new TrackerThis method serves as a convenient way to execute a Suite, especially from
within the Scala interpreter.
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run
is because junit.framework.TestCase declares a run method
that takes no arguments but returns a junit.framework.TestResult. That
run method would not overload with this method if it were named run,
because it would have the same parameters but a different return type than the one
defined in TestCase. To facilitate integration with JUnit 3, therefore,
these convenience "run" methods are named execute. In particular, this allows trait
org.scalatest.junit.JUnit3Suite to extend both org.scalatest.Suite and
junit.framework.TestCase, which enables the creating of classes that
can be run with either ScalaTest or JUnit 3.
Expect that the value passed as expected equals the value passed as actual.
Expect that the value passed as expected equals the value passed as actual.
If the actual value equals the expected value
(as determined by ==), expect returns
normally. Else, expect throws an
TestFailedException whose detail message includes the expected and actual values.
the expected value
the actual value, which should equal the passed expected value
Expect that the value passed as expected equals the value passed as actual.
Expect that the value passed as expected equals the value passed as actual.
If the actual equals the expected
(as determined by ==), expect returns
normally. Else, if actual is not equal to expected, expect throws an
TestFailedException whose detail message includes the expected and actual values, as well as the String
obtained by invoking toString on the passed message.
the expected value
An object whose toString method returns a message to include in a failure report.
the actual value, which should equal the passed expected value
Returns the number of tests expected to be run by JUnit when run is invoked
on this JUnitSuite.
Returns the number of tests expected to be run by JUnit when run is invoked
on this JUnitSuite.
If tagsToInclude in the passed Filter is defined, this class's
implementation of this method returns 0. Else this class's implementation of this method
returns the size of the set returned by testNames on the current instance,
less the number of tests that were annotated with org.junit.Ignore.
a Filter with which to filter tests to count based on their tags
Throws TestFailedException, with the passed
Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passed
Throwable cause, to indicate a test failed.
The getMessage method of the thrown TestFailedException
will return cause.toString().
a Throwable that indicates the cause of the failure.
Throws TestFailedException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
A message describing the failure.
A Throwable that indicates the cause of the failure.
Throws TestFailedException, with the passed
String message as the exception's detail
message, to indicate a test failed.
Throws TestFailedException, with the passed
String message as the exception's detail
message, to indicate a test failed.
A message describing the failure.
Throws TestFailedException to indicate a test failed.
Throws TestFailedException to indicate a test failed.
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.
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.
The groups methods has been deprecated and will be removed in a future version of ScalaTest.
The groups methods has been deprecated and will be removed in a future version of ScalaTest.
Please call (and override) tags instead.
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.
Intercept and return an exception that's expected to be thrown by the passed function value.
Intercept and return an exception that's expected to
be thrown by the passed function value. The thrown exception must be an instance of the
type specified by the type parameter of this method. This method invokes the passed
function. If the function throws an exception that's an instance of the specified type,
this method returns that exception. Else, whether the passed function returns normally
or completes abruptly with a different exception, this method throws TestFailedException.
Note that the type specified as this method's type parameter may represent any subtype of
AnyRef, not just Throwable or one of its subclasses. In
Scala, exceptions can be caught based on traits they implement, so it may at times make sense
to specify a trait that the intercepted exception's class must mix in. If a class instance is
passed for a type that could not possibly be used to catch an exception (such as String,
for example), this method will complete abruptly with a TestFailedException.
the function value that should throw the expected exception
an implicit Manifest representing the type of the specified
type parameter.
the intercepted exception, if it is of the expected type
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.
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. If this Suite contains no nested Suites,
this method returns an empty List. This trait's implementation of this method returns an empty List.
A List of this Suite object's nested Suites. If this Suite contains no nested Suites,
this method returns an empty List. This trait's implementation of 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.
Throws TestPendingException to indicate a test is pending.
Throws TestPendingException to indicate a test is pending.
A pending test is one that has been given a name but is not yet implemented. The purpose of pending tests is to facilitate a style of testing in which documentation of behavior is sketched out before tests are written to verify that behavior (and often, the before the behavior of the system being tested is itself implemented). Such sketches form a kind of specification of what tests and functionality to implement later.
To support this style of testing, a test can be given a name that specifies one
bit of behavior required by the system being tested. The test can also include some code that
sends more information about the behavior to the reporter when the tests run. At the end of the test,
it can call method pending, which will cause it to complete abruptly with TestPendingException.
Because tests in ScalaTest can be designated as pending with TestPendingException, both the test name and any information
sent to the reporter when running the test can appear in the report of a test run. (In other words,
the code of a pending test is executed just like any other test.) However, because the test completes abruptly
with TestPendingException, the test will be reported as pending, to indicate
the actual test, and possibly the functionality it is intended to test, has not yet been implemented.
Note: This method always completes abruptly with a TestPendingException. Thus it always has a side
effect. Methods with side effects are usually invoked with parentheses, as in pending(). This
method is defined as a parameterless method, in flagrant contradiction to recommended Scala style, because it
forms a kind of DSL for pending tests. It enables tests in suites such as FunSuite or Spec
to be denoted by placing "(pending)" after the test name, as in:
test("that style rules are not laws") (pending)
Readers of the code see "pending" in parentheses, which looks like a little note attached to the test name to indicate
it is pending. Whereas "(pending()) looks more like a method call, "(pending)" lets readers
stay at a higher level, forgetting how it is implemented and just focusing on the intent of the programmer who wrote the code.
Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else
throw TestFailedException.
Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else
throw TestFailedException.
This method can be used to temporarily change a failing test into a pending test in such a way that it will
automatically turn back into a failing test once the problem originally causing the test to fail has been fixed.
At that point, you need only remove the pendingUntilFixed call. In other words, a
pendingUntilFixed surrounding a block of code that isn't broken is treated as a test failure.
The motivation for this behavior is to encourage people to remove pendingUntilFixed calls when
there are no longer needed.
This method facilitates a style of testing in which tests are written before the code they test. Sometimes you may
encounter a test failure that requires more functionality than you want to tackle without writing more tests. In this
case you can mark the bit of test code causing the failure with pendingUntilFixed. You can then write more
tests and functionality that eventually will get your production code to a point where the original test won't fail anymore.
At this point the code block marked with pendingUntilFixed will no longer throw an exception (because the
problem has been fixed). This will in turn cause pendingUntilFixed to throw TestFailedException
with a detail message explaining you need to go back and remove the pendingUntilFixed call as the problem orginally
causing your test code to fail has been fixed.
a block of code, which if it completes abruptly, should trigger a TestPendingException
Runs this suite of tests.
Runs this suite of tests.
If testName is None, this trait's implementation of this method
calls these two methods on this object in this order:
runNestedSuites(report, stopper, tagsToInclude, tagsToExclude, configMap, distributor)runTests(testName, report, stopper, tagsToInclude, tagsToExclude, configMap)If testName is defined, then this trait's implementation of this method
calls runTests, but does not call runNestedSuites. This behavior
is part of the contract of this method. Subclasses that override run must take
care not to call runNestedSuites if testName is defined. (The
OneInstancePerTest trait depends on this behavior, for example.)
Subclasses and subtraits that override this run method can implement them without
invoking either the runTests or runNestedSuites methods, which
are invoked by this trait's implementation of this method. It is recommended, but not required,
that subclasses and subtraits that override run in a way that does not
invoke runNestedSuites also override runNestedSuites and make it
final. Similarly it is recommended, but not required,
that subclasses and subtraits that override run in a way that does not
invoke runTests also override runTests (and runTest,
which this trait's implementation of runTests calls) and make it
final. The implementation of these final methods can either invoke the superclass implementation
of the method, or throw an UnsupportedOperationException if appropriate. The
reason for this recommendation is that ScalaTest includes several traits that override
these methods to allow behavior to be mixed into a Suite. For example, trait
BeforeAndAfterEach overrides runTestss. In a Suite
subclass that no longer invokes runTests from run, the
BeforeAndAfterEach trait is not applicable. Mixing it in would have no effect.
By making runTests final in such a Suite subtrait, you make
the attempt to mix BeforeAndAfterEach into a subclass of your subtrait
a compiler error. (It would fail to compile with a complaint that BeforeAndAfterEach
is trying to override runTests, which is a final method in your trait.)
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 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.
Throws UnsupportedOperationException, because this method is unused by this
trait, given this trait's run method delegates to JUnit to run
its tests.
Throws UnsupportedOperationException, because this method is unused by this
trait, given this trait's run method delegates to JUnit to run
its tests.
The main purpose of this method implementation is to render a compiler error an attempt
to mix in a trait that overrides runNestedSuites. Because this
trait does not actually use runNestedSuites, the attempt to mix
in behavior would very likely not work.
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.
Throws UnsupportedOperationException, because this method is unused by this
trait, given this traits's run method delegates to JUnit to run
its tests.
Throws UnsupportedOperationException, because this method is unused by this
trait, given this traits's run method delegates to JUnit to run
its tests.
The main purpose of this method implementation is to render a compiler error an attempt
to mix in a trait that overrides runTest. Because this
trait does not actually use runTest, the attempt to mix
in behavior would very likely not work.
the name of one test to run.
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.
Throws UnsupportedOperationException, because this method is unused by this
trait, given this trait's run method delegates to JUnit to run
its tests.
Throws UnsupportedOperationException, because this method is unused by this
trait, given this trait's run method delegates to JUnit to run
its tests.
The main purpose of this method implementation is to render a compiler error an attempt
to mix in a trait that overrides runTests. Because this
trait does not actually use runTests, the attempt to mix
in behavior would very likely not work.
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 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.
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 for Reports to pass to the suiteStarting, suiteCompleted,
and suiteAborted methods of the Reporter.
this Suite object's suite name.
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.
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.
This trait's implementation of this method uses Java reflection to discover any Java annotations attached to its test methods. The
fully qualified name of each unique annotation that extends TagAnnotation is considered a tag. This trait's
implementation of this method, therefore, places one key/value pair into to the
Map for each unique tag annotation name discovered through reflection. The mapped value for each tag name key will contain
the test method name, as provided via the testNames method.
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 tag has no tests, its name should not appear as a key in the
returned Map.
Note, the TagAnnotation annotation was introduced in ScalaTest 1.0, when "groups" were renamed
to "tags." In 1.0 and 1.1, the TagAnnotation will continue to not be required by an annotation on a Suite
method. Any annotation on a Suite method will be considered a tag until 1.2, to give users time to add
TagAnnotations on any tag annotations they made prior to the 1.0 release. From 1.2 onward, only annotations
themselves annotated by TagAnnotation will be considered tag annotations.
Returns the set of test names that will be executed by JUnit when run is invoked
on an instance of this class, or the instance is passed directly to JUnit for running.
Returns the set of test names that will be executed by JUnit when run is invoked
on an instance of this class, or the instance is passed directly to JUnit for running.
The iterator obtained by invoking elements on this
returned Set will produce the test names in their natural order, as determined by String's
compareTo method. Nevertheless, this method is not consulted by JUnit when it
runs the tests, and JUnit may run the tests in any 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.
Executes the block of code passed as the second parameter, and, if it
completes abruptly with a ModifiableMessage exception,
prepends the "clue" string passed as the first parameter to the beginning of the detail message
of that thrown exception, then rethrows it.
Executes the block of code passed as the second parameter, and, if it
completes abruptly with a ModifiableMessage exception,
prepends the "clue" string passed as the first parameter to the beginning of the detail message
of that thrown exception, then rethrows it. If clue does not end in a white space
character, one space will be added
between it and the existing detail message (unless the detail message is
not defined).
This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:
withClue("(Employee's name was: " + employee.name + ")") {
intercept[IllegalArgumentException] {
employee.getTask(-1)
}
}
If an invocation of intercept completed abruptly with an exception, the resulting message would be something like:
(Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown
Throws UnsupportedOperationException, because this method is unused by this
class, given this class's run method delegates to JUnit to run
its tests.
Throws UnsupportedOperationException, because this method is unused by this
class, given this class's run method delegates to JUnit to run
its tests.
The main purpose of this method implementation is to render a compiler error an attempt
to mix in a trait that overrides withFixture. Because this
trait does not actually use withFixture, the attempt to mix
in behavior would very likely not work.
the no-arg test function to run with a fixture
A suite of tests that can be run with either JUnit or ScalaTest. This trait allows you to write JUnit 4 tests with ScalaTest's more concise assertion syntax as well as JUnit's assertions (
assertEquals, etc.). You create tests by defining methods that are annotated withTest, and can create fixtures with methods annotated withBeforeandAfter. For example:BECAUSE OF A SCALADOC BUG IN SCALA 2.8, I HAD TO PUT A SPACE AFTER THE AT SIGN IN ANNOTATION EXAMPLES. IF YOU WANT TO COPY AND PASTE FROM THESE EXAMPLES, YOU'LL NEED TO REMOVE THE SPACE BY HAND, OR COPY FROM THE JUNITSUITE SCALADOC FOR VERSION 1.1 INSTEAD, WHICH IS ALSO VALID FOR 1.3. - Bill Venners
To execute
JUnitSuites with ScalaTest'sRunner, you must include JUnit's jar file on the class path or runpath. This version ofJUnitSuitewas tested with JUnit version 4.4.Instances of this trait are not thread safe.