ServerAuthenticationTests

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is used in conjunction with an implicit conversion to enable <code>should</code> methods to be invoked on objects of type <code>Any</code>.

Class used via an implicit conversion to enable two objects to be compared with <code>===</code> and <code>!==</code> with a <code>Boolean</code> result and an enforced type constraint between two object types. For example:

<pre class="stHighlight"> assert(a === b) assert(c !== d) </pre>

You can also check numeric values against another with a tolerance. Here are some examples:

<pre class="stHighlight"> assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1)) </pre>

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for <a href="Explicitly.html"><code>Explicitly</code></a> for an overview of the explicitly DSL.

Instances of this class are returned via the <code>decided</code> <code>by</code> <code><an Equality></code> syntax, and enables <code>afterBeing</code> to be invoked on it. Here's an example, given an <code>Equality[String]</code> named <code>myStringEquality</code>:

<pre class="stHighlight"> result should equal ("hello") (decided by myStringEquality afterBeing lowerCased) </pre>

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for <a href="Explicitly.html"><code>Explicitly</code></a> for an overview of the explicitly DSL.

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for <a href="Explicitly.html"><code>Explicitly</code></a> for an overview of the explicitly DSL.

Instances of this class are returned via the <code>decided</code> <code>by</code> <code><an Equivalence></code> syntax, and enables <code>afterBeing</code> to be invoked on it. Here's an example, given an <code> Equivalence[String]</code> named <code>myStringEquivalence</code>:

<pre class="stHighlight"> result should equal ("hello") (determined by myStringEquivalence afterBeing lowerCased) </pre>

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for <a href="Explicitly.html"><code>Explicitly</code></a> for an overview of the explicitly DSL.

Class used via an implicit conversion to enable any two objects to be compared with <code>===</code> and <code>!==</code> with a <code>Boolean</code> result and no enforced type constraint between two object types. For example:

<pre class="stHighlight"> assert(a === b) assert(c !== d) </pre>

You can also check numeric values against another with a tolerance. Here are some examples:

