TestJsonMergeDiff
Attributes
- Source
- TestJsonMergeDiff.scala
- Graph
-
- Supertypes
-
trait TestProtocol[Json]trait Matcherstrait Explicitlytrait MatcherWordstrait Toleranceclass AnyFlatSpectrait AnyFlatSpecLiketrait Documentingtrait Alertingtrait Notifyingtrait Informingtrait CanVerbtrait MustVerbtrait ShouldVerbtrait TestRegistrationtrait TestSuitetrait Suitetrait Serializabletrait Assertionstrait TripleEqualstrait TripleEqualsSupportclass Objecttrait Matchableclass AnyShow all
Members list
Type members
Inherited classlikes
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest 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 in conjunction with an implicit conversion to enable should
methods to be invoked on objects of type Any
.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports the registration of a “subject” being specified and tested via the instance referenced from AnyFlatSpec
's behavior
field.
Class that supports the registration of a “subject” being specified and tested via the instance referenced from AnyFlatSpec
's behavior
field.
This field enables syntax such as the following subject registration:
behavior of "A Stack" ^
For more information and examples of the use of the behavior
field, see the main documentation for trait AnyFlatSpec
.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class used via an implicit conversion to enable two objects to be compared with ===
and !==
with a Boolean
result and an enforced type constraint between two object types.
Class used via an implicit conversion to enable two objects to be compared with ===
and !==
with a Boolean
result and an enforced type constraint between two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
Value parameters
- leftSide
-
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
Attributes
- Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the Scalactic “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)
Attributes
- Inherited from:
- Explicitly
- Source
- Explicitly.scala
- Supertypes
-
trait Equality[A]trait Equivalence[A]class Objecttrait Matchableclass Any
This class is part of the Scalactic “explicitly DSL”.
This class is part of the Scalactic “explicitly DSL”. Please see the documentation for Explicitly
for an overview of the explicitly DSL.
Attributes
- Inherited from:
- Explicitly
- Source
- Explicitly.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the Scalactic “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)
Attributes
- Inherited from:
- Explicitly
- Source
- Explicitly.scala
- Supertypes
-
trait Equivalence[T]class Objecttrait Matchableclass Any
This class is part of the Scalactic “explicitly DSL”.
This class is part of the Scalactic “explicitly DSL”. Please see the documentation for Explicitly
for an overview of the explicitly DSL.
Attributes
- Inherited from:
- Explicitly
- Source
- Explicitly.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class used via an implicit conversion to enable any two objects to be compared with ===
and !==
with a Boolean
result and no enforced type constraint between two object types.
Class used via an implicit conversion to enable any two objects to be compared with ===
and !==
with a Boolean
result and no enforced type constraint between two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
Value parameters
- leftSide
-
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
Attributes
- Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports registration of ignored tests via the IgnoreWord
instance referenced from AnyFlatSpec
's ignore
field.
Class that supports registration of ignored tests via the IgnoreWord
instance referenced from AnyFlatSpec
's ignore
field.
This class enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
In addition, it enables syntax such as the following registration of an ignored, pending test:
ignore should "pop values in last-in-first-out order" is (pending) ^
Note: the is
method is provided for completeness and design symmetry, given there's no way to prevent changing is
to ignore
and marking a pending test as ignored that way. Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
And finally, it also enables syntax such as the following ignored, tagged test registration:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the ignore
field, see the Ignored tests section in the main documentation for trait AnyFlatSpec
.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports registration of ignored, tagged tests via the IgnoreWord
instance referenced from AnyFlatSpec
's ignore
field.
Class that supports registration of ignored, tagged tests via the IgnoreWord
instance referenced from AnyFlatSpec
's ignore
field.
This class enables syntax such as the following registration of an ignored, tagged test:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
In addition, it enables syntax such as the following registration of an ignored, tagged, pending test:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
Note: the is
method is provided for completeness and design symmetry, given there's no way to prevent changing is
to ignore
and marking a pending test as ignored that way. Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
For more information and examples of the use of the ignore
field, see the Ignored tests section in the main documentation for trait AnyFlatSpec
. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AnyFlatSpec
.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports registration of ignored tests via the ItWord
instance referenced from AnyFlatSpec
's ignore
field.
Class that supports registration of ignored tests via the ItWord
instance referenced from AnyFlatSpec
's ignore
field.
This class enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
For more information and examples of the use of the ignore
field, see Ignored tests section in the main documentation for this trait.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports test registration in shorthand form.
Class that supports test registration in shorthand form.
For example, this class enables syntax such as the following test registration in shorthand form:
"A Stack (when empty)" should "be empty" in { ... } ^
This class also enables syntax such as the following ignored test registration in shorthand form:
"A Stack (when empty)" should "be empty" ignore { ... } ^
This class is used via an implicit conversion (named convertToInAndIgnoreMethods
) from ResultOfStringPassedToVerb
. The ResultOfStringPassedToVerb
class does not declare any methods named in
, because the type passed to in
differs in a AnyFlatSpec
and a FixtureAnyFlatSpec
. A FixtureAnyFlatSpec
needs two in
methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a Fixture
as its parameter). By constrast, a AnyFlatSpec
needs only one in
method that takes a by-name parameter. As a result, AnyFlatSpec
and FixtureAnyFlatSpec
each provide an implicit conversion from ResultOfStringPassedToVerb
to a type that provides the appropriate in
methods.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports tagged test registration in shorthand form.
Class that supports tagged test registration in shorthand form.
For example, this class enables syntax such as the following tagged test registration in shorthand form:
"A Stack (when empty)" should "be empty" taggedAs() in { ... } ^
This class also enables syntax such as the following tagged, ignored test registration in shorthand form:
"A Stack (when empty)" should "be empty" taggedAs(SlowTest) ignore { ... } ^
This class is used via an implicit conversion (named convertToInAndIgnoreMethodsAfterTaggedAs
) from ResultOfTaggedAsInvocation
. The ResultOfTaggedAsInvocation
class does not declare any methods named in
, because the type passed to in
differs in a AnyFlatSpec
and a FixtureAnyFlatSpec
. A FixtureAnyFlatSpec
needs two in
methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a Fixture
as its parameter). By constrast, a AnyFlatSpec
needs only one in
method that takes a by-name parameter. As a result, AnyFlatSpec
and FixtureAnyFlatSpec
each provide an implicit conversion from ResultOfTaggedAsInvocation
to a type that provides the appropriate in
methods.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports test registration via the ItWord
instance referenced from AnyFlatSpec
's it
field.
Class that supports test registration via the ItWord
instance referenced from AnyFlatSpec
's it
field.
This class enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following registration of an ignored test:
it should "pop values in last-in-first-out order" ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending test:
it should "pop values in last-in-first-out order" is (pending) ^
And finally, it also enables syntax such as the following tagged test registration:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the it
field, see the main documentation for trait AnyFlatSpec
.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports the registration of tagged tests via the ItWord
instance referenced from AnyFlatSpec
's it
field.
Class that supports the registration of tagged tests via the ItWord
instance referenced from AnyFlatSpec
's it
field.
This class enables syntax such as the following tagged test registration:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
It also enables syntax such as the following registration of an ignored, tagged test:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending, tagged test:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
For more information and examples of the use of the it
field to register tagged tests, see the Tagging tests section in the main documentation for trait AnyFlatSpec
. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AnyFlatSpec
.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports test (and shared test) registration via the instance referenced from AnyFlatSpec
's it
field.
Class that supports test (and shared test) registration via the instance referenced from AnyFlatSpec
's it
field.
This class enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation for this trait.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
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
.
Attributes
- Inherited from:
- TestSuite
- Source
- TestSuite.scala
- Supertypes
-
trait TestDatatrait () => Outcomeclass Objecttrait Matchableclass Any
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
Attributes
- Inherited from:
- Tolerance
- Source
- Tolerance.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
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 can
methods to be invoked on String
s.
Attributes
- Inherited from:
- CanVerb
- Source
- CanVerb.scala
- Supertypes
-
class Objecttrait Matchableclass Any
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 must
methods to be invoked on String
s.
Attributes
- Inherited from:
- MustVerb
- Source
- MustVerb.scala
- Supertypes
-
class Objecttrait Matchableclass Any
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.
Attributes
- Inherited from:
- ShouldVerb
- Source
- ShouldVerb.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the Scalactic “explicitly DSL”.
This class is part of the Scalactic “explicitly DSL”. Please see the documentation for Explicitly
for an overview of the explicitly DSL.
Attributes
- Inherited from:
- Explicitly
- Source
- Explicitly.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports test registration via the TheyWord
instance referenced from AnyFlatSpec
's they
field.
Class that supports test registration via the TheyWord
instance referenced from AnyFlatSpec
's they
field.
This class enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following registration of an ignored test:
they should "pop values in last-in-first-out order" ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending test:
they should "pop values in last-in-first-out order" is (pending) ^
And finally, it also enables syntax such as the following tagged test registration:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the it
field, see the main documentation for trait AnyFlatSpec
.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports the registration of tagged tests via the TheyWord
instance referenced from AnyFlatSpec
's they
field.
Class that supports the registration of tagged tests via the TheyWord
instance referenced from AnyFlatSpec
's they
field.
This class enables syntax such as the following tagged test registration:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
It also enables syntax such as the following registration of an ignored, tagged test:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending, tagged test:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
For more information and examples of the use of the they
field to register tagged tests, see the Tagging tests section in the main documentation for trait AnyFlatSpec
. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AnyFlatSpec
.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class that supports test (and shared test) registration via the instance referenced from AnyFlatSpec
's it
field.
Class that supports test (and shared test) registration via the instance referenced from AnyFlatSpec
's it
field.
This class enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation for this trait.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
- Supertypes
-
class Objecttrait Matchableclass Any
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers
for an overview of the matchers DSL.
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
- Supertypes
-
class Objecttrait Matchableclass Any
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
Attributes
- Returns
-
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set tofalse
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
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
Attributes
- Returns
-
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set tofalse
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
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
Attributes
- Returns
-
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set tofalse
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
This method enables the following syntax:
This method enables the following syntax:
num should (not be < (10) and not be > (17)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
num should (not be <= (10) and not be > (17)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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
Attributes
- Returns
-
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set totrue
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
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
Attributes
- Returns
-
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set totrue
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
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
Attributes
- Returns
-
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set totrue
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
This method enables the following syntax:
This method enables the following syntax:
num should (not be > (10) and not be < (7)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
num should (not be >= (10) and not be < (7)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
a [RuntimeException] should be thrownBy { ... } ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
Returns an Alerter
that during test execution will forward strings passed to its apply
method to the current reporter.
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 AnyFlatSpec
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.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
all(xs) should fullymatch regex ("Hel*o world".r) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (allElementsOf(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (allOf(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
an [Exception] should be thrownBy { ... } ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
Assert that a boolean condition, described in String
message
, is true.
Assert that a boolean condition, described in String
message
, is true. If the condition is true
, this method returns normally. Else, it throws TestFailedException
with a helpful error message appended with the String
obtained by invoking toString
on the specified clue
as the exception's detail message.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
- 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
Attributes
- Throws
-
NullArgumentException if
message
isnull
.TestFailedException if the condition is
false
. - Inherited from:
- Assertions
- Source
- Assertions.scala
Assert that a boolean condition is true.
Assert that a boolean condition is true. If the condition is true
, this method returns normally. Else, it throws TestFailedException
.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
- 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
Attributes
- Throws
-
TestFailedException if the condition is
false
. - Inherited from:
- Assertions
- Source
- Assertions.scala
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
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
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
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
Assert that the value passed as expected
equals the value passed as actual
.
Assert that the value passed as expected
equals the value passed as actual
. If the actual
value equals the expected
value (as determined by ==
), assertResult
returns normally. Else, assertResult
throws a TestFailedException
whose detail message includes the expected and actual values.
Value parameters
- actual
-
the actual value, which should equal the passed
expected
value - expected
-
the expected value
Attributes
- Throws
-
TestFailedException if the passed
actual
value does not equal the passedexpected
value. - Inherited from:
- Assertions
- Source
- Assertions.scala
Assert that the value passed as expected
equals the value passed as actual
.
Assert that the value passed as expected
equals the value passed as actual
. If the actual
equals the expected
(as determined by ==
), assertResult
returns normally. Else, if actual
is not equal to expected
, assertResult
throws a TestFailedException
whose detail message includes the expected and actual values, as well as the String
obtained by invoking toString
on the passed clue
.
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
Attributes
- Throws
-
TestFailedException if the passed
actual
value does not equal the passedexpected
value. - Inherited from:
- Assertions
- Source
- Assertions.scala
Ensure that an expected exception is thrown by the passed function value.
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
Attributes
- 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
- Source
- Assertions.scala
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
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
Assume that a boolean condition, described in String
message
, is true.
Assume that a boolean condition, described in String
message
, is true. If the condition is true
, this method returns normally. Else, it throws TestCanceledException
with a helpful error message appended with String
obtained by invoking toString
on the specified clue
as the exception's detail message.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
- 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
Attributes
- Throws
-
NullArgumentException if
message
isnull
.TestCanceledException if the condition is
false
. - Inherited from:
- Assertions
- Source
- Assertions.scala
Assume that a boolean condition is true.
Assume that a boolean condition is true. If the condition is true
, this method returns normally. Else, it throws TestCanceledException
.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:
- 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
Attributes
- Throws
-
TestCanceledException if the condition is
false
. - Inherited from:
- Assertions
- Source
- Assertions.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
atLeast(1, xs) should fullymatch regex ("Hel*o world".r) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (atLeastOneElementOf (List(1, 2))) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (atLeastOneOf(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
atMost(3, xs) should fullymatch regex ("Hel*o world".r) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (atMostOneElementOf (List(1, 2))) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (atMostOneOf(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
between(1, 3, xs) should fullymatch regex ("Hel*o world".r) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
Throws TestCanceledException
, with the passed Throwable
cause, to indicate a test failed.
Throws TestCanceledException
, with the passed Throwable
cause, to indicate a test failed. The getMessage
method of the thrown TestCanceledException
will return cause.toString
.
Value parameters
- cause
-
a
Throwable
that indicates the cause of the cancellation.
Attributes
- Throws
-
NullArgumentException if
cause
isnull
- Inherited from:
- Assertions
- Source
- Assertions.scala
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.
Attributes
- Throws
-
NullArgumentException if
message
orcause
isnull
- Inherited from:
- Assertions
- Source
- Assertions.scala
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.
Attributes
- Throws
-
NullArgumentException if
message
isnull
- Inherited from:
- Assertions
- Source
- Assertions.scala
Throws TestCanceledException
to indicate a test was canceled.
Throws TestCanceledException
to indicate a test was canceled.
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
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
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
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
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
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
.
Attributes
- Throws
-
NullPointerException if
left
isnull
. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
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 ==
.
Attributes
- Returns
-
a default
Equality
for typeA
- Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
This method enables the following syntax:
This method enables the following syntax:
list should (not be definedAt (7) and not be definedAt (9)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result should equal (null) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result should equal (100 +- 1) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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.
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
every(xs) should fullymatch regex ("Hel*o world".r) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
exactly(xs) should fullymatch regex ("Hel*o world".r) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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 passed Filter
- the sum of the values obtained by invoking expectedTestCount
on every nested Suite
contained in nestedSuites
Value parameters
- filter
-
a
Filter
with which to filter tests to count based on their tags
Attributes
- Inherited from:
- Suite
- Source
- Suite.scala
Throws TestFailedException
, with the passed Throwable
cause, to indicate a test failed.
Throws TestFailedException
, with the passed Throwable
cause, to indicate a test failed. The getMessage
method of the thrown TestFailedException
will return cause.toString
.
Value parameters
- cause
-
a
Throwable
that indicates the cause of the failure.
Attributes
- Throws
-
NullArgumentException if
cause
isnull
- Inherited from:
- Assertions
- Source
- Assertions.scala
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.
Attributes
- Throws
-
NullArgumentException if
message
orcause
isnull
- Inherited from:
- Assertions
- Source
- Assertions.scala
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.
Attributes
- Throws
-
NullArgumentException if
message
isnull
- Inherited from:
- Assertions
- Source
- Assertions.scala
Throws TestFailedException
to indicate a test failed.
Throws TestFailedException
to indicate a test failed.
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (inOrder(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (inOrderElementsOf List(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (inOrderOnly(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
Returns an Informer
that during test execution will forward strings passed to its apply
method to the current reporter.
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.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Intercept and return an exception that's expected to be thrown by the passed function value.
Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException
.
Note that the type specified as this method's type parameter may represent any subtype of AnyRef
, not just Throwable
or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String
, for example), this method will complete abruptly with a TestFailedException
.
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
Attributes
- 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
- Source
- Assertions.scala
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
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
Returns a Documenter
that during test execution will forward strings passed to its apply
method to the current reporter.
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.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
This method enables the following syntax:
This method enables the following syntax:
exception should not have message ("file not found") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
An immutable IndexedSeq
of this Suite
object's nested Suite
s.
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
.
Attributes
- Inherited from:
- Suite
- Source
- Suite.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
no(xs) should fullymatch regex ("Hel*o world".r) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (noElementsOf List(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This field enables the following syntax:
This field enables the following syntax:
noException should be thrownBy ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (noneOf(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
Returns a Notifier
that during test execution will forward strings passed to its apply
method to the current reporter.
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 AnyFlatSpec
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.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
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")) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (oneElementOf (List(1, 2))) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (oneOf(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (only(1, 2)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
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.
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
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
Attributes
- Throws
-
TestPendingException if the passed block of code completes abruptly with an
Exception
orAssertionError
- Inherited from:
- Assertions
- Source
- Assertions.scala
Registers an ignored test.
Registers an ignored test.
Value parameters
- testFun
-
the test function
- testTags
-
the test tags
- testText
-
the test text
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Registers a test.
Registers a test.
Value parameters
- testFun
-
the test function
- testTags
-
the test tags
- testText
-
the test text
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
The fully qualified class name of the rerunner to rerun this suite.
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.
Attributes
- Inherited from:
- Suite
- Source
- Suite.scala
Runs this suite of tests.
Runs this suite of tests.
If testName
is None
, this trait's implementation of this method calls these two methods on this object in this order:
- runNestedSuites
- runTests
If testName
is defined, then this trait's implementation of this method calls runTests
, but does not call runNestedSuites
. This behavior is part of the contract of this method. Subclasses that override run
must take care not to call runNestedSuites
if testName
is defined. (The OneInstancePerTest
trait depends on this behavior, for example.)
Subclasses and subtraits that override this run
method can implement them without invoking either the runTests
or runNestedSuites
methods, which are invoked by this trait's implementation of this method. It is recommended, but not required, that subclasses and subtraits that override run
in a way that does not invoke runNestedSuites
also override runNestedSuites
and make it final. Similarly it is recommended, but not required, that subclasses and subtraits that override run
in a way that does not invoke runTests
also override runTests
(and runTest
, which this trait's implementation of runTests
calls) and make it final. The implementation of these final methods can either invoke the superclass implementation of the method, or throw an UnsupportedOperationException
if appropriate. The reason for this recommendation is that ScalaTest includes several traits that override these methods to allow behavior to be mixed into a Suite
. For example, trait BeforeAndAfterEach
overrides runTests
s. In a Suite
subclass that no longer invokes runTests
from run
, the BeforeAndAfterEach
trait is not applicable. Mixing it in would have no effect. By making runTests
final in such a Suite
subtrait, you make the attempt to mix BeforeAndAfterEach
into a subclass of your subtrait a compiler error. (It would fail to compile with a complaint that BeforeAndAfterEach
is trying to override runTests
, which is a final method in your trait.)
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
.
Attributes
- Returns
-
a
Status
object that indicates when all tests and nested suites 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 passed parameter is
null
. - Definition Classes
-
AnyFlatSpecLike -> Suite
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Run a test.
Run a test. This trait's implementation runs the test registered with the name specified by testName
. Each test's name is a concatenation of the text of all describers surrounding a test, from outside in, and the test's spec text, with one space placed between each item. (See the documenation for testNames
for an example.)
Value parameters
- args
-
the
Args
for this run - testName
-
the name of one test to execute.
Attributes
- Returns
-
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed . - Throws
-
NullArgumentException if any of
testName
,reporter
,stopper
, orconfigMap
isnull
. - Definition Classes
-
AnyFlatSpecLike -> TestSuite -> Suite
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Run zero to many of this AnyFlatSpec
's tests.
Run zero to many of this AnyFlatSpec
's tests.
This method takes a testName
parameter that optionally specifies a test to invoke. If testName
is Some
, this trait's implementation of this method invokes runTest
on this object, passing in:
- testName
- the String
value of the testName
Option
passed to this method
- reporter
- the Reporter
passed to this method, or one that wraps and delegates to it
- stopper
- the Stopper
passed to this method, or one that wraps and delegates to it
- configMap
- the configMap
passed to this method, or one that wraps and delegates to it
This method takes a Set
of tag names that should be included (tagsToInclude
), and a Set
that should be excluded (tagsToExclude
), when deciding which of this Suite
's tests to execute. If tagsToInclude
is empty, all tests will be executed except those those belonging to tags listed in the tagsToExclude
Set
. If tagsToInclude
is non-empty, only tests belonging to tags mentioned in tagsToInclude
, and not mentioned in tagsToExclude
will be executed. However, if testName
is Some
, tagsToInclude
and tagsToExclude
are essentially ignored. Only if testName
is None
will tagsToInclude
and tagsToExclude
be consulted to determine which of the tests named in the testNames
Set
should be run. For more information on trait tags, see the main documentation for this trait.
If testName
is None
, this trait's implementation of this method invokes testNames
on this Suite
to get a Set
of names of tests to potentially execute. (A testNames
value of None
essentially acts as a wildcard that means all tests in this Suite
that are selected by tagsToInclude
and tagsToExclude
should be executed.) For each test in the testName
Set
, in the order they appear in the iterator obtained by invoking the elements
method on the Set
, this trait's implementation of this method checks whether the test should be run based on the tagsToInclude
and tagsToExclude
Set
s. If so, this implementation invokes runTest
, passing in:
- testName
- the String
name of the test to run (which will be one of the names in the testNames
Set
)
- reporter
- the Reporter
passed to this method, or one that wraps and delegates to it
- stopper
- the Stopper
passed to this method, or one that wraps and delegates to it
- configMap
- the configMap
passed to this method, or one that wraps and delegates to it
Value parameters
- args
-
the
Args
for this run - testName
-
an optional name of one test to execute. If
None
, all relevant tests should be executed. I.e.,None
acts like a wildcard that means execute all relevant tests in thisAnyFlatSpec
.
Attributes
- Returns
-
a
Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred. - Throws
-
NullArgumentException if any of
testName
,reporter
,stopper
,tagsToInclude
,tagsToExclude
, orconfigMap
isnull
. - Definition Classes
-
AnyFlatSpecLike -> Suite
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
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.
Attributes
- Returns
-
this
Suite
object's ID. - Inherited from:
- Suite
- Source
- Suite.scala
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
.
Attributes
- Returns
-
this
Suite
object's suite name. - Inherited from:
- Suite
- Source
- Suite.scala
A Map
whose keys are String
names of tagged tests and whose associated values are the Set
of tags for the test.
A Map
whose keys are String
names of tagged tests and whose associated values are the Set
of tags for the test. If this AnyFlatSpec
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 taggedAs
.
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
.
Attributes
- Definition Classes
-
AnyFlatSpecLike -> Suite
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
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
Attributes
- Returns
-
a
TestData
instance for the specified test, which includes the specified config map - Definition Classes
-
AnyFlatSpecLike -> Suite
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
An immutable Set
of test names.
An immutable Set
of test names. If this AnyFlatSpec
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. Each test's name is composed of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the example itself, with all components separated by a space. For example, consider this AnyFlatSpec
:
import org.scalatest.flatspec.AnyFlatSpec class StackSpec extends AnyFlatSpec { "A Stack (when not empty)" must "allow me to pop" in {} it must "not be empty" in {} "A Stack (when not full)" must "allow me to push" in {} it must "not be full" in {} }
Invoking testNames
on this AnyFlatSpec
will yield a set that contains the following two test name strings:
"A Stack (when not empty) must allow me to pop" "A Stack (when not empty) must not be empty" "A Stack (when not full) must allow me to push" "A Stack (when not full) must not be full"
Attributes
- Definition Classes
-
AnyFlatSpecLike -> Suite
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
This method enables the following syntax:
This method enables the following syntax:
the [FileNotFoundException] should be thrownBy { ... } ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (theSameElementsAs(List(1, 2, 3))) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) should contain (theSameElementsInOrderAs(List(1, 2))) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax:
This method enables the following syntax:
a [RuntimeException] should be thrownBy {...} ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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.
Attributes
- Returns
-
a user-friendly string for this suite
- Definition Classes
-
AnyFlatSpec -> Any
- Inherited from:
- AnyFlatSpec
- Source
- AnyFlatSpec.scala
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
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage
exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it.
Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage
exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).
This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:
withClue("(Employee's name was: " + employee.name + ")") { intercept[IllegalArgumentException] { employee.getTask(-1) } }
If an invocation of intercept
completed abruptly with an exception, the resulting message would be something like:
(Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown
Attributes
- Throws
-
NullArgumentException if the passed
clue
isnull
- Inherited from:
- Assertions
- Source
- Assertions.scala
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
Attributes
- Inherited from:
- TestSuite
- Source
- TestSuite.scala
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.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
. - Deprecated
- true
- Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
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.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
. - Deprecated
- true
- Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
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.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
. - Deprecated
- true
- Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
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.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
. - Deprecated
- true
- Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
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.
Attributes
- Deprecated
- true
- Inherited from:
- Assertions
- Source
- Assertions.scala
Inherited fields
This field enables the following syntax:
This field enables the following syntax:
badBook should not be a ('goodRead) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This field enables syntax such as the following:
This field enables syntax such as the following:
result should equal ("hello") (after being lowerCased) ^
Attributes
- Inherited from:
- Explicitly
- Source
- Explicitly.scala
This field enables the following syntax:
This field enables the following syntax:
badBook should not be an (excellentRead) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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)) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
Supports shared test registration in AnyFlatSpec
s.
Supports shared test registration in AnyFlatSpec
s.
This field supports syntax such as the following:
it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of behave
, see the Shared tests section in the main documentation for this trait.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Supports the registration of a “subject” being specified and tested.
Supports the registration of a “subject” being specified and tested.
This field enables syntax such as the following subject registration:
behavior of "A Stack" ^
For more information and examples of the use of the behavior
field, see the main documentation for this trait.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
This field enables the following syntax:
This field enables the following syntax:
"val a: String = 1" shouldNot compile ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables syntax such as the following:
This field enables syntax such as the following:
list should (contain ('a') and have length (7)) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables syntax such as the following:
This field enables syntax such as the following:
result should equal ("hello") (decided by defaultEquality) ^
Attributes
- Inherited from:
- Explicitly
- Source
- Explicitly.scala
This field enables the following syntax:
This field enables the following syntax:
seq should be (defined) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
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) ^
Attributes
- Inherited from:
- Explicitly
- Source
- Explicitly.scala
This field enables the following syntax:
This field enables the following syntax:
list should be (empty) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (endWith ("ago") and include ("score")) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables the following syntax:
This field enables the following syntax:
file should exist ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
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)) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
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')) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
Supports registration of ignored tests in AnyFlatSpec
s.
Supports registration of ignored tests in AnyFlatSpec
s.
This field enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
For more information and examples of the use of the ignore
field, see the Ignored tests section in the main documentation for this trait.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (include ("hope") and not startWith ("no")) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
Supports test (and shared test) registration in AnyFlatSpec
s.
Supports test (and shared test) registration in AnyFlatSpec
s.
This field enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation for this trait.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
This field enables the following syntax:
This field enables the following syntax:
map should not contain key (10) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This field enables the following syntax:
This field enables the following syntax:
"hi" should not have length (3) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables the following syntax:
This field enables the following syntax:
result should matchPattern { case Person("Bob", _) => } ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
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"))) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
This field enables the following syntax:
This field enables the following syntax:
file should be (readable) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables the following syntax:
This field enables the following syntax:
"eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This field enables the following syntax:
This field enables the following syntax:
set should not have size (3) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables the following syntax:
This field enables the following syntax:
seq should be (sorted) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (startWith ("Four") and include ("year")) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
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.
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
This field enables the following syntax:
This field enables the following syntax:
oneString should not be theSameInstanceAs (anotherString) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
Supports test (and shared test) registration in AnyFlatSpec
s.
Supports test (and shared test) registration in AnyFlatSpec
s.
This field enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation for this trait.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
This field enables the following syntax:
This field enables the following syntax:
"val a: String = 1" shouldNot typeCheck ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
This field enables the following syntax:
This field enables the following syntax:
map should not contain value (10) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This field enables the following syntax:
This field enables the following syntax:
file should be (writable) ^
Attributes
- Inherited from:
- MatcherWords
- Source
- MatcherWords.scala
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
.
Attributes
- Deprecated
- true
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Extensions
Inherited extensions
This method enables syntax such as the following:
This method enables syntax such as the following:
string should fullyMatch regex ("a(b*)c" withGroup "bb") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string should fullyMatch regex ("a(b*)(c*)" withGroups ("bb", "cc")) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string should fullyMatch regex ("""(-)?(\d+)(\.\d*)?""") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot fullyMatch regex ("""(-)?(\d+)(\.\d*)?""") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string should compile ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot compile ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot typeCheck ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result should be (3) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result should equal (3) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result should (equal (expected) and have length 3) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
a shouldEqual b ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldEqual 7.1 +- 0.2 ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldEqual null ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result should not equal (3) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
a should === (b) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result should === (100 +- 1) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result should be a aMatcher ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
aDouble shouldBe 8.8 ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
5 shouldBe < (7) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
8 shouldBe > (7) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
5 shouldBe <= (7) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
8 shouldBe >= (7) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables the following syntax, where odd
refers to a BeMatcher[Int]
:
This method enables the following syntax, where odd
refers to a BeMatcher[Int]
:
testing 1 shouldBe odd ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe 7.1 +- 0.2 ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe sorted ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
aDouble shouldBe a [Book] ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
aDouble shouldBe an [Book] ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe readable ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe writable ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe empty ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe defined ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldNot be (3) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldNot (be (3)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldNot (be readable) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe null ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
result shouldBe theSameInstanceAs (anotherObject) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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 ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
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) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
xs should contain oneOf (1, 2, 3) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
xs shouldNot contain (oneOf (1, 2, 3)) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
file should exist ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
file should not (exist) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
file shouldNot exist ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string should include regex ("hi") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string should startWith regex ("hello") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string should endWith regex ("world") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot startWith regex ("hello") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot endWith regex ("world") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
string shouldNot include regex ("hi") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
regex should fullyMatch regex ("a(b*)c" withGroup "bb") ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
This method enables syntax such as the following:
This method enables syntax such as the following:
regex should fullyMatch regex ("a(b*)(c*)" withGroups ("bb", "cc")) ^
Attributes
- Inherited from:
- Matchers
- Source
- Matchers.scala
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
Attributes
- Inherited from:
- Assertions
- Source
- Assertions.scala
Implicits
Inherited implicits
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
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.
Attributes
- Inherited from:
- Tolerance
- Source
- Tolerance.scala
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
.
Attributes
- Throws
-
NullPointerException if
left
isnull
. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala
Implicitly converts an object of type ResultOfStringPassedToVerb
to an InAndIgnoreMethods
, to enable in
and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfStringPassedToVerb
to an InAndIgnoreMethods
, to enable in
and ignore
methods to be invokable on that object.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Implicitly converts an object of type ResultOfTaggedAsInvocation
to an InAndIgnoreMethodsAfterTaggedAs
, to enable in
and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation
to an InAndIgnoreMethodsAfterTaggedAs
, to enable in
and ignore
methods to be invokable on that object.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Implicitly converts an object of type String
to a StringCanWrapper
, to enable can
methods to be invokable on that object.
Implicitly converts an object of type String
to a StringCanWrapper
, to enable can
methods to be invokable on that object.
Attributes
- Inherited from:
- CanVerb
- Source
- CanVerb.scala
Implicitly converts an object of type String
to a StringMustWrapper
, to enable must
methods to be invokable on that object.
Implicitly converts an object of type String
to a StringMustWrapper
, to enable must
methods to be invokable on that object.
Attributes
- Inherited from:
- MustVerb
- Source
- MustVerb.scala
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.
Attributes
- Inherited from:
- ShouldVerb
- Source
- ShouldVerb.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
Supports the shorthand form of shared test registration.
Supports the shorthand form of shared test registration.
For example, this method enables syntax such as the following in:
"A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed) ^
This function is passed as an implicit parameter to a should
method provided in ShouldVerb
, a must
method provided in MustVerb
, and a can
method provided in CanVerb
. When invoked, this function registers the subject description (the parameter to the function) and returns a BehaveWord
.
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Supports the shorthand form of test registration.
Supports the shorthand form of test registration.
For example, this method enables syntax such as the following:
"A Stack (when empty)" should "be empty" in { ... } ^
This function is passed as an implicit parameter to a should
method provided in ShouldVerb
, a must
method provided in MustVerb
, and a can
method provided in CanVerb
. When invoked, this function registers the subject description (the first parameter to the function) and returns a ResultOfStringPassedToVerb
initialized with the verb and rest parameters (the second and third parameters to the function, respectively).
Attributes
- Inherited from:
- AnyFlatSpecLike
- Source
- AnyFlatSpecLike.scala
Attributes
- Inherited from:
- TestProtocol
- Source
- TestProtocol.scala
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.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEqual
method of the passedEquality[A]
. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
- Source
- TripleEquals.scala