Helper class used by code generated by the assert
macro.
Helper class used by code generated by the assert
macro.
Class used via an implicit conversion to enable two objects to be compared with
===
and !==
with a Boolean
result and an enforced type constraint between
two object types.
Class used via an implicit conversion to enable two objects to be compared with
===
and !==
with a Boolean
result and an enforced type constraint between
two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with a Boolean
result and no enforced type constraint between
two object types.
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with a Boolean
result and no enforced type constraint between
two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with an Option[String]
result and an enforced type constraint between
two object types.
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with an Option[String]
result and an enforced type constraint between
two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
The benefit of using assert(a === b)
rather than assert(a == b)
in ScalaTest code is
that a TestFailedException
produced by the former will include the values of a
and b
in its detail message.
Note: This class has "Legacy" in its name because its approach to error messages will eventually be replaced by macros. Once ScalaTest no longer supports Scala 2.9,
this class will be deprecated in favor of class Equalizer
. Instead of obtaining nice error messages via the Option[String]
returned by the methods of this class, the error messages will be obtained by a macro. The "legacy" approach to good error messages will continue to be
used, however, until ScalaTest no longer supports Scala 2.9, since macros were introduced to Scala (in experimental form) in 2.10.
The primary constructor takes one object, left
, whose type is being converted to Equalizer
. The left
value may be a null
reference, because this is allowed by Scala's ==
operator.
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with an Option[String]
result and no enforced type constraint between
two object types.
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with an Option[String]
result and no enforced type constraint between
two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
The benefit of using assert(a === b)
rather than assert(a == b)
in ScalaTest code is
that a TestFailedException
produced by the former will include the values of a
and b
in its detail message.
Note: This class has "Legacy" in its name because its approach to error messages will eventually be replaced by macros. Once ScalaTest no longer supports Scala 2.9,
this class will be deprecated in favor of class Equalizer
. Instead of obtaining nice error messages via the Option[String]
returned by the methods of this class, the error messages will be obtained by a macro. The "legacy" approach to good error messages will continue to be
used, however, until ScalaTest no longer supports Scala 2.9, since macros were introduced to Scala (in experimental form) in 2.10.
The primary constructor takes one object, left
, whose type is being converted to Equalizer
. The left
value may be a null
reference, because this is allowed by Scala's ==
operator.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should !== (<pivot> +- <tolerance>)
”
syntax of Matchers
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should !== (<pivot> +- <tolerance>)
”
syntax of Matchers
.
the Spread[T]
against which to compare the left-hand value
a TripleEqualsInvocationOnSpread
wrapping the passed Spread[T]
value, with
expectingEqual
set to false
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should !== null
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should !== null
” syntax
of Matchers
.
a null reference
a TripleEqualsInvocation
wrapping the passed null
value, with expectingEqual
set to false
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should !== <right>
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should !== <right>
” syntax
of Matchers
.
the right-hand side value for an equality assertion
a TripleEqualsInvocation
wrapping the passed right value, with expectingEqual
set to false
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should === (<pivot> +- <tolerance>)
”
syntax of Matchers
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should === (<pivot> +- <tolerance>)
”
syntax of Matchers
.
the Spread[T]
against which to compare the left-hand value
a TripleEqualsInvocationOnSpread
wrapping the passed Spread[T]
value, with
expectingEqual
set to true
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should === null
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should === null
” syntax
of Matchers
.
a null reference
a TripleEqualsInvocation
wrapping the passed null
value, with expectingEqual
set to true
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should === <right>
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should === <right>
” syntax
of Matchers
.
the right-hand side value for an equality assertion
a TripleEqualsInvocation
wrapping the passed right value, with expectingEqual
set to true
.
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 a helpful error message
appended with the String
obtained by invoking toString
on the
specified clue
as the exception's detail message.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
At this time, any other form of expression will just get a TestFailedException
with message saying the given
expression was false. In the future, we will enhance this macro to give helpful error messages in more situations.
In ScalaTest 2.0, however, this behavior was sufficient to allow the ===
that returns Boolean
,
not Option[String]
to be the default in tests. This makes ===
consistent between tests and production
code. If you have pre-existing code you wrote under ScalaTest 1.x, in which you are expecting===
to return an
Option[String]
, use can get that behavior back by mixing in trait LegacyTripleEquals
.
the boolean condition to assert
An objects whose toString
method returns a message to include in a failure report.
if message
is null
.
if the condition is false
.
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
.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
At this time, any other form of expression will get a TestFailedException
with message saying the given
expression was false. In the future, we will enhance this macro to give helpful error messages in more situations.
In ScalaTest 2.0, however, this behavior was sufficient to allow the ===
that returns Boolean
,
not Option[String]
to be the default in tests. This makes ===
consistent between tests and production
code. If you have pre-existing code you wrote under ScalaTest 1.x, in which you are expecting===
to return an
Option[String]
, use can get that behavior back by mixing in trait LegacyTripleEquals
.
the boolean condition to assert
if the condition is false
.
Asserts that a given string snippet of code passes both the Scala parser and type checker.
Asserts that a given string snippet of code passes both the Scala parser and type checker.
You can use this to make sure a snippet of code compiles:
assertCompiles("val a: Int = 1")
Although assertCompiles
is implemented with a macro that determines at compile time whether
the snippet of code represented by the passed string compiles, errors (i.e.,
snippets of code that do not compile) are reported as test failures at runtime.
the snippet of code that should compile
Asserts that a given string snippet of code does not pass either the Scala parser or type checker.
Asserts that a given string snippet of code does not pass either the Scala parser or type checker.
Often when creating libraries you may wish to ensure that certain arrangements of code that
represent potential “user errors” do not compile, so that your library is more error resistant.
ScalaTest's Assertions
trait includes the following syntax for that purpose:
assertDoesNotCompile("val a: String = \"a string")
Although assertDoesNotCompile
is implemented with a macro that determines at compile time whether
the snippet of code represented by the passed string doesn't compile, errors (i.e.,
snippets of code that do compile) are reported as test failures at runtime.
Note that the difference between assertTypeError
and assertDoesNotCompile
is
that assertDoesNotCompile
will succeed if the given code does not compile for any reason,
whereas assertTypeError
will only succeed if the given code does not compile because of
a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile
will return normally but assertTypeError
will throw a TestFailedException
.
the snippet of code that should not type check
Assert that the value passed as expected
equals the value passed as actual
.
Assert that the value passed as expected
equals the value passed as actual
.
If the actual
value equals the expected
value
(as determined by ==
), assertResult
returns
normally. Else, assertResult
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
if the passed actual
value does not equal the passed expected
value.
Assert that the value passed as expected
equals the value passed as actual
.
Assert that the value passed as expected
equals the value passed as actual
.
If the actual
equals the expected
(as determined by ==
), assertResult
returns
normally. Else, if actual
is not equal to expected
, assertResult
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
if the passed actual
value does not equal the passed expected
value.
Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.
Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.
Often when creating libraries you may wish to ensure that certain arrangements of code that
represent potential “user errors” do not compile, so that your library is more error resistant.
ScalaTest's Assertions
trait includes the following syntax for that purpose:
assertTypeError("val a: String = 1")
Although assertTypeError
is implemented with a macro that determines at compile time whether
the snippet of code represented by the passed string type checks, errors (i.e.,
snippets of code that do type check) are reported as test failures at runtime.
Note that the difference between assertTypeError
and assertDoesNotCompile
is
that assertDoesNotCompile
will succeed if the given code does not compile for any reason,
whereas assertTypeError
will only succeed if the given code does not compile because of
a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile
will return normally but assertTypeError
will throw a TestFailedException
.
the snippet of code that should not type check
Helper instance used by code generated by macro assertion.
Helper instance used by code generated by macro assertion.
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 a helpful error message
appended with String
obtained by invoking toString
on the
specified clue
as the exception's detail message.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
At this time, any other form of expression will just get a TestCanceledException
with message saying the given
expression was false. In the future, we will enhance this macro to give helpful error messages in more situations.
In ScalaTest 2.0, however, this behavior was sufficient to allow the ===
that returns Boolean
,
not Option[String]
to be the default in tests. This makes ===
consistent between tests and production
code. If you have pre-existing code you wrote under ScalaTest 1.x, in which you are expecting===
to return an
Option[String]
, use can get that behavior back by mixing in trait LegacyTripleEquals
.
the boolean condition to assume
An objects whose toString
method returns a message to include in a failure report.
if message
is null
.
if the condition is false
.
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
.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
At this time, any other form of expression will just get a TestCanceledException
with message saying the given
expression was false. In the future, we will enhance this macro to give helpful error messages in more situations.
In ScalaTest 2.0, however, this behavior was sufficient to allow the ===
that returns Boolean
,
not Option[String]
to be the default in tests. This makes ===
consistent between tests and production
code. If you have pre-existing code you wrote under ScalaTest 1.x, in which you are expecting===
to return an
Option[String]
, use can get that behavior back by mixing in trait LegacyTripleEquals
.
the boolean condition to assume
if the condition is false
.
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.
if cause
is null
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.
if message
or cause
is null
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.
if message
is null
Throws TestCanceledException
to indicate a test was canceled.
Throws TestCanceledException
to indicate a test was canceled.
Provides a Constraint[A, B]
class for any two types A
and B
, enforcing the type constraint that B
is
implicitly convertible to A
, given an implicit Equivalence[A]
.
Provides a Constraint[A, B]
class for any two types A
and B
, enforcing the type constraint that B
is
implicitly convertible to A
, given an implicit Equivalence[A]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's
areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits
ConversionCheckedTripleEquals
) and
ConversionCheckedLegacyTripleEquals
, and
overriden as non-implicit by the other subtraits in this package.
an Equivalence[A]
type class to which the Constraint.areEqual
method will delegate to determine equality.
an implicit conversion from B
to A
a Constraint[A, B]
whose areEqual
method delegates to the areEquivalent
method of
the passed Equivalence[A]
.
Provides a Constraint[A, B]
for any two types A
and B
, enforcing the type constraint
that A
must be a subtype of B
, given an explicit Equivalence[B]
.
Provides a Constraint[A, B]
for any two types A
and B
, enforcing the type constraint
that A
must be a subtype of B
, given an explicit Equivalence[B]
.
This method is used to enable the Explicitly
DSL for
TypeCheckedTripleEquals
by requiring an explicit Equivalance[B]
, but
taking an implicit function that provides evidence that A
is a subtype of B.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[B]
's
areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits
LowPriorityTypeCheckedConstraint
(extended by
TypeCheckedTripleEquals
), and
LowPriorityTypeCheckedLegacyConstraint
(extended by
TypeCheckedLegacyTripleEquals
), and
overriden as non-implicit by the other subtraits in this package.
an Equivalence[B]
type class to which the Constraint.areEqual
method
will delegate to determine equality.
evidence that A
is a subype of B
a Constraint[A, B]
whose areEqual
method delegates to the
areEquivalent
method of the passed Equivalence[B]
.
Provides a Constraint[A, B]
class for any two types A
and B
, enforcing the type constraint that A
is
implicitly convertible to B
, given an explicit Equivalence[B]
.
Provides a Constraint[A, B]
class for any two types A
and B
, enforcing the type constraint that A
is
implicitly convertible to B
, given an explicit Equivalence[B]
.
This method is used to enable the Explicitly
DSL for
ConversionCheckedTripleEquals
by requiring an explicit Equivalance[B]
, but
taking an implicit function that converts from A
to B.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[B]
's
areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits
LowPriorityConversionCheckedConstraint
(extended by
ConversionCheckedTripleEquals
), and
LowPriorityConversionCheckedLegacyConstraint
(extended by
ConversionCheckedLegacyTripleEquals
), and
overriden as non-implicit by the other subtraits in this package.
a Constraint[A, B]
whose areEqual
method delegates to the areEquivalent
method of
the passed Equivalence[B]
.
Provides a Constraint[A, B]
for any two types A
and B
, enforcing the type constraint
that B
must be a subtype of A
, given an explicit Equivalence[A]
.
Provides a Constraint[A, B]
for any two types A
and B
, enforcing the type constraint
that B
must be a subtype of A
, given an explicit Equivalence[A]
.
This method is used to enable the Explicitly
DSL for
TypeCheckedTripleEquals
by requiring an explicit Equivalance[B]
, but
taking an implicit function that provides evidence that A
is a subtype of B. For example, under TypeCheckedTripleEquals
,
this method (as an implicit method), would be used to compile this statement:
def closeEnoughTo1(num: Double): Boolean = (num === 1.0)(decided by forgivingEquality)
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's
areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits
TypeCheckedTripleEquals
) and
TypeCheckedLegacyTripleEquals
, and
overriden as non-implicit by the other subtraits in this package.
evidence that B
is a subype of A
a Constraint[A, B]
whose areEqual
method delegates to the areEquivalent
method of
the passed Equivalence[A]
.
Provides a Constraint[A, B]
class for any two types A
and B
, enforcing the type constraint that B
is
implicitly convertible to A
, given an explicit Equivalence[A]
.
Provides a Constraint[A, B]
class for any two types A
and B
, enforcing the type constraint that B
is
implicitly convertible to A
, given an explicit Equivalence[A]
.
This method is used to enable the Explicitly
DSL for
ConversionCheckedTripleEquals
by requiring an explicit Equivalance[A]
, but
taking an implicit function that converts from B
to A. For example, under ConversionCheckedTripleEquals
,
this method (as an implicit method), would be used to compile this statement:
def closeEnoughTo1(num: Double): Boolean = (num === 1.0)(decided by forgivingEquality)
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's
areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits
ConversionCheckedTripleEquals
) and
ConversionCheckedLegacyTripleEquals
, and
overriden as non-implicit by the other subtraits in this package.
an Equivalence[A]
type class to which the Constraint.areEqual
method will delegate to determine equality.
a Constraint[A, B]
whose areEqual
method delegates to the areEquivalent
method of
the passed Equivalence[A]
.
Converts to an CheckingEqualizer
that provides ===
and !==
operators
that result in Boolean
and enforce a type constraint.
Converts to an CheckingEqualizer
that provides ===
and !==
operators
that result in Boolean
and enforce a type constraint.
This method is overridden and made implicit by subtraits TypeCheckedTripleEquals
and
ConversionCheckedTripleEquals
, and overriden as
non-implicit by the other subtraits in this package.
the object whose type to convert to CheckingEqualizer
.
if left
is null
.
Overrides the super
implementation of convertToEqualizer
, turning off the implicit
modifier (if present) to remove the method from the space of implicit conversions.
Overrides the super
implementation of convertToEqualizer
, turning off the implicit
modifier (if present) to remove the method from the space of implicit conversions.
the object whose type to convert to Equalizer
.
if left
is null
.
Converts to a LegacyCheckingEqualizer
that provides ===
and !==
operators
that result in Option[String]
and enforce a type constraint.
Converts to a LegacyCheckingEqualizer
that provides ===
and !==
operators
that result in Option[String]
and enforce a type constraint.
This method is overridden and made implicit by subtraits TypeCheckedLegacyTripleEquals
and ConversionCheckedLegacyTripleEquals
, and
overriden as non-implicit by the other subtraits in this package.
the object whose type to convert to LegacyCheckingEqualizer
.
if left
is null
.
Converts to a LegacyEqualizer
that provides ===
and !==
operators that
result in Option[String]
and enforce no type constraint.
Converts to a LegacyEqualizer
that provides ===
and !==
operators that
result in Option[String]
and enforce no type constraint.
This method is overridden and made implicit by subtrait LegacyTripleEquals
and overriden as non-implicit
by the other subtraits in this package.
the object whose type to convert to LegacyEqualizer
.
if left
is null
.
Returns an Equality[A]
for any type A
that determines equality
by first calling .deep
on any Array
(on either the left or right side),
then comparing the resulting objects with ==
.
Returns an Equality[A]
for any type A
that determines equality
by first calling .deep
on any Array
(on either the left or right side),
then comparing the resulting objects with ==
.
a default Equality
for type A
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.
if cause
is null
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.
if message
or cause
is null
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.
if message
is null
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
if the passed function does not complete abruptly with an exception
that's an instance of the specified type
passed expected
value.
Provides a Constraint[A, B]
class for any two types A
and B
, enforcing the type constraint that A
is
implicitly convertible to B
, given an implicit Equivalence[B]
.
Provides a Constraint[A, B]
class for any two types A
and B
, enforcing the type constraint that A
is
implicitly convertible to B
, given an implicit Equivalence[B]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[B]
's
areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits
LowPriorityConversionCheckedConstraint
(extended by
ConversionCheckedTripleEquals
), and
LowPriorityConversionCheckedLegacyConstraint
(extended by
ConversionCheckedLegacyTripleEquals
), and
overriden as non-implicit by the other subtraits in this package.
an implicit conversion from A
to B
a Constraint[A, B]
whose areEqual
method delegates to the areEquivalent
method of
the passed Equivalence[B]
.
Provides a Constraint[A, B]
for any two types A
and B
, enforcing the type constraint
that A
must be a subtype of B
, given an implicit Equivalence[B]
.
Provides a Constraint[A, B]
for any two types A
and B
, enforcing the type constraint
that A
must be a subtype of B
, given an implicit Equivalence[B]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's
areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits
LowPriorityTypeCheckedConstraint
(extended by
TypeCheckedTripleEquals
), and
LowPriorityTypeCheckedLegacyConstraint
(extended by
TypeCheckedLegacyTripleEquals
), and
overriden as non-implicit by the other subtraits in this package.
an Equivalence[B]
type class to which the Constraint.areEqual
method
will delegate to determine equality.
evidence that A
is a subype of B
a Constraint[A, B]
whose areEqual
method delegates to the
areEquivalent
method of the passed Equivalence[B]
.
Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException
indicating no exception is thrown.
Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException
indicating no exception is thrown.
This method is intended to be used in the Scala interpreter to eliminate large stack traces when trying out ScalaTest assertions and
matcher expressions. It is not intended to be used in regular test code. If you want to ensure that a bit of code throws an expected
exception, use intercept
, not trap
. Here's an example interpreter session without trap
:
scala> import org.scalatest._ import org.scalatest._ scala> import Matchers._ import Matchers._ scala> val x = 12 a: Int = 12 scala> x shouldEqual 13 org.scalatest.exceptions.TestFailedException: 12 did not equal 13 at org.scalatest.Assertions$class.newAssertionFailedException(Assertions.scala:449) at org.scalatest.Assertions$.newAssertionFailedException(Assertions.scala:1203) at org.scalatest.Assertions$AssertionsHelper.macroAssertTrue(Assertions.scala:417) at .<init>(<console>:15) at .<clinit>(<console>) at .<init>(<console>:7) at .<clinit>(<console>) at $print(<console>) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) at java.lang.reflect.Method.invoke(Method.java:597) at scala.tools.nsc.interpreter.IMain$ReadEvalPrint.call(IMain.scala:731) at scala.tools.nsc.interpreter.IMain$Request.loadAndRun(IMain.scala:980) at scala.tools.nsc.interpreter.IMain.loadAndRunReq$1(IMain.scala:570) at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:601) at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:565) at scala.tools.nsc.interpreter.ILoop.reallyInterpret$1(ILoop.scala:745) at scala.tools.nsc.interpreter.ILoop.interpretStartingWith(ILoop.scala:790) at scala.tools.nsc.interpreter.ILoop.command(ILoop.scala:702) at scala.tools.nsc.interpreter.ILoop.processLine$1(ILoop.scala:566) at scala.tools.nsc.interpreter.ILoop.innerLoop$1(ILoop.scala:573) at scala.tools.nsc.interpreter.ILoop.loop(ILoop.scala:576) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply$mcZ$sp(ILoop.scala:867) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822) at scala.tools.nsc.util.ScalaClassLoader$.savingContextLoader(ScalaClassLoader.scala:135) at scala.tools.nsc.interpreter.ILoop.process(ILoop.scala:822) at scala.tools.nsc.MainGenericRunner.runTarget$1(MainGenericRunner.scala:83) at scala.tools.nsc.MainGenericRunner.process(MainGenericRunner.scala:96) at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:105) at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala)
That's a pretty tall stack trace. Here's what it looks like when you use trap
:
scala> trap { x shouldEqual 13 } res1: Throwable = org.scalatest.exceptions.TestFailedException: 12 did not equal 13
Much less clutter. Bear in mind, however, that if no exception is thrown by the
passed block of code, the trap
method will create a new NormalResult
(a subclass of Throwable
made for this purpose only) and return that. If the result was the Unit
value, it
will simply say that no exception was thrown:
scala> trap { x shouldEqual 12 } res2: Throwable = No exception was thrown.
If the passed block of code results in a value other than Unit
, the NormalResult
's toString
will print the value:
scala> trap { "Dude!" } res3: Throwable = No exception was thrown. Instead, result was: "Dude!"
Although you can access the result value from the NormalResult
, its type is Any
and therefore not
very convenient to use. It is not intended that trap
be used in test code. The sole intended use case for trap
is decluttering
Scala interpreter sessions by eliminating stack traces when executing assertion and matcher expressions.
Provides a Constraint[A, B]
for any two types A
and B
, enforcing the type constraint
that B
must be a subtype of A
, given an implicit Equivalence[A]
.
Provides a Constraint[A, B]
for any two types A
and B
, enforcing the type constraint
that B
must be a subtype of A
, given an implicit Equivalence[A]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's
areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits
TypeCheckedTripleEquals
) and
TypeCheckedLegacyTripleEquals
, and
overriden as non-implicit by the other subtraits in this package.
evidence that B
is a subype of A
a Constraint[A, B]
whose areEqual
method delegates to the areEquivalent
method of
the passed Equivalence[A]
.
Provides a Constraint[A, B]
class for any two types A
and B
, with no type constraint enforced, given an
implicit Equality[A]
.
Provides a Constraint[A, B]
class for any two types A
and B
, with no type constraint enforced, given an
implicit Equality[A]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equality[A]
's
areEqual
method to determine equality.
This method is overridden and made implicit by subtraits TripleEquals
and
LegacyTripleEquals
, and
overriden as non-implicit by the other subtraits in this package.
an Equality[A]
type class to which the Constraint.areEqual
method will delegate to determine equality.
a Constraint[A, B]
whose areEqual
method delegates to the areEqual
method of
the passed Equality[A]
.
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
if the passed clue
is null
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
This method has been deprecated in favor of macro assertion and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.
if the Option[String]
is Some
.
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 object whose toString
method returns a message to include in a failure report.
This method has been deprecated in favor of macro assertion and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.
if message
is null
.
if the Option[String]
is Some
.
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:
assume(a === b)
For more information on how this mechanism works, see the documentation for
Equalizer
.
the Option[String]
to assert
This method has been deprecated in favor of macro assumption and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.
if the Option[String]
is Some
.
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 object whose toString
method returns a message to include in a failure report.
This method has been deprecated in favor of macro assumption and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.
if message
is null
.
if the Option[String]
is Some
.
This expect
method has been deprecated; Please use assertResult
instead.
This expect
method has been deprecated; Please use assertResult
instead.
To get rid of the deprecation warning, simply replace expect
with
assertResult
. 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 assertResult instead.
This expect
method has been deprecated; Please use assertResult
instead.
This expect
method has been deprecated; Please use assertResult
instead.
To get rid of the deprecation warning, simply replace expect
with
assertResult
. 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 assertResult instead.
This expectResult
method has been deprecated; Please use assertResult
instead.
This expectResult
method has been deprecated; Please use assertResult
instead.
To get rid of the deprecation warning, simply replace expectResult
with
assertResult
. The name expectResult
will be used for a different purposes in
a future version of ScalaTest.
This expectResult method has been deprecated. Please replace all invocations of expectResult with an identical invocation of assertResult instead.
This expectResult
method has been deprecated; Please use assertResult
instead.
This expectResult
method has been deprecated; Please use assertResult
instead.
To get rid of the deprecation warning, simply replace expectResult
with
assertResult
. The name expectResult
will be used for a different purposes in
a future version of ScalaTest.
This expectResult method has been deprecated. Please replace all invocations of expectResult with an identical invocation of assertResult instead.
Trait that can be mixed into a
Suite
to disable the lone implicit conversion provided by default in traitAssertions
, which traitSuite
extends.Currently there is just one implicit conversion provided by default in
Suite
, the one that adds a===
method to anything. If more default implicits are added toSuite
in future versions of ScalaTest, they will be added here as well so that this trait will disable all of them.This trait can be used to quickly solve a problem in which ScalaTest's default implicit conversion is clashing with those of some other library you need to use in your tests. After mixing in this trait, like this:
You can write tests using
assert
(without triple equals),expect
, andintercept
: