Class used via an implicit conversion to enable any two objects to be compared with
=== in assertions in tests.
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 clue,
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 clue 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
Assume that an Option[String] is None.
Assume that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestCanceledException with the String
value of the Some included in the TestCanceledException's
detail message.
This form of assume 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
Assume that an Option[String] is None.
Assume that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestCanceledException with the String
value of the Some, as well as the
String obtained by invoking toString on the
specified clue,
included in the TestCanceledException's detail message.
This form of assume is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assume(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.
Assume that a boolean condition, described in String
message, is true.
Assume that a boolean condition, described in String
message, is true.
If the condition is true, this method returns normally.
Else, it throws TestCanceledException with the
String obtained by invoking toString on the
specified clue as the exception's detail message.
the boolean condition to assume
An objects whose toString method returns a message to include in a failure report.
Assume that a boolean condition is true.
Assume that a boolean condition is true.
If the condition is true, this method returns normally.
Else, it throws TestCanceledException.
the boolean condition to assert
Throws TestCanceledException, with the passed
Throwable cause, to indicate a test failed.
Throws TestCanceledException, with the passed
Throwable cause, to indicate a test failed.
The getMessage method of the thrown TestCanceledException
will return cause.toString.
a Throwable that indicates the cause of the cancellation.
Throws TestCanceledException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
Throws TestCanceledException, 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 TestCanceledException, with the passed
String message as the exception's detail
message, to indicate a test was canceled.
Throws TestCanceledException, with the passed
String message as the exception's detail
message, to indicate a test was canceled.
A message describing the cancellation.
Throws TestCanceledException to indicate a test was canceled.
Throws TestCanceledException to indicate a test was canceled.
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 Equalizer.
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.
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 ==), expectResult returns
normally. Else, expect throws a
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 ==), expectResult returns
normally. Else, if actual is not equal to expected, expectResult throws a
TestFailedException whose detail message includes the expected and actual values, as well as the String
obtained by invoking toString on the passed clue.
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
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.
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
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
This expect method has been deprecated; Please use expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
To get rid of the deprecation warning, simply replace expect with
expectResult. The name expect will be used for a different purposes in
a future version of ScalaTest.
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
To get rid of the deprecation warning, simply replace expect with
expectResult. The name expect will be used for a different purposes in
a future version of ScalaTest.
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of expectResult instead.
Companion object that facilitates the importing of
AssertionsForJUnitmembers as an alternative to mixing it in. One use case is to importAssertionsForJUnitmembers so you can use them in the Scala interpreter: