The total number of tests that are expected to run when this Suite
's run
method is invoked.
The total number of tests that are expected to run when this Suite
's run
method is invoked.
a Filter
with which to filter tests to count based on their tags
An immutable IndexedSeq
of this SuiteMixin
object's nested Suite
s.
An immutable IndexedSeq
of this SuiteMixin
object's nested Suite
s. If this SuiteMixin
contains no nested Suite
s,
this method returns an empty IndexedSeq
.
The fully qualified name of the class that can be used to rerun this suite.
The fully qualified name of the class that can be used to rerun this suite.
Runs this suite of tests.
Runs this suite of tests.
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 Suite
.
the Args
for this run
a Status
object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
the Args
for this run
a Status
object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.
This suite's style name.
This suite's style name.
This lifecycle method provides a string that is used to determine whether this suite object's style is one of the chosen styles for the project.
A Map
whose keys are String
tag names with which tests in this Suite
are marked, and
whose values are the Set
of test names marked with each tag.
A Map
whose keys are String
tag names with which tests in this Suite
are marked, and
whose values are the Set
of test names marked with each tag. If this Suite
contains no tags, this
method returns an empty Map
.
Subclasses may implement this method to define and/or discover tags in a custom manner, but overriding method implementations
should never return an empty Set
as a value. If a tag has no tests, its name should not appear as a key in the
returned Map
.
A Set
of test names.
A Set
of test names. If this Suite
contains no tests, this method returns an empty Set
.
Although subclass and subtrait implementations of this method may return a Set
whose iterator produces String
test names in a well-defined order, the contract of this method does not required a defined order. Subclasses are free to
implement this method and return test names in either a defined or undefined order.
Runs the passed test function with a fixture established by this method.
Runs the passed test function with a fixture established by this method.
This method should set up the fixture needed by the tests of the
current suite, invoke the test function, and if needed, perform any clean
up needed after the test completes. Because the NoArgTest
function
passed to this method takes no parameters, preparing the fixture will require
side effects, such as initializing an external database.
the no-arg test function to run with a fixture
Construct a new instance of this Suite
.
Construct a new instance of this Suite
.
This trait's implementation of runTests
invokes this method to create
a new instance of this Suite
for each test. This trait's implementation
of this method uses reflection to call this.getClass.newInstance
. This
approach will succeed only if this Suite
's class has a public, no-arg
constructor. In most cases this is likely to be true, because to be instantiated
by ScalaTest's Runner
a Suite
needs a public, no-arg
constructor. However, this will not be true of any Suite
defined as
an inner class of another class or trait, because every constructor of an inner
class type takes a reference to the enclosing instance. In such cases, and in
cases where a Suite
class is explicitly defined without a public,
no-arg constructor, you will need to override this method to construct a new
instance of the Suite
in some other way.
Here's an example of how you could override newInstance
to construct
a new instance of an inner class:
import org.scalatest.Suite
class Outer { class InnerSuite extends Suite with OneInstancePerTest { def testOne() {} def testTwo() {} override def newInstance = new InnerSuite } }
Modifies the behavior of super.runTest
to facilitate running each test in its
own instance of this Suite
's class.
Modifies the behavior of super.runTest
to facilitate running each test in its
own instance of this Suite
's class.
This trait's implementation of runTest
uses the runTestInNewInstance
flag of the passed Args
object to determine whether this instance is the general instance responsible
for running all tests in the suite (runTestInNewInstance
is true
), or a test-specific instance
responsible for running just one test (runTestInNewInstance
is false
).
Note that these Boolean
values are reverse those used by runTests
, because runTests
always inverts the Boolean
value
of runTestInNewInstance
when invoking runTest
.
If runTestInNewInstance
is true
, this trait's implementation of this method creates a new instance of this class (by
invoking newInstance
on itself), then invokes run
on the new instance,
passing in testName
, wrapped in a Some
, and args
unchanged.
(I.e., the Args
object passed to runTest
is forwarded as is to run
on the new instance, including with runTestInNewInstance
set.)
If the invocation of either newInstance
on this
Suite
or run
on a newly created instance of this Suite
completes abruptly with an exception, then this runTests
method will complete
abruptly with the same exception.
If runTestInNewInstance
is false
, this trait's implementation of this method simply invokes super.runTest
,
passing along the same testName
and args
objects.
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 .
Modifies the behavior of super.runTests
to facilitate running each test in its
own instance of this Suite
's class.
Modifies the behavior of super.runTests
to facilitate running each test in its
own instance of this Suite
's class.
This trait's implementation of runTest
uses the runTestInNewInstance
flag of the passed Args
object to determine whether this instance is the general instance responsible
for running all tests in the suite (runTestInNewInstance
is false
), or a test-specific instance
responsible for running just one test (runTestInNewInstance
is true
). Note that these Boolean
values are
reverse those used by runTest
, because runTests
always inverts the Boolean
value of
runTestInNewInstance
when invoking runTest
.
If runTestInNewInstance
is false
, this trait's implementation of this method will invoke
super.runTests
, passing along testName
and args
, but with the
runTestInNewInstance
flag set to true
. By setting runTestInNewInstance
to
true
, runTests
is telling runTest
to create a new instance to run each test.
If runTestInNewInstance
is true
, this trait's implementation of this method will invoke
runTest
directly, passing in testName.get
and the args
object, with
the runTestInNewInstance
flag set to false
. By setting runTestInNewInstance
to
false
, runTests
is telling runTest
that this is the test-specific instance,
so it should just run the specified test.
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.
Trait that facilitates a style of testing in which each test is run in its own instance of the suite class to isolate each test from the side effects of the other tests in the suite.
OneInstancePerTest
is intended primarily to serve as a supertrait forParallelTestExecution
and the path traits, to facilitate porting JUnit tests to ScalaTest, and to make it easy for users who prefer JUnit's approach to isolation to obtain similar behavior in ScalaTest.If you mix this trait into a
Suite
, you can initialize shared reassignable fixture variables as well as shared mutable fixture objects in the constructor of the class. Because each test will run in its own instance of the class, each test will get a fresh copy of the instance variables. This is the approach to test isolation taken, for example, by the JUnit framework.OneInstancePerTest
can, therefore, be handy when porting JUnit tests to ScalaTest.Here's an example of
OneInstancePerTest
being used in aFunSuite
:OneInstancePerTest
is supertrait toParallelTestExecution
, in which running each test in its own instance is intended to make it easier to write suites of tests that run in parallel (by reducing the likelihood of concurrency bugs in those suites.)OneInstancePerTest
is also supertrait to the path traits,path.FunSpec
andpath.FreeSpec
, to make it obvious these traits run each test in a new, isolated instance.For the details on how
OneInstancePerTest
works, see the documentation for methodsrunTests
andrunTest
, which this trait overrides.