Returns an Alerter that during test execution will forward strings (and other objects) passed to its
apply method to the current reporter.
Returns an Alerter that during test execution will forward strings (and other objects) 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
PropSpec 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.
Register a property-based test to ignore, which has the specified name, optional tags, and function value that takes no arguments.
Register a property-based test to ignore, which has the specified name, optional tags, and function value that takes no arguments.
This method will register the test for later ignoring via an invocation of one of the run
methods. This method exists to make it easy to ignore an existing test by changing the call to test
to ignore without deleting or commenting out the actual test code. The test will not be run, but a
report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on
this PropSpec instance.
the name of the test
the optional list of tags for this test
the test function
if a test with the same name has been registered previously
NotAllowedExceptionif testName had been registered previously
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.
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 (and other objects) passed to its
apply method to the current reporter.
Returns a Notifier that during test execution will forward strings (and other objects) 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
PropSpec 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.
Registers shared tests.
Registers shared tests.
This method enables the following syntax for shared tests in a PropSpec:
propertiesFor(nonEmptyStack(lastValuePushed))
This method just provides syntax sugar intended to make the intent of the code clearer.
Because the parameter passed to it is
type Unit, the expression will be evaluated before being passed, which
is sufficient to register the shared tests. For examples of shared tests, see the
Shared tests section in the main documentation for this trait.
Register a property-based test with the specified name, optional tags, and function value that takes no arguments.
Register a property-based test with the specified name, optional tags, and function value that takes no arguments.
This method will register the test for later execution via an invocation of one of the run
methods. The passed test name must not have been registered previously on
this PropSpec instance.
the name of the property
the optional list of tags for this property
the property function
if a test with the same name has been registered previously
NotAllowedExceptionif testName had been registered previously
if testName or any passed test tag is null
if invoked after run has been invoked on this suite
Run a test.
Run a test. This trait's implementation runs the test registered with the name specified by testName.
the name of one test to run.
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 testName is defined but a test with that name does not exist on this PropSpec
if any of testName, reporter, stopper, or configMap
is null.
Run zero to many of this PropSpec's tests.
Run zero to many of this PropSpec'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.
if testName is defined, but no test with the specified test name
exists in this Suite
if any of the passed parameters is null.
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 PropSpec 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 property 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 PropSpec 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.
Implementation trait for class
PropSpec, which represents a suite of property-based tests.PropSpecis 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 ofPropSpecinto some other class, you can use this trait instead, because classPropSpecdoes nothing more than extend this trait and add a nicetoStringimplementation.See the documentation of the class for a detailed overview of
PropSpec.