Apache Pekko/org.apache.pekko.persistence/PluginSpec

PluginSpec

org.apache.pekko.persistence.PluginSpec

abstract class PluginSpec(val config: Config) extends TestKitBase, AnyWordSpecLike, Matchers, BeforeAndAfterAll, BeforeAndAfterEach

Attributes

Source: PluginSpec.scala
Graph
Supertypes: trait BeforeAndAfterEach

trait BeforeAndAfterAll

trait SuiteMixin

trait Matchers

trait Explicitly

trait MatcherWords

trait Tolerance

trait AnyWordSpecLike

trait Documenting

trait Alerting

trait Notifying

trait Informing

trait CanVerb

trait MustVerb

trait ShouldVerb

trait TestRegistration

trait TestSuite

trait Suite

trait Serializable

trait Assertions

trait TripleEquals

trait TripleEqualsSupport

trait TestKitBase

class Object

trait Matchable

class Any
Show all
Known subtypes: class JournalSpec

class JavaJournalSpec

class JournalPerfSpec

class JavaJournalPerfSpec

class SnapshotStoreSpec

class JavaSnapshotStoreSpec
Show all

Members list

Type members

Inherited classlikes

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

Class whose instances are after words, which can be used to reduce text duplication.

If you are repeating a word or phrase at the beginning of each string inside a block, you can "move the word or phrase" out of the block with an after word. You create an after word by passing the repeated word or phrase to the afterWord method. Once created, you can place the after word after when, a verb (should, must, or can), or which. (You can't place one after in or is, the words that introduce a test.) Here's an example that has after words used in all three places:

import org.scalatest._

class ScalaTestGUISpec extends wordspec.AnyWordSpec {

 def theUser = afterWord("the user")
 def display = afterWord("display")
 def is = afterWord("is")

 "The ScalaTest GUI" when theUser {
   "clicks on an event report in the list box" should display {
     "a blue background in the clicked-on row in the list box" in {}
     "the details for the event in the details area" in {}
     "a rerun button" which is {
       "enabled if the clicked-on event is rerunnable" in {}
       "disabled if the clicked-on event is not rerunnable" in {}
     }
   }
 }
}

Running the previous AnyWordSpec in the Scala interpreter would yield:

scala> (new ScalaTestGUISpec).execute()
The ScalaTest GUI (when the user clicks on an event report in the list box)
- should display a blue background in the clicked-on row in the list box
- should display the details for the event in the details area
- should display a rerun button that is enabled if the clicked-on event is rerunnable
- should display a rerun button that is disabled if the clicked-on event is not rerunnable

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

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

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

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

Value parameters

leftSide: An object to convert to Equalizer, which represents the value on the left side of a === or !== invocation.

Attributes

Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala
Supertypes: class Object

trait Matchable

class Any

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

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

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

Attributes

Inherited from:: Explicitly
Source: Explicitly.scala
Supertypes: trait Equality[A]

trait Equivalence[A]

class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Explicitly
Source: Explicitly.scala
Supertypes: class Object

trait Matchable

class Any

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

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

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

Attributes

Inherited from:: Explicitly
Source: Explicitly.scala
Supertypes: trait Equivalence[T]

class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Explicitly
Source: Explicitly.scala
Supertypes: class Object

trait Matchable

class Any

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

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

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

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

Value parameters

leftSide: An object to convert to Equalizer, which represents the value on the left side of a === or !== invocation.

Attributes

Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala
Supertypes: class Object

trait Matchable

class Any

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

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

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

Field	Method	"get" Method	Result
			Throws `TestFailedException`, because no candidates found
		`getTitle()`	Invokes `getTitle()`
	`title()`		Invokes `title()`
	`title()`	`getTitle()`	Invokes `title()` (this can occur when `BeanProperty` annotation is used)
`title`			Accesses field `title`
`title`		`getTitle()`	Invokes `getTitle()`
`title`	`title()`		Invokes `title()`
`title`	`title()`	`getTitle()`	Invokes `title()` (this can occur when `BeanProperty` annotation is used)

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

Class that supports shorthand scope registration via the instance referenced from AnyWordSpecLike's it field.

This class enables syntax such as the following test registration:

"A Stack" when { ... }

it should { ... }
^

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

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

A test function taking no arguments and returning an Outcome.

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

Attributes

Inherited from:: TestSuite
Source: TestSuite.scala
Supertypes: trait TestData

trait () => Outcome

class Object

trait Matchable

class Any

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

Value parameters

tolerance: the tolerance with which to create (and return) a Spread

Attributes

Inherited from:: Tolerance
Source: Tolerance.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ResultOfBeWordForCollectedArray[T]

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class ResultOfBeWordForCollectedAny[Array[T]]

class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

Class that supports the registration of tagged tests.

Instances of this class are returned by the taggedAs method of class AnyWordSpecStringWrapper.

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala
Supertypes: class Object

trait Matchable

class Any

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.

Attributes

Inherited from:: CanVerb
Source: CanVerb.scala
Supertypes: class Object

trait Matchable

class Any

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.

Attributes

Inherited from:: MustVerb
Source: MustVerb.scala
Supertypes: class Object

trait Matchable

class Any

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.

Attributes

Inherited from:: ShouldVerb
Source: ShouldVerb.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Explicitly
Source: Explicitly.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

Class that supports shorthand scope registration via the instance referenced from AnyWordSpecLike's they field.

This class enables syntax such as the following test registration:

"Basketball players" when { ... }

they should { ... }
^

For more information and examples of the use of the they field, see the main documentation for AnyWordSpec.

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Inherited from:: Assertions
Source: Assertions.scala
Supertypes: class Object

trait Matchable

class Any

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala
Supertypes: class Object

trait Matchable

class Any

A class that via an implicit conversion (named convertToWordSpecStringWrapper) enables methods when, which, in, is, taggedAs and ignore to be invoked on Strings.

This class provides much of the syntax for AnyWordSpec, however, it does not add the verb methods (should, must, and can) to String. Instead, these are added via the ShouldVerb, MustVerb, and CanVerb traits, which AnyWordSpec mixes in, to avoid a conflict with implicit conversions provided in Matchers and MustMatchers.

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala
Supertypes: class Object

trait Matchable

class Any

Value members

Concrete methods

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.

Attributes

Definition Classes: BeforeAndAfterAll
Source: PluginSpec.scala

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.

Attributes

Definition Classes: BeforeAndAfterAll
Source: PluginSpec.scala

Defines a method to be run before each of this suite's tests.

This trait's implementation of runTest invokes this method before invoking super.runTest. Thus this method can be used to set up a test fixture needed by each test, before each test begins execution.

This trait's implementation of this method does nothing.

Attributes

Definition Classes: BeforeAndAfterEach
Source: PluginSpec.scala

Attributes

Source: PluginSpec.scala

Attributes

Source: PluginSpec.scala

Attributes

Source: PluginSpec.scala

Inherited methods

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

Value parameters

right: the Spread[T] against which to compare the left-hand value

Attributes

Returns: a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with expectingEqual set to false.
Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala

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

Value parameters

right: a null reference

Attributes

Returns: a TripleEqualsInvocation wrapping the passed null value, with expectingEqual set to false.
Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala

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

Value parameters

right: the right-hand side value for an equality assertion

Attributes

Returns: a TripleEqualsInvocation wrapping the passed right value, with expectingEqual set to false.
Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

Value parameters

right: the Spread[T] against which to compare the left-hand value

Attributes

Returns: a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with expectingEqual set to true.
Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala

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

Value parameters

right: a null reference

Attributes

Returns: a TripleEqualsInvocation wrapping the passed null value, with expectingEqual set to true.
Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala

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

Value parameters

right: the right-hand side value for an equality assertion

Attributes

Returns: a TripleEqualsInvocation wrapping the passed right value, with expectingEqual set to true.
Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

Defines a method to be run after each of this suite's tests.

This trait's implementation of runTest invokes this method after invoking super.runTest. Thus this method can be used to tear down a test fixture needed by each test, after each test completes execution.

This trait's implementation of this method does nothing.

Attributes

Inherited from:: BeforeAndAfterEach
Source: BeforeAndAfterEach.scala

Creates an after word that an be used to reduce text duplication.

import org.scalatest._

class ScalaTestGUISpec extends wordspec.AnyWordSpec {

 def theUser = afterWord("the user")
 def display = afterWord("display")
 def is = afterWord("is")

 "The ScalaTest GUI" when theUser {
   "clicks on an event report in the list box" should display {
     "a blue background in the clicked-on row in the list box" in {}
     "the details for the event in the details area" in {}
     "a rerun button" which is {
       "enabled if the clicked-on event is rerunnable" in {}
       "disabled if the clicked-on event is not rerunnable" in {}
     }
   }
 }
}

Running the previous AnyWordSpec in the Scala interpreter would yield:

scala> (new ScalaTestGUISpec).execute()
The ScalaTest GUI (when the user clicks on an event report in the list box)
- should display a blue background in the clicked-on row in the list box
- should display the details for the event in the details area
- should display a rerun button that is enabled if the clicked-on event is rerunnable
- should display a rerun button that is disabled if the clicked-on event is not rerunnable

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

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 AnyWordSpec is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

This method enables the following syntax for String:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

assert(a == b, "a good clue")
assert(a != b, "a good clue")
assert(a === b, "a good clue")
assert(a !== b, "a good clue")
assert(a > b, "a good clue")
assert(a >= b, "a good clue")
assert(a < b, "a good clue")
assert(a <= b, "a good clue")
assert(a startsWith "prefix", "a good clue")
assert(a endsWith "postfix", "a good clue")
assert(a contains "something", "a good clue")
assert(a eq b, "a good clue")
assert(a ne b, "a good clue")
assert(a > 0 && b > 5, "a good clue")
assert(a > 0 || b > 5, "a good clue")
assert(a.isEmpty, "a good clue")
assert(!a.isEmpty, "a good clue")
assert(a.isInstanceOf[String], "a good clue")
assert(a.length == 8, "a good clue")
assert(a.size == 8, "a good clue")
assert(a.exists(_ == 8), "a good clue")

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

Value parameters

clue: An objects whose toString method returns a message to include in a failure report.
condition: the boolean condition to assert

Attributes

Throws: NullArgumentException
if message is null.

TestFailedException
if the condition is false.
Inherited from:: Assertions
Source: Assertions.scala

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

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

assert(a == b)
assert(a != b)
assert(a === b)
assert(a !== b)
assert(a > b)
assert(a >= b)
assert(a < b)
assert(a <= b)
assert(a startsWith "prefix")
assert(a endsWith "postfix")
assert(a contains "something")
assert(a eq b)
assert(a ne b)
assert(a > 0 && b > 5)
assert(a > 0 || b > 5)
assert(a.isEmpty)
assert(!a.isEmpty)
assert(a.isInstanceOf[String])
assert(a.length == 8)
assert(a.size == 8)
assert(a.exists(_ == 8))

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

Value parameters

condition: the boolean condition to assert

Attributes

Throws: TestFailedException
if the condition is false.
Inherited from:: Assertions
Source: Assertions.scala

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

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

assertCompiles("val a: Int = 1")

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

Value parameters

code: the snippet of code that should compile

Attributes

Inherited from:: Assertions
Source: Assertions.scala

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

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

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

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

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

Value parameters

code: the snippet of code that should not type check

Attributes

Inherited from:: Assertions
Source: Assertions.scala

Evaluate the given assert every interval until exception is thrown or max timeout is expired.

Returns the result of last evaluation of the assertion.

If no timeout is given, take it from the innermost enclosing within block.

Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "pekko.test.timefactor".

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

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

Value parameters

actual: the actual value, which should equal the passed expected value
expected: the expected value

Attributes

Throws: TestFailedException
if the passed actual value does not equal the passed expected value.
Inherited from:: Assertions
Source: Assertions.scala

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

Value parameters

actual: the actual value, which should equal the passed expected value
clue: An object whose toString method returns a message to include in a failure report.
expected: the expected value

Attributes

Throws: TestFailedException
if the passed actual value does not equal the passed expected value.
Inherited from:: Assertions
Source: Assertions.scala

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

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

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

Value parameters

classTag: an implicit ClassTag representing the type of the specified type parameter.
f: the function value that should throw the expected exception

Attributes

Returns: the Succeeded singleton, if an exception of the expected type is thrown
Throws: TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type.
Inherited from:: Assertions
Source: Assertions.scala

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

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.

Value parameters

code: the snippet of code that should not type check

Attributes

Inherited from:: Assertions
Source: Assertions.scala

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

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

assume(a == b, "a good clue")
assume(a != b, "a good clue")
assume(a === b, "a good clue")
assume(a !== b, "a good clue")
assume(a > b, "a good clue")
assume(a >= b, "a good clue")
assume(a < b, "a good clue")
assume(a <= b, "a good clue")
assume(a startsWith "prefix", "a good clue")
assume(a endsWith "postfix", "a good clue")
assume(a contains "something", "a good clue")
assume(a eq b, "a good clue")
assume(a ne b, "a good clue")
assume(a > 0 && b > 5, "a good clue")
assume(a > 0 || b > 5, "a good clue")
assume(a.isEmpty, "a good clue")
assume(!a.isEmpty, "a good clue")
assume(a.isInstanceOf[String], "a good clue")
assume(a.length == 8, "a good clue")
assume(a.size == 8, "a good clue")
assume(a.exists(_ == 8), "a good clue")

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

Value parameters

clue: An objects whose toString method returns a message to include in a failure report.
condition: the boolean condition to assume

Attributes

Throws: NullArgumentException
if message is null.

TestCanceledException
if the condition is false.
Inherited from:: Assertions
Source: Assertions.scala

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))

