scalatestCoreDotty/org.scalatest/TestSuiteMixin

TestSuiteMixin

trait TestSuiteMixin extends SuiteMixin

Trait defining abstract "lifecycle" methods that are implemented in TestSuite and can be overridden in stackable modification traits.

The main use case for this trait is to override withFixture in a mixin trait. Here's an example:

trait Builder extends TestSuiteMixin { this: TestSuite =>

 val builder = new StringBuilder

 abstract override def withFixture(test: NoArgTest) = {
   builder.append("ScalaTest is ")
   try super.withFixture(test) // To be stackable, must call super.withFixture
   finally builder.clear()
 }
}
class Object
trait Matchable
class Any

Value members

Abstract methods

protected def withFixture(test: <none>): Outcome

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.

Value parameters:
test

the no-arg test function to run with a fixture

Inherited methods

def expectedTestCount(filter: Filter): Int

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.

Value parameters:
filter

a Filter with which to filter tests to count based on their tags

Inherited from:
SuiteMixin
def nestedSuites: IndexedSeq[Suite]

An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites, this method returns an empty IndexedSeq.

An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites, this method returns an empty IndexedSeq.

Inherited from:
SuiteMixin
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.

Inherited from:
SuiteMixin
def run(testName: Option[String], args: Args): Status

Runs this suite of tests.

Runs this suite of tests.

Value parameters:
args

the Args for this run

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.

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.

Throws:
NullArgumentException

if any passed parameter is null.

Inherited from:
SuiteMixin
protected 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.

Value parameters:
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.

Throws:
NullArgumentException

if args is null.

Inherited from:
SuiteMixin
protected def runTest(testName: String, args: Args): Status

Runs a test.

Runs a test.

Value parameters:
args

the Args for this run

testName

the name of one test to execute.

Returns:

a Status object that indicates when the test started by this method has completed, and whether or not it failed .

Throws:
NullArgumentException

if any of testName or args is null.

Inherited from:
SuiteMixin
protected def runTests(testName: Option[String], args: Args): Status

Runs zero to many of this suite's tests.

Runs zero to many of this suite's tests.

Value parameters:
args

the Args for this run

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 this Suite.

Returns:

a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.

Throws:
NullArgumentException

if either testName or args is null.

Inherited from:
SuiteMixin
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.

Inherited from:
SuiteMixin
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 for Reports to pass to the suiteStarting, suiteCompleted, and suiteAborted methods of the Reporter.

Returns:

this Suite object's suite name.

Inherited from:
SuiteMixin
def tags: Map[String, Set[String]]

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.

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.

Inherited from:
SuiteMixin
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 to withFixture(NoArgTest) and withFixture(OneArgTest) and the beforeEach and afterEach methods of trait BeforeAndAfterEach.

Value parameters:
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

Inherited from:
SuiteMixin
def testNames: Set[String]

A Set of test names. If this Suite contains no tests, this method returns an empty Set.

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.

Inherited from:
SuiteMixin

Deprecated and Inherited fields

@deprecated("The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.", "3.1.0")
val styleName: String

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.

Deprecated
Inherited from:
SuiteMixin