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.
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.
the specification text, which will be combined with the descText of any surrounding describers to form the test name
the optional list of tags for this test
the test function
if a test with the same name has been registered previously
NullArgumentExceptionif specText or any passed test tag is null
if invoked after run has been invoked on this suite
Run a test.
Run a test. This trait's implementation runs the test registered with the name specified by
testName. Each test's name is a concatenation of the text of all describers surrounding a test,
from outside in, and the test's spec text, with one space placed between each item. (See the documenation
for testNames for an example.)
the name of one test to execute.
the Args for this run
a Status object that indicates when the test started by this method has completed, and whether or not it failed .
if any of testName, reporter, stopper, or configMap
is null.
Run zero to many of this FeatureSpec's tests.
Run zero to many of this FeatureSpec's tests.
This method takes a testName parameter that optionally specifies a test to invoke.
If testName is Some, this trait's implementation of this method
invokes runTest on this object, passing in:
testName - the String value of the testName Option passed
to this methodreporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to itThis method takes a Set of tag names that should be included (tagsToInclude), and a Set
that should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute.
If tagsToInclude is empty, all tests will be executed
except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is non-empty, only tests
belonging to tags mentioned in tagsToInclude, and not mentioned in tagsToExclude
will be executed. However, if testName is Some, tagsToInclude and tagsToExclude are essentially ignored.
Only if testName is None will tagsToInclude and tagsToExclude be consulted to
determine which of the tests named in the testNames Set should be run. For more information on trait tags, see the main documentation for this trait.
If testName is None, this trait's implementation of this method
invokes testNames on this Suite to get a Set of names of tests to potentially execute.
(A testNames value of None essentially acts as a wildcard that means all tests in
this Suite that are selected by tagsToInclude and tagsToExclude should be executed.)
For each test in the testName Set, in the order
they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation
of this method checks whether the test should be run based on the tagsToInclude and tagsToExclude Sets.
If so, this implementation invokes runTest, passing in:
testName - the String name of the test to run (which will be one of the names in the testNames Set)reporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to itan optional name of one test to run. If None, all relevant tests should be run.
I.e., None acts like a wildcard that means run all relevant tests in this Suite.
the Args for this run
a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
if testName is defined, but no test with the specified test name
exists in this Suite
if any of the passed parameters is null.
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.
the specification text, which will be combined with the descText of any surrounding describers to form the test name
the optional list of tags for this test
the test function
if a test with the same name has been registered previously
NullArgumentExceptionif specText or any passed test tag is null
if invoked after run has been invoked on this suite
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 this trait.
Suite style name.
Suite style name.
A Map whose keys are String names of tagged tests and whose associated values are
the Set of tag names for the test.
A Map whose keys are String names of tagged tests and whose associated values are
the Set of tag names for the test. 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 scenario 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
org.scalatest.Ignore.
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. For example, consider this FeatureSpec:
import org.scalatest.FeatureSpec
class StackSpec extends FeatureSpec {
feature("A Stack") {
scenario("(when not empty) must allow me to pop") {}
scenario("(when not full) must allow me to push") {}
}
}
Invoking testNames on this FeatureSpec will yield a set that contains the following
two test name strings:
"A Stack (when not empty) must allow me to pop" "A Stack (when not full) must allow me to push"
Returns a user friendly string for this suite, composed of the
simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite
contains nested suites, the result of invoking toString on each
of the nested suites, separated by commas and surrounded by parentheses.
Returns a user friendly string for this suite, composed of the
simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite
contains nested suites, the result of invoking toString on each
of the nested suites, separated by commas and surrounded by parentheses.
a user-friendly string for this suite