Helper class used by code generated by the assert macro.
Class that supports the registration of a “subject” being specified and tested via the
instance referenced from FlatSpec's behavior field.
Class used via an implicit conversion to enable two objects to be compared with
=== and !== with a Boolean result and an enforced type constraint between
two object types.
Class used via an implicit conversion to enable any two objects to be compared with
=== and !== with a Boolean result and no enforced type constraint between
two object types.
Class that supports registration of ignored tests via the IgnoreWord instance referenced
from FlatSpec's ignore field.
Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced
from FlatSpec's ignore field.
Class that supports registration of ignored tests via the ItWord instance
referenced from FlatSpec's ignore field.
Class that supports test registration in shorthand form.
Class that supports tagged test registration in shorthand form.
Class that supports test registration via the ItWord instance referenced from FlatSpec's it field.
Class that supports the registration of tagged tests via the ItWord instance
referenced from FlatSpec's it field.
Class that supports test (and shared test) registration via the instance referenced from FlatSpec's it field.
Class used via an implicit conversion to enable any two objects to be compared with
=== and !== with an Option[String] result and an enforced type constraint between
two object types.
Class used via an implicit conversion to enable any two objects to be compared with
=== and !== with an Option[String] result and no enforced type constraint between
two object types.
A test function taking no arguments and returning an Outcome.
This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec,
and fixture.WordSpec.
This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec,
and fixture.WordSpec.
This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec,
and fixture.WordSpec.
Class that supports test registration via the TheyWord instance referenced from FlatSpec's they field.
Class that supports the registration of tagged tests via the TheyWord instance
referenced from FlatSpec's they field.
Class that supports test (and shared test) registration via the instance referenced from FlatSpec's it field.
Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate
the “<left> should !== (<pivot> +- <tolerance>)”
syntax of Matchers.
Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate
the “<left> should !== (<pivot> +- <tolerance>)”
syntax of Matchers.
the Spread[T] against which to compare the left-hand value
a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with
expectingEqual set to false.
Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate
the “<left> should !== null” syntax
of Matchers.
Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate
the “<left> should !== null” syntax
of Matchers.
a null reference
a TripleEqualsInvocation wrapping the passed null value, with expectingEqual
set to false.
Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate
the “<left> should !== <right>” syntax
of Matchers.
Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate
the “<left> should !== <right>” syntax
of Matchers.
the right-hand side value for an equality assertion
a TripleEqualsInvocation wrapping the passed right value, with expectingEqual
set to false.
Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate
the “<left> should === (<pivot> +- <tolerance>)”
syntax of Matchers.
Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate
the “<left> should === (<pivot> +- <tolerance>)”
syntax of Matchers.
the Spread[T] against which to compare the left-hand value
a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with
expectingEqual set to true.
Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate
the “<left> should === null” syntax
of Matchers.
Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate
the “<left> should === null” syntax
of Matchers.
a null reference
a TripleEqualsInvocation wrapping the passed null value, with expectingEqual
set to true.
Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate
the “<left> should === <right>” syntax
of Matchers.
Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate
the “<left> should === <right>” syntax
of Matchers.
the right-hand side value for an equality assertion
a TripleEqualsInvocation wrapping the passed right value, with expectingEqual
set to true.
Returns an Alerter that during test execution will forward strings passed to its
apply method to the current reporter.
Returns an Alerter that during test execution will forward strings passed to its
apply method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked while this
FlatSpec 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.
Assert that a boolean condition, described in String
message, is true.
Assert that a boolean condition, described in String
message, is true.
If the condition is true, this method returns normally.
Else, it throws TestFailedException with the
String obtained by invoking toString on the
specified clue as the exception's detail message.
the boolean condition to assert
An objects whose toString method returns a message to include in a failure report.
if message is null.
if the condition is false.
Assert that a boolean condition is true.
Assert that a boolean condition is true.
If the condition is true, this method returns normally.
Else, it throws TestFailedException.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for simple quality checks of this form:
Any other form of expression will just get a plain-old TestFailedException at this time. 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, not Option[String] to be
the default in tests. This makes === consistent between tests and production code. If you have pre-existing
code you wrote under ScalaTest 1.x, in which you are expecting=== to return an Option[String],
use can get that behavior back by mixing in trait LegacyTripleEquals.
the boolean condition to assert
if the condition is false.
Assert that the value passed as expected equals the value passed as actual.
Assert that the value passed as expected equals the value passed as actual.
If the actual value equals the expected value
(as determined by ==), assertResult returns
normally. Else, assertResult throws a
TestFailedException whose detail message includes the expected and actual values.
the expected value
the actual value, which should equal the passed expected value
if the passed actual value does not equal the passed expected value.
Assert that the value passed as expected equals the value passed as actual.
Assert that the value passed as expected equals the value passed as actual.
If the actual equals the expected
(as determined by ==), assertResult returns
normally. Else, if actual is not equal to expected, assertResult throws a
TestFailedException whose detail message includes the expected and actual values, as well as the String
obtained by invoking toString on the passed clue.
the expected value
An object whose toString method returns a message to include in a failure report.
the actual value, which should equal the passed expected value
if the passed actual value does not equal the passed expected value.
Helper instance used by code generated by macro assertion.
Helper instance used by code generated by macro assertion.
Assume that a boolean condition, described in String
message, is true.
Assume that a boolean condition, described in String
message, is true.
If the condition is true, this method returns normally.
Else, it throws TestCanceledException with the
String obtained by invoking toString on the
specified clue as the exception's detail message.
the boolean condition to assume
An objects whose toString method returns a message to include in a failure report.
if message is null.
if the condition is false.
Assume that a boolean condition is true.
Assume that a boolean condition is true.
If the condition is true, this method returns normally.
Else, it throws TestCanceledException.
This method is implemented in terms of a Scala macro that will generate a more helpful error message for simple quality checks of this form:
Any other form of expression will just get a plain-old TestCanceledException at this time. 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, not Option[String] to be
the default in tests. This makes === consistent between tests and production code. If you have pre-existing
code you wrote under ScalaTest 1.x, in which you are expecting=== to return an Option[String],
use can get that behavior back by mixing in trait LegacyTripleEquals.
the boolean condition to assume
if the condition is false.
Supports shared test registration in FlatSpecs.
Supports shared test registration in FlatSpecs.
This field supports syntax such as the following:
it should behave like nonFullStack(stackWithOneItem)
^
For more information and examples of the use of behave, see the Shared tests section
in the main documentation for this trait.
Supports the registration of a “subject” being specified and tested.
Supports the registration of a “subject” being specified and tested.
This field enables syntax such as the following subject registration:
behavior of "A Stack"
^
For more information and examples of the use of the behavior field, see the main documentation
for this trait.
Throws TestCanceledException, with the passed
Throwable cause, to indicate a test failed.
Throws TestCanceledException, with the passed
Throwable cause, to indicate a test failed.
The getMessage method of the thrown TestCanceledException
will return cause.toString.
a Throwable that indicates the cause of the cancellation.
if cause is null
Throws TestCanceledException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
Throws TestCanceledException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
A message describing the failure.
A Throwable that indicates the cause of the failure.
if message or cause is null
Throws TestCanceledException, with the passed
String message as the exception's detail
message, to indicate a test was canceled.
Throws TestCanceledException, with the passed
String message as the exception's detail
message, to indicate a test was canceled.
A message describing the cancellation.
if message is null
Throws TestCanceledException to indicate a test was canceled.
Throws TestCanceledException to indicate a test was canceled.
Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that B is
implicitly convertible to A, given an implicit Equivalence[A].
Provides a Constraint[A, B] class 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
ConversionCheckedLegacyTripleEquals, and
overriden as non-implicit by the other subtraits in this package.
an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.
an implicit conversion from B to A
a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of
the passed Equivalence[A].
Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint
that A must be a subtype of B, given an explicit Equivalence[B].
Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint
that A must be a subtype of B, given an explicit Equivalence[B].
This method is used to enable the Explicitly DSL for
TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but
taking an implicit function that provides evidence that A is a subtype of B.
The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s
areEquivalent method to determine equality.
This method is overridden and made implicit by subtraits
LowPriorityTypeCheckedConstraint (extended by
TypeCheckedTripleEquals), and
LowPriorityTypeCheckedLegacyConstraint (extended by
TypeCheckedLegacyTripleEquals), and
overriden as non-implicit by the other subtraits in this package.
an Equivalence[B] type class to which the Constraint.areEqual method
will delegate to determine equality.
evidence that A is a subype of B
a Constraint[A, B] whose areEqual method delegates to the
areEquivalent method of the passed Equivalence[B].
Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that A is
implicitly convertible to B, given an explicit Equivalence[B].
Provides a Constraint[A, B] class 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
LowPriorityConversionCheckedLegacyConstraint (extended by
ConversionCheckedLegacyTripleEquals), and
overriden as non-implicit by the other subtraits in this package.
a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of
the passed Equivalence[B].
Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint
that B must be a subtype of A, given an explicit Equivalence[A].
Provides a Constraint[A, B] 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
TypeCheckedLegacyTripleEquals, and
overriden as non-implicit by the other subtraits in this package.
evidence that B is a subype of A
a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of
the passed Equivalence[A].
Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that B is
implicitly convertible to A, given an explicit Equivalence[A].
Provides a Constraint[A, B] class 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
ConversionCheckedLegacyTripleEquals, and
overriden as non-implicit by the other subtraits in this package.
an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.
a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of
the passed Equivalence[A].
Converts to an CheckingEqualizer that provides === and !== operators
that result in Boolean and enforce a type constraint.
Converts to an CheckingEqualizer that provides === and !== operators
that result in Boolean and enforce a type constraint.
This method is overridden and made implicit by subtraits TypeCheckedTripleEquals and
ConversionCheckedTripleEquals, and overriden as
non-implicit by the other subtraits in this package.
the object whose type to convert to CheckingEqualizer.
if left is null.
Converts to an Equalizer that provides === and !== operators that
result in Boolean and enforce no type constraint.
Converts to an Equalizer that provides === and !== operators that
result in Boolean and enforce no type constraint.
This method is overridden and made implicit by subtrait TripleEquals and overriden as non-implicit by the other
subtraits in this package.
the object whose type to convert to Equalizer.
if left is null.
Implicitly converts an object of type ResultOfStringPassedToVerb to an
InAndIgnoreMethods, to enable in and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfStringPassedToVerb to an
InAndIgnoreMethods, to enable in and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation to an
InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation to an
InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore
methods to be invokable on that object.
Converts to a LegacyCheckingEqualizer that provides === and !== operators
that result in Option[String] and enforce a type constraint.
Converts to a LegacyCheckingEqualizer that provides === and !== operators
that result in Option[String] and enforce a type constraint.
This method is overridden and made implicit by subtraits TypeCheckedLegacyTripleEquals
and ConversionCheckedLegacyTripleEquals, and
overriden as non-implicit by the other subtraits in this package.
the object whose type to convert to LegacyCheckingEqualizer.
if left is null.
Converts to a LegacyEqualizer that provides === and !== operators that
result in Option[String] and enforce no type constraint.
Converts to a LegacyEqualizer that provides === and !== operators that
result in Option[String] and enforce no type constraint.
This method is overridden and made implicit by subtrait LegacyTripleEquals and overriden as non-implicit
by the other subtraits in this package.
the object whose type to convert to LegacyEqualizer.
if left is null.
Implicitly converts an object of type String to a StringCanWrapper,
to enable can methods to be invokable on that object.
Implicitly converts an object of type String to a StringCanWrapper,
to enable can methods to be invokable on that object.
Implicitly converts an object of type String to a StringMustWrapper,
to enable must methods to be invokable on that object.
Implicitly converts an object of type String to a StringMustWrapper,
to enable must methods to be invokable on that object.
Implicitly converts an object of type String to a StringShouldWrapperForVerb,
to enable should methods to be invokable on that object.
Implicitly converts an object of type String to a StringShouldWrapperForVerb,
to enable should methods to be invokable on that object.
Returns an Equality[A] for any type A that determines equality
by first calling .deep on any Array (on either the left or right side),
then comparing the resulting objects with ==.
Returns an Equality[A] for any type A that determines equality
by first calling .deep on any Array (on either the left or right side),
then comparing the resulting objects with ==.
a default Equality for type A
Executes this Suite, printing results to the standard output.
Executes this Suite, printing results to the standard output.
This method, which simply invokes the other overloaded form of execute with default parameter values,
is intended for use only as a mini-DSL for the Scala interpreter. It allows you to execute a Suite in the
interpreter with a minimum of finger typing:
scala> new SetSpec execute An empty Set - should have size 0 - should produce NoSuchElementException when head is invoked !!! IGNORED !!!
If you do ever want to invoke execute outside the Scala interpreter, it is best style to invoke it with
empty parens to indicate it has a side effect, like this:
// Use empty parens form in regular code (outside the Scala interpreter) (new ExampleSuite).execute()
Executes one or more tests in this Suite, printing results to the standard output.
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 outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set()
for tagsToExcludeconfigMap - the configMap passed to this methoddistributor - Nonetracker - a new TrackerNote: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this method isn't named run is that it takes advantage of
default arguments, and you can't mix overloaded methods and default arguments in Scala. (If named run,
this method would have the same name but different arguments than the main run method that
takes seven arguments. Thus it would overload and couldn't be used with default argument values.)
Design note: This method has two "features" that may seem unidiomatic. First, the default value of testName is null.
Normally in Scala the type of testName would be Option[String] and the default value would
be None, as it is in this trait's run method. The null value is used here for two reasons. First, in
ScalaTest 1.5, execute was changed from four overloaded methods to one method with default values, taking advantage of
the default and named parameters feature introduced in Scala 2.8.
To not break existing source code, testName needed to have type String, as it did in two of the overloaded
execute methods prior to 1.5. The other reason is that execute has always been designed to be called primarily
from an interpeter environment, such as the Scala REPL (Read-Evaluate-Print-Loop). In an interpreter environment, minimizing keystrokes is king.
A String type with a null default value lets users type suite.execute("my test name") rather than
suite.execute(Some("my test name")), saving several keystrokes.
The second non-idiomatic feature is that shortstacks and fullstacks are all lower case rather than
camel case. This is done to be consistent with the Shell, which also uses those forms. The reason
lower case is used in the Shell is to save keystrokes in an interpreter environment. Most Unix commands, for
example, are all lower case, making them easier and quicker to type. In the ScalaTest
Shell, methods like shortstacks, fullstacks, and nostats, etc., are
designed to be all lower case so they feel more like shell commands than methods.
the name of one test to run.
a Map of key-value pairs that can be used by the executing Suite of tests.
a boolean that configures whether output is printed in color
a boolean that configures whether test and suite durations are printed to the standard output
a boolean that configures whether short stack traces should be printed for test failures
a boolean that configures whether full stack traces should be printed for test failures
a boolean that configures whether test and suite statistics are printed to the standard output
if testName is defined, but no test with the specified test name
exists in this Suite
if the passed configMap parameter is null.
The total number of tests that are expected to run when this Suite's run method is invoked.
The total number of tests that are expected to run when this Suite's run method is invoked.
This trait's implementation of this method returns the sum of:
testNames List, minus the number of tests marked as ignored and
any tests that are exluded by the passed FilterexpectedTestCount on every nested Suite contained in
nestedSuitesa Filter with which to filter tests to count based on their tags
Throws TestFailedException, with the passed
Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passed
Throwable cause, to indicate a test failed.
The getMessage method of the thrown TestFailedException
will return cause.toString.
a Throwable that indicates the cause of the failure.
if cause is null
Throws TestFailedException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
A message describing the failure.
A Throwable that indicates the cause of the failure.
if message or cause is null
Throws TestFailedException, with the passed
String message as the exception's detail
message, to indicate a test failed.
Throws TestFailedException, with the passed
String message as the exception's detail
message, to indicate a test failed.
A message describing the failure.
if message is null
Throws TestFailedException to indicate a test failed.
Throws TestFailedException to indicate a test failed.
Supports registration of ignored tests in FlatSpecs.
Supports registration of ignored tests in FlatSpecs.
This field enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... }
^
For more information and examples of the use of the ignore field, see the Ignored tests section
in the main documentation for this trait.
Returns an Informer that during test execution will forward strings passed to its
apply method to the current reporter.
Returns an Informer that during test execution will forward strings passed to its
apply method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked from inside a scope,
it will forward the information to the current reporter immediately. If invoked from inside a test function,
it will record the information and forward it to the current reporter only after the test completed, as recordedEvents
of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
Intercept and return an exception that's expected to be thrown by the passed function value.
Intercept and return an exception that's expected to
be thrown by the passed function value. The thrown exception must be an instance of the
type specified by the type parameter of this method. This method invokes the passed
function. If the function throws an exception that's an instance of the specified type,
this method returns that exception. Else, whether the passed function returns normally
or completes abruptly with a different exception, this method throws TestFailedException.
Note that the type specified as this method's type parameter may represent any subtype of
AnyRef, not just Throwable or one of its subclasses. In
Scala, exceptions can be caught based on traits they implement, so it may at times make sense
to specify a trait that the intercepted exception's class must mix in. If a class instance is
passed for a type that could not possibly be used to catch an exception (such as String,
for example), this method will complete abruptly with a TestFailedException.
the function value that should throw the expected exception
an implicit Manifest representing the type of the specified
type parameter.
the intercepted exception, if it is of the expected type
if the passed function does not complete abruptly with an exception
that's an instance of the specified type
passed expected value.
Supports test (and shared test) registration in FlatSpecs.
Supports test (and shared test) registration in FlatSpecs.
This field enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... }
^
It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it field, see the main documentation
for this trait.
Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that A is
implicitly convertible to B, given an implicit Equivalence[B].
Provides a Constraint[A, B] class for any two types A and B, enforcing the type constraint that A is
implicitly convertible to B, given an implicit Equivalence[B].
The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s
areEquivalent method to determine equality.
This method is overridden and made implicit by subtraits
LowPriorityConversionCheckedConstraint (extended by
ConversionCheckedTripleEquals), and
LowPriorityConversionCheckedLegacyConstraint (extended by
ConversionCheckedLegacyTripleEquals), and
overriden as non-implicit by the other subtraits in this package.
an implicit conversion from A to B
a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of
the passed Equivalence[B].
Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint
that A must be a subtype of B, given an implicit Equivalence[B].
Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint
that A must be a subtype of B, given an implicit Equivalence[B].
The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s
areEquivalent method to determine equality.
This method is overridden and made implicit by subtraits
LowPriorityTypeCheckedConstraint (extended by
TypeCheckedTripleEquals), and
LowPriorityTypeCheckedLegacyConstraint (extended by
TypeCheckedLegacyTripleEquals), and
overriden as non-implicit by the other subtraits in this package.
an Equivalence[B] type class to which the Constraint.areEqual method
will delegate to determine equality.
evidence that A is a subype of B
a Constraint[A, B] whose areEqual method delegates to the
areEquivalent method of the passed Equivalence[B].
Returns a Documenter that during test execution will forward strings passed to its
apply method to the current reporter.
Returns a Documenter that during test execution will forward strings passed to its
apply method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked from inside a scope,
it will forward the information to the current reporter immediately. If invoked from inside a test function,
it will record the information and forward it to the current reporter only after the test completed, as recordedEvents
of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output.
This method can be called safely by any thread.
An immutable IndexedSeq of this Suite object's nested Suites.
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.
Returns a Notifier that during test execution will forward strings passed to its
apply method to the current reporter.
Returns a Notifier that during test execution will forward strings passed to its
apply method to the current reporter. If invoked in a constructor, it
will register the passed string for forwarding later during test execution. If invoked while this
FlatSpec 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.
Throws TestPendingException to indicate a test is pending.
Throws TestPendingException to indicate a test is pending.
A pending test is one that has been given a name but is not yet implemented. The purpose of pending tests is to facilitate a style of testing in which documentation of behavior is sketched out before tests are written to verify that behavior (and often, the before the behavior of the system being tested is itself implemented). Such sketches form a kind of specification of what tests and functionality to implement later.
To support this style of testing, a test can be given a name that specifies one
bit of behavior required by the system being tested. The test can also include some code that
sends more information about the behavior to the reporter when the tests run. At the end of the test,
it can call method pending, which will cause it to complete abruptly with TestPendingException.
Because tests in ScalaTest can be designated as pending with TestPendingException, both the test name and any information
sent to the reporter when running the test can appear in the report of a test run. (In other words,
the code of a pending test is executed just like any other test.) However, because the test completes abruptly
with TestPendingException, the test will be reported as pending, to indicate
the actual test, and possibly the functionality it is intended to test, has not yet been implemented.
Note: This method always completes abruptly with a TestPendingException. Thus it always has a side
effect. Methods with side effects are usually invoked with parentheses, as in pending(). This
method is defined as a parameterless method, in flagrant contradiction to recommended Scala style, because it
forms a kind of DSL for pending tests. It enables tests in suites such as FunSuite or FunSpec
to be denoted by placing "(pending)" after the test name, as in:
test("that style rules are not laws") (pending)
Readers of the code see "pending" in parentheses, which looks like a little note attached to the test name to indicate
it is pending. Whereas "(pending()) looks more like a method call, "(pending)" lets readers
stay at a higher level, forgetting how it is implemented and just focusing on the intent of the programmer who wrote the code.
Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else
throw TestFailedException.
Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else
throw TestFailedException.
This method can be used to temporarily change a failing test into a pending test in such a way that it will
automatically turn back into a failing test once the problem originally causing the test to fail has been fixed.
At that point, you need only remove the pendingUntilFixed call. In other words, a
pendingUntilFixed surrounding a block of code that isn't broken is treated as a test failure.
The motivation for this behavior is to encourage people to remove pendingUntilFixed calls when
there are no longer needed.
This method facilitates a style of testing in which tests are written before the code they test. Sometimes you may
encounter a test failure that requires more functionality than you want to tackle without writing more tests. In this
case you can mark the bit of test code causing the failure with pendingUntilFixed. You can then write more
tests and functionality that eventually will get your production code to a point where the original test won't fail anymore.
At this point the code block marked with pendingUntilFixed will no longer throw an exception (because the
problem has been fixed). This will in turn cause pendingUntilFixed to throw TestFailedException
with a detail message explaining you need to go back and remove the pendingUntilFixed call as the problem orginally
causing your test code to fail has been fixed.
a block of code, which if it completes abruptly, should trigger a TestPendingException
if the passed block of code completes abruptly with an Exception or AssertionError
The fully qualified class name of the rerunner to rerun this suite.
The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.
Runs this suite of tests.
Runs this suite of tests.
If testName is None, this trait's implementation of this method
calls these two methods on this object in this order:
runNestedSuitesrunTestsIf testName is defined, then this trait's implementation of this method
calls runTests, but does not call runNestedSuites. This behavior
is part of the contract of this method. Subclasses that override run must take
care not to call runNestedSuites if testName is defined. (The
OneInstancePerTest trait depends on this behavior, for example.)
Subclasses and subtraits that override this run method can implement them without
invoking either the runTests or runNestedSuites methods, which
are invoked by this trait's implementation of this method. It is recommended, but not required,
that subclasses and subtraits that override run in a way that does not
invoke runNestedSuites also override runNestedSuites and make it
final. Similarly it is recommended, but not required,
that subclasses and subtraits that override run in a way that does not
invoke runTests also override runTests (and runTest,
which this trait's implementation of runTests calls) and make it
final. The implementation of these final methods can either invoke the superclass implementation
of the method, or throw an UnsupportedOperationException if appropriate. The
reason for this recommendation is that ScalaTest includes several traits that override
these methods to allow behavior to be mixed into a Suite. For example, trait
BeforeAndAfterEach overrides runTestss. In a Suite
subclass that no longer invokes runTests from run, the
BeforeAndAfterEach trait is not applicable. Mixing it in would have no effect.
By making runTests final in such a Suite subtrait, you make
the attempt to mix BeforeAndAfterEach into a subclass of your subtrait
a compiler error. (It would fail to compile with a complaint that BeforeAndAfterEach
is trying to override runTests, which is a final method in your trait.)
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.
the Args for this run
a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.
if testName is defined, but no test with the specified test name
exists in this Suite
if any passed parameter is null.
This overloaded form of run has been deprecated and will be removed in a future
version of ScalaTest. Please use the run method that takes two parameters instead.
This overloaded form of run has been deprecated and will be removed in a future
version of ScalaTest. Please use the run method that takes two parameters instead.
This final implementation of this method constructs a Args instance from the passed
reporter, stopper, filter, configMap, distributor,
and tracker, and invokes the overloaded run method that takes two parameters,
passing in the specified testName and the newly constructed Args. This method
implementation enables existing code that called into the old run method to continue to work
during the deprecation cycle. Subclasses and subtraits that overrode this method, however, will need to
be changed to use the new two-parameter form instead.
an optional name of one test to execute. If None, all relevant tests should be executed.
I.e., None acts like a wildcard that means execute all relevant tests in this Suite.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be executed
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.
a Tracker tracking Ordinals being fired by the current thread.
if any passed parameter is null.
Run zero to many of this Suite's nested Suites.
Run zero to many of this Suite's nested Suites.
If the passed distributor is None, this trait's
implementation of this method invokes run on each
nested Suite in the List obtained by invoking nestedSuites.
If a nested Suite's run
method completes abruptly with an exception, this trait's implementation of this
method reports that the Suite aborted and attempts to run the
next nested Suite.
If the passed distributor is defined, this trait's implementation
puts each nested Suite
into the Distributor contained in the Some, in the order in which the
Suites appear in the List returned by nestedSuites, passing
in a new Tracker obtained by invoking nextTracker on the Tracker
passed to this method.
Implementations of this method are responsible for ensuring SuiteStarting events
are fired to the Reporter before executing any nested Suite, and either SuiteCompleted
or SuiteAborted after executing any nested Suite.
the Args for this run
a Status object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.
if any passed parameter is null.
Run a test.
Run a test. This trait's implementation runs the test registered with the name specified by
testName. Each test's name is a concatenation of the text of all describers surrounding a test,
from outside in, and the test's spec text, with one space placed between each item. (See the documenation
for testNames for an example.)
the name of one test to execute.
the Args for this run
a Status object that indicates when the test started by this method has completed, and whether or not it failed .
if any of testName, reporter, stopper, or configMap
is null.
Run zero to many of this FlatSpec's tests.
Run zero to many of this FlatSpec'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 methodreporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to itThis 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 itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to itan optional name of one test to execute. If None, all relevant tests should be executed.
I.e., None acts like a wildcard that means execute all relevant tests in this FlatSpec.
the Args for this run
a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
if any of testName, reporter, stopper, tagsToInclude,
tagsToExclude, or configMap is null.
Supports the shorthand form of shared test registration.
Supports the shorthand form of shared test registration.
For example, this method enables syntax such as the following in:
"A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
^
This function is passed as an implicit parameter to a should method
provided in ShouldVerb, a must method
provided in MustVerb, and a can method
provided in CanVerb. When invoked, this function registers the
subject description (the parameter to the function) and returns a BehaveWord.
Supports the shorthand form of test registration.
Supports the shorthand form of test registration.
For example, this method enables syntax such as the following:
"A Stack (when empty)" should "be empty" in { ... } ^
This function is passed as an implicit parameter to a should method
provided in ShouldVerb, a must method
provided in MustVerb, and a can method
provided in CanVerb. When invoked, this function registers the
subject description (the first parameter to the function) and returns a ResultOfStringPassedToVerb
initialized with the verb and rest parameters (the second and third parameters to
the function, respectively).
Suite style name.
Suite style name.
A string ID for this Suite that is intended to be unique among all suites reported during a run.
A string ID for this Suite that is intended to be unique among all suites reported during a run.
This trait's
implementation of this method returns the fully qualified name of this object's class.
Each suite reported during a run will commonly be an instance of a different Suite class,
and in such cases, this default implementation of this method will suffice. However, in special cases
you may need to override this method to ensure it is unique for each reported suite. For example, if you write
a Suite subclass that reads in a file whose name is passed to its constructor and dynamically
creates a suite of tests based on the information in that file, you will likely need to override this method
in your Suite subclass, perhaps by appending the pathname of the file to the fully qualified class name.
That way if you run a suite of tests based on a directory full of these files, you'll have unique suite IDs for
each reported suite.
The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
this Suite object's ID.
A user-friendly suite name for this Suite.
A user-friendly suite name for this Suite.
This trait's
implementation of this method returns the simple name of this object's class. This
trait's implementation of runNestedSuites calls this method to obtain a
name for Reports to pass to the suiteStarting, suiteCompleted,
and suiteAborted methods of the Reporter.
this Suite object's suite name.
A Map whose keys are String tag names to which tests in this FlatSpec belong, and values
the Set of test names that belong to each tag.
A Map whose keys are String tag names to which tests in this FlatSpec belong, and values
the Set of test names that belong to each tag. If this FlatSpec 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
methods test and ignore.
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 @Ignore.
Provides a TestData instance for the passed test name, given the passed config map.
Provides a TestData instance for the passed test name, given the passed config map.
This method is used to obtain a TestData instance to pass to withFixture(NoArgTest)
and withFixture(OneArgTest) and the beforeEach and afterEach methods
of trait BeforeAndAfterEach.
the name of the test for which to return a TestData instance
the config map to include in the returned TestData
a TestData instance for the specified test, which includes the specified config map
An immutable Set of test names.
An immutable Set of test names. If this FlatSpec 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 FlatSpec:
import org.scalatest.FlatSpec
class StackSpec extends FlatSpec {
"A Stack (when not empty)" must "allow me to pop" in {} it must "not be empty" in {}
"A Stack (when not full)" must "allow me to push" in {} it must "not be full" in {} }
Invoking testNames on this FlatSpec will yield a set that contains the following
two test name strings:
"A Stack (when not empty) must allow me to pop" "A Stack (when not empty) must not be empty" "A Stack (when not full) must allow me to push" "A Stack (when not full) must not be full"
Supports test (and shared test) registration in FlatSpecs.
Supports test (and shared test) registration in FlatSpecs.
This field enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... }
^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it field, see the main documentation
for this trait.
Returns a user friendly string for this suite, composed of the
simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite
contains nested suites, the result of invoking toString on each
of the nested suites, separated by commas and surrounded by parentheses.
Returns a user friendly string for this suite, composed of the
simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite
contains nested suites, the result of invoking toString on each
of the nested suites, separated by commas and surrounded by parentheses.
a user-friendly string for this suite
Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException
indicating no exception is thrown.
Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException
indicating no exception is thrown.
This method is intended to be used in the Scala interpreter to eliminate large stack traces when trying out ScalaTest assertions and
matcher expressions. It is not intended to be used in regular test code. If you want to ensure that a bit of code throws an expected
exception, use intercept, not trap. Here's an example interpreter session without trap:
scala> import org.scalatest._ import org.scalatest._scala> import Matchers._ import Matchers._
scala> val x = 12 a: Int = 12
scala> x shouldEqual 13 org.scalatest.exceptions.TestFailedException: 12 did not equal 13 at org.scalatest.Assertions$class.newAssertionFailedException(Assertions.scala:449) at org.scalatest.Assertions$.newAssertionFailedException(Assertions.scala:1203) at org.scalatest.Assertions$AssertionsHelper.macroAssertTrue(Assertions.scala:417) at .<init>(<console>:15) at .<clinit>(<console>) at .<init>(<console>:7) at .<clinit>(<console>) at $print(<console>) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) at java.lang.reflect.Method.invoke(Method.java:597) at scala.tools.nsc.interpreter.IMain$ReadEvalPrint.call(IMain.scala:731) at scala.tools.nsc.interpreter.IMain$Request.loadAndRun(IMain.scala:980) at scala.tools.nsc.interpreter.IMain.loadAndRunReq$1(IMain.scala:570) at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:601) at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:565) at scala.tools.nsc.interpreter.ILoop.reallyInterpret$1(ILoop.scala:745) at scala.tools.nsc.interpreter.ILoop.interpretStartingWith(ILoop.scala:790) at scala.tools.nsc.interpreter.ILoop.command(ILoop.scala:702) at scala.tools.nsc.interpreter.ILoop.processLine$1(ILoop.scala:566) at scala.tools.nsc.interpreter.ILoop.innerLoop$1(ILoop.scala:573) at scala.tools.nsc.interpreter.ILoop.loop(ILoop.scala:576) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply$mcZ$sp(ILoop.scala:867) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822) at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822) at scala.tools.nsc.util.ScalaClassLoader$.savingContextLoader(ScalaClassLoader.scala:135) at scala.tools.nsc.interpreter.ILoop.process(ILoop.scala:822) at scala.tools.nsc.MainGenericRunner.runTarget$1(MainGenericRunner.scala:83) at scala.tools.nsc.MainGenericRunner.process(MainGenericRunner.scala:96) at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:105) at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala)
That's a pretty tall stack trace. Here's what it looks like when you use trap:
scala> trap { x shouldEqual 13 }
res1: Throwable = org.scalatest.exceptions.TestFailedException: 12 did not equal 13
Much less clutter. Bear in mind, however, that if no exception is thrown by the
passed block of code, the trap method will create a new NormalResult
(a subclass of Throwable made for this purpose only) and return that. If the result was the Unit value, it
will simply say that no exception was thrown:
scala> trap { x shouldEqual 12 }
res2: Throwable = No exception was thrown.
If the passed block of code results in a value other than Unit, the NormalResult's toString will print the value:
scala> trap { "Dude!" }
res3: Throwable = No exception was thrown. Instead, result was: "Dude!"
Although you can access the result value from the NormalResult, its type is Any and therefore not
very convenient to use. It is not intended that trap be used in test code. The sole intended use case for trap is decluttering
Scala interpreter sessions by eliminating stack traces when executing assertion and matcher expressions.
Provides a Constraint[A, B] for any two types A and B, enforcing the type constraint
that B must be a subtype of A, given an implicit Equivalence[A].
Provides a Constraint[A, B] 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
TypeCheckedLegacyTripleEquals, and
overriden as non-implicit by the other subtraits in this package.
evidence that B is a subype of A
a Constraint[A, B] whose areEqual method delegates to the areEquivalent method of
the passed Equivalence[A].
Provides a Constraint[A, B] class for any two types A and B, with no type constraint enforced, given an
implicit Equality[A].
Provides a Constraint[A, B] class 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
LegacyTripleEquals, and
overriden as non-implicit by the other subtraits in this package.
an Equality[A] type class to which the Constraint.areEqual method will delegate to determine equality.
a Constraint[A, B] whose areEqual method delegates to the areEqual method of
the passed Equality[A].
Executes the block of code passed as the second parameter, and, if it
completes abruptly with a ModifiableMessage exception,
prepends the "clue" string passed as the first parameter to the beginning of the detail message
of that thrown exception, then rethrows it.
Executes the block of code passed as the second parameter, and, if it
completes abruptly with a ModifiableMessage exception,
prepends the "clue" string passed as the first parameter to the beginning of the detail message
of that thrown exception, then rethrows it. If clue does not end in a white space
character, one space will be added
between it and the existing detail message (unless the detail message is
not defined).
This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:
withClue("(Employee's name was: " + employee.name + ")") { intercept[IllegalArgumentException] { employee.getTask(-1) } }
If an invocation of intercept completed abruptly with an exception, the resulting message would be something like:
(Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown
if the passed clue is null
Run the passed test function in the context of a fixture established by this method.
Run the passed test function in the context of a fixture established by this method.
This method should set up the fixture needed by the tests of the
current suite, invoke the test function, and if needed, perform any clean
up needed after the test completes. Because the NoArgTest function
passed to this method takes no parameters, preparing the fixture will require
side effects, such as reassigning instance vars in this Suite or initializing
a globally accessible external database. If you want to avoid reassigning instance vars
you can use fixture.Suite.
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.
the no-arg test function to run with a fixture
Assert that an Option[String] is None.
Assert that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestFailedException with the String
value of the Some included in the TestFailedException's
detail message.
This form of assert is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b)
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
This method has been deprecated in favor of macro assertion and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.
if the Option[String] is Some.
Assert that an Option[String] is None.
Assert that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestFailedException with the String
value of the Some, as well as the
String obtained by invoking toString on the
specified clue,
included in the TestFailedException's detail message.
This form of assert is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b, "extra info reported if assertion fails")
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
An object whose toString method returns a message to include in a failure report.
This method has been deprecated in favor of macro assertion and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.
if message is null.
if the Option[String] is Some.
Assume that an Option[String] is None.
Assume that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestCanceledException with the String
value of the Some included in the TestCanceledException's
detail message.
This form of assume is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assume(a === b)
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
This method has been deprecated in favor of macro assumption and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.
if the Option[String] is Some.
Assume that an Option[String] is None.
Assume that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestCanceledException with the String
value of the Some, as well as the
String obtained by invoking toString on the
specified clue,
included in the TestCanceledException's detail message.
This form of assume is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assume(a === b, "extra info reported if assertion fails")
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
An object whose toString method returns a message to include in a failure report.
This method has been deprecated in favor of macro assumption and will be removed in a future version of ScalaTest. If you need this, please copy the source code into your own trait instead.
if message is null.
if the Option[String] is Some.
This expect method has been deprecated; Please use assertResult instead.
This expect method has been deprecated; Please use assertResult instead.
To get rid of the deprecation warning, simply replace expect with
assertResult. The name expect will be used for a different purposes in
a future version of ScalaTest.
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of assertResult instead.
This expect method has been deprecated; Please use assertResult instead.
This expect method has been deprecated; Please use assertResult instead.
To get rid of the deprecation warning, simply replace expect with
assertResult. The name expect will be used for a different purposes in
a future version of ScalaTest.
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of assertResult instead.
This expectResult method has been deprecated; Please use assertResult instead.
This expectResult method has been deprecated; Please use assertResult instead.
To get rid of the deprecation warning, simply replace expectResult with
assertResult. The name expectResult will be used for a different purposes in
a future version of ScalaTest.
This expectResult method has been deprecated. Please replace all invocations of expectResult with an identical invocation of assertResult instead.
This expectResult method has been deprecated; Please use assertResult instead.
This expectResult method has been deprecated; Please use assertResult instead.
To get rid of the deprecation warning, simply replace expectResult with
assertResult. The name expectResult will be used for a different purposes in
a future version of ScalaTest.
This expectResult method has been deprecated. Please replace all invocations of expectResult with an identical invocation of assertResult instead.
Facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.
FlatSpecis a good first step for teams wishing to move from xUnit to BDD, because its structure is flat like xUnit, so simple and familiar, but the test names must be written in a specification style: “X should Y,” “A must B,” etc.Trait
FlatSpecis so named because your specification text and tests line up flat against the left-side indentation level, with no nesting needed. Here's an exampleFlatSpec:Note: you can use
mustorcanas well asshouldin aFlatSpec. For example, instead ofit should "pop..., you could writeit must "pop... orit can "pop....Instead of using a
behavior ofclause, you can alternatively use a shorthand syntax in which you replace the firstitwith the subject string, like this:Running either of the two previous three versions of
SetSpecin the Scala interpreter would yield:An empty Set - should have size 0 - should produce NoSuchElementException when head is invokedIn a
FlatSpecyou write a one (or more) sentence specification for each bit of behavior you wish to specify and test. Each specification sentence has a "subject," which is sometimes called the system under test (or SUT). The subject is the entity being specified and tested and also serves as the subject of the sentences you write for each test. Often you will want to write multiple tests for the same subject. In aFlatSpec, you name the subject once, with abehavior ofclause or its shorthand, then write tests for that subject withit should/must/can "do something"phrases. Eachitrefers to the most recently declared subject. For example, the four tests shown in this snippet are all testing a stack that contains one item:The same is true if the tests are written using the shorthand notation:
In a
FlatSpec, therefore, to figure out what "it" means, you just scan vertically until you find the most recent use ofbehavior ofor the shorthand notation.Because sometimes the subject could be plural, you can alternatively use
theyinstead ofit:A
FlatSpec's lifecycle has two phases: the registration phase and the ready phase. It starts in registration phase and enters ready phase the first timerunis called on it. It then remains in ready phase for the remainder of its lifetime.Tests can only be registered while the
FlatSpecis in its registration phase. Any attempt to register a test after theFlatSpechas entered its ready phase, i.e., afterrunhas been invoked on theFlatSpec, will be met with a thrownTestRegistrationClosedException. The recommended style of usingFlatSpecis to register tests during object construction as is done in all the examples shown here. If you keep to the recommended style, you should never see aTestRegistrationClosedException.Ignored tests
To support the common use case of temporarily disabling a test, with the good intention of resurrecting the test at a later time,
FlatSpecprovides a methodignorethat can be used instead ofitortheyto register a test. For example, to temporarily disable the test with the name"An empty Set should produce NoSuchElementException when head is invoked", just change “it” into “ignore,” like this:If you run this version of
SetSpecwith:It will run only the first test and report that the second test was ignored:
When using shorthand notation, you won't have an
itto change intoignorefor the first test of each new subject. To ignore such tests, you must instead changeintoignore. For example, to temporarily disable the test with the name"An empty Set should have size 0", change “in” into “ignore” like this:If you run this version of
StackSpecwith:It will run only the second test and report that the first test was ignored:
If you wish to temporarily ignore an entire suite of tests, you can annotate the test class with
@Ignore, like this:When you mark a test class with a tag annotation, ScalaTest will mark each test defined in that class with that tag. Thus, marking the
SetSpecin the above example with the@Ignoretag annotation means that both tests in the class will be ignored. If you run the aboveSetSpecin the Scala interpreter, you'll see:Note that marking a test class as ignored won't prevent it from being discovered by ScalaTest. Ignored classes will be discovered and run, and all their tests will be reported as ignored. This is intended to keep the ignored class visible, to encourage the developers to eventually fix and “un-ignore” it. If you want to prevent a class from being discovered at all, use the
DoNotDiscoverannotation instead.Informers
One of the parameters to
FlatSpec'srunmethod is aReporter, which will collect and report information about the running suite of tests. Information about suites and tests that were run, whether tests succeeded or failed, and tests that were ignored will be passed to theReporteras the suite runs. Most often the reporting done by default byFlatSpec's methods will be sufficient, but occasionally you may wish to provide custom information to theReporterfrom a test. For this purpose, anInformerthat will forward information to the currentReporteris provided via theinfoparameterless method. You can pass the extra information to theInformervia itsapplymethod. TheInformerwill then pass the information to theReportervia anInfoProvidedevent.One use case for the
Informeris to pass more information about a specification to the reporter. For example, theGivenWhenThentrait provides methods that use the implicitinfoprovided byFlatSpecto pass such information to the reporter. Here's an example:If you run this
FlatSpecfrom the interpreter, you will see the following output:scala> new SetSpec execute SetSpec: A mutable Set - should allow an element to be added + Given an empty mutable Set + When an element is added + Then the Set should have size 1 + And the Set should contain the added element + That's all folks!Documenters
FlatSpecalso provides amarkupmethod that returns aDocumenter, which allows you to send to theReportertext formatted in Markdown syntax. You can pass the extra information to theDocumentervia itsapplymethod. TheDocumenterwill then pass the information to theReportervia anMarkupProvidedevent.Here's an example
FlatSpecthat usesmarkup:Although all of ScalaTest's built-in reporters will display the markup text in some form, the HTML reporter will format the markup information into HTML. Thus, the main purpose of
markupis to add nicely formatted text to HTML reports. Here's what the aboveSetSpecwould look like in the HTML reporter:Notifiers and alerters
ScalaTest records text passed to
infoandmarkupduring tests, and sends the recorded text in therecordedEventsfield of test completion events likeTestSucceededandTestFailed. This allows string reporters (like the standard out reporter) to showinfoandmarkuptext after the test name in a color determined by the outcome of the test. For example, if the test fails, string reporters will show theinfoandmarkuptext in red. If a test succeeds, string reporters will show theinfoandmarkuptext in green. While this approach helps the readability of reports, it means that you can't useinfoto get status updates from long running tests.To get immediate (i.e., non-recorded) notifications from tests, you can use
note(aNotifier) andalert(anAlerter). Here's an example showing the differences:Because
noteandalertinformation is sent immediately, it will appear before the test name in string reporters, and its color will be unrelated to the ultimate outcome of the test:notetext will always appear in green,alerttext will always appear in yellow. Here's an example:In summary, use
infoandmarkupfor text that should form part of the specification output. Usenoteandalertto send status notifications. (Because the HTML reporter is intended to produce a readable, printable specification,infoandmarkuptext will appear in the HTML report, butnoteandalerttext will not.)Pending tests
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, before the behavior of the system being tested is itself implemented). Such sketches form a kind of specification of what tests and functionality to implement later.
To support this style of testing, a test can be given a name that specifies one bit of behavior required by the system being tested. The test can also include some code that sends more information about the behavior to the reporter when the tests run. At the end of the test, it can call method
pending, which will cause it to complete abruptly withTestPendingException.Because tests in ScalaTest can be designated as pending 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 withTestPendingException, the test will be reported as pending, to indicate the actual test, and possibly the functionality it is intended to test, has not yet been implemented. You can mark tests as pending inFlatSpeclike this:If you run this version of
FlatSpecwith:It will run both tests but report that
An empty Set should have size 0is pending. You'll see:One difference between an ignored test and a pending one is that an ignored test is intended to be used during a significant refactorings of the code under test, when tests break and you don't want to spend the time to fix all of them immediately. You can mark some of those broken tests as ignored temporarily, so that you can focus the red bar on just failing tests you actually want to fix immediately. Later you can go back and fix the ignored tests. In other words, by ignoring some failing tests temporarily, you can more easily notice failed tests that you actually want to fix. By contrast, a pending test is intended to be used before a test and/or the code under test is written. Pending indicates you've decided to write a test for a bit of behavior, but either you haven't written the test yet, or have only written part of it, or perhaps you've written the test but don't want to implement the behavior it tests until after you've implemented a different bit of behavior you realized you need first. Thus ignored tests are designed to facilitate refactoring of existing code whereas pending tests are designed to facilitate the creation of new code.
One other difference between ignored and pending tests is that ignored tests are implemented as a test tag that is excluded by default. Thus an ignored test is never executed. By contrast, a pending test is implemented as a test that throws
TestPendingException(which is what calling thependingmethod does). Thus the body of pending tests are executed up until they throwTestPendingException. The reason for this difference is that it enables your unfinished test to sendInfoProvidedmessages to the reporter before it completes abruptly withTestPendingException, as shown in the previous example onInformers that used theGivenWhenThentrait. For example, the following snippet in aFlatSpec:Would yield the following output when run in the interpreter:
Tagging tests
A
FlatSpec's tests may be classified into groups by tagging them with string names. As with any suite, when executing aFlatSpec, groups of tests can optionally be included and/or excluded. To tag aFlatSpec's tests, you pass objects that extend classorg.scalatest.Tagto methods that register tests. ClassTagtakes one parameter, a string name. If you have created tag annotation interfaces as described in theTagdocumentation, then you will probably want to use tag names on your test functions that match. To do so, simply pass the fully qualified names of the tag interfaces to theTagconstructor. For example, if you've defined tag annotation interfaces with fully qualified names,com.mycompany.tags.SlowTestandcom.mycompany.tags.DbTest, then you could create matching tags forFlatSpecs like this:Given these definitions, you could place
FlatSpectests into groups like this:This code marks both tests with the
com.mycompany.tags.SlowTesttag, and the second test with thecom.mycompany.tags.DbTesttag.The
runmethod takes aFilter, whose constructor takes an optionalSet[String]calledtagsToIncludeand aSet[String]calledtagsToExclude. IftagsToIncludeisNone, all tests will be run except those those belonging to tags listed in thetagsToExcludeSet. IftagsToIncludeis defined, only tests belonging to tags mentioned in thetagsToIncludeset, and not mentioned intagsToExclude, will be run.It is recommended, though not required, that you create a corresponding tag annotation when you create a
Tagobject. A tag annotation allows you to tag all the tests of aFlatSpecin one stroke by annotating the class. For more information and examples, see the documentation for classTag.Shared fixtures
A test fixture is composed of the objects and other artifacts (files, sockets, database connections, etc.) tests use to do their work. When multiple tests need to work with the same fixtures, it is important to try and avoid duplicating the fixture code across those tests. The more code duplication you have in your tests, the greater drag the tests will have on refactoring the actual production code.
ScalaTest recommends three techniques to eliminate such code duplication:
withFixtureEach technique is geared towards helping you reduce code duplication without introducing instance
vars, shared mutable objects, or other dependencies between tests. Eliminating shared mutable state across tests will make your test code easier to reason about and more amenable for parallel test execution.The following sections describe these techniques, including explaining the recommended usage for each. But first, here's a table summarizing the options:
withFixturewhen most or all tests need the same fixture.withFixture(NoArgTest)withFixture(OneArgTest)instead)withFixture(OneArgTest)BeforeAndAfterBeforeAndAfterEachCalling get-fixture methods
If you need to create the same mutable fixture objects in multiple tests, and don't need to clean them up after using them, the simplest approach is to write one or more get-fixture methods. A get-fixture method returns a new instance of a needed fixture object (or a holder object containing multiple fixture objects) each time it is called. You can call a get-fixture method at the beginning of each test that needs the fixture, storing the returned object or objects in local variables. Here's an example:
The “
f.” in front of each use of a fixture object provides a visual indication of which objects are part of the fixture, but if you prefer, you can import the the members with “import f._” and use the names directly.If you need to configure fixture objects differently in different tests, you can pass configuration into the get-fixture method. For example, if you could pass in an initial value for a mutable fixture object as a parameter to the get-fixture method.
Instantiating fixture-context objects
An alternate technique that is especially useful when different tests need different combinations of fixture objects is to define the fixture objects as instance variables of fixture-context objects whose instantiation forms the body of tests. Like get-fixture methods, fixture-context objects are only appropriate if you don't need to clean up the fixtures after using them.
To use this technique, you define instance variables intialized with fixture objects in traits and/or classes, then in each test instantiate an object that contains just the fixture objects needed by the test. Traits allow you to mix together just the fixture objects needed by each test, whereas classes allow you to pass data in via a constructor to configure the fixture objects. Here's an example in which fixture objects are partitioned into two traits and each test just mixes together the traits it needs:
Overriding
withFixture(NoArgTest)Although the get-fixture method and fixture-context object approaches take care of setting up a fixture at the beginning of each test, they don't address the problem of cleaning up a fixture at the end of the test. If you just need to perform a side-effect at the beginning or end of a test, and don't need to actually pass any fixture objects into the test, you can override
withFixture(NoArgTest), one of ScalaTest's lifecycle methods defined in traitSuite.Trait
Suite's implementation ofrunTestpasses a no-arg test function towithFixture(NoArgTest). It iswithFixture's responsibility to invoke that test function.Suite's implementation ofwithFixturesimply invokes the function, like this:You can, therefore, override
withFixtureto perform setup before and/or cleanup after invoking the test function. If you have cleanup to perform, you should invoke the test function inside atryblock and perform the cleanup in afinallyclause, in case an exception propagates back throughwithFixture. (If a test fails because of an exception, the test function invoked by withFixture will result in aFailedwrapping the exception. Nevertheless, best practice is to perform cleanup in a finally clause just in case an exception occurs.)The
withFixturemethod is designed to be stacked, and to enable this, you should always call thesuperimplementation ofwithFixture, and let it invoke the test function rather than invoking the test function directly. That is to say, instead of writing “test()”, you should write “super.withFixture(test)”, like this:Here's an example in which
withFixture(NoArgTest)is used to take a snapshot of the working directory if a test fails, and send that information to the reporter:Running this version of
ExampleSuitein the interpreter in a directory with two files,hello.txtandworld.txtwould give the following output:scala> new ExampleSuite execute ExampleSuite: This test - should succeed - should fail *** FAILED *** 2 did not equal 3 (<console>:33) + Dir snapshot: hello.txt, world.txtNote that the
NoArgTestpassed towithFixture, in addition to anapplymethod that executes the test, also includesTestDatasuch as the test name and the config map passed torunTest. Thus you can also use the test name and configuration objects in yourwithFixtureimplementation.Calling loan-fixture methods
If you need to both pass a fixture object into a test and perform cleanup at the end of the test, you'll need to use the loan pattern. If different tests need different fixtures that require cleanup, you can implement the loan pattern directly by writing loan-fixture methods. A loan-fixture method takes a function whose body forms part or all of a test's code. It creates a fixture, passes it to the test code by invoking the function, then cleans up the fixture after the function returns.
The following example shows three tests that use two fixtures, a database and a file. Both require cleanup after, so each is provided via a loan-fixture method. (In this example, the database is simulated with a
StringBuffer.)As demonstrated by the last test, loan-fixture methods compose. Not only do loan-fixture methods allow you to give each test the fixture it needs, they allow you to give a test multiple fixtures and clean everything up afterwards.
Also demonstrated in this example is the technique of giving each test its own "fixture sandbox" to play in. When your fixtures involve external side-effects, like creating files or databases, it is a good idea to give each file or database a unique name as is done in this example. This keeps tests completely isolated, allowing you to run them in parallel if desired.
Overriding
withFixture(OneArgTest)If all or most tests need the same fixture, you can avoid some of the boilerplate of the loan-fixture method approach by using a
fixture.FlatSpecand overridingwithFixture(OneArgTest). Each test in afixture.FlatSpectakes a fixture as a parameter, allowing you to pass the fixture into the test. You must indicate the type of the fixture parameter by specifyingFixtureParam, and implement awithFixturemethod that takes aOneArgTest. ThiswithFixturemethod is responsible for invoking the one-arg test function, so you can perform fixture set up before, and clean up after, invoking and passing the fixture into the test function.To enable the stacking of traits that define
withFixture(NoArgTest), it is a good idea to letwithFixture(NoArgTest)invoke the test function instead of invoking the test function directly. To do so, you'll need to convert theOneArgTestto aNoArgTest. You can do that by passing the fixture object to thetoNoArgTestmethod ofOneArgTest. In other words, instead of writing “test(theFixture)”, you'd delegate responsibility for invoking the test function to thewithFixture(NoArgTest)method of the same instance by writing:Here's a complete example:
In this example, the tests actually required two fixture objects, a
Fileand aFileWriter. In such situations you can simply define theFixtureParamtype to be a tuple containing the objects, or as is done in this example, a case class containing the objects. For more information on thewithFixture(OneArgTest)technique, see the documentation forfixture.FlatSpec.Mixing in
BeforeAndAfterIn all the shared fixture examples shown so far, the activities of creating, setting up, and cleaning up the fixture objects have been performed during the test. This means that if an exception occurs during any of these activities, it will be reported as a test failure. Sometimes, however, you may want setup to happen before the test starts, and cleanup after the test has completed, so that if an exception occurs during setup or cleanup, the entire suite aborts and no more tests are attempted. The simplest way to accomplish this in ScalaTest is to mix in trait
BeforeAndAfter. With this trait you can denote a bit of code to run before each test withbeforeand/or after each test each test withafter, like this:Note that the only way
beforeandaftercode can communicate with test code is via some side-effecting mechanism, commonly by reassigning instancevars or by changing the state of mutable objects held from instancevals (as in this example). If using instancevars or mutable objects held from instancevals you wouldn't be able to run tests in parallel in the same instance of the test class unless you synchronized access to the shared, mutable state. This is why ScalaTest'sParallelTestExecutiontrait extendsOneInstancePerTest. By running each test in its own instance of the class, each test has its own copy of the instance variables, so you don't need to synchronize. If you mixedParallelTestExecutioninto theExampleSuiteabove, the tests would run in parallel just fine without any synchronization needed on the mutableStringBuilderandListBuffer[String]objects.Although
BeforeAndAfterprovides a minimal-boilerplate way to execute code before and after tests, it isn't designed to enable stackable traits, because the order of execution would be non-obvious. If you want to factor out before and after code that is common to multiple test suites, you should use traitBeforeAndAfterEachinstead, as shown later in the next section, composing fixtures by stacking traits.Composing fixtures by stacking traits
In larger projects, teams often end up with several different fixtures that test classes need in different combinations, and possibly initialized (and cleaned up) in different orders. A good way to accomplish this in ScalaTest is to factor the individual fixtures into traits that can be composed using the stackable trait pattern. This can be done, for example, by placing
withFixturemethods in several traits, each of which callsuper.withFixture. Here's an example in which theStringBuilderandListBuffer[String]fixtures used in the previous examples have been factored out into two stackable fixture traits namedBuilderandBuffer:By mixing in both the
BuilderandBuffertraits,ExampleSuitegets both fixtures, which will be initialized before each test and cleaned up after. The order the traits are mixed together determines the order of execution. In this case,Builderis “super” toBuffer. If you wantedBufferto be “super” toBuilder, you need only switch the order you mix them together, like this:And if you only need one fixture you mix in only that trait:
Another way to create stackable fixture traits is by extending the
BeforeAndAfterEachand/orBeforeAndAfterAlltraits.BeforeAndAfterEachhas abeforeEachmethod that will be run before each test (like JUnit'ssetUp), and anafterEachmethod that will be run after (like JUnit'stearDown). Similarly,BeforeAndAfterAllhas abeforeAllmethod that will be run before all tests, and anafterAllmethod that will be run after all tests. Here's what the previously shown example would look like if it were rewritten to use theBeforeAndAfterEachmethods instead ofwithFixture:To get the same ordering as
withFixture, place yoursuper.beforeEachcall at the end of eachbeforeEachmethod, and thesuper.afterEachcall at the beginning of eachafterEachmethod, as shown in the previous example. It is a good idea to invokesuper.afterEachin atryblock and perform cleanup in afinallyclause, as shown in the previous example, because this ensures the cleanup code is performed even ifsuper.afterEachthrows an exception.The difference between stacking traits that extend
BeforeAndAfterEachversus traits that implementwithFixtureis that setup and cleanup code happens before and after the test inBeforeAndAfterEach, but at the beginning and end of the test inwithFixture. Thus if awithFixturemethod completes abruptly with an exception, it is considered a failed test. By contrast, if any of thebeforeEachorafterEachmethods ofBeforeAndAfterEachcomplete abruptly, it is considered an aborted suite, which will result in aSuiteAbortedevent.Shared tests
Sometimes you may want to run the same test code on different fixture objects. In other words, you may want to write tests that are "shared" by different fixture objects. To accomplish this in a
FlatSpec, you first place shared tests in behavior functions. These behavior functions will be invoked during the construction phase of anyFlatSpecthat uses them, so that the tests they contain will be registered as tests in thatFlatSpec. For example, given this stack class:You may want to test the
Stackclass in different states: empty, full, with one item, with one item less than capacity, etc. You may find you have several tests that make sense any time the stack is non-empty. Thus you'd ideally want to run those same tests for three stack fixture objects: a full stack, a stack with a one item, and a stack with one item less than capacity. With shared tests, you can factor these tests out into a behavior function, into which you pass the stack fixture to use when running the tests. So in yourFlatSpecfor stack, you'd invoke the behavior function three times, passing in each of the three stack fixtures so that the shared tests are run for all three fixtures. You can define a behavior function that encapsulates these shared tests inside theFlatSpecthat uses them. If they are shared between differentFlatSpecs, however, you could also define them in a separate trait that is mixed into eachFlatSpecthat uses them.For example, here the
nonEmptyStackbehavior function (in this case, a behavior method) is defined in a trait along with another method containing shared tests for non-full stacks:Given these behavior functions, you could invoke them directly, but
FlatSpecoffers a DSL for the purpose, which looks like this:If you prefer to use an imperative style to change fixtures, for example by mixing in
BeforeAndAfterEachand reassigning astackvarinbeforeEach, you could write your behavior functions in the context of thatvar, which means you wouldn't need to pass in the stack fixture because it would be in scope already inside the behavior function. In that case, your code would look like this:it should behave like nonEmptyStack // assuming lastValuePushed is also in scope inside nonEmptyStack it should behave like nonFullStackThe recommended style, however, is the functional, pass-all-the-needed-values-in style. Here's an example:
If you load these classes into the Scala interpreter (with scalatest's JAR file on the class path), and execute it, you'll see:
scala> new SharedTestExampleSpec execute A Stack (when empty) - should be empty - should complain on peek - should complain on pop A Stack (with one item) - should be non-empty - should return the top item on peek - should not remove the top item on peek - should remove the top item on pop - should not be full - should add to the top on push A Stack (with one item less than capacity) - should be non-empty - should return the top item on peek - should not remove the top item on peek - should remove the top item on pop - should not be full - should add to the top on push A Stack (full) - should be full - should be non-empty - should return the top item on peek - should not remove the top item on peek - should remove the top item on pop - should complain on a pushOne thing to keep in mind when using shared tests is that in ScalaTest, each test in a suite must have a unique name. If you register the same tests repeatedly in the same suite, one problem you may encounter is an exception at runtime complaining that multiple tests are being registered with the same test name. A good way to solve this problem in a
FlatSpecis to make sure each invocation of a behavior function is in the context of a different set ofwhen, verb (should,must, or can), andthatclauses, which will prepend a string to each test name. For example, the following code in aFlatSpecwould register a test with the name"A Stack (when empty) should be empty":Or, using the shorthand notation:
If the
"should be empty"test was factored out into a behavior function, it could be called repeatedly so long as each invocation of the behavior function is in the context of a different combination ofwhen, verb, andthatclauses.