<pre class="stHighlight"> assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1)) </pre>

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is used as the result of an implicit conversion from class <code>Symbol</code>, to enable symbols to be used in <code>have ('author ("Dickens"))</code> syntax. The name of the implicit conversion method is <code>convertSymbolToHavePropertyMatcherGenerator</code>.

Class <code>HavePropertyMatcherGenerator</code>'s primary constructor takes a <code>Symbol</code>. The <code>apply</code> method uses reflection to find and access a property that has the name specified by the <code>Symbol</code> passed to the constructor, so it can determine if the property has the expected value passed to <code>apply</code>. If the symbol passed is <code>'title</code>, for example, the <code>apply</code> method will use reflection to look for a public Java field named "title", a public method named "title", or a public method named "getTitle". If a method, it must take no parameters. If multiple candidates are found, the <code>apply</code> method will select based on the following algorithm:

<table class="stTable"> <tr><th class="stHeadingCell">Field</th><th class="stHeadingCell">Method</th><th class="stHeadingCell">"get" Method</th><th class="stHeadingCell">Result</th></tr> <tr><td class="stTableCell">&nbsp;</td><td class="stTableCell">&nbsp;</td><td class="stTableCell">&nbsp;</td><td class="stTableCell">Throws <code>TestFailedException</code>, because no candidates found</td></tr> <tr><td class="stTableCell">&nbsp;</td><td class="stTableCell">&nbsp;</td><td class="stTableCell"><code>getTitle()</code></td><td class="stTableCell">Invokes <code>getTitle()</code></td></tr> <tr><td class="stTableCell">&nbsp;</td><td class="stTableCell"><code>title()</code></td><td class="stTableCell">&nbsp;</td><td class="stTableCell">Invokes <code>title()</code></td></tr> <tr><td class="stTableCell">&nbsp;</td><td class="stTableCell"><code>title()</code></td><td class="stTableCell"><code>getTitle()</code></td><td class="stTableCell">Invokes <code>title()</code> (this can occur when <code>BeanProperty</code> annotation is used)</td></tr> <tr><td class="stTableCell"><code>title</code></td><td class="stTableCell">&nbsp;</td><td class="stTableCell">&nbsp;</td><td class="stTableCell">Accesses field <code>title</code></td></tr> <tr><td class="stTableCell"><code>title</code></td><td class="stTableCell">&nbsp;</td><td class="stTableCell"><code>getTitle()</code></td><td class="stTableCell">Invokes <code>getTitle()</code></td></tr> <tr><td class="stTableCell"><code>title</code></td><td class="stTableCell"><code>title()</code></td><td class="stTableCell">&nbsp;</td><td class="stTableCell">Invokes <code>title()</code></td></tr> <tr><td class="stTableCell"><code>title</code></td><td class="stTableCell"><code>title()</code></td><td class="stTableCell"><code>getTitle()</code></td><td class="stTableCell">Invokes <code>title()</code> (this can occur when <code>BeanProperty</code> annotation is used)</td></tr> </table>

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

Wrapper class with a <code>+-</code> method that, given a <code>Numeric</code> argument, returns a <code>Spread</code>.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="InspectorsMatchers.html"><code>InspectorsMatchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class supports the syntax of <code>FlatSpec</code>, <code>WordSpec</code>, <code>fixture.FlatSpec</code>, and <code>fixture.WordSpec</code>.

This class is used in conjunction with an implicit conversion to enable <code>should</code> methods to be invoked on <code>String</code>s.

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for <a href="Explicitly.html"><code>Explicitly</code></a> for an overview of the explicitly DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for <a href="Matchers.html"><code>Matchers</code></a> for an overview of the matchers DSL.

Returns a <code>TripleEqualsInvocationOnSpread[T]</code>, given an <code>Spread[T]</code>, to facilitate the “<code><em><left></em> should !== (<em><pivot></em> +- <em><tolerance></em>)</code>” syntax of <a href="../scalatest/Matchers.html"><code>Matchers</code></a>.

Returns a <code>TripleEqualsInvocation[Null]</code>, given a <code>null</code> reference, to facilitate the “<code><em><left></em> should !== null</code>” syntax of <a href="../scalatest/Matchers.html"><code>Matchers</code></a>.

Returns a <code>TripleEqualsInvocation[T]</code>, given an object of type <code>T</code>, to facilitate the “<code><em><left></em> should !== <em><right></em></code>” syntax of <a href="../scalatest/Matchers.html"><code>Matchers</code></a>.

This method enables the following syntax:

<pre class="stHighlight"> num should (not be &lt; (10) and not be &gt; (17)) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> num should (not be &lt;= (10) and not be &gt; (17)) ^ </pre>

Returns a <code>TripleEqualsInvocationOnSpread[T]</code>, given an <code>Spread[T]</code>, to facilitate the “<code><em><left></em> should === (<em><pivot></em> +- <em><tolerance></em>)</code>” syntax of <a href="../scalatest/Matchers.html"><code>Matchers</code></a>.

Returns a <code>TripleEqualsInvocation[Null]</code>, given a <code>null</code> reference, to facilitate the “<code><em><left></em> should === null</code>” syntax of <a href="../scalatest/Matchers.html"><code>Matchers</code></a>.

Returns a <code>TripleEqualsInvocation[T]</code>, given an object of type <code>T</code>, to facilitate the “<code><em><left></em> should === <em><right></em></code>” syntax of <a href="../scalatest/Matchers.html"><code>Matchers</code></a>.

This method enables the following syntax:

<pre class="stHighlight"> num should (not be &gt; (10) and not be &lt; (7)) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> num should (not be &gt;= (10) and not be < (7)) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> a [RuntimeException] should be thrownBy { ... } ^ </pre>

This method enables the following syntax for <code>String</code>:

<pre class="stHighlight"> all(str) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>java.util.Map</code>:

<pre class="stHighlight"> all(jmap) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>scala.collection.GenMap</code>:

<pre class="stHighlight"> all(map) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> all(xs) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (allElementsOf(1, 2)) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (allOf(1, 2)) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> an [Exception] should be thrownBy { ... } ^ </pre>

Assert that a boolean condition, described in <code>String</code> <code>message</code>, is true. If the condition is <code>true</code>, this method returns normally. Else, it throws <code>TestFailedException</code> with a helpful error message appended with the <code>String</code> obtained by invoking <code>toString</code> on the specified <code>clue</code> 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 <code>TestFailedException</code> 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 <code>===</code> that returns <code>Boolean</code> to be the default in tests. This makes <code>===</code> consistent between tests and production code.

Assert that a boolean condition is true. If the condition is <code>true</code>, this method returns normally. Else, it throws <code>TestFailedException</code>.

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 <code>TestFailedException</code> 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 <code>===</code> that returns <code>Boolean</code> to be the default in tests. This makes <code>===</code> consistent between tests and production code.

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:

<pre class="stHighlight"> assertCompiles("val a: Int = 1") </pre>

Although <code>assertCompiles</code> is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string compiles, errors (<em>i.e.</em>, snippets of code that <em>do not</em> compile) are reported as test failures at runtime.

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 <code>Assertions</code> trait includes the following syntax for that purpose:

<pre class="stHighlight"> assertDoesNotCompile("val a: String = \"a string") </pre>

Although <code>assertDoesNotCompile</code> is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string doesn't compile, errors (<em>i.e.</em>, snippets of code that <em>do</em> compile) are reported as test failures at runtime.

Note that the difference between <code>assertTypeError</code> and <code>assertDoesNotCompile</code> is that <code>assertDoesNotCompile</code> will succeed if the given code does not compile for any reason, whereas <code>assertTypeError</code> 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, <code>assertDoesNotCompile</code> will return normally but <code>assertTypeError</code> will throw a <code>TestFailedException</code>.

Assert that the value passed as <code>expected</code> equals the value passed as <code>actual</code>. If the <code>actual</code> value equals the <code>expected</code> value (as determined by <code>==</code>), <code>assertResult</code> returns normally. Else, <code>assertResult</code> throws a <code>TestFailedException</code> whose detail message includes the expected and actual values.

Assert that the value passed as <code>expected</code> equals the value passed as <code>actual</code>. If the <code>actual</code> equals the <code>expected</code> (as determined by <code>==</code>), <code>assertResult</code> returns normally. Else, if <code>actual</code> is not equal to <code>expected</code>, <code>assertResult</code> throws a <code>TestFailedException</code> whose detail message includes the expected and actual values, as well as the <code>String</code> obtained by invoking <code>toString</code> on the passed <code>clue</code>.

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 <code>Succeeded</code>. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws <code>TestFailedException</code>.

Note that the type specified as this method's type parameter may represent any subtype of <code>AnyRef</code>, not just <code>Throwable</code> 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 <code>String</code>, for example), this method will complete abruptly with a <code>TestFailedException</code>.

Also note that the difference between this method and <code>intercept</code> 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 <code>Succeeded</code>, 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 <code>assertThrows</code> by default, <code>intercept</code> only when you need to inspect the caught exception further.

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 <code>Assertions</code> trait includes the following syntax for that purpose:

<pre class="stHighlight"> assertTypeError("val a: String = 1") </pre>

Although <code>assertTypeError</code> is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string type checks, errors (<em>i.e.</em>, snippets of code that <em>do</em> type check) are reported as test failures at runtime.

Note that the difference between <code>assertTypeError</code> and <code>assertDoesNotCompile</code> is that <code>assertDoesNotCompile</code> will succeed if the given code does not compile for any reason, whereas <code>assertTypeError</code> 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, <code>assertDoesNotCompile</code> will return normally but <code>assertTypeError</code> will throw a <code>TestFailedException</code>.

Assume that a boolean condition, described in <code>String</code> <code>message</code>, is true. If the condition is <code>true</code>, this method returns normally. Else, it throws <code>TestCanceledException</code> with a helpful error message appended with <code>String</code> obtained by invoking <code>toString</code> on the specified <code>clue</code> 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 <code>TestCanceledException</code> 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 <code>===</code> that returns <code>Boolean</code> to be the default in tests. This makes <code>===</code> consistent between tests and production code.

Assume that a boolean condition is true. If the condition is <code>true</code>, this method returns normally. Else, it throws <code>TestCanceledException</code>.

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 <code>TestCanceledException</code> 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 <code>===</code> that returns <code>Boolean</code> to be the default in tests. This makes <code>===</code> consistent between tests and production code.

This method enables the following syntax for <code>String</code>:

<pre class="stHighlight"> atLeast(1, str) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>java.util.Map</code>:

<pre class="stHighlight"> atLeast(1, jmap) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>scala.collection.GenMap</code>:

<pre class="stHighlight"> atLeast(1, map) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> atLeast(1, xs) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (atLeastOneElementOf (List(1, 2))) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (atLeastOneOf(1, 2)) ^ </pre>

This method enables the following syntax for <code>String</code>:

<pre class="stHighlight"> atMost(3, str) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>java.util.Map</code>:

<pre class="stHighlight"> atMost(3, jmap) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>scala.collection.GenMap</code>:

<pre class="stHighlight"> atMost(3, map) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> atMost(3, xs) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (atMostOneElementOf (List(1, 2))) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (atMostOneOf(1, 2)) ^ </pre>

This method enables the following syntax for <code>String</code>:

<pre class="stHighlight"> between(1, 3, str) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>java.util.Map</code>:

<pre class="stHighlight"> between(1, 3, jmap) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> between(1, 3, xs) should fullymatch regex ("Hel*o world".r) ^ </pre>

Throws <code>TestCanceledException</code>, with the passed <code>Throwable</code> cause, to indicate a test failed. The <code>getMessage</code> method of the thrown <code>TestCanceledException</code> will return <code>cause.toString</code>.

Throws <code>TestCanceledException</code>, with the passed <code>String</code> <code>message</code> as the exception's detail message and <code>Throwable</code> cause, to indicate a test failed.

Throws <code>TestCanceledException</code>, with the passed <code>String</code> <code>message</code> as the exception's detail message, to indicate a test was canceled.

Throws <code>TestCanceledException</code> to indicate a test was canceled.

Returns an <code>Equality[A]</code> for any type <code>A</code> that determines equality by first calling <code>.deep</code> on any <code>Array</code> (on either the left or right side), then comparing the resulting objects with <code>==</code>.

This method enables the following syntax:

<pre class="stHighlight"> list should (not be definedAt (7) and not be definedAt (9)) ^ </pre>

This method enables syntax such as the following:

<pre class="stHighlight"> result should equal (null) ^ </pre>

This method enables syntax such as the following:

<pre class="stHighlight"> result should equal (100 +- 1) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> result should equal (7) ^ </pre>

The <code>left should equal (right)</code> syntax works by calling <code>==</code> on the <code>left</code> value, passing in the <code>right</code> value, on every type except arrays. If both <code>left</code> and right are arrays, <code>deep</code> will be invoked on both <code>left</code> and <code>right</code> before comparing them with <em>==</em>. Thus, even though this expression will yield false, because <code>Array</code>'s <code>equals</code> method compares object identity:

<pre class="stHighlight"> Array(1, 2) == Array(1, 2) // yields false </pre>

The following expression will <em>not</em> result in a <code>TestFailedException</code>, because ScalaTest will compare the two arrays structurally, taking into consideration the equality of the array's contents:

<pre class="stHighlight"> Array(1, 2) should equal (Array(1, 2)) // succeeds (i.e., does not throw TestFailedException) </pre>

If you ever do want to verify that two arrays are actually the same object (have the same identity), you can use the <code>be theSameInstanceAs</code> syntax.

This method enables the following syntax for <code>String</code>:

<pre class="stHighlight"> every(str) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>java.util.Map</code>:

<pre class="stHighlight"> every(jmap) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>scala.collection.GenMap</code>:

<pre class="stHighlight"> every(map) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> every(xs) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>String</code>:

<pre class="stHighlight"> exactly(str) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>java.util.Map</code>:

<pre class="stHighlight"> exactly(jmap) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>scala.collection.GenMap</code>:

<pre class="stHighlight"> exactly(map) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> exactly(xs) should fullymatch regex ("Hel*o world".r) ^ </pre>

Throws <code>TestFailedException</code>, with the passed <code>Throwable</code> cause, to indicate a test failed. The <code>getMessage</code> method of the thrown <code>TestFailedException</code> will return <code>cause.toString</code>.

Throws <code>TestFailedException</code>, with the passed <code>String</code> <code>message</code> as the exception's detail message and <code>Throwable</code> cause, to indicate a test failed.

Throws <code>TestFailedException</code>, with the passed <code>String</code> <code>message</code> as the exception's detail message, to indicate a test failed.

Throws <code>TestFailedException</code> to indicate a test failed.

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (inOrder(1, 2)) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (inOrderElementsOf List(1, 2)) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (inOrderOnly(1, 2)) ^ </pre>

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 <code>TestFailedException</code>.

Note that the type specified as this method's type parameter may represent any subtype of <code>AnyRef</code>, not just <code>Throwable</code> 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 <code>String</code>, for example), this method will complete abruptly with a <code>TestFailedException</code>.

Also note that the difference between this method and <code>assertThrows</code> is that this method returns the expected exception, so it lets you perform further assertions on that exception. By contrast, the <code>assertThrows</code> method returns <code>Succeeded</code>, which means it can serve as the last statement in an async- or safe-style suite. <code>assertThrows</code> 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 <code>assertThrows</code> by default, <code>intercept</code> only when you need to inspect the caught exception further.

This method enables the following syntax:

<pre class="stHighlight"> exception should not have message ("file not found") ^ </pre>

This method enables the following syntax for <code>String</code>:

<pre class="stHighlight"> no(str) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax for <code>java.util.Map</code>:

<pre class="stHighlight"> no(jmap) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> no(xs) should fullymatch regex ("Hel*o world".r) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (noElementsOf List(1, 2)) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> noException should be thrownBy ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (noneOf(1, 2)) ^ </pre>

This method enables syntax such as the following:

<pre class="stHighlight"> book should have (message ("A TALE OF TWO CITIES") (of [Book]), title ("A Tale of Two Cities")) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (oneElementOf (List(1, 2))) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (oneOf(1, 2)) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (only(1, 2)) ^ </pre>

Throws <code>TestPendingException</code> to indicate a test is pending.

A <em>pending test</em> 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 <code>pending</code>, which will cause it to complete abruptly with <code>TestPendingException</code>. Because tests in ScalaTest can be designated as pending with <code>TestPendingException</code>, 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 <code>TestPendingException</code>, 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 <code>TestPendingException</code>. Thus it always has a side effect. Methods with side effects are usually invoked with parentheses, as in <code>pending()</code>. 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 <code>FunSuite</code> or <code>FunSpec</code> to be denoted by placing "<code>(pending)</code>" after the test name, as in:

<pre class="stHighlight"> test("that style rules are not laws") (pending) </pre>

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 "<code>(pending())</code> looks more like a method call, "<code>(pending)</code>" 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.

Execute the passed block of code, and if it completes abruptly, throw <code>TestPendingException</code>, else throw <code>TestFailedException</code>.

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 <code>pendingUntilFixed</code> call. In other words, a <code>pendingUntilFixed</code> 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 <code>pendingUntilFixed</code> 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 <code>pendingUntilFixed</code>. 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 <code>pendingUntilFixed</code> will no longer throw an exception (because the problem has been fixed). This will in turn cause <code>pendingUntilFixed</code> to throw <code>TestFailedException</code> with a detail message explaining you need to go back and remove the <code>pendingUntilFixed</code> call as the problem orginally causing your test code to fail has been fixed.

This method enables the following syntax:

<pre class="stHighlight"> the [FileNotFoundException] should be thrownBy { ... } ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (theSameElementsAs(List(1, 2, 3))) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> List(1, 2, 3) should contain (theSameElementsInOrderAs(List(1, 2))) ^ </pre>

This method enables the following syntax:

<pre class="stHighlight"> a [RuntimeException] should be thrownBy {...} ^ </pre>

Executes the block of code passed as the second parameter, and, if it completes abruptly with a <code>ModifiableMessage</code> 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:

<pre class="stHighlight"> withClue("(Employee's name was: " + employee.name + ")") { intercept[IllegalArgumentException] { employee.getTask(-1) } } </pre>

If an invocation of <code>intercept</code> completed abruptly with an exception, the resulting message would be something like:

<pre> (Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown </pre>

Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new <code>RuntimeException</code> 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 <code>intercept</code>, not <code>trap</code>. Here's an example interpreter session without <code>trap</code>:

<pre class="stREPL"> scala&gt; import org.scalatest._ import org.scalatest._ scala&gt; import Matchers._ import Matchers._ scala&gt; val x = 12 a: Int = 12 scala&gt; 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 .&lt;init&gt;(&lt;console&gt;:15) at .&lt;clinit&gt;(&lt;console&gt;) at .&lt;init&gt;(&lt;console&gt;:7) at .&lt;clinit&gt;(&lt;console&gt;) at $print(&lt;console&gt;) 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) </pre>

That's a pretty tall stack trace. Here's what it looks like when you use <code>trap</code>:

<pre class="stREPL"> scala&gt; trap { x shouldEqual 13 } res1: Throwable = org.scalatest.exceptions.TestFailedException: 12 did not equal 13 </pre>

Much less clutter. Bear in mind, however, that if <em>no</em> exception is thrown by the passed block of code, the <code>trap</code> method will create a new <a href="Assertions$$NormalResult.html"><code>NormalResult</code></a> (a subclass of <code>Throwable</code> made for this purpose only) and return that. If the result was the <code>Unit</code> value, it will simply say that no exception was thrown:

<pre class="stREPL"> scala&gt; trap { x shouldEqual 12 } res2: Throwable = No exception was thrown. </pre>

If the passed block of code results in a value other than <code>Unit</code>, the <code>NormalResult</code>'s <code>toString</code> will print the value:

<pre class="stREPL"> scala&gt; trap { "Dude!" } res3: Throwable = No exception was thrown. Instead, result was: "Dude!" </pre>

Although you can access the result value from the <code>NormalResult</code>, its type is <code>Any</code> and therefore not very convenient to use. It is not intended that <code>trap</code> be used in test code. The sole intended use case for <code>trap</code> is decluttering Scala interpreter sessions by eliminating stack traces when executing assertion and matcher expressions.

This field enables the following syntax:

<pre class="stHighlight"> badBook should not be a ('goodRead) ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> result should equal ("hello") (after being lowerCased) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> badBook should not be an (excellentRead) ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string)) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> "val a: String = 1" shouldNot compile ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> list should (contain ('a') and have length (7)) ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> result should equal ("hello") (decided by defaultEquality) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> seq should be (defined) ^ </pre>

This field enables syntax such as the following, given an <a href="Equivalence.html"><code>Equivalence[String]</code></a> named <code>myStringEquivalence</code>:

<pre class="stHighlight"> result should equal ("hello") (determined by myStringEquivalence) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> list should be (empty) ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> string should (endWith ("ago") and include ("score")) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> file should exist ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> string should (fullyMatch regex ("Hel*o, wor.d") and not have length (99)) ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> list should (have length (3) and not contain ('a')) ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> string should (include ("hope") and not startWith ("no")) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> map should not contain key (10) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> "hi" should not have length (3) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> result should matchPattern { case Person("Bob", _) => } ^ </pre>

This field enables syntax like the following:

<pre class="stHighlight"> myFile should (not be an (directory) and not have ('name ("foo.bar"))) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> file should be (readable) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> "eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> set should not have size (3) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> seq should be (sorted) ^ </pre>

This field enables syntax such as the following:

<pre class="stHighlight"> string should (startWith ("Four") and include ("year")) ^ </pre>

The <code>Succeeded</code> singleton.

You can use <code>succeed</code> to solve a type error when an async test does not end in either <code>Future[Assertion]</code> or <code>Assertion</code>. Because <code>Assertion</code> is a type alias for <code>Succeeded.type</code>, putting <code>succeed</code> 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.

This field enables the following syntax:

<pre class="stHighlight"> oneString should not be theSameInstanceAs (anotherString) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> "val a: String = 1" shouldNot typeCheck ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> map should not contain value (10) ^ </pre>

This field enables the following syntax:

<pre class="stHighlight"> file should be (writable) ^ </pre>

Implicitly converts an object of a <code>Numeric</code> type to a <code>PlusOrMinusWrapper</code>, to enable a <code>+-</code> method to be invoked on that object.

This implicit conversion method converts a <code>Symbol</code> to a <code>HavePropertyMatcherGenerator</code>, to enable the symbol to be used with the <code>have ('author ("Dickens"))</code> syntax.

Implicitly converts an object of type <code>String</code> to a <code>StringShouldWrapperForVerb</code>, to enable <code>should</code> methods to be invokable on that object.