BeforeAndAfter
Related Doc:
package scalatest
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 Suites.
An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites,
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 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.
NullArgumentException if args is null.
Runs zero to many of this suite's tests.
Runs zero to many of this suite'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.
NullArgumentException if either testName or args is null.
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 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.
this Suite object's ID.
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 for Reports to pass to the suiteStarting, suiteCompleted,
and suiteAborted methods of the Reporter.
this Suite object's suite name.
A Map whose keys are String names of tagged tests and
whose associated values are the Set of tag names for the test.
A Map whose keys are String names of tagged tests and
whose associated values are the Set of tag names for the test. If a test has no associated tags, its name
does not appear as a key in the returned Map. If this Suite contains no tests with tags, this
method returns an empty Map.
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
returned Map.
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 to withFixture(NoArgTest)
and withFixture(OneArgTest) and the beforeEach and afterEach methods
of trait BeforeAndAfterEach.
the name of the test for which to return a TestData instance
the config map to include in the returned TestData
a TestData instance for the specified test, which includes the specified config 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
Registers code to be executed after each of this suite's tests.
Registers code to be executed after each of this suite's tests.
This trait's implementation of runTest executes the code passed to this method after running
each test. Thus the code passed to this method can be used to tear down a test fixture
needed by each test.
NotAllowedException if invoked more than once on the same Suite or if
invoked after run has been invoked on the Suite
Registers code to be executed before each of this suite's tests.
Registers code to be executed before each of this suite's tests.
This trait's implementation
of runTest executes the code passed to this method before running
each test. Thus the code passed to this method can be used to set up a test fixture
needed by each test.
NotAllowedException if invoked more than once on the same Suite or if
invoked after run has been invoked on the Suite
This trait's implementation of run sets a flag indicating run has been invoked, after which
any invocation to before or after will complete abruptly
with a NotAllowedException.
This trait's implementation of run sets a flag indicating run has been invoked, after which
any invocation to before or after will complete abruptly
with a NotAllowedException.
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 and nested suites started by this method have completed, and whether or not a failure occurred.
Run a test surrounded by calls to the code passed to before and after, if any.
Run a test surrounded by calls to the code passed to before and after, if any.
This trait's implementation of this method ("this method") invokes
the function registered with before, if any,
before running each test and the function registered with after, if any,
after running each test. It runs each test by invoking super.runTest, passing along
the five parameters passed to it.
If any invocation of the function registered with before completes abruptly with an exception, this
method will complete abruptly with the same exception. If any call to
super.runTest completes abruptly with an exception, this method
will complete abruptly with the same exception, however, before doing so, it will
invoke the function registered with after, if any. If the function registered with after
also completes abruptly with an exception, this
method will nevertheless complete abruptly with the exception previously thrown by super.runTest.
If super.runTest returns normally, but the function registered with after completes abruptly with an
exception, this method will complete abruptly with the exception thrown by the function registered with after.
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 .
Trait that can be mixed into suites that need code executed before and after running each test.
BeforeAndAfterwhen you need to perform the same side-effects before and/or after tests, rather than at the beginning or end of tests. Note: For more insight into whereBeforeAndAfterfits into the big picture, see the Shared fixtures section in the documentation for your chosen style trait.A test fixture is composed of the objects and other artifacts (files, sockets, database connections, etc.) tests use to do their work. When multiple tests need to work with the same fixtures, it is important to try and avoid duplicating the fixture code across those tests. The more code duplication you have in your tests, the greater drag the tests will have on refactoring the actual production code. Trait
BeforeAndAfteroffers one way to eliminate such code duplication: abeforeclause that will register code to be run before each test, and anafterclause that will register code to be run after.Here's an example:
package org.scalatest.examples.flatspec.beforeandafter import org.scalatest._ import collection.mutable.ListBuffer class ExampleSpec extends FlatSpec with BeforeAndAfter { val builder = new StringBuilder val buffer = new ListBuffer[String] before { builder.append("ScalaTest is ") } after { builder.clear() buffer.clear() } "Testing" should "be easy" in { builder.append("easy!") assert(builder.toString === "ScalaTest is easy!") assert(buffer.isEmpty) buffer += "sweet" } it should "be fun" in { builder.append("fun!") assert(builder.toString === "ScalaTest is fun!") assert(buffer.isEmpty) } }The
beforeandaftermethods can each only be called once perSuite, and cannot be invoked afterrunhas been invoked. If either of the registered before or after functions complete abruptly with an exception, it will be reported as an aborted suite and no more tests will be attempted in that suite.Note that the only way
beforeandaftercode can communicate with test code is via some side-effecting mechanism, commonly by reassigning instancevars or by changing the state of mutable objects held from instancevals (as in this example). If using instancevars or mutable objects held from instancevals you wouldn't be able to run tests in parallel in the same instance of the test class unless you synchronized access to the shared, mutable state. This is why ScalaTest'sParallelTestExecutiontrait extendsOneInstancePerTest. By running each test in its own instance of the class, each test has its own copy of the instance variables, so you don't need to synchronize. Were you to mixParallelTestExecutioninto theExampleSuiteabove, the tests would run in parallel just fine without any synchronization needed on the mutableStringBuilderandListBuffer[String]objects.Although
BeforeAndAfterprovides a minimal-boilerplate way to execute code before and after tests, it isn't designed to enable stackable traits, because the order of execution would be non-obvious. If you want to factor out before and after code that is common to multiple test suites, you should use traitBeforeAndAfterEachinstead.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 thebeforeregistration function is allowed in a suite or spec that mixes inBeforeAndAfter. In addition,BeforeAndAfterEachallows you to access the config map and test name via theTestDatapassed to itsbeforeEachandafterEachmethods, whereasBeforeAndAftergives you no access to the config map.