MultipleFixtureFeatureSpec

MultipleFixtureFeatureSpec has been deprecated and will be removed in a future version of ScalaTest.
Please use FixtureFeatureSpec with ConfigMapFixture instead.

I deprecated this trait because I decided using explicit calls to with-fixture methods is preferrable to implicitly
calling them, as was recommended and made slightly less concise by this trait. You can of course continue to use
the implicit conversion approach if you prefer it. To get rid of this deprecation warning,
just change "MultipleFixtureFeatureSpec" to "FixtureFeatureSpec with ConfigMapFixture" in your code. - Bill Venners

def!=(arg0: Any): Boolean

def##(): Int

def==(arg0: AnyRef): Boolean

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.

defclone(): AnyRef

Implicitly converts a function that takes no parameters and results in Any to
a function from FixtureParam to Any, to enable no-arg tests to registered
by methods that require a test function that takes a FixtureParam.

Implicitly converts a function that takes no parameters and results in Any to
a function from FixtureParam to Any, to enable no-arg tests to registered
by methods that require a test function that takes a FixtureParam.

Implicitly converts a function that takes no parameters and results in PendingNothing to
a function from FixtureParam to Any, to enable pending tests to registered as by-name parameters
by methods that require a test function that takes a FixtureParam.

Implicitly converts a function that takes no parameters and results in PendingNothing to
a function from FixtureParam to Any, to enable pending tests to registered as by-name parameters
by methods that require a test function that takes a FixtureParam.

This method makes it possible to write pending tests as simply (pending), without needing
to write (fixture => pending).

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:

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

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

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.

deffail(): Nothing

deffeature(description: String)(fun: ⇒ 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.

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

defhashCode(): Int

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

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.

configMap

a Map of properties that can be used by this FeatureSpec's executing tests.

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

testName - the String value of the 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 execute. If None, all relevant tests should be executed.
I.e., None acts like a wildcard that means execute all relevant tests in this FeatureSpec.

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 this FeatureSpec's executing 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.

Register a test with the given spec text, optional tags, and test function value that takes no arguments.

Register a test with the given spec text, optional tags, and test function value that takes no arguments.
An invocation of this method is called an “example.”

This method will register the test for later execution via an invocation of one of the execute
methods. 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 FeatureSpec instance.

specText

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

defscenariosFor(unit: Unit): Unit

Registers shared scenarios.

Registers shared scenarios.

This method enables the following syntax for shared scenarios in a FeatureSpec:

scenariosFor(nonEmptyStack(lastValuePushed))

This method just provides syntax sugar intended to make the intent of the code clearer.
Because the parameter passed to it is
type Unit, the expression will be evaluated before being passed, which
is sufficient to register the shared scenarios. For examples of shared scenarios, see the
Shared scenarios section in the main documentation for
trait FeatureSpec.

valstyleName: String

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.

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

deftags: Map[String, Set[String]]

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

deftestNames: Set[String]

An immutable Set of test names.

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

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