Class that, via an instance referenced from the it
field,
supports test (and shared test) registration in PathAnyFunSpec
s.
Class that, via an instance referenced from the it
field,
supports test (and shared test) registration in PathAnyFunSpec
s.
This class supports syntax such as the following test registration:
it("should be empty") ^
and the following shared test registration:
it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples, see the main documentation for PathAnyFunSpec
.
Class that, via an instance referenced from the they
field,
supports test (and shared test) registration in PathAnyFunSpec
s.
Class that, via an instance referenced from the they
field,
supports test (and shared test) registration in PathAnyFunSpec
s.
This class supports syntax such as the following test registration:
they("should be empty") ^
and the following shared test registration:
they should behave like nonFullStack(stackWithOneItem) ^
For more information and examples, see the main documentation for PathAnyFunSpec
.
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
PathAnyFunSpec
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 PathAnyFunSpec
s.
Supports shared test registration in PathAnyFunSpec
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 sister
trait org.scalatest.funspec.AnyFunSpec
.
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.funspec.PathAnyFunSpec
.
The total number of tests that are expected to run when this PathAnyFunSpec
's run
method
is invoked.
The total number of tests that are expected to run when this PathAnyFunSpec
'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.AnyFunSpec
. 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
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
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 PathAnyFunSpec
, 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 PathAnyFunSpec
s.
Supports test (and shared test) registration in PathAnyFunSpec
s.
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 PathAnyFunSpec
, 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 PathAnyFunSpec
. Because
a PathAnyFunSpec
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.funspec.PathAnyFunSpec
than in an org.scalatest.funspec.AnyFunSpec
. In an
org.scalatest.funspec.PathAnyFunSpec
, nested suites are executed then tests are executed. In an
org.scalatest.funspec.PathAnyFunSpec
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 PathAnyFunSpec
, 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
PathAnyFunSpec
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 PathAnyFunSpec
, reporting test results that were registered when the tests
were run, each during the construction of its own instance.
Runs this PathAnyFunSpec
, 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
PathAnyFunSpec
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
IllegalArgumentException
if testName
is defined, but no test with the specified test name
exists in this Suite
NullArgumentException
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 PathAnyFunSpec
. Because
a PathAnyFunSpec
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.funspec.PathAnyFunSpec
than in an org.scalatest.funspec.PathAnyFunSpec
. In an
org.scalatest.funspec.AnyFunSpec
, nested suites are executed then tests are executed. In an
org.scalatest.funspec.PathAnyFunSpec
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 PathAnyFunSpec
, 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.
NullArgumentException
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.
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 PathAnyFunSpec
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 PathAnyFunSpec
:
import org.scalatest.funspec class StackSpec extends funspec.PathAnyFunSpec { 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 PathAnyFunSpec
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 PathAnyFunSpec
s.
Supports test (and shared test) registration in PathAnyFunSpec
s.
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 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
(Since version 3.1.0) The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
(Since version 3.1.0) The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
(Since version 3.1.0) The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
(Since version 3.1.0) The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
The styleName
lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
The styleName
lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0
will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for styleName
.
(Since version 3.1.0) The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.
A sister class to
org.scalatest.funspec.AnyFunSpec
that 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.Class
PathAnyFunSpec
behaves similarly to classorg.scalatest.funspec.AnyFunSpec
, except that tests are isolated based on their path. The purpose ofPathAnyFunSpec
is to facilitate writing specification-style tests for mutable objects in a clear, boilerpate-free way. To test mutable objects, you need to mutate them. Using a path class, you can make a statement in text, then implement that statement in code (including mutating state), and nest and combine these test/code pairs in any way you wish. Each test will only see the side effects of code that is in blocks that enclose the test. Here's an example:Note that the above class is organized by writing a bit of specification text that opens a new block followed by, at the top of the new block, some code that "implements" or "performs" what is described in the text. This is repeated as the mutable object (here, a
ListBuffer
), is prepared for the enclosed tests. For example:Or:
Note also that although each test mutates the
ListBuffer
, none of the other tests observe those side effects:This kind of isolation of tests from each other is a consequence of running each test in its own instance of the test class, and can also be achieved by simply mixing
OneInstancePerTest
into a regularorg.scalatest.funspec.AnyFunSpec
. However,PathAnyFunSpec
takes isolation one step further: a test in aPathAnyFunSpec
does not observe side effects performed outside tests in earlier blocks that do not enclose it. Here's an example:Running the full
ExampleSpec
, shown above, in the Scala interpeter would give you:scala> import org.scalatest._ import org.scalatest._ scala> run(new ExampleSpec) ExampleSpec: A ListBuffer - should be empty when created when 1 is appended - should contain 1 when 2 is appended - should contain 1 and 2 when 2 is removed - should contain only 1 again when 3 is appended - should contain 1, 2, and 3 when 88 is appended - should contain 1 and 88 - should have size 0 when created
Note: class
PathAnyFunSpec
's approach to isolation was inspired in part by the specsy framework, written by Esko Luontola.Shared fixtures
A test fixture is objects or other artifacts (such as files, sockets, database connections, etc.) used by tests to do their work. If a fixture is used by only one test, then the definitions of the fixture objects can be local to the method. If multiple tests need to share an immutable fixture, you can simply assign them to instance variables. If multiple tests need to share mutable fixture objects or
var
s, there's one and only one way to do it in aPathAnyFunSpec
: place the mutable objects lexically before the test. Any mutations needed by the test must be placed lexically before and/or after the test. As used here, "Lexically before" means that the code needs to be executed during construction of that test's instance of the test class to reach the test (or put another way, the code is along the "path to the test.") "Lexically after" means that the code needs to be executed to exit the constructor after the test has been executed.The reason lexical placement is the one and only one way to share fixtures in a
PathAnyFunSpec
is because all of its lifecycle methods are overridden and declaredfinal
. Thus you can't mix inBeforeAndAfter
orBeforeAndAfterEach
, because both overriderunTest
, which isfinal
in aPathAnyFunSpec
. You also can't overridewithFixture
, becausePathAnyFunSpec
extendsSuite
notTestSuite
, wherewithFixture
is defined. In short:PathAnyFunSpec
, if you need some code to execute before a test, place that code lexically before the test. If you need some code to execute after a test, place that code lexically after the test.The reason the life cycle methods are final, by the way, is to prevent users from attempting to combine a
PathAnyFunSpec
's approach to isolation with other ways ScalaTest provides to share fixtures or execute tests, because doing so could make the resulting test code hard to reason about. APathAnyFunSpec
's execution model is a bit magical, but because it executes in one and only one way, users should be able to reason about the code. To help you visualize how aPathAnyFunSpec
is executed, consider the following variant ofExampleSpec
that includes print statements:Running the above version of
ExampleSpec
in the Scala interpreter will give you output similar to:Note that each test is executed in order of appearance in the
PathAnyFunSpec
, and that only thoseprintln
statements residing in blocks that enclose the test being run are executed. Anyprintln
statements in blocks that do not form the "path" to a test are not executed in the instance of the class that executes that test.How it executes
To provide its special brand of test isolation,
PathAnyFunSpec
executes quite differently from its sister class inorg.scalatest.funspec
. Anorg.scalatest.funspec.AnyFunSpec
registers tests during construction and executes them whenrun
is invoked. Anorg.scalatest.funspec.PathAnyFunSpec
, by contrast, runs each test in its own instance while that instance is being constructed. During construction, it registers not the tests to run, but the results of running those tests. Whenrun
is invoked on aPathAnyFunSpec
, it reports the registered results and does not run the tests again. Ifrun
is invoked a second or third time, in fact, aPathAnyFunSpec
will each time report the same results registered during construction. If you want to run the tests of aPathAnyFunSpec
anew, you'll need to create a new instance and invokerun
on that.A
PathAnyFunSpec
will create one instance for each "leaf" node it contains. The main kind of leaf node is a test, such as:However, an empty scope (a scope that contains no tests or nested scopes) is also a leaf node:
The tests will be executed sequentially, in the order of appearance. The first test (or empty scope, if that is first) will be executed when a class that mixes in
PathAnyFunSpec
is instantiated. Only the first test will be executed during this initial instance, and of course, only the path to that test. Then, the first time the client uses the initial instance (by invoking one ofrun
,expectedTestsCount
,tags
, ortestNames
on the instance), the initial instance will, before doing anything else, ensure that any remaining tests are executed, each in its own instance.To ensure that the correct path is taken in each instance, and to register its test results, the initial
PathAnyFunSpec
instance must communicate with the other instances it creates for running any subsequent leaf nodes. It does so by setting a thread-local variable prior to creating each instance (a technique suggested by Esko Luontola). Each instance ofPathAnyFunSpec
checks the thread-local variable. If the thread-local is not set, it knows it is an initial instance and therefore executes every block it encounters until it discovers, and executes the first test (or empty scope, if that's the first leaf node). It then discovers, but does not execute the next leaf node, or discovers there are no other leaf nodes remaining to execute. It communicates the path to the next leaf node, if any, and the result of running the test it did execute, if any, back to the initial instance. The initial instance repeats this process until all leaf nodes have been executed and all test results registered.Ignored tests
You mark a test as ignored in an
org.scalatest.funspec.PathAnyFunSpec
in the same manner as in anorg.scalatest.funspec.AnyFunSpec
. Please see the Ignored tests section in its documentation for more information.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.Informers
You output information using
Informer
s in anorg.scalatest.funspec.PathAnyFunSpec
in the same manner as in anorg.scalatest.funspec.AnyFunSpec
. Please see the Informers section in its documentation for more information.Pending tests
You mark a test as pending in an
org.scalatest.funspec.PathAnyFunSpec
in the same manner as in anorg.scalatest.funspec.AnyFunSpec
. Please see the Pending tests section in its documentation for more information.Note that a separate instance will be created for a pending test, and the path to the ignored test will be executed in that instance, as well as the test function (up until it completes abruptly with a
TestPendingException
).Tagging tests
You can place tests into groups by tagging them in an
org.scalatest.funspec.PathAnyFunSpec
in the same manner as in anorg.scalatest.funspec.AnyFunSpec
. Please see the Tagging tests section in its documentation for more information.Note that one difference between this class and its sister class
org.scalatest.funspec.AnyFunSpec
is that because tests are executed at construction time, rather than each time run is invoked, anorg.scalatest.funspec.PathAnyFunSpec
will always execute all non-ignored tests. Whenrun
is invoked on aPathAnyFunSpec
, if some tests are excluded based on tags, the registered results of running those tests will not be reported. (But those tests will have already run and the results registered.) By contrast, because anorg.scalatest.funspec.AnyFunSpec
only executes tests afterrun
has been called, and at that time the tags to include and exclude are known, only tests selected by the tags will be executed.In short, in an
org.scalatest.funspec.AnyFunSpec
, tests not selected by the tags to include and exclude specified for the run (via theFilter
passed torun
) will not be executed. In anorg.scalatest.funspec.PathAnyFunSpec
, by contrast, all non-ignored tests will be executed, each during the construction of its own instance, and tests not selected by the tags to include and exclude specified for a run will not be reported. (One upshot of this is that if you have tests that you want to tag as being slow so you can sometimes exclude them during a run, you probably don't want to put them in aPathAnyFunSpec
. Because in apath.Freespec
the slow tests will be run regardless, with only their registered results not being reported if you exclude slow tests during a run.)Shared tests
You can factor out shared tests in an
org.scalatest.funspec.PathAnyFunSpec
in the same manner as in anorg.scalatest.funspec.AnyFunSpec
. Please see the Shared tests section in its documentation for more information.Nested suites
Nested suites are not allowed in a
PathAnyFunSpec
. Because aPathAnyFunSpec
executes tests eagerly at construction time, registering the results of those test runs and reporting them later whenrun
is invoked, the order of nested suites versus test runs would be different in aorg.scalatest.funspec.PathAnyFunSpec
than in anorg.scalatest.funspec.AnyFunSpec
. Inorg.scalatest.funspec.AnyFunSpec
's implementation ofrun
, nested suites are executed then tests are executed. Aorg.scalatest.funspec.PathAnyFunSpec
with nested suites would execute these in the opposite order: first tests then nested suites. To help makePathAnyFunSpec
code easier to reason about by giving readers of one less difference to think about, nested suites are not allowed. If you want to add nested suites to aPathAnyFunSpec
, you can instead wrap them all in aSuites
object. They will be executed in the order of appearance (unless a Distributor is passed, in which case they will execute in parallel).Durations
Many ScalaTest events include a duration that indicates how long the event being reported took to execute. For example, a
TestSucceeded
event provides a duration indicating how long it took for that test to execute. ASuiteCompleted
event provides a duration indicating how long it took for that entire suite of tests to execute.In the test completion events fired by a
PathAnyFunSpec
(TestSucceeded
,TestFailed
, orTestPending
), the durations reported refer to the time it took for the tests to run. This time is registered with the test results and reported along with the test results each timerun
is invoked. By contrast, the suite completion events fired for aPathAnyFunSpec
represent the amount of time it took to report the registered results. (These events are not fired byPathAnyFunSpec
, but instead by the entity that invokesrun
on thePathAnyFunSpec
.) As a result, the total time for running the tests of aPathAnyFunSpec
, calculated by summing the durations of all the individual test completion events, may be greater than the duration reported for executing the entire suite.