Value parameters

condition: the boolean condition to assume

Attributes

Throws: TestCanceledException
if the condition is false.
Inherited from:: Assertions
Source: Assertions.scala

This method enables the following syntax for String:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax for String:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

Evaluate the given assert every interval until it does not throw an exception and return the result.

If the max timeout expires the last exception is thrown.

If no timeout is given, take it from the innermost enclosing within block.

Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "pekko.test.timefactor".

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Await until the given condition evaluates to true or the timeout expires, whichever comes first.

If no timeout is given, take it from the innermost enclosing within block.

Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "pekko.test.timefactor".

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

This method enables the following syntax for String:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

Value parameters

cause: a Throwable that indicates the cause of the cancellation.

Attributes

Throws: NullArgumentException
if cause is null
Inherited from:: Assertions
Source: Assertions.scala

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

Value parameters

cause: A Throwable that indicates the cause of the failure.
message: A message describing the failure.

Attributes

Throws: NullArgumentException
if message or cause is null
Inherited from:: Assertions
Source: Assertions.scala

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

Value parameters

message: A message describing the cancellation.

Attributes

Throws: NullArgumentException
if message is null
Inherited from:: Assertions
Source: Assertions.scala

Throws TestCanceledException to indicate a test was canceled.

Attributes

Inherited from:: Assertions
Source: Assertions.scala

