Class that, via an instance referenced from the it field,
supports test (and shared test) registration in FunSpecs.
Class that, via an instance referenced from the they field,
supports test (and shared test) registration in FunSpecs.
Returns an Alerter that during test execution will forward strings passed to its
apply method to the current reporter.
Returns an Alerter 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 while this
path.FunSpec 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.
Supports shared test registration in path.FunSpecs.
Supports shared test registration in path.FunSpecs.
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 sister
trait org.scalatest.FunSpec.
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 class's implementation of this method will decide whether to
register the description text and invoke the passed function
based on whether or not this is part of the current "test path." For the details on this process, see
the How it executes section of the main documentation for trait
org.scalatest.path.FunSpec.
The total number of tests that are expected to run when this path.FunSpec's run method
is invoked.
The total number of tests that are expected to run when this path.FunSpec's run method
is invoked.
This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.
This trait's implementation of this method returns the size of the testNames List, minus
the number of tests marked as ignored as well as any tests excluded by the passed Filter.
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
a Filter with which to filter tests to count based on their tags
Supports registration of a test to ignore.
Supports registration of a test to ignore.
For more information and examples of this method's use, see the
Ignored tests section in the main documentation for sister
trait org.scalatest.FunSpec. Note that a separate instance will be created for an ignored test,
and the path to the ignored test will be executed in that instance, but the test function itself will not
be executed. Instead, a TestIgnored event will be fired.
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
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 (including within a test, since
those are invoked during construction in a path.FunSpec, it
will register the passed string for forwarding later when run is invoked. 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.
Supports test (and shared test) registration in FunSpecs.
Supports test (and shared test) registration in FunSpecs.
This field supports syntax such as the following:
it("should be empty")
^
class="stExamples" it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of the it field, see the main documentation for this trait.
Returns a Documenter that during test execution will forward strings (and other objects) passed to its
apply method to the current reporter.
Returns a Documenter that during test execution will forward strings (and other objects) passed to its
apply method to the current reporter. If invoked in a constructor (including within a test, since
those are invoked during construction in a path.FunSpec, it
will register the passed string for forwarding later when run is invoked. 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.
Returns an empty list.
Returns an empty list.
This lifecycle method is unused by this trait. If invoked, it will return an empty list, because
nested suites are not allowed in a path.FunSpec. Because
a path.FunSpec executes tests eagerly at construction time, registering the results of
those test runs and reporting them later, the order of nested suites versus test runs would be different
in a org.scalatest.path.FunSpec than in an org.scalatest.FunSpec. In an
org.scalatest.FunSpec, nested suites are executed then tests are executed. In an
org.scalatest.path.FunSpec it would be the opposite. To make the code easy to reason about,
therefore, this is just not allowed. If you want to add nested suites to a path.FunSpec, you can
instead wrap them all in a Suites
object and put them in whatever order you wish.
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
Returns a Notifier that during test execution will forward strings passed to its
apply method to the current reporter.
Returns a Notifier 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 while this
path.FunSpec 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.
Runs this path.FunSpec, reporting test results that were registered when the tests
were run, each during the construction of its own instance.
Runs this path.FunSpec, reporting test results that were registered when the tests
were run, each during the construction of its own instance.
This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.
If testName is None, this trait's implementation of this method
will report the registered results for all tests except any excluded by the passed Filter.
If testName is defined, it will report the results of only that named test. Because a
path.FunSpec is not allowed to contain nested suites, this trait's implementation of
this method does not call runNestedSuites.
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
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.
the Args for this run
if testName is defined, but no test with the specified test name
exists in this Suite
if any passed parameter is null.
This lifecycle method is unused by this trait, and is implemented to do nothing.
This lifecycle method is unused by this trait, and is implemented to do nothing. If invoked, it will just return immediately.
Nested suites are not allowed in a path.FunSpec. Because
a path.FunSpec executes tests eagerly at construction time, registering the results of
those test runs and reporting them later, the order of nested suites versus test runs would be different
in a org.scalatest.path.FunSpec than in an org.scalatest.FunSpec. In an
org.scalatest.FunSpec, nested suites are executed then tests are executed. In an
org.scalatest.path.FunSpec it would be the opposite. To make the code easy to reason about,
therefore, this is just not allowed. If you want to add nested suites to a path.FunSpec, you can
instead wrap them all in a Suites
object and put them in whatever order you wish.
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
Runs a test.
Runs a test.
This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.
This trait's implementation reports the test results 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 documentation
for testNames for an example.)
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
the name of one test to execute.
if any of testName, reporter, stopper, or configMap
is null.
This lifecycle method is unused by this trait, and will complete abruptly with
UnsupportedOperationException if invoked.
This lifecycle method is unused by this trait, and will complete abruptly with
UnsupportedOperationException if invoked.
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
Suite style name.
Suite style name.
A Map whose keys are String tag names to which tests in this path.FreeSpec
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 path.FreeSpec
belong, and values the Set of test names that belong to each tag. If this path.FreeSpec
contains no tags, this method returns an empty Map.
This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.
This trait's implementation returns tags that were passed as strings contained in Tag objects passed
to methods it 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.
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
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 first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.
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 FunSpec:
import org.scalatest.path
class StackSpec extends path.FunSpec {
describe("A Stack") {
describe("when not empty") {
"must allow me to pop" in {}
}
describe("when not full") {
"must allow me to push" in {}
}
}
}
Invoking testNames on this FunSpec 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"
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
Supports test (and shared test) registration in FunSpecs.
Supports test (and shared test) registration in FunSpecs.
This field supports syntax such as the following:
it("should be empty")
^
class="stExamples" it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of the it field, see the main documentation for this trait.
This lifecycle method is unused by this trait, and will complete abruptly with
UnsupportedOperationException if invoked.
This lifecycle method is unused by this trait, and will complete abruptly with
UnsupportedOperationException if invoked.
This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.
Implementation trait for class
path.FunSpec, which is a sister class toorg.scalatest.FunSpecthat isolates tests by running each test in its own instance of the test class, and for each test, only executing the path leading to that test.path.FunSpecis 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 ofpath.FunSpecinto some other class, you can use this trait instead, because classpath.FunSpecdoes nothing more than extend this trait and add a nicetoStringimplementation.See the documentation of the class for a detailed overview of
path.FunSpec.