trait SuiteMixin extends AnyRef
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
- Self Type
- SuiteMixin with Suite
- Source
- SuiteMixin.scala
- Alphabetic
- By Inheritance
- SuiteMixin
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def expectedTestCount(filter: Filter): Int
The total number of tests that are expected to run when this
Suite'srunmethod is invoked.The total number of tests that are expected to run when this
Suite'srunmethod is invoked.- filter
a
Filterwith which to filter tests to count based on their tags
- abstract def nestedSuites: IndexedSeq[Suite]
An immutable
IndexedSeqof thisSuiteMixinobject's nestedSuites.An immutable
IndexedSeqof thisSuiteMixinobject's nestedSuites. If thisSuiteMixincontains no nestedSuites, this method returns an emptyIndexedSeq. - abstract def rerunner: Option[String]
The fully qualified name of the class that can be used to rerun this suite.
- abstract def run(testName: Option[String], args: Args): Status
Runs this suite of tests.
Runs this suite of tests.
- testName
an optional name of one test to execute. If
None, all relevant tests should be executed. I.e.,Noneacts like a wildcard that means execute all relevant tests in thisSuite.- args
the
Argsfor this run- returns
a
Statusobject that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.
- Exceptions thrown
NullArgumentExceptionif any passed parameter isnull.
- abstract 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.
- args
the
Argsfor this run- returns
a
Statusobject that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Exceptions thrown
NullArgumentExceptionifargsisnull.
- abstract def runTest(testName: String, args: Args): Status
Runs a test.
Runs a test.
- testName
the name of one test to execute.
- args
the
Argsfor this run- returns
a
Statusobject that indicates when the test started by this method has completed, and whether or not it failed .
- Attributes
- protected
- Exceptions thrown
NullArgumentExceptionif any oftestNameorargsisnull.
- abstract 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.
- testName
an optional name of one test to run. If
None, all relevant tests should be run. I.e.,Noneacts like a wildcard that means run all relevant tests in thisSuite.- args
the
Argsfor this run- returns
a
Statusobject that indicates when all tests started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Exceptions thrown
NullArgumentExceptionif eithertestNameorargsisnull.
- abstract def suiteId: String
A string ID for this
Suitethat is intended to be unique among all suites reported during a run.A string ID for this
Suitethat 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
Suiteobject's ID.
- abstract 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
runNestedSuitescalls this method to obtain a name forReports to pass to thesuiteStarting,suiteCompleted, andsuiteAbortedmethods of theReporter.- returns
this
Suiteobject's suite name.
- abstract def tags: Map[String, Set[String]]
A
Mapwhose keys areStringnames of tagged tests and whose associated values are theSetof tag names for the test.A
Mapwhose keys areStringnames of tagged tests and whose associated values are theSetof tag names for the test. If a test has no associated tags, its name does not appear as a key in the returnedMap. If thisSuitecontains no tests with tags, this method returns an emptyMap.Subclasses may override this method to define and/or discover tags in a custom manner, but overriding method implementations should never return an empty
Setas a value. If a test has no tags, its name should not appear as a key in the returnedMap. - abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
Provides a
TestDatainstance for the passed test name, given the passed config map.Provides a
TestDatainstance for the passed test name, given the passed config map.This method is used to obtain a
TestDatainstance to pass towithFixture(NoArgTest)andwithFixture(OneArgTest)and thebeforeEachandafterEachmethods of traitBeforeAndAfterEach.- testName
the name of the test for which to return a
TestDatainstance- theConfigMap
the config map to include in the returned
TestData- returns
a
TestDatainstance for the specified test, which includes the specified config map
- abstract def testNames: Set[String]
A
Setof test names.A
Setof test names. If thisSuitecontains no tests, this method returns an emptySet.Although subclass and subtrait implementations of this method may return a
Setwhose iterator producesStringtest 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. - abstract val styleName: String
The
styleNamelifecycle method has been deprecated and will be removed in a future version of ScalaTest.The
styleNamelifecycle 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.- Annotations
- @deprecated
- Deprecated
(Since version 3.1.0) The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()