Class that supports the registration of a “subject” being specified and tested via the
instance referenced from FlatSpec
's behavior
field.
Class that supports registration of ignored tests via the IgnoreWord
instance referenced
from FlatSpec
's ignore
field.
Class that supports registration of ignored, tagged tests via the IgnoreWord
instance referenced
from FlatSpec
's ignore
field.
Class that supports registration of ignored tests via the ItWord
instance
referenced from FlatSpec
's ignore
field.
Class that supports test registration in shorthand form.
Class that supports tagged test registration in shorthand form.
Class that supports test registration via the ItWord
instance referenced from FlatSpec
's it
field.
Class that supports the registration of tagged tests via the ItWord
instance
referenced from FlatSpec
's it
field.
Class that supports test (and shared test) registration via the instance referenced from FlatSpec
's it
field.
Class that supports test registration via the TheyWord
instance referenced from FlatSpec
's they
field.
Class that supports the registration of tagged tests via the TheyWord
instance
referenced from FlatSpec
's they
field.
Class that supports test (and shared test) registration via the instance referenced from FlatSpec
's it
field.
Supports shared test registration in FlatSpec
s.
Supports shared test registration in FlatSpec
s.
This field supports syntax such as the following:
it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of behave
, see the Shared tests section
in the main documentation for this trait.
Supports the registration of a “subject” being specified and tested.
Supports the registration of a “subject” being specified and tested.
This field enables syntax such as the following subject registration:
behavior of "A Stack" ^
For more information and examples of the use of the behavior
field, see the main documentation
for this trait.
Implicitly converts an object of type ResultOfStringPassedToVerb
to an
InAndIgnoreMethods
, to enable in
and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfStringPassedToVerb
to an
InAndIgnoreMethods
, to enable in
and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation
to an
InAndIgnoreMethodsAfterTaggedAs
, to enable in
and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation
to an
InAndIgnoreMethodsAfterTaggedAs
, to enable in
and ignore
methods to be invokable on that object.
Supports registration of ignored tests in FlatSpec
s.
Supports registration of ignored tests in FlatSpec
s.
This field enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
For more information and examples of the use of the ignore
field, see the Ignored tests section
in the main documentation for this trait.
Supports test (and shared test) registration in FlatSpec
s.
Supports test (and shared test) registration in FlatSpec
s.
This field enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation
for this trait.
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 FlatSpec
's tests.
Run zero to many of this FlatSpec
'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
Set
s.
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 execute. If None
, all relevant tests should be executed.
I.e., None
acts like a wildcard that means execute all relevant tests in this FlatSpec
.
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 any of testName
, reporter
, stopper
, tagsToInclude
,
tagsToExclude
, or configMap
is null
.
Supports the shorthand form of shared test registration.
Supports the shorthand form of shared test registration.
For example, this method enables syntax such as the following in:
"A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed) ^
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 description (the parameter to the function) and returns a BehaveWord
.
Supports the shorthand form of test registration.
Supports the shorthand form of test registration.
For example, this method enables syntax such as the following:
"A Stack (when empty)" should "be empty" in { ... } ^
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 description (the first parameter to the function) and returns a ResultOfStringPassedToVerb
initialized with the verb and rest parameters (the second and third parameters to
the function, respectively).
Suite style name.
Suite style name.
A Map
whose keys are String
names of tagged tests and whose associated values are
the Set
of tags for the test.
A Map
whose keys are String
names of tagged tests and whose associated values are
the Set
of tags for the test. If this FlatSpec
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
taggedAs
.
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 FlatSpec
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 FlatSpec
:
import org.scalatest.FlatSpec class StackSpec extends FlatSpec { "A Stack (when not empty)" must "allow me to pop" in {} it must "not be empty" in {} "A Stack (when not full)" must "allow me to push" in {} it must "not be full" in {} }
Invoking testNames
on this FlatSpec
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 empty) must not be empty" "A Stack (when not full) must allow me to push" "A Stack (when not full) must not be full"
Supports test (and shared test) registration in FlatSpec
s.
Supports test (and shared test) registration in FlatSpec
s.
This field enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it
field, see the main documentation
for this trait.
Implementation trait for class
FlatSpec
, which facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.FlatSpec
is a class, not a trait, to minimize compile time given there is a slight compiler overhead to mixing in traits compared to extending classes. If you need to mix the behavior ofFlatSpec
into some other class, you can use this trait instead, because classFlatSpec
does nothing more than extend this trait and add a nicetoString
implementation.See the documentation of the class for a detailed overview of
FlatSpec
.