Args

Arguments bundle passed to four of ScalaTest's lifecycle methods: run, runNestedSuites, runTests, and runTest.

The signatures of these methods, defined in trait Suite, are:

def run(testName: Option[String], args: Args)
def runNestedSuites(args: Args)
def runTests(testName: Option[String], args: Args)
def runTest(testName: String, args: Args)

The purpose of bundling these arguments into an Args object instead of passing them in individually is to make the signature of these four lifecycle methods easier to read, write, and remember, as well as to make the methods more pleasant to override in user code.

reporter: the Reporter to which results will be reported
stopper: the Stopper that will be consulted to determine whether to stop execution early.
filter: a Filter with which to filter tests based on their tags
configMap: a ConfigMap of key-value pairs that can be used by the executing Suite of tests.
distributor: 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.
tracker: a Tracker tracking Ordinals being fired by the current thread.
chosenStyles: a (possibly empty) Set of Strings specifying the run's chosen styles
runTestInNewInstance: a flag used to pass information between run methods in OneInstancePerTest and ParallelTestExecution.
distributedTestSorter: an optional DistributedTestSorter used by ParallelTestExecution to sort the events for the parallel-executed tests of one suite back into sequential order on the fly, with a timeout in case a test takes too long to complete
distributedSuiteSorter: an optional DistributedSuiteSorter used by ParallelTestExecution to ensure the events for the parallel-executed suites are sorted back into sequential order, with a timeout in case a suite takes to long to complete, even when tests are executed in parallel

Source: Args.scala
Exceptions thrown: NullPointerException
if any passed parameter is null.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Args(reporter: Reporter, stopper: Stopper = Stopper.default, filter: Filter = Filter.default, configMap: ConfigMap = ConfigMap.empty, distributor: Option[Distributor] = scala.None, tracker: Tracker = Tracker.default, chosenStyles: Set[String] = scala.this.Predef.Set.empty[String], runTestInNewInstance: Boolean = false, distributedTestSorter: Option[DistributedTestSorter] = scala.None, distributedSuiteSorter: Option[DistributedSuiteSorter] = scala.None)

reporter
the Reporter to which results will be reported
stopper
the Stopper that will be consulted to determine whether to stop execution early.
filter
a Filter with which to filter tests based on their tags
configMap
a ConfigMap of key-value pairs that can be used by the executing Suite of tests.
distributor
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.
tracker
a Tracker tracking Ordinals being fired by the current thread.
chosenStyles
a (possibly empty) Set of Strings specifying the run's chosen styles
runTestInNewInstance
a flag used to pass information between run methods in OneInstancePerTest and ParallelTestExecution.
distributedTestSorter
an optional DistributedTestSorter used by ParallelTestExecution to sort the events for the parallel-executed tests of one suite back into sequential order on the fly, with a timeout in case a test takes too long to complete
distributedSuiteSorter
an optional DistributedSuiteSorter used by ParallelTestExecution to ensure the events for the parallel-executed suites are sorted back into sequential order, with a timeout in case a suite takes to long to complete, even when tests are executed in parallel

Exceptions thrown
NullPointerException
if any passed parameter is null.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val chosenStyles: Set[String]

a (possibly empty) Set of Strings specifying the run's chosen styles
a (possibly empty) Set of Strings specifying the run's chosen styles
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
val configMap: ConfigMap

a ConfigMap of key-value pairs that can be used by the executing Suite of tests.
val distributedSuiteSorter: Option[DistributedSuiteSorter]

an optional DistributedSuiteSorter used by ParallelTestExecution to ensure the events for the parallel-executed suites are sorted back into sequential order, with a timeout in case a suite takes to long to complete, even when tests are executed in parallel
an optional DistributedSuiteSorter used by ParallelTestExecution to ensure the events for the parallel-executed suites are sorted back into sequential order, with a timeout in case a suite takes to long to complete, even when tests are executed in parallel
val distributedTestSorter: Option[DistributedTestSorter]

an optional DistributedTestSorter used by ParallelTestExecution to sort the events for the parallel-executed tests of one suite back into sequential order on the fly, with a timeout in case a test takes too long to complete
an optional DistributedTestSorter used by ParallelTestExecution to sort the events for the parallel-executed tests of one suite back into sequential order on the fly, with a timeout in case a test takes too long to complete
val distributor: Option[Distributor]

an optional Distributor, into which to put nested Suites to be executed by another entity, such as concurrently by a pool of threads.
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.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val filter: Filter

a Filter with which to filter tests based on their tags
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val reporter: Reporter

the Reporter to which results will be reported
val runTestInNewInstance: Boolean

a flag used to pass information between run methods in OneInstancePerTest and ParallelTestExecution.
a flag used to pass information between run methods in OneInstancePerTest and ParallelTestExecution.
val stopper: Stopper

the Stopper that will be consulted to determine whether to stop execution early.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tracker: Tracker

a Tracker tracking Ordinals being fired by the current thread.
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()

Instance Constructors

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val chosenStyles: Set[String]

def clone(): AnyRef

val configMap: ConfigMap

val distributedSuiteSorter: Option[DistributedSuiteSorter]

val distributedTestSorter: Option[DistributedTestSorter]

val distributor: Option[Distributor]

final def eq(arg0: AnyRef): Boolean

val filter: Filter

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val reporter: Reporter

val runTestInNewInstance: Boolean

val stopper: Stopper

final def synchronized[T0](arg0: ⇒ T0): T0

val tracker: Tracker

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped