ServerStubStreamingTest

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

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

Class that supports the registration of a “subject” being specified and tested via the instance referenced from AsyncFlatSpec's behavior field.

This field enables syntax such as the following subject registration:

behavior of "A Stack"
^

For more information and examples of the use of the behavior field, see the main documentation for trait AsyncFlatSpec.

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

assert(a === b)
assert(c !== d)

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

assert(a === (2.0 +- 0.1))
assert(c !== (2.0 +- 0.1))

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for Explicitly for an overview of the explicitly DSL.

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

result should equal ("hello") (decided by myStringEquality afterBeing lowerCased)

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for Explicitly for an overview of the explicitly DSL.

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for Explicitly for an overview of the explicitly DSL.

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

result should equal ("hello") (determined by myStringEquivalence afterBeing lowerCased)

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for Explicitly for an overview of the explicitly DSL.

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

assert(a === b)
assert(c !== d)

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

assert(a === (2.0 +- 0.1))
assert(c !== (2.0 +- 0.1))

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

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

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

Class that supports registration of ignored tests via the IgnoreWord instance referenced from AsyncFlatSpec's ignore field.

This class enables syntax such as the following registration of an ignored test:

ignore should "pop values in last-in-first-out order" in { ... }
                                                     ^

In addition, it enables syntax such as the following registration of an ignored, pending test:

ignore should "pop values in last-in-first-out order" is (pending)
                                                     ^

Note: the is method is provided for completeness and design symmetry, given there's no way to prevent changing is to ignore and marking a pending test as ignored that way. Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.

And finally, it also enables syntax such as the following ignored, tagged test registration:

ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
                                                     ^

For more information and examples of the use of the ignore field, see the Ignored tests section in the main documentation for trait AsyncFlatSpec.

Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced from AsyncFlatSpec's ignore field.

This class enables syntax such as the following registration of an ignored, tagged test:

ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
                                                                        ^

In addition, it enables syntax such as the following registration of an ignored, tagged, pending test:

ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
                                                                        ^

Note: the is method is provided for completeness and design symmetry, given there's no way to prevent changing is to ignore and marking a pending test as ignored that way. Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.

For more information and examples of the use of the ignore field, see the Ignored tests section in the main documentation for trait AsyncFlatSpec. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AsyncFlatSpec.

Class that supports registration of ignored tests via the ItWord instance referenced from AsyncFlatSpec's ignore field.

This class enables syntax such as the following registration of an ignored test:

ignore should "pop values in last-in-first-out order" in { ... }
^

For more information and examples of the use of the ignore field, see Ignored tests section in the main documentation for this trait.

Class that supports test registration in shorthand form.

For example, this class enables syntax such as the following test registration in shorthand form:

"A Stack (when empty)" should "be empty" in { ... }
                                        ^

This class also enables syntax such as the following ignored test registration in shorthand form:

"A Stack (when empty)" should "be empty" ignore { ... }
                                        ^

This class is used via an implicit conversion (named convertToInAndIgnoreMethods) from ResultOfStringPassedToVerb. The ResultOfStringPassedToVerb class does not declare any methods named in, because the type passed to in differs in a AsyncFlatSpec and a FixtureAsyncFlatSpec. A FixtureAsyncFlatSpec needs two in methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a Fixture as its parameter). By constrast, a AsyncFlatSpec needs only one in method that takes a by-name parameter. As a result, AsyncFlatSpec and FixtureAsyncFlatSpec each provide an implicit conversion from ResultOfStringPassedToVerb to a type that provides the appropriate in methods.

Class that supports tagged test registration in shorthand form.

For example, this class enables syntax such as the following tagged test registration in shorthand form:

"A Stack (when empty)" should "be empty" taggedAs() in { ... }
                                                   ^

This class also enables syntax such as the following tagged, ignored test registration in shorthand form:

"A Stack (when empty)" should "be empty" taggedAs(SlowTest) ignore { ... }
                                                           ^

This class is used via an implicit conversion (named convertToInAndIgnoreMethodsAfterTaggedAs) from ResultOfTaggedAsInvocation. The ResultOfTaggedAsInvocation class does not declare any methods named in, because the type passed to in differs in a AsyncFlatSpec and a FixtureAsyncFlatSpec. A FixtureAsyncFlatSpec needs two in methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a Fixture as its parameter). By constrast, a AsyncFlatSpec needs only one in method that takes a by-name parameter. As a result, AsyncFlatSpec and FixtureAsyncFlatSpec each provide an implicit conversion from ResultOfTaggedAsInvocation to a type that provides the appropriate in methods.

