Trait that can be mixed into suites that need code executed before and after running each test. This trait facilitates a style of testing in which mutable fixture objects held in instance variables are replaced or reinitialized before each test or suite. Here's an example:
import org.scalatest._ import scala.collection.mutable.ListBufferclass MySuite extends BeforeAndAfterEachFunctions {
// Fixtures as reassignable variables and mutable objects var sb: StringBuilder = _ val lb = new ListBuffer[String]
beforeEach { sb = new StringBuilder("ScalaTest is ") lb.clear() }
def testEasy() { sb.append("easy!") assert(sb.toString === "ScalaTest is easy!") assert(lb.isEmpty) lb += "sweet" }
def testFun() { sb.append("fun!") assert(sb.toString === "ScalaTest is fun!") assert(lb.isEmpty) } }
Because this trait invokes super.runTest to
run each test, you may need to mix this trait in last to get the desired behavior. For example, this won't
work, because BeforeAndAfterEachFunctions is "super" to FunSuite:
class MySuite extends BeforeAndAfterEachFunctions with FunSuite
You'd need to turn it around, so that FunSuite is "super" to BeforeAndAfterEachFunctions, like this:
class MySuite extends FunSuite with BeforeAndAfterEachFunctions
The beforeEach and afterEach methods can each only be called once per Suite,
and cannot be invoked after run has been invoked.
Note: The advantage this trait has over BeforeAndAfterEach is that its syntax is more concise.
The main disadvantage is that it is not stackable, whereas BeforeAndAfterEach is. I.e.,
you can write several traits that extend BeforeAndAfterEach and provide beforeEach methods
that include a call to super.beforeEach, and mix them together in various combinations. By contrast,
only one call to the beforeEach registration function is allowed in a suite or spec that mixes
in BeforeAndAfterEachFunctions. In addition, BeforeAndAfterEach allows you to access
the config map in its beforeEach and afterEach methods, but BeforeAndAfterEachFunctions
does not.
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
A List of this Suite object's nested Suites. If this Suite contains no nested Suites,
this method returns an empty List.
A List of this Suite object's nested Suites. If this Suite contains no nested Suites,
this method returns an empty List.
This trait's implementation of run sets a flag indicating run has been invoked, after which
any invocation to beforeEach or afterEach will complete abruptly
with a NotAllowedException.@param testName an optional name of one test to execute. If None, all relevant tests should be executed.
This trait's implementation of run sets a flag indicating run has been invoked, after which
any invocation to beforeEach or afterEach will complete abruptly
with a NotAllowedException.@param 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 this Suite.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be executed
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.
a Tracker tracking Ordinals being fired by the current thread.
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.
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.
An Set of test names. If this Suite contains no tests, this method returns an empty Set.
An 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.
Trait that can be mixed into suites that need code executed before and after running each test. This trait facilitates a style of testing in which mutable fixture objects held in instance variables are replaced or reinitialized before each test or suite. Here's an example:
Because this trait invokes
super.runTestto run each test, you may need to mix this trait in last to get the desired behavior. For example, this won't work, becauseBeforeAndAfterEachFunctionsis "super" to FunSuite:You'd need to turn it around, so that
FunSuiteis "super" toBeforeAndAfterEachFunctions, like this:The
beforeEachandafterEachmethods can each only be called once perSuite, and cannot be invoked afterrunhas been invoked.Note: The advantage this trait has over
BeforeAndAfterEachis that its syntax is more concise. The main disadvantage is that it is not stackable, whereasBeforeAndAfterEachis. I.e., you can write several traits that extendBeforeAndAfterEachand providebeforeEachmethods that include a call tosuper.beforeEach, and mix them together in various combinations. By contrast, only one call to thebeforeEachregistration function is allowed in a suite or spec that mixes inBeforeAndAfterEachFunctions. In addition,BeforeAndAfterEachallows you to access the config map in itsbeforeEachandafterEachmethods, butBeforeAndAfterEachFunctionsdoes not.