Spawns an actor as a child of this test actor with an auto-generated name and stopping supervisor strategy, returning the child's ActorRef.

Value parameters

props: Props to create the child actor

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Spawns an actor as a child of this test actor with a stopping supervisor strategy, and returns the child's ActorRef.

Value parameters

name: Actor name for the child actor
props: Props to create the child actor

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Spawns an actor as a child of this test actor with an auto-generated name, and returns the child's ActorRef.

Value parameters

props: Props to create the child actor
supervisorStrategy: Strategy should decide what to do with failures in the actor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Value parameters

name: Actor name for the child actor
props: Props to create the child actor
supervisorStrategy: Strategy should decide what to do with failures in the actor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

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

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

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

Value parameters

equivalenceOfB: an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.
ev: evidence that A is a subype of B

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

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

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

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

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

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

Value parameters

equalityOfA: an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.
ev: evidence that B is a subype of A

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

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

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

Value parameters

left: the object whose type to convert to CheckingEqualizer.

Attributes

Throws: NullPointerException
if left is null.
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

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

Attributes

Returns: a default Equality for type A
Inherited from:: TripleEqualsSupport
Source: TripleEqualsSupport.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables syntax such as the following:

result should equal (null)
             ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables syntax such as the following:

result should equal (100 +- 1)
             ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

result should equal (7)
             ^

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

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

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

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

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

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This method enables the following syntax for String:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax for String:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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.

Value parameters

color: a boolean that configures whether output is printed in color
configMap: a Map of key-value pairs that can be used by the executing Suite of tests.
durations: a boolean that configures whether test and suite durations are printed to the standard output
fullstacks: a boolean that configures whether full stack traces should be printed for test failures
shortstacks: a boolean that configures whether short stack traces should be printed for test failures
stats: a boolean that configures whether test and suite statistics are printed to the standard output
testName: the name of one test to run.

Attributes

Throws: IllegalArgumentException
if testName is defined, but no test with the specified test name exists in this Suite

NullArgumentException
if the passed configMap parameter is null.
Inherited from:: Suite
Source: Suite.scala

Receive one message from the test actor and assert that it equals the given object. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Attributes

Returns: the received object
Inherited from:: TestKitBase
Source: TestKit.scala

Receive one message from the test actor and assert that it equals the given object. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Attributes

Returns: the received object
Inherited from:: TestKitBase
Source: TestKit.scala

Same as expectMsg(remainingOrDefault, obj), but correctly treating the timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which is of that class (equality, not conformance). This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Same as expectMsgAllClassOf(remainingOrDefault, obj...), but correctly treating the timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive a number of messages from the test actor matching the given number of classes and assert that for each given class one is received which conforms to that class (and vice versa). This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Beware that one object may satisfy all given class constraints, which may be counter-intuitive.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Same as expectMsgAllConformingOf(remainingOrDefault, obj...), but correctly treating the timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa. This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

 dispatcher ! SomeWork1()
 dispatcher ! SomeWork2()
 expectMsgAllOf(1 second, Result1(), Result2())

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Same as expectMsgAllOf(remainingOrDefault, obj...), but correctly treating the timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive one message from the test actor and assert that it conforms to one of the given classes. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Attributes

Returns: the received object
Inherited from:: TestKitBase
Source: TestKit.scala