Class that supports test registration via the ItWord instance referenced from AsyncFlatSpec's it field.

This class enables syntax such as the following test registration:

it should "pop values in last-in-first-out order" in { ... }
                                                 ^

It also enables syntax such as the following registration of an ignored test:

it should "pop values in last-in-first-out order" ignore { ... }
                                                 ^

In addition, it enables syntax such as the following registration of a pending test:

it should "pop values in last-in-first-out order" is (pending)
                                                 ^

And finally, it also enables syntax such as the following tagged test registration:

it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
                                                 ^

For more information and examples of the use of the it field, see the main documentation for trait AsyncFlatSpec.

Class that supports the registration of tagged tests via the ItWord instance referenced from AsyncFlatSpec's it field.

This class enables syntax such as the following tagged test registration:

it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
                                                                    ^

It also enables syntax such as the following registration of an ignored, tagged test:

it should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
                                                                    ^

In addition, it enables syntax such as the following registration of a pending, tagged test:

it should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
                                                                    ^

For more information and examples of the use of the it field to register tagged tests, see the Tagging tests section in the main documentation for trait AsyncFlatSpec. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AsyncFlatSpec.

Class that supports test (and shared test) registration via the instance referenced from AsyncFlatSpec's it field.

This class enables syntax such as the following test registration:

it should "pop values in last-in-first-out order" in { ... }
^

It also enables syntax such as the following shared test registration:

it should behave like nonEmptyStack(lastItemPushed)
^

For more information and examples of the use of the it field, see the main documentation for this trait.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

A test function taking no arguments and returning a FutureOutcome.

For more detail and examples, see the relevant section in the documentation for trait AsyncFlatSpec.

Wrapper class with a +- method that, given a Numeric argument, returns a Spread.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

Class that provides the lastly method of the complete-lastly syntax.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for InspectorsMatchers for an overview of the matchers DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.

This class is used in conjunction with an implicit conversion to enable can methods to be invoked on Strings.

This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.

This class is used in conjunction with an implicit conversion to enable must methods to be invoked on Strings.

This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.

This class is used in conjunction with an implicit conversion to enable should methods to be invoked on Strings.

This class is part of the Scalactic “explicitly DSL”. Please see the documentation for Explicitly for an overview of the explicitly DSL.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

Class that supports test registration via the TheyWord instance referenced from AsyncFlatSpec's they field.

This class enables syntax such as the following test registration:

they should "pop values in last-in-first-out order" in { ... }
                                                   ^

It also enables syntax such as the following registration of an ignored test:

they should "pop values in last-in-first-out order" ignore { ... }
                                                   ^

In addition, it enables syntax such as the following registration of a pending test:

they should "pop values in last-in-first-out order" is (pending)
                                                   ^

And finally, it also enables syntax such as the following tagged test registration:

they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
                                                   ^

For more information and examples of the use of the it field, see the main documentation for trait AsyncFlatSpec.

Class that supports the registration of tagged tests via the TheyWord instance referenced from AsyncFlatSpec's they field.

This class enables syntax such as the following tagged test registration:

they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
                                                                      ^

It also enables syntax such as the following registration of an ignored, tagged test:

they should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
                                                                      ^

In addition, it enables syntax such as the following registration of a pending, tagged test:

they should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
                                                                      ^

For more information and examples of the use of the they field to register tagged tests, see the Tagging tests section in the main documentation for trait AsyncFlatSpec. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AsyncFlatSpec.

Class that supports test (and shared test) registration via the instance referenced from AsyncFlatSpec's it field.

This class enables syntax such as the following test registration:

they should "pop values in last-in-first-out order" in { ... }
^

It also enables syntax such as the following shared test registration:

they should behave like nonEmptyStack(lastItemPushed)
^

For more information and examples of the use of the it field, see the main documentation for this trait.

This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of the matchers DSL.

Must be an instance of streams.BinaryStream

Defines a method to be run after all of this suite's tests and nested suites have been run.

This trait's implementation of run invokes this afterAll() method. This trait's implementation of this method does nothing.

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

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should !== null” syntax of Matchers.

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should !== <right>” syntax of Matchers.

This method enables the following syntax:

num should (not be < (10) and not be > (17))
                  ^

This method enables the following syntax:

num should (not be <= (10) and not be > (17))
                  ^

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

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should === null” syntax of Matchers.

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should === <right>” syntax of Matchers.

This method enables the following syntax:

num should (not be > (10) and not be < (7))
                  ^

This method enables the following syntax:

num should (not be >= (10) and not be < (7))
                  ^

This method enables the following syntax:

a [RuntimeException] should be thrownBy { ... }
^

Returns an Alerter that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this AsyncFlatSpec is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.

This method enables the following syntax for String:

all(str) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for java.util.Map:

all(jmap) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for scala.collection.GenMap:

all(map) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

all(xs) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

List(1, 2, 3) should contain (allElementsOf(1, 2))
                             ^

This method enables the following syntax:

List(1, 2, 3) should contain (allOf(1, 2))
                             ^

This method enables the following syntax:

an [Exception] should be thrownBy { ... }
^

Assert that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with a helpful error message appended with the String obtained by invoking toString on the specified clue as the exception's detail message.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

• assert(a == b, "a good clue")

• assert(a != b, "a good clue")

• assert(a === b, "a good clue")

• assert(a !== b, "a good clue")

• assert(a > b, "a good clue")

• assert(a >= b, "a good clue")

• assert(a < b, "a good clue")

• assert(a <= b, "a good clue")

• assert(a startsWith "prefix", "a good clue")

• assert(a endsWith "postfix", "a good clue")

• assert(a contains "something", "a good clue")

• assert(a eq b, "a good clue")

• assert(a ne b, "a good clue")

• assert(a > 0 && b > 5, "a good clue")

• assert(a > 0 || b > 5, "a good clue")

• assert(a.isEmpty, "a good clue")

• assert(!a.isEmpty, "a good clue")

• assert(a.isInstanceOf[String], "a good clue")

• assert(a.length == 8, "a good clue")

• assert(a.size == 8, "a good clue")

• assert(a.exists(_ == 8), "a good clue")

At this time, any other form of expression will just get a TestFailedException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

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

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

• assert(a == b)

• assert(a != b)

• assert(a === b)

• assert(a !== b)

• assert(a > b)

• assert(a >= b)

• assert(a < b)

• assert(a <= b)

• assert(a startsWith "prefix")

• assert(a endsWith "postfix")

• assert(a contains "something")

• assert(a eq b)

• assert(a ne b)

• assert(a > 0 && b > 5)

• assert(a > 0 || b > 5)

• assert(a.isEmpty)

• assert(!a.isEmpty)

• assert(a.isInstanceOf[String])

• assert(a.length == 8)

• assert(a.size == 8)

• assert(a.exists(_ == 8))

At this time, any other form of expression will get a TestFailedException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Asserts that a given string snippet of code passes both the Scala parser and type checker.

You can use this to make sure a snippet of code compiles:

assertCompiles("val a: Int = 1")

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

Asserts that a given string snippet of code does not pass either the Scala parser or type checker.

Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's Assertions trait includes the following syntax for that purpose:

assertDoesNotCompile("val a: String = \"a string")

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

Note that the difference between assertTypeError and assertDoesNotCompile is that assertDoesNotCompile will succeed if the given code does not compile for any reason, whereas assertTypeError will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile will return normally but assertTypeError will throw a TestFailedException.

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

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

Ensure that an expected exception is thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns Succeeded. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Note that the type specified as this method's type parameter may represent any subtype of AnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.

Also note that the difference between this method and intercept is that this method does not return the expected exception, so it does not let you perform further assertions on that exception. Instead, this method returns Succeeded, which means it can serve as the last statement in an async- or safe-style suite. It also indicates to the reader of the code that nothing further is expected about the thrown exception other than its type. The recommended usage is to use assertThrows by default, intercept only when you need to inspect the caught exception further.

Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.

Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's Assertions trait includes the following syntax for that purpose:

assertTypeError("val a: String = 1")

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

Note that the difference between assertTypeError and assertDoesNotCompile is that assertDoesNotCompile will succeed if the given code does not compile for any reason, whereas assertTypeError will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile will return normally but assertTypeError will throw a TestFailedException.

Assume that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException with a helpful error message appended with String obtained by invoking toString on the specified clue as the exception's detail message.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

• assume(a == b, "a good clue")

• assume(a != b, "a good clue")

• assume(a === b, "a good clue")

• assume(a !== b, "a good clue")

• assume(a > b, "a good clue")

• assume(a >= b, "a good clue")

• assume(a < b, "a good clue")

• assume(a <= b, "a good clue")

• assume(a startsWith "prefix", "a good clue")

• assume(a endsWith "postfix", "a good clue")

• assume(a contains "something", "a good clue")

• assume(a eq b, "a good clue")

• assume(a ne b, "a good clue")

• assume(a > 0 && b > 5, "a good clue")

• assume(a > 0 || b > 5, "a good clue")

• assume(a.isEmpty, "a good clue")

• assume(!a.isEmpty, "a good clue")

• assume(a.isInstanceOf[String], "a good clue")

• assume(a.length == 8, "a good clue")

• assume(a.size == 8, "a good clue")

• assume(a.exists(_ == 8), "a good clue")

At this time, any other form of expression will just get a TestCanceledException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

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

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

• assume(a == b)

• assume(a != b)

• assume(a === b)

• assume(a !== b)

• assume(a > b)

• assume(a >= b)

• assume(a < b)

• assume(a <= b)

• assume(a startsWith "prefix")

• assume(a endsWith "postfix")

• assume(a contains "something")

• assume(a eq b)

• assume(a ne b)

• assume(a > 0 && b > 5)

• assume(a > 0 || b > 5)

• assume(a.isEmpty)

• assume(!a.isEmpty)

• assume(a.isInstanceOf[String])

• assume(a.length == 8)

• assume(a.size == 8)

• assume(a.exists(_ == 8))

At this time, any other form of expression will just get a TestCanceledException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

This method enables the following syntax for String:

atLeast(1, str) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for java.util.Map:

atLeast(1, jmap) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for scala.collection.GenMap:

atLeast(1, map) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

atLeast(1, xs) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

List(1, 2, 3) should contain (atLeastOneElementOf (List(1, 2)))
                             ^

This method enables the following syntax:

List(1, 2, 3) should contain (atLeastOneOf(1, 2))
                             ^

This method enables the following syntax for String:

atMost(3, str) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for java.util.Map:

atMost(3, jmap) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for scala.collection.GenMap:

atMost(3, map) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

atMost(3, xs) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

List(1, 2, 3) should contain (atMostOneElementOf (List(1, 2)))
                             ^

This method enables the following syntax:

List(1, 2, 3) should contain (atMostOneOf(1, 2))
                             ^

Defines a method to be run before any of this suite's tests or nested suites are run.

This trait's implementation of run invokes this beforeAll() method. This trait's implementation of this method does nothing.

This method enables the following syntax for String:

between(1, 3, str) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for java.util.Map:

between(1, 3, jmap) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

between(1, 3, xs) should fullymatch regex ("Hel*o world".r)
^

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

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

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

Throws TestCanceledException to indicate a test was canceled.

Registers a block of code that produces any "futuristic" type (any type F for which an implicit Futuristic[F] instance is implicitly available), returning an object that offers a lastly method.

See the main documentation for trait CompleteLastly for more detail.

Provides a A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an explicit Equivalence[B].

This method is used to enable the Explicitly DSL for TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that provides evidence that A is a subtype of B.

The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint (extended by TypeCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an explicit Equivalence[A].

This method is used to enable the Explicitly DSL for TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that provides evidence that A is a subtype of B. For example, under TypeCheckedTripleEquals, this method (as an implicit method), would be used to compile this statement:

def closeEnoughTo1(num: Double): Boolean =
 (num === 1.0)(decided by forgivingEquality)

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits TypeCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Converts to an CheckingEqualizer that provides === and !== operators that result in Boolean and enforce a type constraint.

This method is overridden and made implicit by subtrait TypeCheckedTripleEquals, and overriden as non-implicit by the other subtraits in this package.

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

This method enables the following syntax:

list should (not be definedAt (7) and not be definedAt (9))
                   ^

This method enables syntax such as the following:

result should equal (null)
             ^

This method enables syntax such as the following:

result should equal (100 +- 1)
             ^

This method enables the following syntax:

result should equal (7)
             ^

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

Array(1, 2) == Array(1, 2) // yields false

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

Array(1, 2) should equal (Array(1, 2)) // succeeds (i.e., does not throw TestFailedException)

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

This method enables the following syntax for String:

every(str) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for java.util.Map:

every(jmap) should fullymatch regex ("Hel*o world".r)

^

This method enables the following syntax for scala.collection.GenMap:

every(map) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

every(xs) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for String:

exactly(str) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for java.util.Map:

exactly(jmap) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for scala.collection.GenMap:

exactly(map) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

exactly(xs) should fullymatch regex ("Hel*o world".r)
^

Executes one or more tests in this Suite, printing results to the standard output.

This method invokes run on itself, passing in values that can be configured via the parameters to this method, all of which have default values. This behavior is convenient when working with ScalaTest in the Scala interpreter. Here's a summary of this method's parameters and how you can use them:

The testName parameter

If you leave testName at its default value (of null), this method will pass None to the testName parameter of run, and as a result all the tests in this suite will be executed. If you specify a testName, this method will pass Some(testName) to run, and only that test will be run. Thus to run all tests in a suite from the Scala interpreter, you can write:

scala> (new ExampleSuite).execute()

(The above syntax actually invokes the overloaded parameterless form of execute, which calls this form with its default parameter values.) To run just the test named "my favorite test" in a suite from the Scala interpreter, you would write:

scala> (new ExampleSuite).execute("my favorite test")

Or:

scala> (new ExampleSuite).execute(testName = "my favorite test")

The configMap parameter

If you provide a value for the configMap parameter, this method will pass it to run. If not, the default value of an empty Map will be passed. For more information on how to use a config map to configure your test suites, see the config map section in the main documentation for this trait. Here's an example in which you configure a run with the name of an input file:

scala> (new ExampleSuite).execute(configMap = Map("inputFileName" -> "in.txt")

The color parameter

If you leave the color parameter unspecified, this method will configure the reporter it passes to run to print to the standard output in color (via ansi escape characters). If you don't want color output, specify false for color, like this:

scala> (new ExampleSuite).execute(color = false)

The durations parameter

If you leave the durations parameter unspecified, this method will configure the reporter it passes to run to not print durations for tests and suites to the standard output. If you want durations printed, specify true for durations, like this:

scala> (new ExampleSuite).execute(durations = true)

The shortstacks and fullstacks parameters

If you leave both the shortstacks and fullstacks parameters unspecified, this method will configure the reporter it passes to run to not print stack traces for failed tests if it has a stack depth that identifies the offending line of test code. If you prefer a short stack trace (10 to 15 stack frames) to be printed with any test failure, specify true for shortstacks:

scala> (new ExampleSuite).execute(shortstacks = true)

For full stack traces, set fullstacks to true:

scala> (new ExampleSuite).execute(fullstacks = true)

If you specify true for both shortstacks and fullstacks, you'll get full stack traces.

The stats parameter

If you leave the stats parameter unspecified, this method will not fire RunStarting and either RunCompleted or RunAborted events to the reporter it passes to run. If you specify true for stats, this method will fire the run events to the reporter, and the reporter will print the expected test count before the run, and various statistics after, including the number of suites completed and number of tests that succeeded, failed, were ignored or marked pending. Here's how you get the stats:

scala> (new ExampleSuite).execute(stats = true)

To summarize, this method will pass to run:

• testName - None if this method's testName parameter is left at its default value of null, else Some(testName).

• reporter - a reporter that prints to the standard output

• stopper - a Stopper whose apply method always returns false

• filter - a Filter constructed with None for tagsToInclude and Set() for tagsToExclude

• configMap - the configMap passed to this method

• distributor - None

• tracker - a new Tracker

Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and can be used interchangably. The reason this method isn't named run is that it takes advantage of default arguments, and you can't mix overloaded methods and default arguments in Scala. (If named run, this method would have the same name but different arguments than the main run method that takes seven arguments. Thus it would overload and couldn't be used with default argument values.)

Design note: This method has two "features" that may seem unidiomatic. First, the default value of testName is null. Normally in Scala the type of testName would be Option[String] and the default value would be None, as it is in this trait's run method. The null value is used here for two reasons. First, in ScalaTest 1.5, execute was changed from four overloaded methods to one method with default values, taking advantage of the default and named parameters feature introduced in Scala 2.8. To not break existing source code, testName needed to have type String, as it did in two of the overloaded execute methods prior to 1.5. The other reason is that execute has always been designed to be called primarily from an interpeter environment, such as the Scala REPL (Read-Evaluate-Print-Loop). In an interpreter environment, minimizing keystrokes is king. A String type with a null default value lets users type suite.execute("my test name") rather than suite.execute(Some("my test name")), saving several keystrokes.

The second non-idiomatic feature is that shortstacks and fullstacks are all lower case rather than camel case. This is done to be consistent with the Shell, which also uses those forms. The reason lower case is used in the Shell is to save keystrokes in an interpreter environment. Most Unix commands, for example, are all lower case, making them easier and quicker to type. In the ScalaTest Shell, methods like shortstacks, fullstacks, and nostats, etc., are designed to be all lower case so they feel more like shell commands than methods.

The total number of tests that are expected to run when this Suite's run method is invoked.

This trait's implementation of this method returns the sum of:

• the size of the testNames List, minus the number of tests marked as ignored and any tests that are exluded by the passed Filter

• the sum of the values obtained by invoking expectedTestCount on every nested Suite contained in nestedSuites

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

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

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

Throws TestFailedException to indicate a test failed.

This method enables the following syntax:

List(1, 2, 3) should contain (inOrder(1, 2))
                             ^

This method enables the following syntax:

List(1, 2, 3) should contain (inOrderElementsOf List(1, 2))
                             ^

This method enables the following syntax:

List(1, 2, 3) should contain (inOrderOnly(1, 2))
                             ^

Returns an Informer that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, as recordedEvents of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.

Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Note that the type specified as this method's type parameter may represent any subtype of AnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.

Also note that the difference between this method and assertThrows is that this method returns the expected exception, so it lets you perform further assertions on that exception. By contrast, the assertThrows method returns Succeeded, which means it can serve as the last statement in an async- or safe-style suite. assertThrows also indicates to the reader of the code that nothing further is expected about the thrown exception other than its type. The recommended usage is to use assertThrows by default, intercept only when you need to inspect the caught exception further.

Provides an A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an implicit Equivalence[B].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint (extended by TypeCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Returns a Documenter that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, as recordedEvents of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.

This method enables the following syntax:

exception should not have message ("file not found")
                         ^

An immutable IndexedSeq of this Suite object's nested Suites. If this Suite contains no nested Suites, this method returns an empty IndexedSeq. This trait's implementation of this method returns an empty List.

This method enables the following syntax for String:

no(str) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax for java.util.Map:

no(jmap) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

no(xs) should fullymatch regex ("Hel*o world".r)
^

This method enables the following syntax:

List(1, 2, 3) should contain (noElementsOf List(1, 2))
                             ^

This field enables the following syntax:

noException should be thrownBy
^

This method enables the following syntax:

List(1, 2, 3) should contain (noneOf(1, 2))
                             ^

Returns a Notifier that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this AsyncFlatSpec is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.

This method enables syntax such as the following:

book should have (message ("A TALE OF TWO CITIES") (of [Book]), title ("A Tale of Two Cities"))
                                                   ^

This method enables the following syntax:

List(1, 2, 3) should contain (oneElementOf (List(1, 2)))
                             ^

This method enables the following syntax:

List(1, 2, 3) should contain (oneOf(1, 2))
                             ^

This method enables the following syntax:

List(1, 2, 3) should contain (only(1, 2))
                             ^

Throws TestPendingException to indicate a test is pending.

A pending test is one that has been given a name but is not yet implemented. The purpose of pending tests is to facilitate a style of testing in which documentation of behavior is sketched out before tests are written to verify that behavior (and often, the before the behavior of the system being tested is itself implemented). Such sketches form a kind of specification of what tests and functionality to implement later.

To support this style of testing, a test can be given a name that specifies one bit of behavior required by the system being tested. The test can also include some code that sends more information about the behavior to the reporter when the tests run. At the end of the test, it can call method pending, which will cause it to complete abruptly with TestPendingException. Because tests in ScalaTest can be designated as pending with TestPendingException, both the test name and any information sent to the reporter when running the test can appear in the report of a test run. (In other words, the code of a pending test is executed just like any other test.) However, because the test completes abruptly with TestPendingException, the test will be reported as pending, to indicate the actual test, and possibly the functionality it is intended to test, has not yet been implemented.

Note: This method always completes abruptly with a TestPendingException. Thus it always has a side effect. Methods with side effects are usually invoked with parentheses, as in pending(). This method is defined as a parameterless method, in flagrant contradiction to recommended Scala style, because it forms a kind of DSL for pending tests. It enables tests in suites such as FunSuite or FunSpec to be denoted by placing "(pending)" after the test name, as in:

test("that style rules are not laws") (pending)

Readers of the code see "pending" in parentheses, which looks like a little note attached to the test name to indicate it is pending. Whereas "(pending()) looks more like a method call, "(pending)" lets readers stay at a higher level, forgetting how it is implemented and just focusing on the intent of the programmer who wrote the code.