object MustMatchers extends MustMatchers
Companion object that facilitates the importing of Matchers members as
an alternative to mixing it the trait. One use case is to import Matchers members so you can use
them in the Scala interpreter.
- Source
- MustMatchers.scala
- Alphabetic
- By Inheritance
- MustMatchers
- MustMatchers
- Explicitly
- MatcherWords
- MustVerb
- Tolerance
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
AssertionsHelper extends AnyRef
Helper class used by code generated by the
assertmacro.Helper class used by code generated by the
assertmacro.- Definition Classes
- Assertions
-
final
class
AWord extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
AnWord extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
sealed
class
AnyMustWrapper[T] extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.This class is used in conjunction with an implicit conversion to enable
mustmethods to be invoked on objects of typeAny.- Definition Classes
- MustMatchers
-
class
CheckingEqualizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
-
class
DecidedByEquality[A] extends Equality[A]
- Definition Classes
- Explicitly
-
class
DecidedWord extends AnyRef
- Definition Classes
- Explicitly
-
class
DeterminedByEquivalence[T] extends Equivalence[T]
- Definition Classes
- Explicitly
-
class
DeterminedWord extends AnyRef
- Definition Classes
- Explicitly
-
class
Equalizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
-
final
class
HavePropertyMatcherGenerator extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.This class is used as the result of an implicit conversion from class
Symbol, to enable symbols to be used inhave ('author ("Dickens"))syntax. The name of the implicit conversion method isconvertSymbolToHavePropertyMatcherGenerator.Class
HavePropertyMatcherGenerator's primary constructor takes aSymbol. Theapplymethod uses reflection to find and access a property that has the name specified by theSymbolpassed to the constructor, so it can determine if the property has the expected value passed toapply. If the symbol passed is'title, for example, theapplymethod will use reflection to look for a public Java field named "title", a public method named "title", or a public method named "getTitle". If a method, it must take no parameters. If multiple candidates are found, theapplymethod will select based on the following algorithm:Field Method "get" Method Result Throws TestFailedException, because no candidates foundgetTitle()Invokes getTitle()title()Invokes title()title()getTitle()Invokes title()(this can occur whenBeanPropertyannotation is used)titleAccesses field titletitlegetTitle()Invokes getTitle()titletitle()Invokes title()titletitle()getTitle()Invokes title()(this can occur whenBeanPropertyannotation is used)- Definition Classes
- MustMatchers
-
final
class
KeyWord extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
PlusOrMinusWrapper[T] extends AnyRef
- Definition Classes
- Tolerance
-
final
class
RegexWord extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
RegexWrapper extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.This class is used in conjunction with an implicit conversion to enable
withGroupandwithGroupsmethods to be invoked onRegexs.- Definition Classes
- MustMatchers
-
class
ResultOfBeWordForAny[T] extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
sealed
class
ResultOfBeWordForCollectedAny[T] extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfBeWordForCollectedArray[T] extends ResultOfBeWordForCollectedAny[Array[T]]
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfCollectedAny[T] extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfContainWordForCollectedAny[T] extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfEndWithWordForCollectedString extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfEndWithWordForString extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfFullyMatchWordForCollectedString extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfFullyMatchWordForString extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfHaveWordForCollectedExtent[A] extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfHaveWordForExtent[A] extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfIncludeWordForCollectedString extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfIncludeWordForString extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfNotWordForCollectedAny[T] extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfStartWithWordForCollectedString extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
InspectorsMatchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ResultOfStartWithWordForString extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
StringMustWrapper extends AnyMustWrapper[String] with StringMustWrapperForVerb
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.This class is used in conjunction with an implicit conversion to enable
mustmethods to be invoked onStrings.- Definition Classes
- MustMatchers
-
class
TheAfterWord extends AnyRef
- Definition Classes
- Explicitly
-
final
class
TheSameInstanceAsPhrase extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
final
class
ValueWord extends AnyRef
This class is part of the ScalaTest matchers DSL.
This class is part of the ScalaTest matchers DSL. Please see the documentation for
Matchersfor an overview of the matchers DSL.- Definition Classes
- MustMatchers
-
trait
StringMustWrapperForVerb extends AnyRef
This class supports the syntax of
FlatSpec,WordSpec,fixture.FlatSpec, andfixture.WordSpec.This class supports the syntax of
FlatSpec,WordSpec,fixture.FlatSpec, andfixture.WordSpec.This class is used in conjunction with an implicit conversion to enable
mustmethods to be invoked onStrings.- Definition Classes
- MustVerb
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
!==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
-
def
!==(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
-
def
!==[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
<[T](right: T)(implicit arg0: Ordering[T]): ResultOfLessThanComparison[T]
This method enables the following syntax:
This method enables the following syntax:
num must (not be < (10) and not be > (17)) ^
- Definition Classes
- MustMatchers
-
def
<=[T](right: T)(implicit arg0: Ordering[T]): ResultOfLessThanOrEqualToComparison[T]
This method enables the following syntax:
This method enables the following syntax:
num must (not be <= (10) and not be > (17)) ^
- Definition Classes
- MustMatchers
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
-
def
===(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
-
def
===[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
-
def
>[T](right: T)(implicit arg0: Ordering[T]): ResultOfGreaterThanComparison[T]
This method enables the following syntax:
This method enables the following syntax:
num must (not be > (10) and not be < (7)) ^
- Definition Classes
- MustMatchers
-
def
>=[T](right: T)(implicit arg0: Ordering[T]): ResultOfGreaterThanOrEqualToComparison[T]
This method enables the following syntax:
This method enables the following syntax:
num must (not be >= (10) and not be < (7)) ^
- Definition Classes
- MustMatchers
-
def
a[T](implicit arg0: ClassTag[T]): ResultOfATypeInvocation[T]
This method enables the following syntax:
This method enables the following syntax:
a [RuntimeException] must be thrownBy { ... } ^- Definition Classes
- MustMatchers
-
val
a: AWord
This field enables the following syntax:
This field enables the following syntax:
badBook must not be a ('goodRead) ^- Definition Classes
- MustMatchers
-
val
after: TheAfterWord
- Definition Classes
- Explicitly
-
def
all(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
This method enables the following syntax for
String:This method enables the following syntax for
String:all(str) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
all[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
This method enables the following syntax for
java.util.Map:This method enables the following syntax for
java.util.Map:all(jmap) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
all[K, V, MAP[k, v] <: GenMap[k, v]](xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
This method enables the following syntax for
scala.collection.GenMap:This method enables the following syntax for
scala.collection.GenMap:all(map) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
all[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
This method enables the following syntax:
This method enables the following syntax:
all(xs) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
allElementsOf[R](elements: GenTraversable[R]): ResultOfAllElementsOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (allElementsOf(1, 2)) ^
- Definition Classes
- MustMatchers
-
def
allOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAllOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (allOf(1, 2)) ^
- Definition Classes
- MustMatchers
-
def
an[T](implicit arg0: ClassTag[T]): ResultOfAnTypeInvocation[T]
This method enables the following syntax:
This method enables the following syntax:
an [Exception] must be thrownBy { ... } ^- Definition Classes
- MustMatchers
-
val
an: AnWord
This field enables the following syntax:
This field enables the following syntax:
badBook must not be an (excellentRead) ^- Definition Classes
- MustMatchers
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
macro
def
assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Assert that a boolean condition, described in
Stringmessage, is true.Assert that a boolean condition, described in
Stringmessage, is true. If the condition istrue, this method returns normally. Else, it throwsTestFailedExceptionwith a helpful error message appended with theStringobtained by invokingtoStringon the specifiedclueas 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
TestFailedExceptionwith 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 returnsBooleanto be the default in tests. This makes===consistent between tests and production code.- condition
the boolean condition to assert
- clue
An objects whose
toStringmethod returns a message to include in a failure report.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionifmessageisnull.TestFailedExceptionif the condition isfalse.
-
macro
def
assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
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 throwsTestFailedException.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
TestFailedExceptionwith 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 returnsBooleanto be the default in tests. This makes===consistent between tests and production code.- condition
the boolean condition to assert
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedExceptionif the condition isfalse.
-
macro
def
assertCompiles(code: String)(implicit pos: Position): Assertion
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
assertCompilesis 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.- code
the snippet of code that should compile
- Definition Classes
- Assertions
-
macro
def
assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
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
Assertionstrait includes the following syntax for that purpose:assertDoesNotCompile("val a: String = \"a string")Although
assertDoesNotCompileis 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
assertTypeErrorandassertDoesNotCompileis thatassertDoesNotCompilewill succeed if the given code does not compile for any reason, whereasassertTypeErrorwill 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,assertDoesNotCompilewill return normally butassertTypeErrorwill throw aTestFailedException.- code
the snippet of code that should not type check
- Definition Classes
- Assertions
-
def
assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Assert that the value passed as
expectedequals the value passed asactual.Assert that the value passed as
expectedequals the value passed asactual. If theactualvalue equals theexpectedvalue (as determined by==),assertResultreturns normally. Else,assertResultthrows aTestFailedExceptionwhose detail message includes the expected and actual values.- expected
the expected value
- actual
the actual value, which should equal the passed
expectedvalue
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedExceptionif the passedactualvalue does not equal the passedexpectedvalue.
-
def
assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Assert that the value passed as
expectedequals the value passed asactual.Assert that the value passed as
expectedequals the value passed asactual. If theactualequals theexpected(as determined by==),assertResultreturns normally. Else, ifactualis not equal toexpected,assertResultthrows aTestFailedExceptionwhose detail message includes the expected and actual values, as well as theStringobtained by invokingtoStringon the passedclue.- expected
the expected value
- clue
An object whose
toStringmethod returns a message to include in a failure report.- actual
the actual value, which should equal the passed
expectedvalue
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedExceptionif the passedactualvalue does not equal the passedexpectedvalue.
-
def
assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
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 throwsTestFailedException.Note that the type specified as this method's type parameter may represent any subtype of
AnyRef, not justThrowableor 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 asString, for example), this method will complete abruptly with aTestFailedException.Also note that the difference between this method and
interceptis that this method does not return the expected exception, so it does not let you perform further assertions on that exception. Instead, this method returnsSucceeded, 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 useassertThrowsby default,interceptonly when you need to inspect the caught exception further.- f
the function value that should throw the expected exception
- classTag
an implicit
ClassTagrepresenting the type of the specified type parameter.- returns
the
Succeededsingleton, if an exception of the expected type is thrown
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedExceptionif the passed function does not complete abruptly with an exception that's an instance of the specified type.
-
macro
def
assertTypeError(code: String)(implicit pos: Position): Assertion
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
Assertionstrait includes the following syntax for that purpose:assertTypeError("val a: String = 1")Although
assertTypeErroris 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
assertTypeErrorandassertDoesNotCompileis thatassertDoesNotCompilewill succeed if the given code does not compile for any reason, whereasassertTypeErrorwill 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,assertDoesNotCompilewill return normally butassertTypeErrorwill throw aTestFailedException.- code
the snippet of code that should not type check
- Definition Classes
- Assertions
-
val
assertionsHelper: AssertionsHelper
Helper instance used by code generated by macro assertion.
Helper instance used by code generated by macro assertion.
- Definition Classes
- Assertions
-
macro
def
assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
Assume that a boolean condition, described in
Stringmessage, is true.Assume that a boolean condition, described in
Stringmessage, is true. If the condition istrue, this method returns normally. Else, it throwsTestCanceledExceptionwith a helpful error message appended withStringobtained by invokingtoStringon the specifiedclueas 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
TestCanceledExceptionwith 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 returnsBooleanto be the default in tests. This makes===consistent between tests and production code.- condition
the boolean condition to assume
- clue
An objects whose
toStringmethod returns a message to include in a failure report.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionifmessageisnull.TestCanceledExceptionif the condition isfalse.
-
macro
def
assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
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 throwsTestCanceledException.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
TestCanceledExceptionwith 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 returnsBooleanto be the default in tests. This makes===consistent between tests and production code.- condition
the boolean condition to assume
- Definition Classes
- Assertions
- Exceptions thrown
TestCanceledExceptionif the condition isfalse.
-
def
atLeast(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
This method enables the following syntax for
String:This method enables the following syntax for
String:atLeast(1, str) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
atLeast[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
This method enables the following syntax for
java.util.Map:This method enables the following syntax for
java.util.Map:atLeast(1, jmap) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
atLeast[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
This method enables the following syntax for
scala.collection.GenMap:This method enables the following syntax for
scala.collection.GenMap:atLeast(1, map) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
atLeast[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
This method enables the following syntax:
This method enables the following syntax:
atLeast(1, xs) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
atLeastOneElementOf(elements: GenTraversable[Any]): ResultOfAtLeastOneElementOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (atLeastOneElementOf (List(1, 2))) ^
- Definition Classes
- MustMatchers
-
def
atLeastOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAtLeastOneOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (atLeastOneOf(1, 2)) ^
- Definition Classes
- MustMatchers
-
def
atMost(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
This method enables the following syntax for
String:This method enables the following syntax for
String:atMost(3, str) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
atMost[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
This method enables the following syntax for
java.util.Map:This method enables the following syntax for
java.util.Map:atMost(3, jmap) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
atMost[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
This method enables the following syntax for
scala.collection.GenMap:This method enables the following syntax for
scala.collection.GenMap:atMost(3, map) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
atMost[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
This method enables the following syntax:
This method enables the following syntax:
atMost(3, xs) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
atMostOneElementOf[R](elements: GenTraversable[R]): ResultOfAtMostOneElementOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (atMostOneElementOf (List(1, 2))) ^
- Definition Classes
- MustMatchers
-
def
atMostOneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfAtMostOneOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (atMostOneOf(1, 2)) ^
- Definition Classes
- MustMatchers
-
val
be: BeWord
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)) ^- Definition Classes
- MatcherWords
-
def
between(from: Int, upTo: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
This method enables the following syntax for
String:This method enables the following syntax for
String:between(1, 3, str) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
between[K, V, JMAP[k, v] <: Map[k, v]](from: Int, upTo: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
This method enables the following syntax for
java.util.Map:This method enables the following syntax for
java.util.Map:between(1, 3, jmap) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
between[E, C[_]](from: Int, upTo: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
This method enables the following syntax:
This method enables the following syntax:
between(1, 3, xs) must fullymatch regex ("Hel*o world".r) ^
- Definition Classes
- MustMatchers
-
def
cancel(cause: Throwable)(implicit pos: Position): Nothing
Throws
TestCanceledException, with the passedThrowablecause, to indicate a test failed.Throws
TestCanceledException, with the passedThrowablecause, to indicate a test failed. ThegetMessagemethod of the thrownTestCanceledExceptionwill returncause.toString.- cause
a
Throwablethat indicates the cause of the cancellation.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionifcauseisnull
-
def
cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
Throws
TestCanceledException, with the passedStringmessageas the exception's detail message andThrowablecause, to indicate a test failed.Throws
TestCanceledException, with the passedStringmessageas the exception's detail message andThrowablecause, to indicate a test failed.- message
A message describing the failure.
- cause
A
Throwablethat indicates the cause of the failure.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionifmessageorcauseisnull
-
def
cancel(message: String)(implicit pos: Position): Nothing
Throws
TestCanceledException, with the passedStringmessageas the exception's detail message, to indicate a test was canceled.Throws
TestCanceledException, with the passedStringmessageas the exception's detail message, to indicate a test was canceled.- message
A message describing the cancellation.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionifmessageisnull
-
def
cancel()(implicit pos: Position): Nothing
Throws
TestCanceledExceptionto indicate a test was canceled.Throws
TestCanceledExceptionto indicate a test was canceled.- Definition Classes
- Assertions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
val
compile: CompileWord
This field enables the following syntax:
This field enables the following syntax:
"val a: String = 1" shouldNot compile ^- Definition Classes
- MatcherWords
-
val
contain: ContainWord
This field enables syntax such as the following:
This field enables syntax such as the following:
list should (contain ('a') and have length (7)) ^
- Definition Classes
- MatcherWords
-
def
conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
def
convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
def
convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
def
convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
def
convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
implicit
def
convertNumericToPlusOrMinusWrapper[T](pivot: T)(implicit arg0: Numeric[T]): PlusOrMinusWrapper[T]
- Definition Classes
- Tolerance
-
implicit
def
convertSymbolToHavePropertyMatcherGenerator(symbol: Symbol)(implicit prettifier: Prettifier, pos: Position): HavePropertyMatcherGenerator
This implicit conversion method converts a
Symbolto aHavePropertyMatcherGenerator, to enable the symbol to be used with thehave ('author ("Dickens"))syntax.This implicit conversion method converts a
Symbolto aHavePropertyMatcherGenerator, to enable the symbol to be used with thehave ('author ("Dickens"))syntax.- Definition Classes
- MustMatchers
-
implicit
def
convertToAnyMustWrapper[T](o: T)(implicit pos: Position, prettifier: Prettifier): AnyMustWrapper[T]
Implicitly converts an object of type
Tto aAnyMustWrapper[T], to enablemustmethods to be invokable on that object.Implicitly converts an object of type
Tto aAnyMustWrapper[T], to enablemustmethods to be invokable on that object.- Definition Classes
- MustMatchers
-
def
convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
implicit
def
convertToEqualizer[T](left: T): Equalizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
implicit
def
convertToRegexWrapper(o: Regex): RegexWrapper
Implicitly converts an object of type
scala.util.matching.Regexto aRegexWrapper, to enablewithGroupandwithGroupsmethods to be invokable on that object.Implicitly converts an object of type
scala.util.matching.Regexto aRegexWrapper, to enablewithGroupandwithGroupsmethods to be invokable on that object.- Definition Classes
- MustMatchers
-
implicit
def
convertToStringMustWrapper(o: String)(implicit pos: Position, prettifier: Prettifier): StringMustWrapper
Implicitly converts an object of type
java.lang.Stringto aStringMustWrapper, to enablemustmethods to be invokable on that object.Implicitly converts an object of type
java.lang.Stringto aStringMustWrapper, to enablemustmethods to be invokable on that object.- Definition Classes
- MustMatchers
-
implicit
def
convertToStringMustWrapperForVerb(o: String)(implicit position: Position): StringMustWrapperForVerb
Implicitly converts an object of type
Stringto aStringMustWrapper, to enablemustmethods to be invokable on that object.Implicitly converts an object of type
Stringto aStringMustWrapper, to enablemustmethods to be invokable on that object.- Definition Classes
- MustVerb
-
val
decided: DecidedWord
- Definition Classes
- Explicitly
-
def
defaultEquality[A]: Equality[A]
- Definition Classes
- TripleEqualsSupport
-
val
defined: DefinedWord
This field enables the following syntax:
This field enables the following syntax:
seq should be (defined) ^- Definition Classes
- MatcherWords
-
def
definedAt[T](right: T): ResultOfDefinedAt[T]
This method enables the following syntax:
This method enables the following syntax:
list must (not be definedAt (7) and not be definedAt (9)) ^
- Definition Classes
- MustMatchers
-
val
determined: DeterminedWord
- Definition Classes
- Explicitly
-
val
empty: EmptyWord
This field enables the following syntax:
This field enables the following syntax:
list should be (empty) ^- Definition Classes
- MatcherWords
-
val
endWith: EndWithWord
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (endWith ("ago") and include ("score")) ^
- Definition Classes
- MatcherWords
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equal(o: Null): Matcher[AnyRef]
This method enables syntax such as the following:
This method enables syntax such as the following:
result must equal (null) ^- Definition Classes
- MustMatchers
-
def
equal[T](spread: Spread[T]): Matcher[T]
This method enables syntax such as the following:
This method enables syntax such as the following:
result must equal (100 +- 1) ^
- Definition Classes
- MustMatchers
-
def
equal(right: Any): MatcherFactory1[Any, Equality]
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 theleftvalue, passing in therightvalue, on every type except arrays. If bothleftand right are arrays,deepwill be invoked on bothleftandrightbefore comparing them with ==. Thus, even though this expression will yield false, becauseArray'sequalsmethod 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 theSameInstanceAssyntax.- Definition Classes
- MatcherWords
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
every(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
This method enables the following syntax for
String:This method enables the following syntax for
String:every(str) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
every[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
This method enables the following syntax for
java.util.Map:This method enables the following syntax for
java.util.Map:every(jmap) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
every[K, V, MAP[k, v] <: Map[k, v]](xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
This method enables the following syntax for
scala.collection.GenMap:This method enables the following syntax for
scala.collection.GenMap:every(map) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
every[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
This method enables the following syntax:
This method enables the following syntax:
every(xs) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
exactly(num: Int, xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
This method enables the following syntax for
String:This method enables the following syntax for
String:exactly(str) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
exactly[K, V, JMAP[k, v] <: Map[k, v]](num: Int, xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
This method enables the following syntax for
java.util.Map:This method enables the following syntax for
java.util.Map:exactly(jmap) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
exactly[K, V, MAP[k, v] <: GenMap[k, v]](num: Int, xs: MAP[K, V])(implicit collecting: Collecting[(K, V), GenTraversable[(K, V)]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[(K, V)]
This method enables the following syntax for
scala.collection.GenMap:This method enables the following syntax for
scala.collection.GenMap:exactly(map) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
exactly[E, C[_]](num: Int, xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
This method enables the following syntax:
This method enables the following syntax:
exactly(xs) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
val
exist: ExistWord
This field enables the following syntax:
This field enables the following syntax:
file should exist ^- Definition Classes
- MatcherWords
-
def
fail(cause: Throwable)(implicit pos: Position): Nothing
Throws
TestFailedException, with the passedThrowablecause, to indicate a test failed.Throws
TestFailedException, with the passedThrowablecause, to indicate a test failed. ThegetMessagemethod of the thrownTestFailedExceptionwill returncause.toString.- cause
a
Throwablethat indicates the cause of the failure.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionifcauseisnull
-
def
fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
Throws
TestFailedException, with the passedStringmessageas the exception's detail message andThrowablecause, to indicate a test failed.Throws
TestFailedException, with the passedStringmessageas the exception's detail message andThrowablecause, to indicate a test failed.- message
A message describing the failure.
- cause
A
Throwablethat indicates the cause of the failure.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionifmessageorcauseisnull
-
def
fail(message: String)(implicit pos: Position): Nothing
Throws
TestFailedException, with the passedStringmessageas the exception's detail message, to indicate a test failed.Throws
TestFailedException, with the passedStringmessageas the exception's detail message, to indicate a test failed.- message
A message describing the failure.
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionifmessageisnull
-
def
fail()(implicit pos: Position): Nothing
Throws
TestFailedExceptionto indicate a test failed.Throws
TestFailedExceptionto indicate a test failed.- Definition Classes
- Assertions
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
val
fullyMatch: FullyMatchWord
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)) ^
- Definition Classes
- MatcherWords
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
val
have: HaveWord
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')) ^
- Definition Classes
- MatcherWords
-
def
inOrder(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfInOrderApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (inOrder(1, 2)) ^
- Definition Classes
- MustMatchers
-
def
inOrderElementsOf[R](elements: GenTraversable[R]): ResultOfInOrderElementsOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (inOrderElementsOf List(1, 2)) ^
- Definition Classes
- MustMatchers
-
def
inOrderOnly[T](firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfInOrderOnlyApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (inOrderOnly(1, 2)) ^
- Definition Classes
- MustMatchers
-
val
include: IncludeWord
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (include ("hope") and not startWith ("no")) ^
- Definition Classes
- MatcherWords
-
def
intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): T
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 justThrowableor 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 asString, for example), this method will complete abruptly with aTestFailedException.Also note that the difference between this method and
assertThrowsis that this method returns the expected exception, so it lets you perform further assertions on that exception. By contrast, theassertThrowsmethod returnsSucceeded, which means it can serve as the last statement in an async- or safe-style suite.assertThrowsalso 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 useassertThrowsby default,interceptonly when you need to inspect the caught exception further.- f
the function value that should throw the expected exception
- classTag
an implicit
ClassTagrepresenting the type of the specified type parameter.- returns
the intercepted exception, if it is of the expected type
- Definition Classes
- Assertions
- Exceptions thrown
TestFailedExceptionif the passed function does not complete abruptly with an exception that's an instance of the specified type.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
key: KeyWord
This field enables the following syntax:
This field enables the following syntax:
map must not contain key (10) ^- Definition Classes
- MustMatchers
-
val
length: LengthWord
This field enables the following syntax:
This field enables the following syntax:
"hi" should not have length (3) ^
- Definition Classes
- MatcherWords
-
def
lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
def
lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
val
matchPattern: MatchPatternWord
This field enables the following syntax:
This field enables the following syntax:
result should matchPattern { case Person("Bob", _) => } ^- Definition Classes
- MatcherWords
-
def
message(expectedMessage: String): ResultOfMessageWordApplication
This method enables the following syntax:
This method enables the following syntax:
exception must not have message ("file not found") ^- Definition Classes
- MustMatchers
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
no(xs: String)(implicit collecting: Collecting[Char, String], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Char]
This method enables the following syntax for
String:This method enables the following syntax for
String:no(str) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
no[K, V, JMAP[k, v] <: Map[k, v]](xs: JMAP[K, V])(implicit collecting: Collecting[Entry[K, V], JMAP[K, V]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[Entry[K, V]]
This method enables the following syntax for
java.util.Map:This method enables the following syntax for
java.util.Map:no(jmap) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
no[E, C[_]](xs: C[E])(implicit collecting: Collecting[E, C[E]], prettifier: Prettifier, pos: Position): ResultOfCollectedAny[E]
This method enables the following syntax:
This method enables the following syntax:
no(xs) must fullymatch regex ("Hel*o world".r) ^- Definition Classes
- MustMatchers
-
def
noElementsOf(elements: GenTraversable[Any]): ResultOfNoElementsOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (noElementsOf List(1, 2)) ^
- Definition Classes
- MustMatchers
-
def
noException(implicit pos: Position): NoExceptionWord
This field enables the following syntax:
This field enables the following syntax:
noException should be thrownBy ^
- Definition Classes
- MatcherWords
-
def
noneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfNoneOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (noneOf(1, 2)) ^
- Definition Classes
- MustMatchers
-
val
not: NotWord
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"))) ^
- Definition Classes
- MatcherWords
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
of[T](implicit ev: ClassTag[T]): ResultOfOfTypeInvocation[T]
This method enables syntax such as the following:
This method enables syntax such as the following:
book must have (message ("A TALE OF TWO CITIES") (of [Book]), title ("A Tale of Two Cities")) ^
- Definition Classes
- MustMatchers
-
def
oneElementOf(elements: GenTraversable[Any]): ResultOfOneElementOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (oneElementOf (List(1, 2))) ^
- Definition Classes
- MustMatchers
-
def
oneOf(firstEle: Any, secondEle: Any, remainingEles: Any*)(implicit pos: Position): ResultOfOneOfApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (oneOf(1, 2)) ^
- Definition Classes
- MustMatchers
-
def
only(xs: Any*)(implicit pos: Position): ResultOfOnlyApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (only(1, 2)) ^
- Definition Classes
- MustMatchers
-
def
pending: Assertion with PendingStatement
Throws
TestPendingExceptionto indicate a test is pending.Throws
TestPendingExceptionto 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 withTestPendingException. Because tests in ScalaTest can be designated as pending withTestPendingException, 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 withTestPendingException, 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 inpending(). 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 asFunSuiteorFunSpecto 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.- Definition Classes
- Assertions
-
def
pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement
Execute the passed block of code, and if it completes abruptly, throw
TestPendingException, else throwTestFailedException.Execute the passed block of code, and if it completes abruptly, throw
TestPendingException, else throwTestFailedException.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
pendingUntilFixedcall. In other words, apendingUntilFixedsurrounding a block of code that isn't broken is treated as a test failure. The motivation for this behavior is to encourage people to removependingUntilFixedcalls 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 withpendingUntilFixedwill no longer throw an exception (because the problem has been fixed). This will in turn causependingUntilFixedto throwTestFailedExceptionwith a detail message explaining you need to go back and remove thependingUntilFixedcall as the problem orginally causing your test code to fail has been fixed.- f
a block of code, which if it completes abruptly, should trigger a
TestPendingException
- Definition Classes
- Assertions
- Exceptions thrown
TestPendingExceptionif the passed block of code completes abruptly with anExceptionorAssertionError
-
val
readable: ReadableWord
This field enables the following syntax:
This field enables the following syntax:
file should be (readable) ^- Definition Classes
- MatcherWords
-
val
regex: RegexWord
This field enables the following syntax:
This field enables the following syntax:
"eight" must not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r) ^
- Definition Classes
- MustMatchers
-
val
size: SizeWord
This field enables the following syntax:
This field enables the following syntax:
set should not have size (3) ^- Definition Classes
- MatcherWords
-
val
sorted: SortedWord
This field enables the following syntax:
This field enables the following syntax:
seq should be (sorted) ^- Definition Classes
- MatcherWords
-
val
startWith: StartWithWord
This field enables syntax such as the following:
This field enables syntax such as the following:
string should (startWith ("Four") and include ("year")) ^
- Definition Classes
- MatcherWords
-
final
val
succeed: Assertion
The
Succeededsingleton.The
Succeededsingleton.You can use
succeedto solve a type error when an async test does not end in eitherFuture[Assertion]orAssertion. BecauseAssertionis a type alias forSucceeded.type, puttingsucceedat 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.- Definition Classes
- Assertions
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
the[T](implicit arg0: ClassTag[T], pos: Position): ResultOfTheTypeInvocation[T]
This method enables the following syntax:
This method enables the following syntax:
the [FileNotFoundException] must be thrownBy { ... } ^- Definition Classes
- MustMatchers
-
def
theSameElementsAs(xs: GenTraversable[_]): ResultOfTheSameElementsAsApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (theSameElementsAs(List(1, 2, 3))) ^
- Definition Classes
- MustMatchers
-
def
theSameElementsInOrderAs(xs: GenTraversable[_]): ResultOfTheSameElementsInOrderAsApplication
This method enables the following syntax:
This method enables the following syntax:
List(1, 2, 3) must contain (theSameElementsInOrderAs(List(1, 2))) ^
- Definition Classes
- MustMatchers
-
val
theSameInstanceAs: TheSameInstanceAsPhrase
This field enables the following syntax:
This field enables the following syntax:
oneString must not be theSameInstanceAs (anotherString) ^- Definition Classes
- MustMatchers
-
def
thrownBy(fun: ⇒ Any): ResultOfThrownByApplication
This method enables the following syntax:
This method enables the following syntax:
a [RuntimeException] must be thrownBy {...} ^- Definition Classes
- MustMatchers
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
typeCheck: TypeCheckWord
This field enables the following syntax:
This field enables the following syntax:
"val a: String = 1" shouldNot typeCheck ^- Definition Classes
- MatcherWords
-
def
typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
implicit
def
unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
val
value: ValueWord
This field enables the following syntax:
This field enables the following syntax:
map must not contain value (10) ^- Definition Classes
- MustMatchers
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
withClue[T](clue: Any)(fun: ⇒ T): T
Executes the block of code passed as the second parameter, and, if it completes abruptly with a
ModifiableMessageexception, 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
ModifiableMessageexception, 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
interceptcompleted 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
- Definition Classes
- Assertions
- Exceptions thrown
NullArgumentExceptionif the passedclueisnull
-
val
writable: WritableWord
This field enables the following syntax:
This field enables the following syntax:
file should be (writable) ^- Definition Classes
- MatcherWords
Deprecated Value Members
-
def
trap[T](f: ⇒ T): Throwable
Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new
RuntimeExceptionindicating 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
RuntimeExceptionindicating 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, nottrap. Here's an example interpreter session withouttrap: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 13Much less clutter. Bear in mind, however, that if no exception is thrown by the passed block of code, the
trapmethod will create a newNormalResult(a subclass ofThrowablemade for this purpose only) and return that. If the result was theUnitvalue, 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, theNormalResult'stoStringwill 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 isAnyand therefore not very convenient to use. It is not intended thattrapbe used in test code. The sole intended use case fortrapis decluttering Scala interpreter sessions by eliminating stack traces when executing assertion and matcher expressions.- Definition Classes
- Assertions
- Annotations
- @deprecated
- Deprecated
The trap method is no longer needed for demos in the REPL, which now abreviates stack traces, and will be removed in a future version of ScalaTest