Same as expectMsgAnyClassOf(remainingOrDefault, obj...), but correctly treating the timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive one message from the test actor and assert that it equals one of the given objects. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Attributes

Returns: the received object
Inherited from:: TestKitBase
Source: TestKit.scala

Same as expectMsgAnyOf(remainingOrDefault, obj...), but correctly treating the timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive one message from the test actor and assert that it conforms to the given class. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Attributes

Returns: the received object
Inherited from:: TestKitBase
Source: TestKit.scala

Same as expectMsgClass(remainingOrDefault, c), but correctly treating the timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive one message from the test actor and assert that the given partial function accepts it. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Use this variant to implement more complicated or conditional processing.

Attributes

Returns: the received object as transformed by the partial function
Inherited from:: TestKitBase
Source: TestKit.scala

Receive one message from the test actor and assert that it conforms to the given type (after erasure). Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Attributes

Returns: the received object
Inherited from:: TestKitBase
Source: TestKit.scala

Same as expectMsgType[T](remainingOrDefault), but correctly treating the timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Assert that no message is received. Waits for the default period configured as pekko.test.expect-no-message-default. That timeout is scaled using the configuration entry "pekko.test.timefactor".

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Assert that no message is received for the specified time. Supplied value is not dilated.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef. Before calling this method, you have to watch the target actor ref. Wait time is bounded by the given duration, with an AssertionFailure being thrown in case of timeout.

Value parameters

max: wait no more than max time, otherwise throw AssertionFailure
target: the actor ref expected to be Terminated

Attributes

Returns: the received Terminated message
Inherited from:: TestKitBase
Source: TestKit.scala

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

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

the size of the testNames List, minus the number of tests marked as ignored and any tests that are exluded by the passed Filter
the sum of the values obtained by invoking expectedTestCount on every nested Suite contained in nestedSuites

Value parameters

filter: a Filter with which to filter tests to count based on their tags

Attributes

Inherited from:: Suite
Source: Suite.scala

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

Value parameters

cause: a Throwable that indicates the cause of the failure.

Attributes

Throws: NullArgumentException
if cause is null
Inherited from:: Assertions
Source: Assertions.scala

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

Value parameters

cause: A Throwable that indicates the cause of the failure.
message: A message describing the failure.

Attributes

Throws: NullArgumentException
if message or cause is null
Inherited from:: Assertions
Source: Assertions.scala

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

Value parameters

message: A message describing the failure.

Attributes

Throws: NullArgumentException
if message is null
Inherited from:: Assertions
Source: Assertions.scala

Throws TestFailedException to indicate a test failed.

Attributes

Inherited from:: Assertions
Source: Assertions.scala

Hybrid of expectMsgPF and receiveWhile: receive messages while the partial function matches and returns false. Use it to ignore certain messages while waiting for a specific message.

Attributes

Returns: the last received message, i.e. the first one for which the partial function returned true
Inherited from:: TestKitBase
Source: TestKit.scala

Waits for specific message that partial function matches while ignoring all other messages coming in the meantime. Use it to ignore any number of messages while waiting for a specific one.

Attributes

Returns: result of applying partial function to the last received message, i.e. the first one for which the partial function is defined
Inherited from:: TestKitBase
Source: TestKit.scala

Ignore all messages in the test actor for which the given partial function returns true.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Stop ignoring messages in the test actor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

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.

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

Value parameters

classTag: an implicit ClassTag representing the type of the specified type parameter.
f: the function value that should throw the expected exception

Attributes

Returns: the intercepted exception, if it is of the expected type
Throws: TestFailedException
if the passed function does not complete abruptly with an exception that's an instance of the specified type.
Inherited from:: Assertions
Source: Assertions.scala

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

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

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

Value parameters

equivalenceOfB: an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.
ev: evidence that A is a subype of B

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

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

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

Query queue status.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

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.

Attributes

Inherited from:: Suite
Source: Suite.scala

This method enables the following syntax for String:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This field enables the following syntax:

noException should be thrownBy
^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Obtain current time (System.nanoTime) as Duration.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

This method enables syntax such as the following:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

Throws TestPendingException to indicate a test is pending.

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

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

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

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

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

Attributes

Inherited from:: Assertions
Source: Assertions.scala

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

This method can be used to temporarily change a failing test into a pending test in such a way that it will automatically turn back into a failing test once the problem originally causing the test to fail has been fixed. At that point, you need only remove the pendingUntilFixed call. In other words, a pendingUntilFixed surrounding a block of code that isn't broken is treated as a test failure. The motivation for this behavior is to encourage people to remove pendingUntilFixed calls when there are no longer needed.

This method facilitates a style of testing in which tests are written before the code they test. Sometimes you may encounter a test failure that requires more functionality than you want to tackle without writing more tests. In this case you can mark the bit of test code causing the failure with pendingUntilFixed. You can then write more tests and functionality that eventually will get your production code to a point where the original test won't fail anymore. At this point the code block marked with pendingUntilFixed will no longer throw an exception (because the problem has been fixed). This will in turn cause pendingUntilFixed to throw TestFailedException with a detail message explaining you need to go back and remove the pendingUntilFixed call as the problem orginally causing your test code to fail has been fixed.

Value parameters

f: a block of code, which if it completes abruptly, should trigger a TestPendingException

Attributes

Throws: TestPendingException
if the passed block of code completes abruptly with an Exception or AssertionError
Inherited from:: Assertions
Source: Assertions.scala

Receive N messages in a row before the given deadline.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Same as receiveN(n, remaining) but correctly taking into account Duration.timeFactor.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive one message from the internal queue of the TestActor. If the given duration is zero, the queue is polled (non-blocking).

This method does NOT automatically scale its Duration parameter!

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Receive a series of messages until one does not match the given partial function or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed or expected messages count is reached. Returns the sequence of messages.

Note that it is not an error to hit the max duration in this case.

One possible use of this method is for testing whether messages of certain characteristics are generated at a certain rate:

test ! ScheduleTicks(100 millis)
val series = receiveWhile(750 millis) {
   case Tick(count) => count
}
assert(series == (1 to 7).toList)

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Registers an ignored test.

