Class that, via an instance referenced from the it
field,
supports test (and shared test) registration in FunSpec
s.
Class that, via an instance referenced from the it
field,
supports test (and shared test) registration in FunSpec
s.
This class supports syntax such as the following:
it("should be empty") ^
it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples, see the main documentation for FunSpec
.
Class that, via an instance referenced from the they
field,
supports test (and shared test) registration in FunSpec
s.
Class that, via an instance referenced from the they
field,
supports test (and shared test) registration in FunSpec
s.
This class supports syntax such as the following:
they("should be empty") ^
they should behave like nonFullStack(stackWithOneItem) ^
For more information and examples, see the main documentation for FunSpec
.
Supports shared test registration in FunSpec
s.
Supports shared test registration in FunSpec
s.
This field supports syntax such as the following:
it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of <cod>behave, see the Shared tests section
in the main documentation for trait FunSpec
.
Implicitly converts a function that takes no parameters and results in PendingStatement
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 PendingStatement
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)
.
a function
a function of FixtureParam => Any
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.
the description text
the function which makes up the body for the description
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 FunSpec
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
DuplicateTestNameException
if a test with the same name has been registered previously
NullArgumentException
if specText
or any passed test tag is null
TestRegistrationClosedException
if invoked after run
has been invoked on this suite
Supports test (and shared test) registration in FunSpec
s.
Supports test (and shared test) registration in FunSpec
s.
This field supports syntax such as the following:
it("should be empty") ^
it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of the it
field, see
the main documentation for FunSpec
.
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 .
NullArgumentException
if testName
or args
is null
.
Run zero to many of this FunSpec
's tests.
Run zero to many of this FunSpec
'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 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 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
Set
s.
If so, this implementation invokes runTest
with passed args
.
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 FunSpec
.
the Args
to which results will be reported
a Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
NullArgumentException
if any of testName
or args
is null
.
Suite style name.
Suite style name.
org.scalatest.fixture.FunSpec
A Map
whose keys are String
tag names to which tests in this FunSpec
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 FunSpec
belong, and values
the Set
of test names that belong to each tag. If this FunSpec
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.
An immutable Set
of test names.
An immutable Set
of test names. If this FunSpec
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.
the Set
of test names
Supports test (and shared test) registration in FunSpec
s.
Supports test (and shared test) registration in FunSpec
s.
This field supports syntax such as the following:
they("should be empty") ^
they should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of the it
field, see
the main documentation for FunSpec
.
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