Spec

Trait that facilitates a “behavior-driven” style of development (BDD), in which tests
are combined with text that specifies the behavior the tests verify.
(Note: In BDD, the word example is usually used instead of test. The word test will not appear
in your code if you use WordSpec, so if you prefer the word example you can use it. However, in this documentation
the word test will be used, for clarity and to be consistent with the rest of ScalaTest.)
Here's an example Spec:

A Spec contains describe clauses and tests. You define a describe clause
with describe, and a test with it. Both
describe and it are methods, defined in
Spec, which will be invoked
by the primary constructor of StackSpec.
A describe clause names, or gives more information about, the subject (class or other entity) you are specifying
and testing. In the previous example, "A Stack"
is the subject under specification and test. With each test you provide a string (the spec text) that specifies
one bit of behavior of the subject, and a block of code that tests that behavior.
You place the spec text between the parentheses, followed by the test code between curly
braces. The test code will be wrapped up as a function passed as a by-name parameter to
it, which will register the test for later execution.

A Spec's lifecycle has two phases: the registration phase and the
ready phase. It starts in registration phase and enters ready phase the first time
run is called on it. It then remains in ready phase for the remainder of its lifetime.

Tests can only be registered with the it method while the Spec is
in its registration phase. Any attempt to register a test after the Spec has
entered its ready phase, i.e., after run has been invoked on the Spec,
will be met with a thrown TestRegistrationClosedException. The recommended style
of using Spec is 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 a
TestRegistrationClosedException.

When you execute a Spec, it will send Formatters in the events it sends to the
Reporter. ScalaTest's built-in reporters will report these events in such a way
that the output is easy to read as an informal specification of the subject being tested.
For example, if you ran StackSpec from within the Scala interpreter:

scala> (new StackSpec).execute()

You would see:

A Stack
- should pop values in last-in-first-out order
- should throw NoSuchElementException if an empty stack is popped

Shared fixtures

A test fixture is objects or other artifacts (such as files, sockets, database
connections, etc.) used by tests to do their work. You can use fixtures in
Specs with the same approaches suggested for Suite in
its documentation. The same text that appears in the test fixture
section of Suite's documentation is repeated here, with examples changed from
Suite to Spec.

If a fixture is used by only one test, then the definitions of the fixture objects can
be local to the test function, such as the objects assigned to stack and emptyStack in the
previous StackSpec examples. If multiple tests need to share a fixture, the best approach
is to assign them to instance variables. Here's a (very contrived) example, in which the object assigned
to shared is used by multiple test functions:

In some cases, however, shared mutable fixture objects may be changed by tests such that
they need to be recreated or reinitialized before each test. Shared resources such
as files or database connections may also need to
be created and initialized before, and cleaned up after, each test. JUnit offers methods setUp and
tearDown for this purpose. In ScalaTest, you can use the BeforeAndAfterEach trait,
which will be described later, to implement an approach similar to JUnit's setUp
and tearDown, however, this approach often involves reassigning vars
between tests. Before going that route, you should consider some approaches that
avoid vars. One approach is to write one or more create-fixture methods
that return a new instance of a needed object (or a tuple or case class holding new instances of
multiple objects) each time it is called. You can then call a create-fixture method at the beginning of each
test that needs the fixture, storing the fixture object or objects in local variables. Here's an example:

If different tests in the same Spec require different fixtures, you can create multiple create-fixture methods and
call the method (or methods) needed by each test at the begining of the test. If every test requires the same set of
mutable fixture objects, one other approach you can take is make them simply vals and mix in trait
OneInstancePerTest. If you mix in OneInstancePerTest, each test
will be run in its own instance of the Spec, similar to the way JUnit tests are executed.

Although the create-fixture and OneInstancePerTest approaches take care of setting up a fixture before each
test, they don't address the problem of cleaning up a fixture after the test completes. In this situation,
one option is to mix in the BeforeAndAfterEach trait.
BeforeAndAfterEach's beforeEach method will be run before, and its afterEach
method after, each test (like JUnit's setUp and tearDown
methods, respectively).
For example, you could create a temporary file before each test, and delete it afterwords, like this:

In this example, the instance variable reader is a var, so
it can be reinitialized between tests by the beforeEach method.

Although the BeforeAndAfterEach approach should be familiar to the users of most
test other frameworks, ScalaTest provides another alternative that also allows you to perform cleanup
after each test: overriding withFixture(NoArgTest).
To execute each test, Suite's implementation of the runTest method wraps an invocation
of the appropriate test method in a no-arg function. runTest passes that test function to the withFixture(NoArgTest)
method, which is responsible for actually running the test by invoking the function. Suite's
implementation of withFixture(NoArgTest) simply invokes the function, like this:

The withFixture(NoArgTest) method exists so that you can override it and set a fixture up before, and clean it up after, each test.
Thus, the previous temp file example could also be implemented without mixing in BeforeAndAfterEach, like this:

If you prefer to keep your test classes immutable, one final variation is to use the
FixtureSpec trait from the
org.scalatest.fixture package. Tests in an org.scalatest.fixture.FixtureSpec can have a fixture
object passed in as a parameter. You must indicate the type of the fixture object
by defining the Fixture type member and define a withFixture method that takes a one-arg test function.
(A FixtureSpec has two overloaded withFixture methods, therefore, one that takes a OneArgTest
and the other, inherited from Suite, that takes a NoArgTest.)
Inside the withFixture(OneArgTest) method, you create the fixture, pass it into the test function, then perform any
necessary cleanup after the test function returns. Instead of invoking each test directly, a FixtureSpec will
pass a function that invokes the code of a test to withFixture(OneArgTest). Your withFixture(OneArgTest) method, therefore,
is responsible for actually running the code of the test by invoking the test function.
For example, you could pass the temp file reader fixture to each test that needs it
by overriding the withFixture(OneArgTest) method of a FixtureSpec, like this:

It is worth noting that the only difference in the test code between the mutable
BeforeAndAfterEach approach shown here and the immutable FixtureSpec
approach shown previously is that two of the FixtureSpec's test functions take a FileReader as
a parameter via the "reader =>" at the beginning of the function. Otherwise the test code is identical.
One benefit of the explicit parameter is that, as demonstrated
by the "should work without a fixture" test, a FixtureSpec
test need not take the fixture. So you can have some tests that take a fixture, and others that don't.
In this case, the FixtureSpec provides documentation indicating which
tests use the fixture and which don't, whereas the BeforeAndAfterEach approach does not.
(If you have want to combine tests that take different fixture types in the same Spec, you can
use MultipleFixtureSpec.)

If you want to execute code before and after all tests (and nested suites) in a suite, such
want to execute code before and after all tests (and nested suites) in a suite, such
as you could do with @BeforeClass and @AfterClass
annotations in JUnit 4, you can use the beforeAll and afterAll
methods of BeforeAndAfterAll. See the documentation for BeforeAndAfterAll for
an example.

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 Spec, you first place shared tests in behavior functions. These behavior functions will be
invoked during the construction phase of any Spec that uses them, so that the tests they contain will be registered as tests in that Spec.
For example, given this stack class:

You may want to test the Stack class 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 your Spec for 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 the Spec that uses them. If they are shared
between different Specs, however, you could also define them in a separate trait that is mixed into each Spec that uses them.

For example, here the nonEmptyStack behavior 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 Spec offers a DSL for the purpose,
which looks like this:

it should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
it should behave like nonFullStack(stackWithOneItem)

If you prefer to use an imperative style to change fixtures, for example by mixing in BeforeAndAfterEach and
reassigning a stackvar in beforeEach, you could write your behavior functions
in the context of that var, 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 nonFullStack

The 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 StackSpec).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 push

One 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 Spec is to surround
each invocation of a behavior function with a describe clause, which will prepend a string to each test name.
For example, the following code in a Spec would register a test with the name "A Stack (when empty) should be empty":

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 inside a different set of describe clauses.

Tagging tests

A Spec's tests may be classified into groups by tagging them with string names.
As with any suite, when executing a Spec, groups of tests can
optionally be included and/or excluded. To tag a Spec's tests,
you pass objects that extend abstract class org.scalatest.Tag to the methods
that register tests, it and ignore. Class Tag takes one parameter,
a string name. If you have
created Java annotation interfaces for use as group names in direct subclasses of org.scalatest.Suite,
then you will probably want to use group names on your Specs that match. To do so, simply
pass the fully qualified names of the Java interfaces to the Tag constructor. For example, if you've
defined Java annotation interfaces with fully qualified names, com.mycompany.groups.SlowTest and com.mycompany.groups.DbTest, then you could
create matching groups for Specs like this:

This code marks both tests with the com.mycompany.groups.SlowTest tag,
and test "should subtract correctly" with the com.mycompany.groups.DbTest tag.

The primary run method takes a Filter, whose constructor takes an optional
Set[String]s called tagsToInclude and a Set[String] called
tagsToExclude. If tagsToInclude is None, all tests will be run
except those those belonging to tags listed in the
tagsToExcludeSet. If tagsToInclude is defined, only tests
belonging to tags mentioned in the tagsToInclude set, and not mentioned in tagsToExclude,
will be run.

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, Spec provides registration
methods that start with ignore instead of it. For example, to temporarily
disable the test with the name "should pop values in last-in-first-out order", just change “it” into “ignore,” like this:

It will run only the second test and report that the first test was ignored:

A Stack
- should pop values in last-in-first-out order !!! IGNORED !!!
- should throw NoSuchElementException if an empty stack is popped

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, 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, has not yet been implemented.

You can mark a test as pending in Spec by placing "(pending)" after the
test name, like this:

(Note: "(pending)" is the body of the test. Thus the test contains just one statement, an invocation
of the pending method, which throws TestPendingException.)
If you run this version of StackSpec with:

scala> (new StackSpec).execute()

It will run both tests, but report that the test named "A stack should pop values in last-in-first-out order" is pending. You'll see:

A Stack
- should pop values in last-in-first-out order
- should throw NoSuchElementException if an empty stack is popped (pending)

A test function taking no arguments, which also provides a test name and config map.

Value Members

def!=(arg0: AnyRef): Boolean

Attributes

final

Definition Classes

AnyRef

def!=(arg0: Any): Boolean

Attributes

final

Definition Classes

Any

def##(): Int

Attributes

final

Definition Classes

AnyRef → Any

def==(arg0: AnyRef): Boolean

Attributes

final

Definition Classes

AnyRef

def==(arg0: Any): Boolean

Attributes

final

Definition Classes

Any

defasInstanceOf[T0]: T0

Attributes

final

Definition Classes

Any

defassert(o: Option[String]): Unit

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:

defassert(o: Option[String], clue: Any): Unit

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 message,
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:

defassert(condition: Boolean, clue: Any): Unit

Assert that a boolean condition, described in Stringmessage, is true.

Assert that a boolean condition, described in Stringmessage, 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 message as the exception's detail message.

condition

the boolean condition to assert

clue

An objects whose toString method returns a message to include in a failure report.

Because trait Suite mixes in Assertions, this implicit conversion will always be
available by default in ScalaTest Suites. This is the only implicit conversion that is in scope by default in every
ScalaTest Suite. Other implicit conversions offered by ScalaTest, such as those that support the matchers DSL
or invokePrivate, must be explicitly invited into your test code, either by mixing in a trait or importing the
members of its companion object. The reason ScalaTest requires you to invite in implicit conversions (with the exception of the
implicit conversion for === operator) is because if one of ScalaTest's implicit conversions clashes with an
implicit conversion used in the code you are trying to test, your program won't compile. Thus there is a chance that if you
are ever trying to use a library or test some code that also offers an implicit conversion involving a === operator,
you could run into the problem of a compiler error due to an ambiguous implicit conversion. If that happens, you can turn off
the implicit conversion offered by this convertToEqualizer method simply by overriding the method in your
Suite subclass, but not marking it as implicit:

defdescribe(description: String)(f: ⇒ Unit): Unit

Describe a “subject” being specified and tested by the passed function value.”“

Describe a “subject” being specified and tested by the passed function value. The
passed function value may contain more describers (defined with describe) and/or tests
(defined with it). This trait's implementation of this method will register the
description string and immediately invoke the passed function.

Attributes

protected

defeq(arg0: AnyRef): Boolean

Attributes

final

Definition Classes

AnyRef

defequals(arg0: Any): Boolean

Definition Classes

AnyRef → Any

defexecute(testName: String, configMap: Map[String, Any]): Unit

Executes the test specified as testName in this Suite with the specified configMap, printing
results to the standard output.

Executes the test specified as testName in this Suite with the specified configMap, printing
results to the standard output.

This method implementation calls run on this Suite, passing in:

testName - Some(testName)

reporter - a reporter that prints to the standard output

stopper - a Stopper whose apply method always returns false

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

configMap - the specified configMapMap[String, Any]

distributor - None

tracker - a new Tracker

This method serves as a convenient way to execute a single test, passing in some objects via the configMap, especially from
within the Scala interpreter.

Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().

testName

the name of one test to run.

configMap

a Map of key-value pairs that can be used by the executing Suite of tests.

defexecute(testName: String): Unit

Executes the test specified as testName in this Suite, printing results to the standard output.

Executes the test specified as testName in this Suite, printing results to the standard output.

This method implementation calls run on this Suite, passing in:

testName - Some(testName)

reporter - a reporter that prints to the standard output

stopper - a Stopper whose apply method always returns false

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

configMap - an empty Map[String, Any]

distributor - None

tracker - a new Tracker

This method serves as a convenient way to run a single test, especially from within the Scala interpreter.

Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().

defexecute(configMap: Map[String, Any]): Unit

Executes this Suite with the specified configMap, printing results to the standard output.

Executes this Suite with the specified configMap, printing results to the standard output.

This method implementation calls run on this Suite, passing in:

testName - None

reporter - a reporter that prints to the standard output

stopper - a Stopper whose apply method always returns false

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

configMap - the specified configMapMap[String, Any]

distributor - None

tracker - a new Tracker

This method serves as a convenient way to execute a Suite, passing in some objects via the configMap, especially from within the Scala interpreter.

Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().

configMap

a Map of key-value pairs that can be used by the executing Suite of tests.

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

configMap - an empty Map[String, Any]

distributor - None

tracker - a new Tracker

This method serves as a convenient way to execute a Suite, especially from
within the Scala interpreter.

Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run
is because junit.framework.TestCase declares a run method
that takes no arguments but returns a junit.framework.TestResult. That
run method would not overload with this method if it were named run,
because it would have the same parameters but a different return type than the one
defined in TestCase. To facilitate integration with JUnit 3, therefore,
these convenience "run" methods are named execute. In particular, this allows trait
org.scalatest.junit.JUnit3Suite to extend both org.scalatest.Suite and
junit.framework.TestCase, which enables the creating of classes that
can be run with either ScalaTest or JUnit 3.

defexpect(expected: Any, clue: Any)(actual: Any): Unit

Expect that the value passed as expected equals the value passed as actual.

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

expected

the expected value

clue

An object whose toString method returns a message to include in a failure report.

deffinalize(): Unit

defgetClass(): java.lang.Class[_]

defhashCode(): Int

Definition Classes

AnyRef → Any

defignore(specText: String)(testFun: ⇒ Unit): Unit

Register a test to ignore, which has the given spec text and test function value that takes no arguments.

Register a test to ignore, which has the given spec text and test function value that takes no arguments.
This method will register the test for later ignoring via an invocation of one of the execute
methods. This method exists to make it easy to ignore an existing test by changing the call to it
to ignore without deleting or commenting out the actual test code. The test will not be executed, but a
report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
from outside in, and the passed spec text, with one space placed between each item. (See the documenation
for testNames for an example.) The resulting test name must not have been registered previously on
this Spec instance.

specText

the specification text, which will be combined with the descText of any surrounding describers
to form the test name

Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.

Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.
This method will register the test for later ignoring via an invocation of one of the execute
methods. This method exists to make it easy to ignore an existing test by changing the call to it
to ignore without deleting or commenting out the actual test code. The test will not be executed, but a
report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
from outside in, and the passed spec text, with one space placed between each item. (See the documenation
for testNames for an example.) The resulting test name must not have been registered previously on
this Spec instance.

specText

the specification text, which will be combined with the descText of any surrounding describers
to form the test name

Returns an Informer that during test execution will forward strings (and other objects) passed to its
apply method to the current reporter.

Returns an Informer that during test execution will forward strings (and other objects) 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
Spec 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
throw an exception. 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.

f

the function value that should throw the expected exception

manifest

an implicit Manifest representing the type of the specified
type parameter.

defnotifyAll(): Unit

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 Spec
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.

defpendingUntilFixed(f: ⇒ Unit): Unit

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.

f

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

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

testName

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

reporter

the Reporter to which results will be reported

stopper

the Stopper that will be consulted to determine whether to stop execution early.

filter

a Filter with which to filter tests based on their tags

configMap

a Map of key-value pairs that can be used by the executing Suite of tests.

distributor

an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.

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.

reporter

the Reporter to which results will be reported

stopper

the Stopper that will be consulted to determine whether to stop execution early.

filter

a Filter with which to filter tests based on their tags

configMap

a Map of key-value pairs that can be used by the executing Suite of tests.

distributor

an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.

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

testName

the name of one test to execute.

reporter

the Reporter to which results will be reported

stopper

the Stopper that will be consulted to determine whether to stop execution early.

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 testNameOption passed
to this method

reporter - the Reporter passed to this method, or one that wraps and delegates to it

stopper - the Stopper passed to this method, or one that wraps and delegates to it

configMap - the configMap passed to this method, or one that wraps and delegates to it

This method takes a Set of tag names that should be included (tagsToInclude), and a Set
that should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute.
If tagsToInclude is empty, all tests will be executed
except those those belonging to tags listed in the tagsToExcludeSet. 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 testNamesSet 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 testNameSet, 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 tagsToExcludeSets.
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 testNamesSet)

reporter - the Reporter passed to this method, or one that wraps and delegates to it

stopper - the Stopper passed to this method, or one that wraps and delegates to it

configMap - the configMap passed to this method, or one that wraps and delegates to it

testName

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

reporter

the Reporter to which results will be reported

stopper

the Stopper that will be consulted to determine whether to stop execution early.

filter

a Filter with which to filter tests based on their tags

configMap

a Map of key-value pairs that can be used by the executing Suite of tests.

distributor

an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.

defsuiteName: String

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.

deftestNames: Set[String]

An immutable Set of test names.

An immutable Set of test names. If this Spec 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 Spec:

deftoString(): String

defwait(): Unit

defwait(arg0: Long, arg1: Int): Unit

Attributes

final

Definition Classes

AnyRef

Annotations

@throws()

defwait(arg0: Long): Unit

Attributes

final

Definition Classes

AnyRef

Annotations

@throws()

defwithClue(clue: Any)(fun: ⇒ Unit): Unit

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:

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 FixtureSuite.

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

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