Value parameters

testFun: the test function
testTags: the test tags
testText: the test text

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Registers a test.

Value parameters

testFun: the test function
testTags: the test tags
testText: the test text

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Obtain time remaining for execution of the innermost enclosing within block or throw an java.lang.AssertionError if no within block surrounds this call.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Obtain time remaining for execution of the innermost enclosing within block or missing that it returns the given duration.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Obtain time remaining for execution of the innermost enclosing within block or missing that it returns the properly dilated default for this case from settings (key "pekko.test.single-expect-default").

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.

Attributes

Inherited from:: Suite
Source: Suite.scala

Execute a suite surrounded by calls to beforeAll and afterAll.

This trait's implementation of this method ("this method") invokes beforeAll(ConfigMap) before executing any tests or nested suites and afterAll(ConfigMap) after executing all tests and nested suites. It runs the suite by invoking super.run, passing along the parameters passed to it.

If any invocation of beforeAll completes abruptly with an exception, this method will complete abruptly with the same exception. If any call to super.run completes abruptly with an exception, this method will complete abruptly with the same exception, however, before doing so, it will invoke afterAll. If afterAll also completes abruptly with an exception, this method will nevertheless complete abruptly with the exception previously thrown by super.run. If super.run returns normally, but afterAll completes abruptly with an exception, this method will complete abruptly with the same exception.

This method does not invoke either beforeAll or afterAll if runTestsInNewInstance is true so that any side effects only happen once per test if OneInstancePerTest is being used. In addition, if no tests are expected, then beforeAll and afterAll will be invoked only if the invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected flag is true. By default, this flag is false, so that if all tests are excluded (such as if the entire suite class has been marked with @Ignore), then side effects would happen only if at least one test will ultimately be executed in this suite or its nested suites.

Value parameters

args: the Args for this run
testName: an optional name of one test to run. If None, all relevant tests should be run. I.e., None acts like a wildcard that means run all relevant tests in this Suite.

Attributes

Returns: a Status object that indicates when the test started by this method has completed, and whether or not it failed .
Inherited from:: BeforeAndAfterAll
Source: BeforeAndAfterAll.scala

Runs a test surrounded by calls to beforeEach() and afterEach().

This trait's implementation of this method ("this method") invokes beforeEach() before running each test and afterEach() after running each test. It runs each test by invoking super.runTest, passing along the two parameters passed to it.

If any invocation of beforeEach() completes abruptly with an exception, this method will complete abruptly with the same exception, however, before doing so, it will invoke afterEach(). If beforeEach() returns normally, but the subsequent call to super.runTest completes abruptly with an exception, this method will complete abruptly with the same exception, however, before doing so, it will invoke afterEach(). If afterEach() completes abruptly with an exception, this method will nevertheless complete abruptly with an exception previously thrown by either beforeEach() or super.runTest. If both beforeEach() and super.runTest return normally, but afterEach() completes abruptly with an exception, this method will complete abruptly with the exception thrown by afterEach().

The reason this method invokes afterEach() even if beforeEach() or super.runTest throws an exception is to reduce the chance that a resource acquired by beforeEach() or super.runTest prior to completing abruptly with the exception is not cleaned up and therefore leaked.

Value parameters

args: the Args for this run
testName: the name of one test to run.

Attributes

Returns: a Status object that indicates when the test started by this method has completed, and whether or not it failed .
Inherited from:: BeforeAndAfterEach
Source: BeforeAndAfterEach.scala

Run zero to many of this AnyWordSpec's tests.

This method takes a testName parameter that optionally specifies a test to invoke. If testName is Some, this trait's implementation of this method invokes runTest on this object, passing in:

testName - the String value of the testName Option passed to this method
reporter - the Reporter passed to this method, or one that wraps and delegates to it
stopper - the Stopper passed to this method, or one that wraps and delegates to it
configMap - the configMap passed to this method, or one that wraps and delegates to it

This method takes a Set of tag names that should be included (tagsToInclude), and a Set that should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute. If tagsToInclude is empty, all tests will be executed except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is non-empty, only tests belonging to tags mentioned in tagsToInclude, and not mentioned in tagsToExclude will be executed. However, if testName is Some, tagsToInclude and tagsToExclude are essentially ignored. Only if testName is None will tagsToInclude and tagsToExclude be consulted to determine which of the tests named in the testNames Set should be run. For more information on trait tags, see the main documentation for this trait.

If testName is None, this trait's implementation of this method invokes testNames on this Suite to get a Set of names of tests to potentially execute. (A testNames value of None essentially acts as a wildcard that means all tests in this Suite that are selected by tagsToInclude and tagsToExclude should be executed.) For each test in the testName Set, in the order they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation of this method checks whether the test should be run based on the tagsToInclude and tagsToExclude Sets. If so, this implementation invokes runTest, passing in:

testName - the String name of the test to run (which will be one of the names in the testNames Set)
reporter - the Reporter passed to this method, or one that wraps and delegates to it
stopper - the Stopper passed to this method, or one that wraps and delegates to it
configMap - the configMap passed to this method, or one that wraps and delegates to it

Value parameters

args: the Args for this run
testName: an optional name of one test to run. If None, all relevant tests should be run. I.e., None acts like a wildcard that means run all relevant tests in this Suite.

Attributes

Returns: a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
Throws: IllegalArgumentException
if testName is defined, but no test with the specified test name exists in this Suite

NullArgumentException
if any of the passed parameters is null.
Definition Classes: AnyWordSpecLike -> Suite
Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Install an AutoPilot to drive the testActor: the AutoPilot will be run for each received message and can be used to send or forward messages, etc. Each invocation must return the AutoPilot for the next round.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Shut down an actor system and wait for termination. On failure debug output will be logged about the remaining actors in the system.

If verifySystemShutdown is true, then an exception will be thrown on failure.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

A string ID for this Suite that is intended to be unique among all suites reported during a run.

