ScalatraFunSuite
Convenience trait to add Scalatra test support to FunSuite.
Type members
Inherited classlikes
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of
the matchers DSL.
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:
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))
- Value parameters:
- leftSide
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
- Inherited from:
- TripleEqualsSupport
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
Instances of this class are returned via the decided
by
<an Equality>
syntax, and enables afterBeing
to be invoked on it. Here's an example, given an
Equality[String]
named myStringEquality
:
result should equal ("hello") (decided by myStringEquality afterBeing lowerCased)
- Inherited from:
- Explicitly
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
- Inherited from:
- Explicitly
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
Instances of this class are returned via the decided
by
<an Equivalence>
syntax, and enables afterBeing
to be invoked on it. Here's an example, given an
Equivalence[String]
named myStringEquivalence
:
result should equal ("hello") (determined by myStringEquivalence afterBeing lowerCased)
- Inherited from:
- Explicitly
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
- Inherited from:
- Explicitly
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:
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))
- Value parameters:
- leftSide
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
- Inherited from:
- TripleEqualsSupport
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of
the matchers DSL.
This class is used as the result of an implicit conversion from class Symbol
, to enable symbols to be
used in have ('author ("Dickens"))
syntax. The name of the implicit conversion method is
convertSymbolToHavePropertyMatcherGenerator
.
Class HavePropertyMatcherGenerator
's primary constructor takes a Symbol
. The
apply
method uses reflection to find and access a property that has the name specified by the
Symbol
passed to the constructor, so it can determine if the property has the expected value
passed to apply
.
If the symbol passed is 'title
, for example, the apply
method
will use reflection to look for a public Java field named
"title", a public method named "title", or a public method named "getTitle".
If a method, it must take no parameters. If multiple candidates are found,
the apply
method will select based on the following algorithm:
Field | Method | "get" Method | Result |
---|---|---|---|
Throws TestFailedException , because no candidates found | |||
getTitle() | Invokes getTitle() | ||
title() | Invokes title() | ||
title() | getTitle() | Invokes title() (this can occur when BeanProperty annotation is used) | |
title | Accesses field title | ||
title | getTitle() | Invokes getTitle() | |
title | title() | Invokes title() | |
title | title() | getTitle() | Invokes title() (this can occur when BeanProperty annotation is used) |
- Inherited from:
- Matchers
A test function taking no arguments and returning an Outcome
.
A test function taking no arguments and returning an Outcome
.
For more detail and examples, see the relevant section in the
documentation for trait fixture.FlatSpec
.
- Inherited from:
- TestSuite
Wrapper class with a +-
method that, given a Numeric
argument, returns a Spread
.
Wrapper class with a +-
method that, given a Numeric
argument, returns a Spread
.
- Value parameters:
- tolerance
the tolerance with which to create (and return) a
Spread
- Inherited from:
- Tolerance
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of
the matchers DSL.
- Inherited from:
- Matchers
This class supports the syntax of FlatSpec
, WordSpec
, fixture.FlatSpec
,
and fixture.WordSpec
.
This class supports the syntax of FlatSpec
, WordSpec
, fixture.FlatSpec
,
and fixture.WordSpec
.
This class is used in conjunction with an implicit conversion to enable should
methods to
be invoked on String
s.
- Inherited from:
- ShouldVerb
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
This class is part of the Scalactic “explicitly DSL”. Please
see the documentation for Explicitly
for an overview of
the explicitly DSL.
- Inherited from:
- Explicitly
Value members
Inherited methods
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
.
- Value parameters:
- right
the
Spread[T]
against which to compare the left-hand value
- Returns:
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
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
.
- Value parameters:
- right
a null reference
- Returns:
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
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
.
- Value parameters:
- right
the right-hand side value for an equality assertion
- Returns:
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
This method enables the following syntax:
This method enables the following syntax:
num should (not be < (10) and not be > (17)) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
num should (not be <= (10) and not be > (17)) ^
- Inherited from:
- Matchers
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
.
- Value parameters:
- right
the
Spread[T]
against which to compare the left-hand value
- Returns:
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
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
.
- Value parameters:
- right
a null reference
- Returns:
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
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
.
- Value parameters:
- right
the right-hand side value for an equality assertion
- Returns:
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
This method enables the following syntax:
This method enables the following syntax:
num should (not be > (10) and not be < (7)) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
num should (not be >= (10) and not be < (7)) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
a [RuntimeException] should be thrownBy { ... } ^
- Inherited from:
- Matchers
- Inherited from:
- JettyContainer
Defines a method to be run after all of this suite's tests and nested suites have been run.
Defines a method to be run after all of this suite's tests and nested suites have been run.
This trait's implementation
of run
invokes this afterAll()
method.
This trait's implementation of this method does nothing.
- Definition Classes
- ScalatraSuite -> BeforeAndAfterAll
- Inherited from:
- ScalatraSuite
Returns an Alerter
that during test execution will forward strings passed to its
apply
method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked while this
AnyFunSuite
is being executed, such as from inside a test function, it will forward the information to
the current reporter immediately. If invoked at any other time, it will
print to the standard output. This method can be called safely by any thread.
Returns an Alerter
that during test execution will forward strings passed to its
apply
method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked while this
AnyFunSuite
is being executed, such as from inside a test function, it will forward the information to
the current reporter immediately. If invoked at any other time, it will
print to the standard output. This method can be called safely by any thread.
- Inherited from:
- AnyFunSuiteLike
This method enables the following syntax for String
:
This method enables the following syntax for String
:
all(str) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for java.util.Map
:
This method enables the following syntax for java.util.Map
:
all(jmap) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for scala.collection.GenMap
:
This method enables the following syntax for scala.collection.GenMap
:
all(map) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
all(xs) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (allElementsOf(1, 2)) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (allOf(1, 2)) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
an [Exception] should be thrownBy { ... } ^
- Inherited from:
- Matchers
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.
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:
-
assert(a == b, "a good clue")
-
assert(a != b, "a good clue")
-
assert(a === b, "a good clue")
-
assert(a !== b, "a good clue")
-
assert(a > b, "a good clue")
-
assert(a >= b, "a good clue")
-
assert(a < b, "a good clue")
-
assert(a <= b, "a good clue")
-
assert(a startsWith "prefix", "a good clue")
-
assert(a endsWith "postfix", "a good clue")
-
assert(a contains "something", "a good clue")
-
assert(a eq b, "a good clue")
-
assert(a ne b, "a good clue")
-
assert(a > 0 && b > 5, "a good clue")
-
assert(a > 0 || b > 5, "a good clue")
-
assert(a.isEmpty, "a good clue")
-
assert(!a.isEmpty, "a good clue")
-
assert(a.isInstanceOf[String], "a good clue")
-
assert(a.length == 8, "a good clue")
-
assert(a.size == 8, "a good clue")
-
assert(a.exists(_ == 8), "a good clue")
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
to be the default in tests. This makes ===
consistent between tests and production
code.
- Value parameters:
- clue
An objects whose
toString
method returns a message to include in a failure report.- condition
the boolean condition to assert
- Throws:
- NullArgumentException
if
message
isnull
.- TestFailedException
if the condition is
false
.
- Inherited from:
- Assertions
Assert that a boolean condition is true.
If the condition is true
, this method returns normally.
Else, it throws TestFailedException
.
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:
-
assert(a == b)
-
assert(a != b)
-
assert(a === b)
-
assert(a !== b)
-
assert(a > b)
-
assert(a >= b)
-
assert(a < b)
-
assert(a <= b)
-
assert(a startsWith "prefix")
-
assert(a endsWith "postfix")
-
assert(a contains "something")
-
assert(a eq b)
-
assert(a ne b)
-
assert(a > 0 && b > 5)
-
assert(a > 0 || b > 5)
-
assert(a.isEmpty)
-
assert(!a.isEmpty)
-
assert(a.isInstanceOf[String])
-
assert(a.length == 8)
-
assert(a.size == 8)
-
assert(a.exists(_ == 8))
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
to be the default in tests. This makes ===
consistent between tests and production
code.
- Value parameters:
- condition
the boolean condition to assert
- Throws:
- TestFailedException
if the condition is
false
.
- Inherited from:
- Assertions
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.
- Value parameters:
- code
the snippet of code that should compile
- Inherited from:
- Assertions
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
.
- Value parameters:
- code
the snippet of code that should not type check
- Inherited from:
- Assertions
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.
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.
- Value parameters:
- actual
the actual value, which should equal the passed
expected
value- expected
the expected value
- Throws:
- TestFailedException
if the passed
actual
value does not equal the passedexpected
value.
- Inherited from:
- Assertions
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
.
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
.
- Value parameters:
- actual
the actual value, which should equal the passed
expected
value- clue
An object whose
toString
method returns a message to include in a failure report.- expected
the expected value
- Throws:
- TestFailedException
if the passed
actual
value does not equal the passedexpected
value.
- Inherited from:
- Assertions
Ensure that an expected exception is 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 Succeeded
. Else, whether the passed function returns normally
or completes abruptly with a different exception, this method throws TestFailedException
.
Ensure that an expected exception is 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 Succeeded
. 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
.
Also note that the difference between this method and intercept
is that this method
does not return the expected exception, so it does not let you perform further assertions on
that exception. Instead, this method returns Succeeded
, which means it can
serve as the last statement in an async- or safe-style suite. It also indicates to the reader
of the code that nothing further is expected about the thrown exception other than its type.
The recommended usage is to use assertThrows
by default, intercept
only when you
need to inspect the caught exception further.
- Value parameters:
- classTag
an implicit
ClassTag
representing the type of the specified type parameter.- f
the function value that should throw the expected exception
- Returns:
the
Succeeded
singleton, if an exception of the expected type is thrown- Throws:
- TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type.
- Inherited from:
- Assertions
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
.
- Value parameters:
- code
the snippet of code that should not type check
- Inherited from:
- Assertions
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.
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:
-
assume(a == b, "a good clue")
-
assume(a != b, "a good clue")
-
assume(a === b, "a good clue")
-
assume(a !== b, "a good clue")
-
assume(a > b, "a good clue")
-
assume(a >= b, "a good clue")
-
assume(a < b, "a good clue")
-
assume(a <= b, "a good clue")
-
assume(a startsWith "prefix", "a good clue")
-
assume(a endsWith "postfix", "a good clue")
-
assume(a contains "something", "a good clue")
-
assume(a eq b, "a good clue")
-
assume(a ne b, "a good clue")
-
assume(a > 0 && b > 5, "a good clue")
-
assume(a > 0 || b > 5, "a good clue")
-
assume(a.isEmpty, "a good clue")
-
assume(!a.isEmpty, "a good clue")
-
assume(a.isInstanceOf[String], "a good clue")
-
assume(a.length == 8, "a good clue")
-
assume(a.size == 8, "a good clue")
-
assume(a.exists(_ == 8), "a good clue")
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
to be the default in tests. This makes ===
consistent between tests and production
code.
- Value parameters:
- clue
An objects whose
toString
method returns a message to include in a failure report.- condition
the boolean condition to assume
- Throws:
- NullArgumentException
if
message
isnull
.- TestCanceledException
if the condition is
false
.
- Inherited from:
- Assertions
Assume that a boolean condition is true.
If the condition is true
, this method returns normally.
Else, it throws TestCanceledException
.
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:
-
assume(a == b)
-
assume(a != b)
-
assume(a === b)
-
assume(a !== b)
-
assume(a > b)
-
assume(a >= b)
-
assume(a < b)
-
assume(a <= b)
-
assume(a startsWith "prefix")
-
assume(a endsWith "postfix")
-
assume(a contains "something")
-
assume(a eq b)
-
assume(a ne b)
-
assume(a > 0 && b > 5)
-
assume(a > 0 || b > 5)
-
assume(a.isEmpty)
-
assume(!a.isEmpty)
-
assume(a.isInstanceOf[String])
-
assume(a.length == 8)
-
assume(a.size == 8)
-
assume(a.exists(_ == 8))
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
to be the default in tests. This makes ===
consistent between tests and production
code.
- Value parameters:
- condition
the boolean condition to assume
- Throws:
- TestCanceledException
if the condition is
false
.
- Inherited from:
- Assertions
This method enables the following syntax for String
:
This method enables the following syntax for String
:
atLeast(1, str) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for java.util.Map
:
This method enables the following syntax for java.util.Map
:
atLeast(1, jmap) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for scala.collection.GenMap
:
This method enables the following syntax for scala.collection.GenMap
:
atLeast(1, map) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
atLeast(1, xs) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (atLeastOneElementOf (List(1, 2))) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (atLeastOneOf(1, 2)) ^
- Inherited from:
- Matchers
This method enables the following syntax for String
:
This method enables the following syntax for String
:
atMost(3, str) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for java.util.Map
:
This method enables the following syntax for java.util.Map
:
atMost(3, jmap) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for scala.collection.GenMap
:
This method enables the following syntax for scala.collection.GenMap
:
atMost(3, map) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
atMost(3, xs) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (atMostOneElementOf (List(1, 2))) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (atMostOneOf(1, 2)) ^
- Inherited from:
- Matchers
Defines a method to be run before any of this suite's tests or nested suites are run.
Defines a method to be run before any of this suite's tests or nested suites are run.
This trait's implementation
of run
invokes this beforeAll()
method. This trait's implementation of this method does nothing.
- Definition Classes
- ScalatraSuite -> BeforeAndAfterAll
- Inherited from:
- ScalatraSuite
This method enables the following syntax for String
:
This method enables the following syntax for String
:
between(1, 3, str) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for java.util.Map
:
This method enables the following syntax for java.util.Map
:
between(1, 3, jmap) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
between(1, 3, xs) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
Throws TestCanceledException
, with the passed
Throwable
cause, to indicate a test failed.
The getMessage
method of the thrown TestCanceledException
will return cause.toString
.
Throws TestCanceledException
, with the passed
Throwable
cause, to indicate a test failed.
The getMessage
method of the thrown TestCanceledException
will return cause.toString
.
- Value parameters:
- cause
a
Throwable
that indicates the cause of the cancellation.
- Throws:
- NullArgumentException
if
cause
isnull
- Inherited from:
- Assertions
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.
- Value parameters:
- cause
A
Throwable
that indicates the cause of the failure.- message
A message describing the failure.
- Throws:
- NullArgumentException
if
message
orcause
isnull
- Inherited from:
- Assertions
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.
- Value parameters:
- message
A message describing the cancellation.
- Throws:
- NullArgumentException
if
message
isnull
- Inherited from:
- Assertions
Throws TestCanceledException
to indicate a test was canceled.
Throws TestCanceledException
to indicate a test was canceled.
- Inherited from:
- Assertions
- Inherited from:
- Client
Provides a A CanEqual 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 A CanEqual 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- equivalenceOfB
an
Equivalence[B]
type class to which theConstraint.areEqual
method will delegate to determine equality.- ev
evidence that
A
is a subype of B
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
.- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
Provides an A CanEqual B
instance 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 an A CanEqual B
instance 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- equalityOfA
an
Equivalence[A]
type class to which theConstraint.areEqual
method will delegate to determine equality.- ev
evidence that
B
is a subype of A
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
.- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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 subtrait TypeCheckedTripleEquals
, and
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- left
the object whose type to convert to
CheckingEqualizer
.
- Throws:
- NullPointerException
if
left
isnull
.
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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 ==
.
- Returns:
a default
Equality
for typeA
- Inherited from:
- TripleEqualsSupport
This method enables the following syntax:
This method enables the following syntax:
list should (not be definedAt (7) and not be definedAt (9)) ^
- Inherited from:
- Matchers
- Inherited from:
- Client
This method enables syntax such as the following:
This method enables syntax such as the following:
result should equal (null) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result should equal (100 +- 1) ^
- Inherited from:
- Matchers
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.
- Inherited from:
- MatcherWords
This method enables the following syntax for String
:
This method enables the following syntax for String
:
every(str) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for java.util.Map
:
This method enables the following syntax for java.util.Map
:
every(jmap) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for scala.collection.GenMap
:
This method enables the following syntax for scala.collection.GenMap
:
every(map) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
every(xs) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for String
:
This method enables the following syntax for String
:
exactly(str) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for java.util.Map
:
This method enables the following syntax for java.util.Map
:
exactly(jmap) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for scala.collection.GenMap
:
This method enables the following syntax for scala.collection.GenMap
:
exactly(map) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
exactly(xs) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
Executes one or more tests in this Suite
, printing results to the standard output.
Executes one or more tests in this Suite
, printing results to the standard output.
This method invokes run
on itself, passing in values that can be configured via the parameters to this
method, all of which have default values. This behavior is convenient when working with ScalaTest in the Scala interpreter.
Here's a summary of this method's parameters and how you can use them:
The testName
parameter
If you leave testName
at its default value (of null
), this method will pass None
to
the testName
parameter of run
, and as a result all the tests in this suite will be executed. If you
specify a testName
, this method will pass Some(testName)
to run
, and only that test
will be run. Thus to run all tests in a suite from the Scala interpreter, you can write:
scala> (new ExampleSuite).execute()
(The above syntax actually invokes the overloaded parameterless form of execute
, which calls this form with its default parameter values.)
To run just the test named "my favorite test"
in a suite from the Scala interpreter, you would write:
scala> (new ExampleSuite).execute("my favorite test")
Or:
scala> (new ExampleSuite).execute(testName = "my favorite test")
The configMap
parameter
If you provide a value for the configMap
parameter, this method will pass it to run
. If not, the default value
of an empty Map
will be passed. For more information on how to use a config map to configure your test suites, see
the config map section in the main documentation for this trait. Here's an example in which you configure
a run with the name of an input file:
scala> (new ExampleSuite).execute(configMap = Map("inputFileName" -> "in.txt")
The color
parameter
If you leave the color
parameter unspecified, this method will configure the reporter it passes to run
to print
to the standard output in color (via ansi escape characters). If you don't want color output, specify false for color
, like this:
scala> (new ExampleSuite).execute(color = false)
The durations
parameter
If you leave the durations
parameter unspecified, this method will configure the reporter it passes to run
to
not print durations for tests and suites to the standard output. If you want durations printed, specify true for durations
,
like this:
scala> (new ExampleSuite).execute(durations = true)
The shortstacks
and fullstacks
parameters
If you leave both the shortstacks
and fullstacks
parameters unspecified, this method will configure the reporter
it passes to run
to not print stack traces for failed tests if it has a stack depth that identifies the offending
line of test code. If you prefer a short stack trace (10 to 15 stack frames) to be printed with any test failure, specify true for
shortstacks
:
scala> (new ExampleSuite).execute(shortstacks = true)
For full stack traces, set fullstacks
to true:
scala> (new ExampleSuite).execute(fullstacks = true)
If you specify true for both shortstacks
and fullstacks
, you'll get full stack traces.
The stats
parameter
If you leave the stats
parameter unspecified, this method will not fire RunStarting
and either RunCompleted
or RunAborted
events to the reporter it passes to run
.
If you specify true for stats
, this method will fire the run events to the reporter, and the reporter will print the
expected test count before the run, and various statistics after, including the number of suites completed and number of tests that
succeeded, failed, were ignored or marked pending. Here's how you get the stats:
scala> (new ExampleSuite).execute(stats = true)
To summarize, this method will pass to run
:
-
testName
-None
if this method'stestName
parameter is left at its default value ofnull
, elseSome(testName)
. -
reporter
- a reporter that prints to the standard output -
stopper
- aStopper
whoseapply
method always returnsfalse
-
filter
- aFilter
constructed withNone
fortagsToInclude
andSet()
fortagsToExclude
-
configMap
- theconfigMap
passed to this method -
distributor
-None
-
tracker
- a newTracker
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this method isn't named run
is that it takes advantage of
default arguments, and you can't mix overloaded methods and default arguments in Scala. (If named run
,
this method would have the same name but different arguments than the main run
method that
takes seven arguments. Thus it would overload and couldn't be used with default argument values.)
Design note: This method has two "features" that may seem unidiomatic. First, the default value of testName
is null
.
Normally in Scala the type of testName
would be Option[String]
and the default value would
be None
, as it is in this trait's run
method. The null
value is used here for two reasons. First, in
ScalaTest 1.5, execute
was changed from four overloaded methods to one method with default values, taking advantage of
the default and named parameters feature introduced in Scala 2.8.
To not break existing source code, testName
needed to have type String
, as it did in two of the overloaded
execute
methods prior to 1.5. The other reason is that execute
has always been designed to be called primarily
from an interpeter environment, such as the Scala REPL (Read-Evaluate-Print-Loop). In an interpreter environment, minimizing keystrokes is king.
A String
type with a null
default value lets users type suite.execute("my test name")
rather than
suite.execute(Some("my test name"))
, saving several keystrokes.
The second non-idiomatic feature is that shortstacks
and fullstacks
are all lower case rather than
camel case. This is done to be consistent with the Shell
, which also uses those forms. The reason
lower case is used in the Shell
is to save keystrokes in an interpreter environment. Most Unix commands, for
example, are all lower case, making them easier and quicker to type. In the ScalaTest
Shell
, methods like shortstacks
, fullstacks
, and nostats
, etc., are
designed to be all lower case so they feel more like shell commands than methods.
- Value parameters:
- color
a boolean that configures whether output is printed in color
- configMap
a
Map
of key-value pairs that can be used by the executingSuite
of tests.- durations
a boolean that configures whether test and suite durations are printed to the standard output
- fullstacks
a boolean that configures whether full stack traces should be printed for test failures
- shortstacks
a boolean that configures whether short stack traces should be printed for test failures
- stats
a boolean that configures whether test and suite statistics are printed to the standard output
- testName
the name of one test to run.
- Throws:
- IllegalArgumentException
if
testName
is defined, but no test with the specified test name exists in thisSuite
- NullArgumentException
if the passed
configMap
parameter isnull
.
- Inherited from:
- Suite
The total number of tests that are expected to run when this Suite
's run
method is invoked.
The total number of tests that are expected to run when this Suite
's run
method is invoked.
This trait's implementation of this method returns the sum of:
-
the size of the
testNames
List
, minus the number of tests marked as ignored and any tests that are exluded by the passedFilter
-
the sum of the values obtained by invoking
expectedTestCount
on every nestedSuite
contained innestedSuites
- Value parameters:
- filter
a
Filter
with which to filter tests to count based on their tags
- Inherited from:
- Suite
Throws TestFailedException
, with the passed
Throwable
cause, to indicate a test failed.
The getMessage
method of the thrown TestFailedException
will return cause.toString
.
Throws TestFailedException
, with the passed
Throwable
cause, to indicate a test failed.
The getMessage
method of the thrown TestFailedException
will return cause.toString
.
- Value parameters:
- cause
a
Throwable
that indicates the cause of the failure.
- Throws:
- NullArgumentException
if
cause
isnull
- Inherited from:
- Assertions
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.
- Value parameters:
- cause
A
Throwable
that indicates the cause of the failure.- message
A message describing the failure.
- Throws:
- NullArgumentException
if
message
orcause
isnull
- Inherited from:
- Assertions
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.
- Value parameters:
- message
A message describing the failure.
- Throws:
- NullArgumentException
if
message
isnull
- Inherited from:
- Assertions
Throws TestFailedException
to indicate a test failed.
Throws TestFailedException
to indicate a test failed.
- Inherited from:
- Assertions
- Inherited from:
- Client
- Inherited from:
- Client
Register a test to ignore, which has the specified name, optional tags, and function value that takes no arguments.
This method will register the test for later ignoring via an invocation of one of the run
methods. This method exists to make it easy to ignore an existing test by changing the call to test
to ignore
without deleting or commenting out the actual test code. The test will not be run, but a
report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on
this AnyFunSuite
instance.
Register a test to ignore, which has the specified name, optional tags, and function value that takes no arguments.
This method will register the test for later ignoring via an invocation of one of the run
methods. This method exists to make it easy to ignore an existing test by changing the call to test
to ignore
without deleting or commenting out the actual test code. The test will not be run, but a
report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on
this AnyFunSuite
instance.
- Value parameters:
- testFun
the test function
- testName
the name of the test
- testTags
the optional list of tags for this test
- Throws:
- DuplicateTestNameException
if a test with the same name has been registered previously
- NotAllowedException
if
testName
had been registered previously- TestRegistrationClosedException
if invoked after
run
has been invoked on this suite
- Inherited from:
- AnyFunSuiteLike
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (inOrder(1, 2)) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (inOrderElementsOf List(1, 2)) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (inOrderOnly(1, 2)) ^
- Inherited from:
- Matchers
Returns an Informer
that during test execution will forward strings passed to its
apply
method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked from inside a scope,
it will forward the information to the current reporter immediately. If invoked from inside a test function,
it will record the information and forward it to the current reporter only after the test completed, as recordedEvents
of the test completed event, such as TestSucceeded
. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
Returns an Informer
that during test execution will forward strings passed to its
apply
method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked from inside a scope,
it will forward the information to the current reporter immediately. If invoked from inside a test function,
it will record the information and forward it to the current reporter only after the test completed, as recordedEvents
of the test completed event, such as TestSucceeded
. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
- Inherited from:
- AnyFunSuiteLike
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
.
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
.
Also note that the difference between this method and assertThrows
is that this method
returns the expected exception, so it lets you perform further assertions on
that exception. By contrast, the assertThrows
method returns Succeeded
, which means it can
serve as the last statement in an async- or safe-style suite. assertThrows
also indicates to the reader
of the code that nothing further is expected about the thrown exception other than its type.
The recommended usage is to use assertThrows
by default, intercept
only when you
need to inspect the caught exception further.
- Value parameters:
- classTag
an implicit
ClassTag
representing the type of the specified type parameter.- f
the function value that should throw the expected exception
- Returns:
the intercepted exception, if it is of the expected type
- Throws:
- TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type.
- Inherited from:
- Assertions
The port of the currently running Jetty. May differ from port if port is 0.
The port of the currently running Jetty. May differ from port if port is 0.
- Returns:
Some port if Jetty is currently listening, or None if it is not.
- Inherited from:
- EmbeddedJettyContainer
Provides an A CanEqual 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 an A CanEqual 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- equivalenceOfB
an
Equivalence[B]
type class to which theConstraint.areEqual
method will delegate to determine equality.- ev
evidence that
A
is a subype of B
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
.- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
Returns a Documenter
that during test execution will forward strings passed to its
apply
method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked from inside a scope,
it will forward the information to the current reporter immediately. If invoked from inside a test function,
it will record the information and forward it to the current reporter only after the test completed, as recordedEvents
of the test completed event, such as TestSucceeded
. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
Returns a Documenter
that during test execution will forward strings passed to its
apply
method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked from inside a scope,
it will forward the information to the current reporter immediately. If invoked from inside a test function,
it will record the information and forward it to the current reporter only after the test completed, as recordedEvents
of the test completed event, such as TestSucceeded
. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
- Inherited from:
- AnyFunSuiteLike
This method enables the following syntax:
This method enables the following syntax:
exception should not have message ("file not found") ^
- Inherited from:
- Matchers
An immutable IndexedSeq
of this Suite
object's nested Suite
s. If this Suite
contains no nested Suite
s,
this method returns an empty IndexedSeq
. This trait's implementation of this method returns an empty List
.
An immutable IndexedSeq
of this Suite
object's nested Suite
s. If this Suite
contains no nested Suite
s,
this method returns an empty IndexedSeq
. This trait's implementation of this method returns an empty List
.
- Inherited from:
- Suite
This method enables the following syntax for String
:
This method enables the following syntax for String
:
no(str) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax for java.util.Map
:
This method enables the following syntax for java.util.Map
:
no(jmap) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
no(xs) should fullymatch regex ("Hel*o world".r) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (noElementsOf List(1, 2)) ^
- Inherited from:
- Matchers
This field enables the following syntax:
This field enables the following syntax:
noException should be thrownBy ^
- Inherited from:
- MatcherWords
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (noneOf(1, 2)) ^
- Inherited from:
- Matchers
Returns a Notifier
that during test execution will forward strings passed to its
apply
method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked while this
AnyFunSuite
is being executed, such as from inside a test function, it will forward the information to
the current reporter immediately. If invoked at any other time, it will
print to the standard output. This method can be called safely by any thread.
Returns a Notifier
that during test execution will forward strings passed to its
apply
method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked while this
AnyFunSuite
is being executed, such as from inside a test function, it will forward the information to
the current reporter immediately. If invoked at any other time, it will
print to the standard output. This method can be called safely by any thread.
- Inherited from:
- AnyFunSuiteLike
This method enables syntax such as the following:
This method enables syntax such as the following:
book should have (message ("A TALE OF TWO CITIES") (of [Book]), title ("A Tale of Two Cities")) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (oneElementOf (List(1, 2))) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (oneOf(1, 2)) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (only(1, 2)) ^
- Inherited from:
- Matchers
- Inherited from:
- Client
- Inherited from:
- Client
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 FunSpec
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.
- Inherited from:
- Assertions
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.
- Value parameters:
- f
a block of code, which if it completes abruptly, should trigger a
TestPendingException
- Throws:
- TestPendingException
if the passed block of code completes abruptly with an
Exception
orAssertionError
- Inherited from:
- Assertions
Sets the port to listen on. 0 means listen on any available port.
Sets the port to listen on. 0 means listen on any available port.
- Inherited from:
- EmbeddedJettyContainer
- Inherited from:
- Client
- Inherited from:
- Client
- Inherited from:
- Client
- Inherited from:
- Client
- Inherited from:
- Client
- Inherited from:
- Client
Registers an ignored test.
Registers an ignored test.
- Value parameters:
- testFun
the test function
- testTags
the test tags
- testText
the test text
- Inherited from:
- AnyFunSuiteLike
Registers a test.
Registers a test.
- Value parameters:
- testFun
the test function
- testTags
the test tags
- testText
the test text
- Inherited from:
- AnyFunSuiteLike
The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.
The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.
- Inherited from:
- Suite
Returns the current response within the scope of the submit method.
Returns the current response within the scope of the submit method.
- Inherited from:
- Client
Execute a suite surrounded by calls to beforeAll
and afterAll
.
Execute a suite surrounded by calls to beforeAll
and afterAll
.
This trait's implementation of this method ("this method") invokes beforeAll(ConfigMap)
before executing any tests or nested suites and afterAll(ConfigMap)
after executing all tests and nested suites. It runs the suite by invoking super.run
, passing along
the parameters passed to it.
If any invocation of beforeAll
completes abruptly with an exception, this
method will complete abruptly with the same exception. If any call to
super.run
completes abruptly with an exception, this method
will complete abruptly with the same exception, however, before doing so, it will
invoke afterAll
. If afterAll
also completes abruptly with an exception, this
method will nevertheless complete abruptly with the exception previously thrown by super.run
.
If super.run
returns normally, but afterAll
completes abruptly with an
exception, this method will complete abruptly with the same exception.
This method does not invoke either beforeAll
or afterAll
if runTestsInNewInstance
is true so
that any side effects only happen once per test if OneInstancePerTest
is being used. In addition, if no tests
are expected, then beforeAll
and afterAll
will be invoked only if the
invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected
flag is true. By default, this flag is false, so that if
all tests are excluded (such as if the entire suite class has been marked with @Ignore
), then side effects
would happen only if at least one test will ultimately be executed in this suite or its nested suites.
- Value parameters:
- args
the
Args
for this run- testName
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 thisSuite
.
- Returns:
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .- Inherited from:
- BeforeAndAfterAll
Run a test. This trait's implementation runs the test registered with the name specified by testName
.
Run a test. This trait's implementation runs the test registered with the name specified by testName
.
- Value parameters:
- args
the
Args
for this run- testName
the name of one test to run.
- Returns:
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .- Throws:
- IllegalArgumentException
if
testName
is defined but a test with that name does not exist on thisAnyFunSuite
- NullArgumentException
if any of
testName
,reporter
,stopper
, orconfigMap
isnull
.
- Definition Classes
- AnyFunSuiteLike -> TestSuite -> Suite
- Inherited from:
- AnyFunSuiteLike
Run zero to many of this AnyFunSuite
's tests.
Run zero to many of this AnyFunSuite
's tests.
- Value parameters:
- args
the
Args
for this run- testName
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 thisSuite
.
- Returns:
a
Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.- Throws:
- IllegalArgumentException
if
testName
is defined, but no test with the specified test name exists in thisSuite
- NullArgumentException
if any of the passed parameters is
null
.
- Definition Classes
- AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
- Inherited from:
- HttpComponentsClient
- Inherited from:
- HttpComponentsClient
A string ID for this Suite
that is intended to be unique among all suites reported during a run.
A string ID for this Suite
that is intended to be unique among all suites reported during a run.
This trait's
implementation of this method returns the fully qualified name of this object's class.
Each suite reported during a run will commonly be an instance of a different Suite
class,
and in such cases, this default implementation of this method will suffice. However, in special cases
you may need to override this method to ensure it is unique for each reported suite. For example, if you write
a Suite
subclass that reads in a file whose name is passed to its constructor and dynamically
creates a suite of tests based on the information in that file, you will likely need to override this method
in your Suite
subclass, perhaps by appending the pathname of the file to the fully qualified class name.
That way if you run a suite of tests based on a directory full of these files, you'll have unique suite IDs for
each reported suite.
The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
- Returns:
this
Suite
object's ID.- Inherited from:
- Suite
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 Report
s to pass to the suiteStarting
, suiteCompleted
,
and suiteAborted
methods of the Reporter
.
- Returns:
this
Suite
object's suite name.- Inherited from:
- Suite
A Map
whose keys are String
names of tagged tests and whose associated values are
the Set
of tags for the test. If this AnyFunSuite
contains no tags, this method returns an empty Map
.
A Map
whose keys are String
names of tagged tests and whose associated values are
the Set
of tags for the test. If this AnyFunSuite
contains no tags, this method returns an empty Map
.
This trait's implementation returns tags that were passed as strings contained in Tag
objects passed to
methods test
and ignore
.
In addition, this trait's implementation will also auto-tag tests with class level annotations.
For example, if you annotate @Ignore
at the class level, all test methods in the class will be auto-annotated with
org.scalatest.Ignore
.
- Definition Classes
- AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
Register a test with the specified name, optional tags, and function value that takes no arguments.
This method will register the test for later execution via an invocation of one of the run
methods. The passed test name must not have been registered previously on
this AnyFunSuite
instance.
Register a test with the specified name, optional tags, and function value that takes no arguments.
This method will register the test for later execution via an invocation of one of the run
methods. The passed test name must not have been registered previously on
this AnyFunSuite
instance.
- Value parameters:
- testFun
the test function
- testName
the name of the test
- testTags
the optional list of tags for this test
- Throws:
- DuplicateTestNameException
if a test with the same name has been registered previously
- NotAllowedException
if
testName
had been registered previously- NullArgumentException
if
testName
or any passed test tag isnull
- TestRegistrationClosedException
if invoked after
run
has been invoked on this suite
- Inherited from:
- AnyFunSuiteLike
Provides a TestData
instance for the passed test name, given the passed config map.
Provides a TestData
instance for the passed test name, given the passed config map.
This method is used to obtain a TestData
instance to pass to withFixture(NoArgTest)
and withFixture(OneArgTest)
and the beforeEach
and afterEach
methods
of trait BeforeAndAfterEach
.
- Value parameters:
- testName
the name of the test for which to return a
TestData
instance- theConfigMap
the config map to include in the returned
TestData
- Returns:
a
TestData
instance for the specified test, which includes the specified config map- Definition Classes
- AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
An immutable Set
of test names. If this AnyFunSuite
contains no tests, this method returns an empty Set
.
An immutable Set
of test names. If this AnyFunSuite
contains no tests, this method returns an empty Set
.
This trait's implementation of this method will return a set that contains the names of all registered tests. The set's iterator will return those names in the order in which the tests were registered.
- Definition Classes
- AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
Registers shared tests.
Registers shared tests.
This method enables the following syntax for shared tests in a AnyFunSuite
:
testsFor(nonEmptyStack(lastValuePushed))
This method just provides syntax sugar intended to make the intent of the code clearer.
Because the parameter passed to it is
type Unit
, the expression will be evaluated before being passed, which
is sufficient to register the shared tests. For examples of shared tests, see the
Shared tests section in the main documentation for this trait.
- Inherited from:
- AnyFunSuiteLike
This method enables the following syntax:
This method enables the following syntax:
the [FileNotFoundException] should be thrownBy { ... } ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (theSameElementsAs(List(1, 2, 3))) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (theSameElementsInOrderAs(List(1, 2))) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
a [RuntimeException] should be thrownBy {...} ^
- Inherited from:
- Matchers
Returns a user friendly string for this suite, composed of the
simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite
contains nested suites, the result of invoking toString
on each
of the nested suites, separated by commas and surrounded by parentheses.
Returns a user friendly string for this suite, composed of the
simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite
contains nested suites, the result of invoking toString
on each
of the nested suites, separated by commas and surrounded by parentheses.
- Returns:
a user-friendly string for this suite
- Definition Classes
- AnyFunSuite -> AnyFunSuiteLike -> Any
- Inherited from:
- AnyFunSuite
- Inherited from:
- Client
Provides an A CanEqual B
instance 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 an A CanEqual B
instance 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- equalityOfA
an
Equivalence[A]
type class to which theConstraint.areEqual
method will delegate to determine equality.- ev
evidence that
B
is a subype of A
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
.- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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).
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:
- NullArgumentException
if the passed
clue
isnull
- Inherited from:
- Assertions
Run the passed test function in the context of a fixture established by this method.
Run the passed test function in the context of a fixture established by this method.
This method should set up the fixture needed by the tests of the
current suite, invoke the test function, and if needed, perform any clean
up needed after the test completes. Because the NoArgTest
function
passed to this method takes no parameters, preparing the fixture will require
side effects, such as reassigning instance var
s in this Suite
or initializing
a globally accessible external database. If you want to avoid reassigning instance var
s
you can use FixtureSuite.
This trait's implementation of runTest
invokes this method for each test, passing
in a NoArgTest
whose apply
method will execute the code of the test.
This trait's implementation of this method simply invokes the passed NoArgTest
function.
- Value parameters:
- test
the no-arg test function to run with a fixture
- Inherited from:
- TestSuite
Deprecated and Inherited methods
The conversionCheckedConstraint
method has been deprecated and will be removed in a future version of Scalactic. It
is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
The conversionCheckedConstraint
method has been deprecated and will be removed in a future version of Scalactic. It
is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
Provides an A CanEqual B
instance 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- cnv
an implicit conversion from
B
to A- equivalenceOfA
an
Equivalence[A]
type class to which theConstraint.areEqual
method will delegate to determine equality.
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
.- Deprecated
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
The convertEquivalenceToAToBConversionConstraint
method has been deprecated and will be removed in a future version of Scalactic.
It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
The convertEquivalenceToAToBConversionConstraint
method has been deprecated and will be removed in a future version of Scalactic.
It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
Provides an A CanEqual B
instance 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- cnv
an implicit conversion from
A
to B- equalityOfB
an
Equivalence[B]
type class to which theConstraint.areEqual
method will delegate to determine equality.
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
.- Deprecated
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
The convertEquivalenceToBToAConversionConstraint
method has been deprecated and will be removed in a future version of Scalactic.
It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
The convertEquivalenceToBToAConversionConstraint
method has been deprecated and will be removed in a future version of Scalactic.
It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
Provides an A CanEqual B
instance 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- cnv
an implicit conversion from
B
to A- equivalenceOfA
an
Equivalence[A]
type class to which theConstraint.areEqual
method will delegate to determine equality.
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
.- Deprecated
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
The lowPriorityConversionCheckedConstraint
method has been deprecated and will be removed in a future version of Scalactic. It
is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
The lowPriorityConversionCheckedConstraint
method has been deprecated and will be removed in a future version of Scalactic. It
is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
Provides an A CanEqual B
instance 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- cnv
an implicit conversion from
A
to B- equalityOfB
an
Equivalence[B]
type class to which theConstraint.areEqual
method will delegate to determine equality.
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
.- Deprecated
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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.
- Deprecated
- Inherited from:
- Assertions
Inherited fields
This field enables the following syntax:
This field enables the following syntax:
badBook should not be a ('goodRead) ^
- Inherited from:
- Matchers
This field enables syntax such as the following:
This field enables syntax such as the following:
result should equal ("hello") (after being lowerCased) ^
- Inherited from:
- Explicitly
This field enables the following syntax:
This field enables the following syntax:
badBook should not be an (excellentRead) ^
- Inherited from:
- Matchers
This field enables syntax such as the following:
This field enables syntax such as the following:
obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string)) ^
- Inherited from:
- MatcherWords
This field enables the following syntax:
This field enables the following syntax:
"val a: String = 1" shouldNot compile ^
- Inherited from:
- MatcherWords
This field enables syntax such as the following:
This field enables syntax such as the following:
list should (contain ('a') and have length (7)) ^
- Inherited from:
- MatcherWords
This field enables syntax such as the following:
This field enables syntax such as the following:
result should equal ("hello") (decided by defaultEquality) ^
- Inherited from:
- Explicitly
This field enables the following syntax:
This field enables the following syntax:
seq should be (defined) ^
- Inherited from:
- MatcherWords
This field enables syntax such as the following, given an
Equivalence[String]
named myStringEquivalence
:
This field enables syntax such as the following, given an
Equivalence[String]
named myStringEquivalence
:
result should equal ("hello") (determined by myStringEquivalence) ^
- Inherited from:
- Explicitly
This field enables the following syntax:
This field enables the following syntax:
list should be (empty) ^
- Inherited from:
- MatcherWords
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (endWith ("ago") and include ("score")) ^
- Inherited from:
- MatcherWords
This field enables the following syntax:
This field enables the following syntax:
file should exist ^
- Inherited from:
- MatcherWords
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (fullyMatch regex ("Hel*o, wor.d") and not have length (99)) ^
- Inherited from:
- MatcherWords
This field enables syntax such as the following:
This field enables syntax such as the following:
list should (have length (3) and not contain ('a')) ^
- Inherited from:
- MatcherWords
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (include ("hope") and not startWith ("no")) ^
- Inherited from:
- MatcherWords
Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.
Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.
The default value is false
, which means beforeAll and afterAll will not be invoked
if there are no tests expected. Whether tests are expected is determined by invoking expectedTestCount
passing in
the passed filter. Because this count does not include tests excluded based on tags, such as ignored tests, this prevents
any side effects in beforeAll
or afterAll
if no tests will ultimately be executed anyway.
If you always want to see the side effects even if no tests are expected, override this val
and set it to true.
- Inherited from:
- BeforeAndAfterAll
This field enables the following syntax:
This field enables the following syntax:
map should not contain key (10) ^
- Inherited from:
- Matchers
This field enables the following syntax:
This field enables the following syntax:
"hi" should not have length (3) ^
- Inherited from:
- MatcherWords
This field enables the following syntax:
This field enables the following syntax:
result should matchPattern { case Person("Bob", _) => } ^
- Inherited from:
- MatcherWords
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"))) ^
- Inherited from:
- MatcherWords
This field enables the following syntax:
This field enables the following syntax:
file should be (readable) ^
- Inherited from:
- MatcherWords
This field enables the following syntax:
This field enables the following syntax:
"eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r) ^
- Inherited from:
- Matchers
This field enables the following syntax:
This field enables the following syntax:
set should not have size (3) ^
- Inherited from:
- MatcherWords
This field enables the following syntax:
This field enables the following syntax:
seq should be (sorted) ^
- Inherited from:
- MatcherWords
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (startWith ("Four") and include ("year")) ^
- Inherited from:
- MatcherWords
The Succeeded
singleton.
The Succeeded
singleton.
You can use succeed
to solve a type error when an async test
does not end in either Future[Assertion]
or Assertion
.
Because Assertion
is a type alias for Succeeded.type
,
putting succeed
at the end of a test body (or at the end of a
function being used to map the final future of a test body) will solve
the type error.
- Inherited from:
- Assertions
This field enables the following syntax:
This field enables the following syntax:
oneString should not be theSameInstanceAs (anotherString) ^
- Inherited from:
- Matchers
This field enables the following syntax:
This field enables the following syntax:
"val a: String = 1" shouldNot typeCheck ^
- Inherited from:
- MatcherWords
This field enables the following syntax:
This field enables the following syntax:
map should not contain value (10) ^
- Inherited from:
- Matchers
Deprecated and Inherited fields
The styleName
lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
The styleName
lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0
will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for styleName
.
- Deprecated
- Inherited from:
- AnyFunSuiteLike
Extensions
Inherited extensions
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot fullyMatch regex ("""(-)?(\d+)(\.\d*)?""") ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot typeCheck ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot compile ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string should compile ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string should fullyMatch regex ("""(-)?(\d+)(\.\d*)?""") ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
file should not (exist) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
list shouldBe a ('empty) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
file shouldNot exist ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
aDouble shouldBe a [Book] ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
list shouldBe 'empty ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe readable ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
5 shouldBe < (7) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
a shouldEqual b ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldNot have length (3) ^ result shouldNot have size (3) ^ exception shouldNot have message ("file not found") ^
- Inherited from:
- Matchers
This method enables the following syntax, where excellentRead
refers to a BePropertyMatcher[Book]
:
This method enables the following syntax, where excellentRead
refers to a BePropertyMatcher[Book]
:
programmingInScala shouldBe excellentRead ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
8 shouldBe >= (7) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe sorted ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldEqual null ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
xs should contain oneOf (1, 2, 3) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result should not equal (3) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string should endWith regex ("world") ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result should be (3) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe writable ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
file should exist ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
aDouble shouldBe an [Book] ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result should (equal (expected) and have length 3) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
xs shouldNot contain (oneOf (1, 2, 3)) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
aDouble shouldBe 8.8 ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result should have length (3) ^ result should have size (3) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string should startWith regex ("hello") ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
a should === (b) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot endWith regex ("world") ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string should include regex ("hi") ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result should === (100 +- 1) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe theSameInstanceAs (anotherObject) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe null ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot startWith regex ("hello") ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldNot (be (3)) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
5 shouldBe <= (7) ^
- Inherited from:
- Matchers
This method enables the following syntax, where goodRead
refers to a BePropertyMatcher[Book]
:
This method enables the following syntax, where goodRead
refers to a BePropertyMatcher[Book]
:
programmingInScala shouldBe a (goodRead) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe empty ^
- Inherited from:
- Matchers
This method enables the following syntax, where excellentRead
refers to a BePropertyMatcher[Book]
:
This method enables the following syntax, where excellentRead
refers to a BePropertyMatcher[Book]
:
programmingInScala shouldBe an (excellentRead) ^
- Inherited from:
- Matchers
This method enables the following syntax:
This method enables the following syntax:
list shouldBe an ('empty) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
8 shouldBe > (7) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result should equal (3) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldNot be (3) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe defined ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldNot (be readable) ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot include regex ("hi") ^
- Inherited from:
- Matchers
This method enables syntax such as the following:
This method enables syntax such as the following:
result should be a aMatcher ^
- Inherited from:
- Matchers
Implicits
Inherited implicits
Implicitly converts an object of a Numeric
type to a PlusOrMinusWrapper
,
to enable a +-
method to be invoked on that object.
Implicitly converts an object of a Numeric
type to a PlusOrMinusWrapper
,
to enable a +-
method to be invoked on that object.
- Inherited from:
- Tolerance
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.
- Inherited from:
- Matchers
Converts to an Equalizer
that provides ===
and !==
operators that
result in Boolean
and enforce no type constraint.
Converts to an Equalizer
that provides ===
and !==
operators that
result in Boolean
and enforce no type constraint.
This method is overridden and made implicit by subtrait TripleEquals
and overriden as non-implicit by the other
subtraits in this package.
- Value parameters:
- left
the object whose type to convert to
Equalizer
.
- Throws:
- NullPointerException
if
left
isnull
.
- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
Implicitly converts an object of type String
to a StringShouldWrapperForVerb
,
to enable should
methods to be invokable on that object.
Implicitly converts an object of type String
to a StringShouldWrapperForVerb
,
to enable should
methods to be invokable on that object.
- Inherited from:
- ShouldVerb
Provides an A CanEqual B
instance for any two types A
and B
, with no type constraint enforced, given an
implicit Equality[A]
.
Provides an A CanEqual B
instance 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
overriden as non-implicit by the other subtraits in this package.
- Value parameters:
- equalityOfA
an
Equality[A]
type class to which theConstraint.areEqual
method will delegate to determine equality.
- Returns:
an
A CanEqual B
instance whoseareEqual
method delegates to theareEqual
method of the passedEquality[A]
.- Definition Classes
- TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals