trait OneInstancePerTest extends SuiteMixin
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.
Recommended Usage: Trait OneInstancePerTest is intended primarily to serve as a supertrait for
ParallelTestExecution 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 a FunSuite
:
import org.scalatest.FunSuite import org.scalatest.OneInstancePerTest import collection.mutable.ListBuffer class MySuite extends FunSuite with OneInstancePerTest { val builder = new StringBuilder("ScalaTest is ") val buffer = new ListBuffer[String] test("easy") { builder.append("easy!") assert(builder.toString === "ScalaTest is easy!") assert(buffer.isEmpty) buffer += "sweet" } test("fun") { builder.append("fun!") assert(builder.toString === "ScalaTest is fun!") assert(buffer.isEmpty) } }
OneInstancePerTest
is supertrait to ParallelTestExecution
, 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
and path.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 methods runTests
and runTest
,
which this trait overrides.
- Self Type
- OneInstancePerTest with Suite
- Source
- OneInstancePerTest.scala
- Alphabetic
- By Inheritance
- OneInstancePerTest
- SuiteMixin
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
expectedTestCount(filter: Filter): Int
The total number of tests that are expected to run when this
Suite
'srun
method is invoked.The total number of tests that are expected to run when this
Suite
'srun
method is invoked.- filter
a
Filter
with which to filter tests to count based on their tags
- Definition Classes
- SuiteMixin
-
abstract
def
nestedSuites: IndexedSeq[Suite]
An immutable
IndexedSeq
of thisSuiteMixin
object's nestedSuite
s.An immutable
IndexedSeq
of thisSuiteMixin
object's nestedSuite
s. If thisSuiteMixin
contains no nestedSuite
s, this method returns an emptyIndexedSeq
.- Definition Classes
- SuiteMixin
-
abstract
def
rerunner: Option[String]
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.
- Definition Classes
- SuiteMixin
-
abstract
def
run(testName: Option[String], args: Args): Status
Runs this suite of tests.
Runs this suite of tests.
- testName
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 thisSuite
.- args
the
Args
for this run- returns
a
Status
object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
if any passed parameter isnull
.
-
abstract
def
runNestedSuites(args: Args): Status
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
- args
the
Args
for this run- returns
a
Status
object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
ifargs
isnull
.
-
abstract
val
styleName: String
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.
- Definition Classes
- SuiteMixin
-
abstract
def
suiteId: String
A string ID for this
Suite
that is intended to be unique among all suites reported during a run.A string ID for this
Suite
that is intended to be unique among all suites reported during a run.The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
- returns
this
Suite
object's ID.
- Definition Classes
- SuiteMixin
-
abstract
def
suiteName: String
A user-friendly suite name for this
Suite
.A user-friendly suite name for this
Suite
.This trait's implementation of this method returns the simple name of this object's class. This trait's implementation of
runNestedSuites
calls this method to obtain a name forReport
s to pass to thesuiteStarting
,suiteCompleted
, andsuiteAborted
methods of theReporter
.- returns
this
Suite
object's suite name.
- Definition Classes
- SuiteMixin
-
abstract
def
tags: Map[String, Set[String]]
A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tag names for the test.A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tag names for the test. If a test has no associated tags, its name does not appear as a key in the returnedMap
. If thisSuite
contains no tests with tags, this method returns an emptyMap
.Subclasses may override 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 test has no tags, its name should not appear as a key in the returnedMap
.- Definition Classes
- SuiteMixin
-
abstract
def
testDataFor(testName: String, theConfigMap: ConfigMap): TestData
Provides a
TestData
instance for the passed test name, given the passed config map.Provides a
TestData
instance for the passed test name, given the passed config map.This method is used to obtain a
TestData
instance to pass towithFixture(NoArgTest)
andwithFixture(OneArgTest)
and thebeforeEach
andafterEach
methods of traitBeforeAndAfterEach
.- testName
the name of the test for which to return a
TestData
instance- theConfigMap
the config map to include in the returned
TestData
- returns
a
TestData
instance for the specified test, which includes the specified config map
- Definition Classes
- SuiteMixin
-
abstract
def
testNames: Set[String]
A
Set
of test names.A
Set
of test names. If thisSuite
contains no tests, this method returns an emptySet
.Although subclass and subtrait implementations of this method may return a
Set
whose iterator producesString
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.- Definition Classes
- SuiteMixin
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newInstance: Suite with OneInstancePerTest
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 thisSuite
for each test. This trait's implementation of this method uses reflection to callthis.getClass.newInstance
. This approach will succeed only if thisSuite
's class has a public, no-arg constructor. In most cases this is likely to be true, because to be instantiated by ScalaTest'sRunner
aSuite
needs a public, no-arg constructor. However, this will not be true of anySuite
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 aSuite
class is explicitly defined without a public, no-arg constructor, you will need to override this method to construct a new instance of theSuite
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 } }
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
runTest(testName: String, args: Args): Status
Modifies the behavior of
super.runTest
to facilitate running each test in its own instance of thisSuite
's class.Modifies the behavior of
super.runTest
to facilitate running each test in its own instance of thisSuite
's class.This trait's implementation of
runTest
uses therunTestInNewInstance
flag of the passedArgs
object to determine whether this instance is the general instance responsible for running all tests in the suite (runTestInNewInstance
istrue
), or a test-specific instance responsible for running just one test (runTestInNewInstance
isfalse
). Note that theseBoolean
values are reverse those used byrunTests
, becauserunTests
always inverts theBoolean
value ofrunTestInNewInstance
when invokingrunTest
.If
runTestInNewInstance
istrue
, this trait's implementation of this method creates a new instance of this class (by invokingnewInstance
on itself), then invokesrun
on the new instance, passing intestName
, wrapped in aSome
, andargs
unchanged. (I.e., theArgs
object passed torunTest
is forwarded as is torun
on the new instance, including withrunTestInNewInstance
set.) If the invocation of eithernewInstance
on thisSuite
orrun
on a newly created instance of thisSuite
completes abruptly with an exception, then thisrunTests
method will complete abruptly with the same exception.If
runTestInNewInstance
isfalse
, this trait's implementation of this method simply invokessuper.runTest
, passing along the sametestName
andargs
objects.- testName
the name of one test to execute.
- args
the
Args
for this run- returns
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .
- Attributes
- protected
- Definition Classes
- OneInstancePerTest → SuiteMixin
-
def
runTests(testName: Option[String], args: Args): Status
Modifies the behavior of
super.runTests
to facilitate running each test in its own instance of thisSuite
's class.Modifies the behavior of
super.runTests
to facilitate running each test in its own instance of thisSuite
's class.This trait's implementation of
runTest
uses therunTestInNewInstance
flag of the passedArgs
object to determine whether this instance is the general instance responsible for running all tests in the suite (runTestInNewInstance
isfalse
), or a test-specific instance responsible for running just one test (runTestInNewInstance
istrue
). Note that theseBoolean
values are reverse those used byrunTest
, becauserunTests
always inverts theBoolean
value ofrunTestInNewInstance
when invokingrunTest
.If
runTestInNewInstance
isfalse
, this trait's implementation of this method will invokesuper.runTests
, passing alongtestName
andargs
, but with therunTestInNewInstance
flag set totrue
. By settingrunTestInNewInstance
totrue
,runTests
is tellingrunTest
to create a new instance to run each test.If
runTestInNewInstance
istrue
, this trait's implementation of this method will invokerunTest
directly, passing intestName.get
and theargs
object, with therunTestInNewInstance
flag set tofalse
. By settingrunTestInNewInstance
tofalse
,runTests
is tellingrunTest
that this is the test-specific instance, so it should just run the specified test.- testName
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 thisSuite
.- args
the
Args
for this run- returns
a
Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Definition Classes
- OneInstancePerTest → SuiteMixin
- Exceptions thrown
IllegalArgumentException
iftestName
is defined, but no test with the specified test name exists in thisSuite
, or ifrunTestInNewInstance
istrue
, buttestName
is empty.NullPointerException
if any of the passed parameters isnull
.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )