This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
Class used via an implicit conversion to enable any two objects to be compared with
===
in assertions in tests.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL.
This method enables the following syntax:
This method enables the following syntax:
num should (not be < (10) and not be > (17)) ^
This method enables the following syntax:
This method enables the following syntax:
num should (not be <= (10) and not be > (17)) ^
This method enables the following syntax:
This method enables the following syntax:
num should not be === (10)
^
This method enables the following syntax:
This method enables the following syntax:
num should (not be > (10) and not be < (7)) ^
This method enables the following syntax:
This method enables the following syntax:
num should (not be >= (10) and not be < (7)) ^
This field enables the following syntax:
This field enables the following syntax:
badBook should not be a ('goodRead)
^
This field enables the following syntax:
This field enables the following syntax:
badBook should not be an (excellentRead) ^
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 enables syntax such as the following:
This method enables syntax such as the following:
obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string)) ^
This method enables syntax such as the following:
This method enables syntax such as the following:
list should (contain ('a') and have length (7)) ^
Implicitly converts an object of type Byte
to a BytePlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
Implicitly converts an object of type Byte
to a BytePlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
Implicitly converts an object of type Double
to a DoublePlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
Implicitly converts an object of type Double
to a DoublePlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
Implicitly converts an object of type Float
to a FloatPlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
Implicitly converts an object of type Float
to a FloatPlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
This implicit conversion method converts an object with a getLength
field of type Int
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a getLength
field of type Int
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a getLength
field of type Long
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a getLength
field of type Long
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a getLength
method of type Int
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a getLength
method of type Int
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a getLength
method of type Long
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a getLength
method of type Long
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a getSize
field of type Int
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a getSize
field of type Int
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a getSize
field of type Long
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a getSize
field of type Long
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a getSize
method of type Int
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a getSize
method of type Int
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a getSize
method of type Long
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a getSize
method of type Long
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
Implicitly converts an object of type Int
to a IntPlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
Implicitly converts an object of type Int
to a IntPlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
This implicit conversion method converts an object with a length
field of type Int
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a length
field of type Int
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a length
field of type Long
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a length
field of type Long
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a length
method of type Int
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a length
method of type Int
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a length
method of type Long
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
This implicit conversion method converts an object with a length
method of type Long
to a
LengthWrapper
, to enable that object to be used with the have length (7)
syntax.
Implicitly converts an object of type Long
to a LongPlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
Implicitly converts an object of type Long
to a LongPlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
This implicit conversion method enables the following syntax (javaMap
is a java.util.Map
):
This implicit conversion method enables the following syntax (javaMap
is a java.util.Map
):
javaMap should (contain key ("two"))
The (contain key ("two"))
expression will result in a Matcher[scala.collection.Map[String, Any]]
. This
implicit conversion method will convert that matcher to a Matcher[java.util.Map[String, Any]]
.
Implicitly converts an object of type Short
to a ShortPlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
Implicitly converts an object of type Short
to a ShortPlusOrMinusWrapper
,
to enable a plusOrMinus
method to be invokable on that object.
This implicit conversion method converts an object with a size
field of type Int
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a size
field of type Int
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a size
field of type Long
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a size
field of type Long
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a size
method of type Int
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a size
method of type Int
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a size
method of type Long
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts an object with a size
method of type Long
to a
LengthWrapper
, to enable that object to be used with the have size (7)
syntax.
This implicit conversion method converts a Symbol
to a
HavePropertyMatcherGenerator
, to enable the symbol to be used with the have ('author ("Dickens"))
syntax.
This implicit conversion method converts a Symbol
to a
HavePropertyMatcherGenerator
, to enable the symbol to be used with the have ('author ("Dickens"))
syntax.
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 Suite
s. 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 implicit conversion method enables ScalaTest matchers expressions that involve and
and or
.
This implicit conversion method enables ScalaTest matchers expressions that involve and
and or
.
This implicit conversion method enables the following syntax:
This implicit conversion method enables the following syntax:
Array(1, 2) should (not contain (3) and not contain (2))
The (not contain ("two"))
expression will result in a Matcher[Traversable[String]]
. This
implicit conversion method will convert that matcher to a Matcher[Array[String]]
.
This implicit conversion method enables the following syntax (javaColl
is a java.util.Collection
):
This implicit conversion method enables the following syntax (javaColl
is a java.util.Collection
):
javaColl should contain ("two")
The (contain ("two"))
expression will result in a Matcher[Traversable[String]]
. This
implicit conversion method will convert that matcher to a Matcher[java.util.Collection[String]]
.
This method enables syntax such as the following:
This method enables syntax such as the following:
string should (endWith ("ago") and include ("score")) ^
This method enables the following syntax:
This method enables the following syntax:
result should equal (7)
^
The left should equal (right)
syntax works by calling ==
on the left
value, passing in the right
value, on every type except arrays. If both left
and right are arrays, deep
will be invoked on both left
and right
before comparing them with ==. Thus, even though this expression
will yield false, because Array
's equals
method compares object identity:
Array(1, 2) == Array(1, 2) // yields false
The following expression will not result in a TestFailedException
, because ScalaTest will compare
the two arrays structurally, taking into consideration the equality of the array's contents:
Array(1, 2) should equal (Array(1, 2)) // succeeds (i.e., does not throw TestFailedException)
If you ever do want to verify that two arrays are actually the same object (have the same identity), you can use the
be theSameInstanceAs
syntax.
This method enables syntax such as the following:
This method enables syntax such as the following:
evaluating { "hi".charAt(-1) } should produce [StringIndexOutOfBoundsException] ^
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
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 enables syntax such as the following:
This method enables syntax such as the following:
string should (fullyMatch regex ("Hel*o, wor.d") and not have length (99)) ^
This method enables syntax such as the following:
This method enables syntax such as the following:
list should (have length (3) and not contain ('a')) ^
This method enables syntax such as the following:
This method enables syntax such as the following:
string should (include ("hope") and not startWith ("no")) ^
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 field enables the following syntax:
This field enables the following syntax:
map should not contain key (10)
^
This field enables the following syntax:
This field enables the following syntax:
"hi" should not have length (3) ^
This field enables syntax like the following:
This field enables syntax like the following:
myFile should (not be an (directory) and not have ('name ("foo.bar"))) ^
This method enables the following syntax:
This method enables the following syntax:
evaluating { "hi".charAt(-1) } should produce [StringIndexOutOfBoundsException] ^
This field enables the following syntax:
This field enables the following syntax:
"eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r) ^
This field enables the following syntax:
This field enables the following syntax:
set should not have size (3)
^
This method enables syntax such as the following:
This method enables syntax such as the following:
string should (startWith ("Four") and include ("year")) ^
This field enables the following syntax:
This field enables the following syntax:
oneString should not be theSameInstanceAs (anotherString) ^
This field enables the following syntax:
This field enables the following syntax:
map should not contain value (10)
^
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 trait is part of the ScalaTest matchers DSL. Please see the documentation for ShouldMatchers or MustMatchers for an overview of the matchers DSL.