WordSpec

A sister class to org.scalatest.WordSpec that can pass a fixture object into its tests.

Recommended Usage:
Use class fixture.WordSpec in situations for which WordSpec
would be a good choice, when all or most tests need the same fixture objects
that must be cleaned up afterwards. Note: fixture.WordSpec is intended for use in special situations, with class WordSpec used for general needs. For
more insight into where fixture.WordSpec fits in the big picture, see the withFixture(OneArgTest) subsection of the Shared fixtures section in the documentation for class WordSpec.

Class fixture.WordSpec behaves similarly to class org.scalatest.WordSpec, except that tests may have a
fixture parameter. The type of the
fixture parameter is defined by the abstract FixtureParam type, which is a member of this class.
This class also has an abstract withFixture method. This withFixture method
takes a OneArgTest, which is a nested trait defined as a member of this class.
OneArgTest has an apply method that takes a FixtureParam.
This apply method is responsible for running a test.
This class's runTest method delegates the actual running of each test to withFixture(OneArgTest), passing
in the test code to run via the OneArgTest argument. The withFixture(OneArgTest) method (abstract in this class) is responsible
for creating the fixture argument and passing it to the test function.

Subclasses of this class must, therefore, do three things differently from a plain old org.scalatest.WordSpec:

define the type of the fixture parameter by specifying type FixtureParam

define the withFixture(OneArgTest) method

write tests that take a fixture parameter

(You can also define tests that don't take a fixture parameter.)

If the fixture you want to pass into your tests consists of multiple objects, you will need to combine
them into one object to use this class. One good approach to passing multiple fixture objects is
to encapsulate them in a case class. Here's an example:

case class FixtureParam(file: File, writer: FileWriter)

To enable the stacking of traits that define withFixture(NoArgTest), it is a good idea to let
withFixture(NoArgTest) invoke the test function instead of invoking the test
function directly. To do so, you'll need to convert the OneArgTest to a NoArgTest. You can do that by passing
the fixture object to the toNoArgTest method of OneArgTest. In other words, instead of
writing “test(theFixture)”, you'd delegate responsibility for
invoking the test function to the withFixture(NoArgTest) method of the same instance by writing:

If a test fails, the OneArgTest function will result in a Failed wrapping the exception describing the failure.
To ensure clean up happens even if a test fails, you should invoke the test function from inside a try block and do the cleanup in a
finally clause, as shown in the previous example.

Sharing fixtures across classes

If multiple test classes need the same fixture, you can define the FixtureParam and withFixture(OneArgTest) implementations
in a trait, then mix that trait into the test classes that need it. For example, if your application requires a database and your integration tests
use that database, you will likely have many test classes that need a database fixture. You can create a "database fixture" trait that creates a
database with a unique name, passes the connector into the test, then removes the database once the test completes. This is shown in the following example:

Often when you create fixtures in a trait like DbFixture, you'll still need to enable individual test classes
to "setup" a newly created fixture before it gets passed into the tests. A good way to accomplish this is to pass the newly
created fixture into a setup method, like populateDb in the previous example, before passing it to the test
function. Classes that need to perform such setup can override the method, as does ExampleSpec.

If a test doesn't need the fixture, you can indicate that by providing a no-arg instead of a one-arg function, as is done in the
third test in the previous example, “Test code should be clear”. In other words, instead of starting your function literal
with something like “db =>”, you'd start it with “() =>”. For such tests, runTest
will not invoke withFixture(OneArgTest). It will instead directly invoke withFixture(NoArgTest).

Both examples shown above demonstrate 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 these examples. This keeps tests completely isolated, allowing you to run them in parallel if desired. You could mix
ParallelTestExecution into either of these ExampleSpec classes, and the tests would run in parallel just fine.

Instance Constructors

newWordSpec()

Type Members

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

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

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

Running the previous fixture.WordSpec in the Scala interpreter would yield:

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

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

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

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

Abstract Value Members

This method should create the fixture object needed by the tests of the
current suite, invoke the test function (passing in the fixture object),
and if needed, perform any clean up needed after the test completes.
For more detail and examples, see the main documentation for this trait.

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

Running the previous fixture.WordSpec in the Scala interpreter would yield:

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

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

Returns an Alerter 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
fixture.WordSpec 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.

final defasInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

condition

the boolean condition to assert

clue

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

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

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

assert(a == b)

assert(a != b)

assert(a === b)

assert(a !== b)

assert(a > b)

assert(a >= b)

assert(a < b)

assert(a <= b)

assert(a startsWith "prefix")

assert(a endsWith "postfix")

assert(a contains "something")

assert(a eq b)

assert(a ne b)

assert(a > 0 && b > 5)

assert(a > 0 || b > 5)

assert(a.isEmpty)

assert(!a.isEmpty)

assert(a.isInstanceOf[String])

assert(a.length == 8)

assert(a.size == 8)

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

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

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

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

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

assertCompiles("val a: Int = 1")

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

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

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

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

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

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

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

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

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.

expected

the expected value

clue

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

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

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

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

assertTypeError("val a: String = 1")

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

condition

the boolean condition to assume

clue

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

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

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

assume(a == b)

assume(a != b)

assume(a === b)

assume(a !== b)

assume(a > b)

assume(a >= b)

assume(a < b)

assume(a <= b)

assume(a startsWith "prefix")

assume(a endsWith "postfix")

assume(a contains "something")

assume(a eq b)

assume(a ne b)

assume(a > 0 && b > 5)

assume(a > 0 || b > 5)

assume(a.isEmpty)

assume(!a.isEmpty)

assume(a.isInstanceOf[String])

assume(a.length == 8)

assume(a.size == 8)

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

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

defdefaultEquality[A]: Equality[A]

final defeq(arg0: AnyRef): Boolean

defequals(arg0: Any): Boolean

Definition Classes

AnyRef → Any

final defexecute: Unit

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:

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:

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

scala> new ExampleSuite execute (color = false)

The durations parameter

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

scala> new ExampleSuite execute (durations = true)

The shortstacks and fullstacks parameters

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

scala> new ExampleSuite execute (shortstacks = true)

For full stack traces, set fullstacks to true:

scala> new ExampleSuite execute (fullstacks = true)

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

The stats parameter

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

scala> new ExampleSuite execute (stats = true)

To summarize, this method will pass to run:

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

reporter - a reporter that prints to the standard output

stopper - a Stopper whose apply method always returns false

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

configMap - the configMap passed to this method

distributor - None

tracker - a new Tracker

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

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

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

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.

color

a boolean that configures whether output is printed in color

durations

a boolean that configures whether test and suite durations are printed to the standard output

shortstacks

a boolean that configures whether short stack traces should be printed for test failures

fullstacks

a boolean that configures whether full stack traces should be printed for test failures

stats

a boolean that configures whether test and suite statistics are printed to the standard output

final defgetClass(): Class[_]

defhashCode(): Int

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.

f

the function value that should throw the expected exception

classTag

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

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.

final defne(arg0: AnyRef): Boolean

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 (and other objects) passed to its
apply method to the current reporter.

Returns a Notifier 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
fixture.WordSpec 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.

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

f

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

defrerunner: Option[String]

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.

If testName is None, this trait's implementation of this method
calls these two methods on this object in this order:

runNestedSuites

runTests

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.

args

the Args for this run

returns

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

args

the Args for this run

returns

a Status object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.

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.

args

the Args for this run

returns

a Status object that indicates when the test started by this method has completed, and whether or not it failed .

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 with passed args.

This method takes an args that contains 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 with passed args.

testName

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

args

the Args for this run

returns

a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.

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

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

defsuiteId: String

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.

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.

final defsynchronized[T0](arg0: ⇒ T0): T0

Definition Classes

AnyRef

deftags: Map[String, Set[String]]

A Map whose keys are String tag names to which tests in this WordSpec 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 WordSpec belong, and values
the Set of test names that belong to each tag. If this fixture.WordSpec 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.

deftestNames: Set[String]

An immutable Set of test names.

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

deftoString(): String

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.

deftrap[T](f: ⇒ T): Throwable

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:

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:

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.

final defwait(): Unit

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

Definition Classes

AnyRef

Annotations

@throws(...)

final defwait(arg0: Long): Unit

Definition Classes

AnyRef

Annotations

@throws(...)

defwithClue[T](clue: Any)(fun: ⇒ T): T

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