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
FixtureAnyPropSpec
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.
Implicitly converts a function that takes no parameters and results in PendingStatement
to
a function from FixtureParam
to Any
, to enable pending tests to registered as by-name parameters
by methods that require a test function that takes a FixtureParam
.
Implicitly converts a function that takes no parameters and results in PendingStatement
to
a function from FixtureParam
to Any
, to enable pending tests to registered as by-name parameters
by methods that require a test function that takes a FixtureParam
.
This method makes it possible to write pending tests as simply (pending)
, without needing
to write (fixture => pending)
.
a function
a function of FixtureParam => Any
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 FixtureAnyPropSpec
instance.
the name of the test
the optional list of tags for this test
DuplicateTestNameException
if a test with the same name has been registered previously
NotAllowedException
if testName
had been registered previously
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.
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
FixtureAnyPropSpec
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 FixtureAnyPropSpec
:
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
trait AnyPropSpec
.
a Unit
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 FixtureAnyPropSpec
instance.
the name of the test
the optional list of tags for this test
DuplicateTestNameException
if a test with the same name has been registered previously
NotAllowedException
if testName
had been registered previously
NullArgumentException
if testName
or any passed test tag is null
TestRegistrationClosedException
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 .
IllegalArgumentException
if testName
is defined but a test with that name does not exist on this FixtureAnyPropSpec
NullArgumentException
if any of testName
or args
is null
.
Run zero to many of this FixtureAnyPropSpecLike
's tests.
Run zero to many of this FixtureAnyPropSpecLike
'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 with passed args
.
This method takes an args
that contains 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
with passed args
.
an 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 FunSpec
.
the Args
to which results will be reported
a Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
NullArgumentException
if any of testName
or args
is null
.
A Map
whose keys are String
tag names to which tests in this FixtureAnyPropSpec
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 FixtureAnyPropSpec
belong, and values
the Set
of test names that belong to each tag. If this FixtureAnyPropSpec
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 test
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.
An immutable Set
of test names.
An immutable Set
of test names. If this FixtureAnyPropSpec
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.
the Set
of test names
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.propspec.AnyPropSpec
that can pass a fixture object into its tests.FixtureAnyPropSpec
in situations for whichAnyPropSpec
would be a good choice, when all or most tests need the same fixture objects that must be cleaned up afterwards. Note:FixtureAnyPropSpec
is intended for use in special situations, with classAnyPropSpec
used for general needs. For more insight into whereFixtureAnyPropSpec
fits in the big picture, see thewithFixture(OneArgTest)
subsection of the Shared fixtures section in the documentation for classAnyPropSpec
.Class
FixtureAnyPropSpec
behaves similarly to classorg.scalatest.propspec.AnyPropSpec
, except that tests may have a fixture parameter. The type of the fixture parameter is defined by the abstractFixtureParam
type, which is a member of this class. This class also has an abstractwithFixture
method. ThiswithFixture
method takes aOneArgTest
, which is a nested trait defined as a member of this class.OneArgTest
has anapply
method that takes aFixtureParam
. Thisapply
method is responsible for running a test. This class'srunTest
method delegates the actual running of each test towithFixture
, passing in the test code to run via theOneArgTest
argument. ThewithFixture
method (abstract in this class) is responsible for creating the fixture argument and passing it to the test function.Subclasses of this class must, therefore, do three things differently from a plain old
org.scalatest.propspec.AnyPropSpec
:FixtureParam
withFixture(OneArgTest)
methodHere's an example:
Note: to run the examples on this page, you'll need to include ScalaCheck on the classpath in addition to ScalaTest.
In the previous example,
withFixture
creates and initializes a temp file, then invokes the test function, passing in aFileReader
connected to that file. In addition to setting up the fixture before a test, thewithFixture
method also cleans it up afterwards. If you need to do some clean up that must happen even if a test fails, you should invoke the test function from inside atry
block and do the cleanup in afinally
clause, as shown in the previous example.If a test fails, the
OneArgTest
function will result in a Failed wrapping the exception describing the failure. The reason you must perform cleanup in afinally
clause is that in case an exception propagates back throughwithFixture
, thefinally
clause will ensure the fixture cleanup happens as that exception propagates back up the call stack torunTest
.If a test doesn't need the fixture, you can indicate that by providing a no-arg instead of a one-arg function. In other words, instead of starting your function literal with something like “
reader =>
”, you'd start it with “() =>
”, as is done in the third test in the above example. For such tests,runTest
will not invokewithFixture(OneArgTest)
. It will instead directly invokewithFixture(NoArgTest)
.Passing multiple fixture objects
If the fixture you want to pass into your tests consists of multiple objects, you will need to combine them into one object to use this class. One good approach to passing multiple fixture objects is to encapsulate them in a case class. Here's an example:
To enable the stacking of traits that define
withFixture(NoArgTest)
, it is a good idea to letwithFixture(NoArgTest)
invoke the test function instead of invoking the test function directly. To do so, you'll need to convert theOneArgTest
to aNoArgTest
. You can do that by passing the fixture object to thetoNoArgTest
method ofOneArgTest
. In other words, instead of writing “test(theFixture)
”, you'd delegate responsibility for invoking the test function to thewithFixture(NoArgTest)
method of the same instance by writing:Here's a complete example: