scalatestCoreDotty/org.scalatest/SuiteMixin

SuiteMixin

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

The main purpose of SuiteMixin is to differentiate core Suite style traits, such as Spec, FunSuite, and FunSpec from stackable modification traits for Suites such as BeforeAndAfterEach, OneInstancePerTest, and SequentialNestedSuiteExecution. Because these stackable traits extend SuiteMixin instead of Suite, you can't define a suite by simply extending one of the stackable traits:

class MySuite extends BeforeAndAfterEach // Won't compile

Instead, you need to extend a core Suite trait and mix the stackable BeforeAndAfterEach trait into that, like this:

class MySuite extends FunSuite with BeforeAndAfterEach // Compiles fine

class Object

trait Matchable

class Any

trait AsyncTestSuiteMixin

trait AsyncCancelAfterFailure

trait AsyncTimeLimitedTests

trait BeforeAndAfter

trait BeforeAndAfterAll

trait BeforeAndAfterAllConfigMap

trait BeforeAndAfterEach

trait BeforeAndAfterEachTestData

trait OneInstancePerTest

trait ParallelTestExecution

trait RandomTestOrder

trait SequentialNestedSuiteExecution

class Sequential

trait StepwiseNestedSuiteExecution

class Stepwise

trait TestSuiteMixin

trait CancelAfterFailure

trait SeveredStackTraces

trait ConductorMethods

trait TimeLimitedTests

trait TestsBeforeNestedSuites

Suite

Value members

Abstract methods

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

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

Deprecated 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")

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