AsyncFunSpecLike
Related Doc:
package funspec
Class that, via an instance referenced from the it field,
supports test (and shared test) registration in AsyncFunSpecs.
Class that, via an instance referenced from the it field,
supports test (and shared test) registration in AsyncFunSpecs.
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 AsyncFunSpec.
Class that, via an instance referenced from the they field,
supports test (and shared test) registration in AsyncFunSpecs.
Class that, via an instance referenced from the they field,
supports test (and shared test) registration in AsyncFunSpecs.
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 AsyncFunSpec.
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
FreeSpec 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 AsyncFunSpecs.
Supports shared test registration in AsyncFunSpecs.
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 this trait.
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 AsyncFunSpec 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
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 passed to its
apply method to the current reporter.
Returns an Informer 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 from inside a scope,
it will forward the information to the current reporter immediately. 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 AsyncFunSpecs.
Supports test (and shared test) registration in AsyncFunSpecs.
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 passed to its
apply method to the current reporter.
Returns a Documenter 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 from inside a scope,
it will forward the information to the current reporter immediately. 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 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
FreeSpec 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.
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 any of testName, reporter, stopper, or configMap
is null.
Run zero to many of this AsyncFunSpec's tests.
Run zero to many of this AsyncFunSpec's tests.
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
a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
IllegalArgumentException if testName is defined, but no test with the specified test name
exists in this Suite
NullArgumentException if any of the passed parameters is null.
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 AsyncFunSpec 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 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
org.scalatest.Ignore.
An immutable Set of test names.
An immutable Set of test names. If this AsyncFunSpec 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 AsyncFunSpec:
import org.scalatest.funspec.AsyncFunSpec
class StackSpec extends AsyncFunSpec {
describe("A Stack") {
describe("(when not empty)") {
it("must allow me to pop") {}
}
describe("(when not full)") {
it("must allow me to push") {}
}
}
}
Invoking testNames on this AsyncFunSpec 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"
Supports test (and shared test) registration in AsyncFunSpecs.
Supports test (and shared test) registration in AsyncFunSpecs.
This field supports syntax such as the following:
they("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.
(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.
Implementation trait for class
AsyncFunSpec, which facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.AsyncFunSpecis 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 ofAsyncFunSpecinto some other class, you can use this trait instead, because classAsyncFunSpecdoes nothing more than extend this trait and add a nicetoStringimplementation.See the documentation of the class for a detailed overview of
AsyncFunSpec.