This trait's implementation of this method returns the fully qualified name of this object's class. Each suite reported during a run will commonly be an instance of a different Suite class, and in such cases, this default implementation of this method will suffice. However, in special cases you may need to override this method to ensure it is unique for each reported suite. For example, if you write a Suite subclass that reads in a file whose name is passed to its constructor and dynamically creates a suite of tests based on the information in that file, you will likely need to override this method in your Suite subclass, perhaps by appending the pathname of the file to the fully qualified class name. That way if you run a suite of tests based on a directory full of these files, you'll have unique suite IDs for each reported suite.

The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.

Attributes

Returns: this Suite object's ID.
Inherited from:: Suite
Source: Suite.scala

A user-friendly suite name for this Suite.

This trait's implementation of this method returns the simple name of this object's class. This trait's implementation of runNestedSuites calls this method to obtain a name for Reports to pass to the suiteStarting, suiteCompleted, and suiteAborted methods of the Reporter.

Attributes

Returns: this Suite object's suite name.
Inherited from:: Suite
Source: Suite.scala

A Map whose keys are String names of tagged tests and whose associated values are the Set of tags for the test. If this AnyWordSpec contains no tags, this method returns an empty Map.

This trait's implementation returns tags that were passed as strings contained in Tag objects passed to taggedAs.

In addition, this trait's implementation will also auto-tag tests with class level annotations. For example, if you annotate @Ignore at the class level, all test methods in the class will be auto-annotated with org.scalatest.Ignore.

Attributes

Definition Classes: AnyWordSpecLike -> Suite
Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Defines the testActor name.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Provides a TestData instance for the passed test name, given the passed config map.

This method is used to obtain a TestData instance to pass to withFixture(NoArgTest) and withFixture(OneArgTest) and the beforeEach and afterEach methods of trait BeforeAndAfterEach.

Value parameters

testName: the name of the test for which to return a TestData instance
theConfigMap: the config map to include in the returned TestData

Attributes

Returns: a TestData instance for the specified test, which includes the specified config map
Definition Classes: AnyWordSpecLike -> Suite
Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

An immutable Set of test names. If this AnyWordSpec contains no tests, this method returns an empty Set.

This trait's implementation of this method will return a set that contains the names of all registered tests. The set's iterator will return those names in the order in which the tests were registered. Each test's name is composed of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the example itself, with all components separated by a space. For example, consider this AnyWordSpec:

import org.scalatest._

class StackSpec {
 "A Stack" when {
   "not empty" must {
     "allow me to pop" in {}
   }
   "not full" must {
     "allow me to push" in {}
   }
 }
}

Invoking testNames on this AnyWordSpec will yield a set that contains the following two test name strings:

"A Stack (when not empty) must allow me to pop"
"A Stack (when not full) must allow me to push"

Attributes

Definition Classes: AnyWordSpecLike -> Suite
Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

This method enables the following syntax:

the [FileNotFoundException] should be thrownBy { ... }
^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This method enables the following syntax:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

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

Value parameters

equalityOfA: an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.
ev: evidence that B is a subype of A

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

Have the testActor stop watching someone (i.e. context.unwatch(...)).

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Have the testActor watch someone (i.e. context.watch(...)).

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).

This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:

withClue("(Employee's name was: " + employee.name + ")") {
 intercept[IllegalArgumentException] {
   employee.getTask(-1)
 }
}

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

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

Attributes

Throws: NullArgumentException
if the passed clue is null
Inherited from:: Assertions
Source: Assertions.scala

Run the passed test function in the context of a fixture established by this method.

This method should set up the fixture needed by the tests of the current suite, invoke the test function, and if needed, perform any clean up needed after the test completes. Because the NoArgTest function passed to this method takes no parameters, preparing the fixture will require side effects, such as reassigning instance vars in this Suite or initializing a globally accessible external database. If you want to avoid reassigning instance vars you can use FixtureSuite.

This trait's implementation of runTest invokes this method for each test, passing in a NoArgTest whose apply method will execute the code of the test.

This trait's implementation of this method simply invokes the passed NoArgTest function.

Value parameters

test: the no-arg test function to run with a fixture

Attributes

Inherited from:: TestSuite
Source: TestSuite.scala

Same as calling within(0 seconds, max)(f).

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Execute code block while bounding its execution time between min and max. within blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing within block.

Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "pekko.test.timefactor", while the min Duration is not.

val ret = within(50 millis) {
 test ! "ping"
 expectMsgClass(classOf[String])
}

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

Deprecated and Inherited methods

The conversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an implicit Equivalence[A].

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

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

Value parameters

cnv: an implicit conversion from B to A
equivalenceOfA: an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].
Deprecated: [Since version 3.1.0] The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an explicit Equivalence[B].

This method is used to enable the Explicitly DSL for ConversionCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that converts from A to B.

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

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

Value parameters

cnv: an implicit conversion from A to B
equalityOfB: an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].
Deprecated: [Since version 3.1.0] The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an explicit Equivalence[A].

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

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

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

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

Value parameters

cnv: an implicit conversion from B to A
equivalenceOfA: an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].
Deprecated: [Since version 3.1.0] The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

Assert that no message is received for the specified time. NOTE! Supplied value is always dilated.

Attributes

Deprecated: [Since version Akka 2.5.5] Use expectNoMessage instead
Inherited from:: TestKitBase
Source: TestKit.scala

Assert that no message is received. Waits for the default period configured as pekko.test.expect-no-message-default. That timeout is scaled using the configuration entry "pekko.test.timefactor".

Attributes

Deprecated: [Since version Akka 2.5.5] Use expectNoMessage instead
Inherited from:: TestKitBase
Source: TestKit.scala

The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an implicit Equivalence[B].

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

Value parameters

cnv: an implicit conversion from A to B
equalityOfB: an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].
Deprecated: [Since version 3.1.0] The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException indicating no exception is thrown.

This method is intended to be used in the Scala interpreter to eliminate large stack traces when trying out ScalaTest assertions and matcher expressions. It is not intended to be used in regular test code. If you want to ensure that a bit of code throws an expected exception, use intercept, not trap. Here's an example interpreter session without trap:

scala> import org.scalatest._
import org.scalatest._

scala> import Matchers._
import Matchers._

scala> val x = 12
a: Int = 12

scala> x shouldEqual 13
org.scalatest.exceptions.TestFailedException: 12 did not equal 13
  at org.scalatest.Assertions$class.newAssertionFailedException(Assertions.scala:449)
  at org.scalatest.Assertions$.newAssertionFailedException(Assertions.scala:1203)
  at org.scalatest.Assertions$AssertionsHelper.macroAssertTrue(Assertions.scala:417)
  at .<init>(<console>:15)
  at .<clinit>(<console>)
  at .<init>(<console>:7)
  at .<clinit>(<console>)
  at $print(<console>)
  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
  at java.lang.reflect.Method.invoke(Method.java:597)
  at scala.tools.nsc.interpreter.IMain$ReadEvalPrint.call(IMain.scala:731)
  at scala.tools.nsc.interpreter.IMain$Request.loadAndRun(IMain.scala:980)
  at scala.tools.nsc.interpreter.IMain.loadAndRunReq$1(IMain.scala:570)
  at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:601)
  at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:565)
  at scala.tools.nsc.interpreter.ILoop.reallyInterpret$1(ILoop.scala:745)
  at scala.tools.nsc.interpreter.ILoop.interpretStartingWith(ILoop.scala:790)
  at scala.tools.nsc.interpreter.ILoop.command(ILoop.scala:702)
  at scala.tools.nsc.interpreter.ILoop.processLine$1(ILoop.scala:566)
  at scala.tools.nsc.interpreter.ILoop.innerLoop$1(ILoop.scala:573)
  at scala.tools.nsc.interpreter.ILoop.loop(ILoop.scala:576)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply$mcZ$sp(ILoop.scala:867)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822)
  at scala.tools.nsc.util.ScalaClassLoader$.savingContextLoader(ScalaClassLoader.scala:135)
  at scala.tools.nsc.interpreter.ILoop.process(ILoop.scala:822)
  at scala.tools.nsc.MainGenericRunner.runTarget$1(MainGenericRunner.scala:83)
  at scala.tools.nsc.MainGenericRunner.process(MainGenericRunner.scala:96)
  at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:105)
  at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala)

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

scala> trap { x shouldEqual 13 }
res1: Throwable = org.scalatest.exceptions.TestFailedException: 12 did not equal 13

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

scala> trap { x shouldEqual 12 }
res2: Throwable = No exception was thrown.

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

scala> trap { "Dude!" }
res3: Throwable = No exception was thrown. Instead, result was: "Dude!"

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

Attributes

Deprecated: The trap method is no longer needed for demos in the REPL, which now abreviates stack traces, and will be removed in a future version of ScalaTest
Inherited from:: Assertions
Source: Assertions.scala

Concrete fields

Attributes

Source: PluginSpec.scala

Attributes

Source: PluginSpec.scala

Inherited fields

This field enables the following syntax:

badBook should not be a ('goodRead)
                     ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This field enables syntax such as the following:

result should equal ("hello") (after being lowerCased)
                              ^

Attributes

Inherited from:: Explicitly
Source: Explicitly.scala

This field enables the following syntax:

badBook should not be an (excellentRead)
                     ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This field enables syntax such as the following:

obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string))
           ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

Supports shared test registration in AnyWordSpecs.

This field enables syntax such as the following:

behave like nonFullStack(stackWithOneItem)
^

For more information and examples of the use of behave, see the Shared tests section in the main documentation for this trait.

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

This field enables the following syntax:

"val a: String = 1" shouldNot compile
                             ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax such as the following:

list should (contain ('a') and have length (7))
            ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax such as the following:

result should equal ("hello") (decided by defaultEquality)
                              ^

Attributes

Inherited from:: Explicitly
Source: Explicitly.scala

This field enables the following syntax:

seq should be (defined)
             ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax such as the following, given an Equivalence[String] named myStringEquivalence:

result should equal ("hello") (determined by myStringEquivalence)
                              ^

Attributes

Inherited from:: Explicitly
Source: Explicitly.scala

This field enables the following syntax:

list should be (empty)
               ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax such as the following:

string should (endWith ("ago") and include ("score"))
              ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables the following syntax:

file should exist
           ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax such as the following:

string should (fullyMatch regex ("Hel*o, wor.d") and not have length (99))
              ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax such as the following:

list should (have length (3) and not contain ('a'))
            ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax such as the following:

string should (include ("hope") and not startWith ("no"))
              ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.

The default value is false, which means beforeAll and afterAll will not be invoked if there are no tests expected. Whether tests are expected is determined by invoking expectedTestCount passing in the passed filter. Because this count does not include tests excluded based on tags, such as ignored tests, this prevents any side effects in beforeAll or afterAll if no tests will ultimately be executed anyway. If you always want to see the side effects even if no tests are expected, override this val and set it to true.

Attributes

Inherited from:: BeforeAndAfterAll
Source: BeforeAndAfterAll.scala

Supports shorthand scope registration in AnyWordSpecLikes.

This field enables syntax such as the following test registration:

"A Stack" when { ... }

it should { ... }
^

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

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

This field enables the following syntax:

map should not contain key (10)
                      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This field enables the following syntax:

"hi" should not have length (3)
                    ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables the following syntax:

result should matchPattern { case Person("Bob", _) => }
             ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax like the following:

myFile should (not be an (directory) and not have ('name ("foo.bar")))
              ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

Attributes

Inherited from:: Assertions
Source: Assertions.scala

This field enables the following syntax:

file should be (readable)
               ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables the following syntax:

"eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r)
                             ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This field enables the following syntax:

set should not have size (3)
                   ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables the following syntax:

seq should be (sorted)
             ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables syntax such as the following:

string should (startWith ("Four") and include ("year"))
              ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

The Succeeded singleton.

You can use succeed to solve a type error when an async test does not end in either Future[Assertion] or Assertion. Because Assertion is a type alias for Succeeded.type, putting succeed at the end of a test body (or at the end of a function being used to map the final future of a test body) will solve the type error.

Attributes

Inherited from:: Assertions
Source: Assertions.scala

ActorRef of the test actor. Access is provided to enable e.g. registration as message target.

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

This field enables the following syntax:

oneString should not be theSameInstanceAs (anotherString)
                       ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

Supports shorthand scope registration in AnyWordSpecLikes.

This field enables syntax such as the following test registration:

"A Stack" when { ... }

they should { ... }
^

For more information and examples of the use of the they field, see the main documentation for AnyWordSpec.

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

This field enables the following syntax:

"val a: String = 1" shouldNot typeCheck
                             ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

This field enables the following syntax:

map should not contain value (10)
                      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

This field enables the following syntax:

file should be (writable)
               ^

Attributes

Inherited from:: MatcherWords
Source: MatcherWords.scala

Deprecated and Inherited fields

The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.

This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0 will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for styleName.

Attributes

Deprecated: [Since version 3.1.0] The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.
Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Extensions

Inherited extensions

extension (leftSideString: String)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string should fullyMatch regex ("a(b*)c" withGroup "bb")
                                        ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (leftSideString: String)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string should fullyMatch regex ("a(b*)(c*)" withGroups ("bb", "cc"))
                                           ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (leftSideString: String)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string should fullyMatch regex ("""(-)?(\d+)(\.\d*)?""")
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (leftSideString: String)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string shouldNot fullyMatch regex ("""(-)?(\d+)(\.\d*)?""")
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (inline leftSideString: String)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string should compile
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (inline leftSideString: String)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string shouldNot compile
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (inline leftSideString: String)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string shouldNot typeCheck
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result should be (3)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T, TYPECLASS1[_]](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result should equal (3)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T, TYPECLASS1[_], TYPECLASS2[_]](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result should (equal (expected) and have length 3)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

a shouldEqual b
 ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldEqual 7.1 +- 0.2
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldEqual null
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result should not equal (3)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T, U](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

a should === (b)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result should === (100 +- 1)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result should be a aMatcher
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T, R](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

aDouble shouldBe 8.8
       ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

5 shouldBe < (7)
 ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

8 shouldBe > (7)
 ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

5 shouldBe <= (7)
 ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

8 shouldBe >= (7)
 ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables the following syntax, where odd refers to a BeMatcher[Int]:

testing
1 shouldBe odd
 ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldBe 7.1 +- 0.2
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldBe sorted
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

aDouble shouldBe a [Book]
       ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

aDouble shouldBe an [Book]
       ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldBe readable
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldBe writable
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldBe empty
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldBe defined
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldNot be (3)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldNot (be (3))
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T, TYPECLASS1[_]](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldNot (be readable)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldNot have length (3)
      ^
result shouldNot have size (3)
      ^
exception shouldNot have message ("file not found")
         ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result should have length (3)
      ^
result should have size (3)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldBe null
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

result shouldBe theSameInstanceAs (anotherObject)
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables the following syntax:

list shouldBe 'empty
    ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables the following syntax:

list shouldBe a ('empty)
    ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables the following syntax:

list shouldBe an ('empty)
    ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables the following syntax, where excellentRead refers to a BePropertyMatcher[Book]:

programmingInScala shouldBe excellentRead
                  ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T, U >: T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables the following syntax, where goodRead refers to a BePropertyMatcher[Book]:

programmingInScala shouldBe a (goodRead)
                  ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T, U >: T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables the following syntax, where excellentRead refers to a BePropertyMatcher[Book]:

programmingInScala shouldBe an (excellentRead)
                  ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

xs shouldNot contain (oneOf (1, 2, 3))
  ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

file should exist
    ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

file should not (exist)
    ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

file shouldNot exist
    ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string should include regex ("hi")
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string should startWith regex ("hello")
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string should endWith regex ("world")
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string shouldNot startWith regex ("hello")
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string shouldNot endWith regex ("world")
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension [T](leftSideValue: T)(using pos: Position, prettifier: Prettifier)

This method enables syntax such as the following:

string shouldNot include regex ("hi")
      ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (regex: Regex)

This method enables syntax such as the following:

regex should fullyMatch regex ("a(b*)c" withGroup "bb")
                                       ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (regex: Regex)

This method enables syntax such as the following:

regex should fullyMatch regex ("a(b*)(c*)" withGroups ("bb", "cc"))
                                          ^

Attributes

Inherited from:: Matchers
Source: Matchers.scala

extension (x: String)

Attributes

Inherited from:: Assertions
Source: Assertions.scala

extension (x: String)

Attributes

Inherited from:: Assertions
Source: Assertions.scala

Implicits

Inherited implicits

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

Attributes

Inherited from:: Tolerance
Source: Tolerance.scala

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

Attributes

Inherited from:: Matchers
Source: Matchers.scala

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

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

Value parameters

left: the object whose type to convert to Equalizer.

Attributes

Throws: NullPointerException
if left is null.
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

Implicitly converts an object of type String to a StringCanWrapper, to enable can methods to be invokable on that object.

Attributes

Inherited from:: CanVerb
Source: CanVerb.scala

Implicitly converts an object of type String to a StringMustWrapper, to enable must methods to be invokable on that object.

Attributes

Inherited from:: MustVerb
Source: MustVerb.scala

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

Attributes

Inherited from:: ShouldVerb
Source: ShouldVerb.scala

Implicitly converts Strings to WordSpecStringWrapper, which enables methods when, which, in, is, taggedAs and ignore to be invoked on Strings.

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Supports the registration of subjects.

For example, this method enables syntax such as the following:

"A Stack" should { ...
         ^

This function is passed as an implicit parameter to a should method provided in ShouldVerb, a must method provided in MustVerb, and a can method provided in CanVerb. When invoked, this function registers the subject and executes the block.

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Supports the registration of subject descriptions with after words.

For example, this method enables syntax such as the following:

def provide = afterWord("provide")

"The ScalaTest Matchers DSL" can provide { ... }
                            ^

Attributes

Inherited from:: AnyWordSpecLike
Source: AnyWordSpecLike.scala

Provides an A CanEqual B instance for any two types A and B, with no type constraint enforced, given an implicit Equality[A].

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

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

Value parameters

equalityOfA: an Equality[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns: an A CanEqual B instance whose areEqual method delegates to the areEqual method of the passed Equality[A].
Definition Classes: TripleEquals -> TripleEqualsSupport
Inherited from:: TripleEquals
Source: TripleEquals.scala

Inherited and Abstract implicits

Attributes

Inherited from:: TestKitBase
Source: TestKit.scala

In this article

Generated with