trait AnyFlatSpecLike extends TestSuite with TestRegistration with ShouldVerb with MustVerb with CanVerb with Informing with Notifying with Alerting with Documenting
Implementation trait for class AnyFlatSpec
, which facilitates a
“behavior-driven” style of development (BDD), in which tests
are combined with text that specifies the behavior the tests verify.
AnyFlatSpec
is a class, not a trait,
to minimize compile time given there is a slight compiler overhead to
mixing in traits compared to extending classes. If you need to mix the
behavior of AnyFlatSpec
into some other class, you can use this
trait instead, because class AnyFlatSpec
does nothing more than
extend this trait and add a nice toString
implementation.
See the documentation of the class for a detailed
overview of AnyFlatSpec
.
- Self Type
- AnyFlatSpecLike
- Annotations
- @Finders()
- Source
- AnyFlatSpecLike.scala
- Alphabetic
- By Inheritance
- AnyFlatSpecLike
- Documenting
- Alerting
- Notifying
- Informing
- CanVerb
- MustVerb
- ShouldVerb
- TestRegistration
- TestSuite
- Suite
- Serializable
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final class BehaviorWord extends AnyRef
Class that supports the registration of a “subject” being specified and tested via the instance referenced from
AnyFlatSpec
'sbehavior
field.Class that supports the registration of a “subject” being specified and tested via the instance referenced from
AnyFlatSpec
'sbehavior
field.This field enables syntax such as the following subject registration:
behavior of "A Stack" ^
For more information and examples of the use of the
behavior
field, see the main documentation for traitAnyFlatSpec
.- Attributes
- protected
- class CheckingEqualizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- class Equalizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- final class IgnoreVerbString extends AnyRef
Class that supports registration of ignored tests via the
IgnoreWord
instance referenced fromAnyFlatSpec
'signore
field.Class that supports registration of ignored tests via the
IgnoreWord
instance referenced fromAnyFlatSpec
'signore
field.This class enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
In addition, it enables syntax such as the following registration of an ignored, pending test:
ignore should "pop values in last-in-first-out order" is (pending) ^
Note: the
is
method is provided for completeness and design symmetry, given there's no way to prevent changingis
toignore
and marking a pending test as ignored that way. Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.And finally, it also enables syntax such as the following ignored, tagged test registration:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the
ignore
field, see the Ignored tests section in the main documentation for traitAnyFlatSpec
.- Attributes
- protected
- final class IgnoreVerbStringTaggedAs extends AnyRef
Class that supports registration of ignored, tagged tests via the
IgnoreWord
instance referenced fromAnyFlatSpec
'signore
field.Class that supports registration of ignored, tagged tests via the
IgnoreWord
instance referenced fromAnyFlatSpec
'signore
field.This class enables syntax such as the following registration of an ignored, tagged test:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
In addition, it enables syntax such as the following registration of an ignored, tagged, pending test:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
Note: the
is
method is provided for completeness and design symmetry, given there's no way to prevent changingis
toignore
and marking a pending test as ignored that way. Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.For more information and examples of the use of the
ignore
field, see the Ignored tests section in the main documentation for traitAnyFlatSpec
. For examples of tagged test registration, see the Tagging tests section in the main documentation for traitAnyFlatSpec
.- Attributes
- protected
- final class IgnoreWord extends AnyRef
Class that supports registration of ignored tests via the
ItWord
instance referenced fromAnyFlatSpec
'signore
field.Class that supports registration of ignored tests via the
ItWord
instance referenced fromAnyFlatSpec
'signore
field.This class enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
For more information and examples of the use of the
ignore
field, see Ignored tests section in the main documentation for this trait.- Attributes
- protected
- final class InAndIgnoreMethods extends AnyRef
Class that supports test registration in shorthand form.
Class that supports test registration in shorthand form.
For example, this class enables syntax such as the following test registration in shorthand form:
"A Stack (when empty)" should "be empty" in { ... } ^
This class also enables syntax such as the following ignored test registration in shorthand form:
"A Stack (when empty)" should "be empty" ignore { ... } ^
This class is used via an implicit conversion (named
convertToInAndIgnoreMethods
) fromResultOfStringPassedToVerb
. TheResultOfStringPassedToVerb
class does not declare any methods namedin
, because the type passed toin
differs in aAnyFlatSpec
and aFixtureAnyFlatSpec
. AFixtureAnyFlatSpec
needs twoin
methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes aFixture
as its parameter). By constrast, aAnyFlatSpec
needs only onein
method that takes a by-name parameter. As a result,AnyFlatSpec
andFixtureAnyFlatSpec
each provide an implicit conversion fromResultOfStringPassedToVerb
to a type that provides the appropriatein
methods.- Attributes
- protected
- final class InAndIgnoreMethodsAfterTaggedAs extends AnyRef
Class that supports tagged test registration in shorthand form.
Class that supports tagged test registration in shorthand form.
For example, this class enables syntax such as the following tagged test registration in shorthand form:
"A Stack (when empty)" should "be empty" taggedAs() in { ... } ^
This class also enables syntax such as the following tagged, ignored test registration in shorthand form:
"A Stack (when empty)" should "be empty" taggedAs(SlowTest) ignore { ... } ^
This class is used via an implicit conversion (named
convertToInAndIgnoreMethodsAfterTaggedAs
) fromResultOfTaggedAsInvocation
. TheResultOfTaggedAsInvocation
class does not declare any methods namedin
, because the type passed toin
differs in aAnyFlatSpec
and aFixtureAnyFlatSpec
. AFixtureAnyFlatSpec
needs twoin
methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes aFixture
as its parameter). By constrast, aAnyFlatSpec
needs only onein
method that takes a by-name parameter. As a result,AnyFlatSpec
andFixtureAnyFlatSpec
each provide an implicit conversion fromResultOfTaggedAsInvocation
to a type that provides the appropriatein
methods.- Attributes
- protected
- final class ItVerbString extends AnyRef
Class that supports test registration via the
ItWord
instance referenced fromAnyFlatSpec
'sit
field.Class that supports test registration via the
ItWord
instance referenced fromAnyFlatSpec
'sit
field.This class enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following registration of an ignored test:
it should "pop values in last-in-first-out order" ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending test:
it should "pop values in last-in-first-out order" is (pending) ^
And finally, it also enables syntax such as the following tagged test registration:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the
it
field, see the main documentation for traitAnyFlatSpec
.- Attributes
- protected
- final class ItVerbStringTaggedAs extends AnyRef
Class that supports the registration of tagged tests via the
ItWord
instance referenced fromAnyFlatSpec
'sit
field.Class that supports the registration of tagged tests via the
ItWord
instance referenced fromAnyFlatSpec
'sit
field.This class enables syntax such as the following tagged test registration:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
It also enables syntax such as the following registration of an ignored, tagged test:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending, tagged test:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
For more information and examples of the use of the
it
field to register tagged tests, see the Tagging tests section in the main documentation for traitAnyFlatSpec
. For examples of tagged test registration, see the Tagging tests section in the main documentation for traitAnyFlatSpec
.- Attributes
- protected
- final class ItWord extends AnyRef
Class that supports test (and shared test) registration via the instance referenced from
AnyFlatSpec
'sit
field.Class that supports test (and shared test) registration via the instance referenced from
AnyFlatSpec
'sit
field.This class enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the
it
field, see the main documentation for this trait.- Attributes
- protected
- trait NoArgTest extends () => Outcome with TestData
- Attributes
- protected
- Definition Classes
- TestSuite
- trait StringCanWrapperForVerb extends AnyRef
- Definition Classes
- CanVerb
- trait StringMustWrapperForVerb extends AnyRef
- Definition Classes
- MustVerb
- trait StringShouldWrapperForVerb extends AnyRef
- Definition Classes
- ShouldVerb
- final class TheyVerbString extends AnyRef
Class that supports test registration via the
TheyWord
instance referenced fromAnyFlatSpec
'sthey
field.Class that supports test registration via the
TheyWord
instance referenced fromAnyFlatSpec
'sthey
field.This class enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following registration of an ignored test:
they should "pop values in last-in-first-out order" ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending test:
they should "pop values in last-in-first-out order" is (pending) ^
And finally, it also enables syntax such as the following tagged test registration:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
For more information and examples of the use of the
it
field, see the main documentation for traitAnyFlatSpec
.- Attributes
- protected
- final class TheyVerbStringTaggedAs extends AnyRef
Class that supports the registration of tagged tests via the
TheyWord
instance referenced fromAnyFlatSpec
'sthey
field.Class that supports the registration of tagged tests via the
TheyWord
instance referenced fromAnyFlatSpec
'sthey
field.This class enables syntax such as the following tagged test registration:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... } ^
It also enables syntax such as the following registration of an ignored, tagged test:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... } ^
In addition, it enables syntax such as the following registration of a pending, tagged test:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending) ^
For more information and examples of the use of the
they
field to register tagged tests, see the Tagging tests section in the main documentation for traitAnyFlatSpec
. For examples of tagged test registration, see the Tagging tests section in the main documentation for traitAnyFlatSpec
.- Attributes
- protected
- final class TheyWord extends AnyRef
Class that supports test (and shared test) registration via the instance referenced from
AnyFlatSpec
'sit
field.Class that supports test (and shared test) registration via the instance referenced from
AnyFlatSpec
'sit
field.This class enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the
it
field, see the main documentation for this trait.- Attributes
- protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
- def !==(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
- def !==[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
- def ===(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
- def ===[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
- def alert: Alerter
Returns an
Alerter
that during test execution will forward strings passed to itsapply
method to the current reporter.Returns an
Alerter
that during test execution will forward strings passed to itsapply
method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while thisAnyFlatSpec
is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.- Attributes
- protected
- Definition Classes
- AnyFlatSpecLike → Alerting
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertCompiles(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assertTypeError(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
- val behave: BehaveWord
Supports shared test registration in
AnyFlatSpec
s.Supports shared test registration in
AnyFlatSpec
s.This field supports syntax such as the following:
it should behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of
behave
, see the Shared tests section in the main documentation for this trait.- Attributes
- protected
- val behavior: BehaviorWord
Supports the registration of a “subject” being specified and tested.
Supports the registration of a “subject” being specified and tested.
This field enables syntax such as the following subject registration:
behavior of "A Stack" ^
For more information and examples of the use of the
behavior
field, see the main documentation for this trait.- Attributes
- protected
- def cancel(cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel(message: String)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def cancel()(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- implicit def convertToEqualizer[T](left: T): Equalizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- implicit def convertToInAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb): InAndIgnoreMethods
Implicitly converts an object of type
ResultOfStringPassedToVerb
to anInAndIgnoreMethods
, to enablein
andignore
methods to be invokable on that object.Implicitly converts an object of type
ResultOfStringPassedToVerb
to anInAndIgnoreMethods
, to enablein
andignore
methods to be invokable on that object.- Attributes
- protected
- implicit def convertToInAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation): InAndIgnoreMethodsAfterTaggedAs
Implicitly converts an object of type
ResultOfTaggedAsInvocation
to anInAndIgnoreMethodsAfterTaggedAs
, to enablein
andignore
methods to be invokable on that object.Implicitly converts an object of type
ResultOfTaggedAsInvocation
to anInAndIgnoreMethodsAfterTaggedAs
, to enablein
andignore
methods to be invokable on that object.- Attributes
- protected
- implicit def convertToStringCanWrapper(o: String)(implicit position: Position): StringCanWrapperForVerb
- Definition Classes
- CanVerb
- implicit def convertToStringMustWrapperForVerb(o: String)(implicit position: Position): StringMustWrapperForVerb
- Definition Classes
- MustVerb
- implicit def convertToStringShouldWrapperForVerb(o: String)(implicit position: Position): StringShouldWrapperForVerb
- Definition Classes
- ShouldVerb
- def defaultEquality[A]: Equality[A]
- Definition Classes
- TripleEqualsSupport
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit
- Definition Classes
- Suite
- def expectedTestCount(filter: Filter): Int
- Definition Classes
- Suite
- def fail(cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail(message: String)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- def fail()(implicit pos: Position): Nothing
- Definition Classes
- Assertions
- 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()
- val ignore: IgnoreWord
Supports registration of ignored tests in
AnyFlatSpec
s.Supports registration of ignored tests in
AnyFlatSpec
s.This field enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... } ^
For more information and examples of the use of the
ignore
field, see the Ignored tests section in the main documentation for this trait.- Attributes
- protected
- def info: Informer
Returns an
Informer
that during test execution will forward strings passed to itsapply
method to the current reporter.Returns an
Informer
that during test execution will forward strings passed to itsapply
method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, asrecordedEvents
of the test completed event, such asTestSucceeded
. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.- Attributes
- protected
- Definition Classes
- AnyFlatSpecLike → Informing
- def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): T
- Definition Classes
- Assertions
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val it: ItWord
Supports test (and shared test) registration in
AnyFlatSpec
s.Supports test (and shared test) registration in
AnyFlatSpec
s.This field enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the
it
field, see the main documentation for this trait.- Attributes
- protected
- def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- def markup: Documenter
Returns a
Documenter
that during test execution will forward strings passed to itsapply
method to the current reporter.Returns a
Documenter
that during test execution will forward strings passed to itsapply
method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, asrecordedEvents
of the test completed event, such asTestSucceeded
. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.- Attributes
- protected
- Definition Classes
- AnyFlatSpecLike → Documenting
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nestedSuites: IndexedSeq[Suite]
- Definition Classes
- Suite
- def note: Notifier
Returns a
Notifier
that during test execution will forward strings passed to itsapply
method to the current reporter.Returns a
Notifier
that during test execution will forward strings passed to itsapply
method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while thisAnyFlatSpec
is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.- Attributes
- protected
- Definition Classes
- AnyFlatSpecLike → Notifying
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def pending: Assertion with PendingStatement
- Definition Classes
- Assertions
- def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
- Definition Classes
- Assertions
- final def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: => Any)(implicit pos: Position): Unit
- Definition Classes
- AnyFlatSpecLike → TestRegistration
- final def registerTest(testText: String, testTags: Tag*)(testFun: => Any)(implicit pos: Position): Unit
- Definition Classes
- AnyFlatSpecLike → TestRegistration
- def rerunner: Option[String]
- Definition Classes
- Suite
- def run(testName: Option[String], args: Args): Status
- Definition Classes
- AnyFlatSpecLike → Suite
- def runNestedSuites(args: Args): Status
- Attributes
- protected
- Definition Classes
- Suite
- def runTest(testName: String, args: Args): Status
Run a test.
Run a test. This trait's implementation runs the test registered with the name specified by
testName
. Each test's name is a concatenation of the text of all describers surrounding a test, from outside in, and the test's spec text, with one space placed between each item. (See the documenation fortestNames
for an example.)- testName
the name of one test to execute.
- args
the
Args
for this run- returns
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .
- Attributes
- protected
- Definition Classes
- AnyFlatSpecLike → TestSuite → Suite
- Exceptions thrown
NullArgumentException
if any oftestName
,reporter
,stopper
, orconfigMap
isnull
.
- def runTests(testName: Option[String], args: Args): Status
Run zero to many of this
AnyFlatSpec
's tests.Run zero to many of this
AnyFlatSpec
's tests.This method takes a
testName
parameter that optionally specifies a test to invoke. IftestName
isSome
, this trait's implementation of this method invokesrunTest
on this object, passing in:testName
- theString
value of thetestName
Option
passed to this methodreporter
- theReporter
passed to this method, or one that wraps and delegates to itstopper
- theStopper
passed to this method, or one that wraps and delegates to itconfigMap
- theconfigMap
passed to this method, or one that wraps and delegates to it
This method takes a
Set
of tag names that should be included (tagsToInclude
), and aSet
that should be excluded (tagsToExclude
), when deciding which of thisSuite
's tests to execute. IftagsToInclude
is empty, all tests will be executed except those those belonging to tags listed in thetagsToExclude
Set
. IftagsToInclude
is non-empty, only tests belonging to tags mentioned intagsToInclude
, and not mentioned intagsToExclude
will be executed. However, iftestName
isSome
,tagsToInclude
andtagsToExclude
are essentially ignored. Only iftestName
isNone
willtagsToInclude
andtagsToExclude
be consulted to determine which of the tests named in thetestNames
Set
should be run. For more information on trait tags, see the main documentation for this trait.If
testName
isNone
, this trait's implementation of this method invokestestNames
on thisSuite
to get aSet
of names of tests to potentially execute. (AtestNames
value ofNone
essentially acts as a wildcard that means all tests in thisSuite
that are selected bytagsToInclude
andtagsToExclude
should be executed.) For each test in thetestName
Set
, in the order they appear in the iterator obtained by invoking theelements
method on theSet
, this trait's implementation of this method checks whether the test should be run based on thetagsToInclude
andtagsToExclude
Set
s. If so, this implementation invokesrunTest
, passing in:testName
- theString
name of the test to run (which will be one of the names in thetestNames
Set
)reporter
- theReporter
passed to this method, or one that wraps and delegates to itstopper
- theStopper
passed to this method, or one that wraps and delegates to itconfigMap
- theconfigMap
passed to this method, or one that wraps and delegates to it
- 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 thisAnyFlatSpec
.- args
the
Args
for this run- returns
a
Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Definition Classes
- AnyFlatSpecLike → Suite
- Exceptions thrown
NullArgumentException
if any oftestName
,reporter
,stopper
,tagsToInclude
,tagsToExclude
, orconfigMap
isnull
.
- implicit val shorthandSharedTestRegistrationFunction: StringVerbBehaveLikeInvocation
Supports the shorthand form of shared test registration.
Supports the shorthand form of shared test registration.
For example, this method enables syntax such as the following in:
"A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed) ^
This function is passed as an implicit parameter to a
should
method provided inShouldVerb
, amust
method provided inMustVerb
, and acan
method provided inCanVerb
. When invoked, this function registers the subject description (the parameter to the function) and returns aBehaveWord
.- Attributes
- protected
- implicit val shorthandTestRegistrationFunction: StringVerbStringInvocation
Supports the shorthand form of test registration.
Supports the shorthand form of test registration.
For example, this method enables syntax such as the following:
"A Stack (when empty)" should "be empty" in { ... } ^
This function is passed as an implicit parameter to a
should
method provided inShouldVerb
, amust
method provided inMustVerb
, and acan
method provided inCanVerb
. When invoked, this function registers the subject description (the first parameter to the function) and returns aResultOfStringPassedToVerb
initialized with the verb and rest parameters (the second and third parameters to the function, respectively).- Attributes
- protected
- final val succeed: Assertion
- Definition Classes
- Assertions
- def suiteId: String
- Definition Classes
- Suite
- def suiteName: String
- Definition Classes
- Suite
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tags: Map[String, Set[String]]
A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tags for the test.A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tags for the test. If thisAnyFlatSpec
contains no tags, this method returns an emptyMap
.This trait's implementation returns tags that were passed as strings contained in
Tag
objects passed totaggedAs
.In addition, this trait's implementation will also auto-tag tests with class level annotations. For example, if you annotate
@Ignore
at the class level, all test methods in the class will be auto-annotated withorg.scalatest.Ignore
.- Definition Classes
- AnyFlatSpecLike → Suite
- def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
- Definition Classes
- AnyFlatSpecLike → Suite
- def testNames: Set[String]
An immutable
Set
of test names.An immutable
Set
of test names. If thisAnyFlatSpec
contains no tests, this method returns an emptySet
.This trait's implementation of this method will return a set that contains the names of all registered tests. The set's iterator will return those names in the order in which the tests were registered. Each test's name is composed of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the example itself, with all components separated by a space. For example, consider this
AnyFlatSpec
:import org.scalatest.flatspec.AnyFlatSpec class StackSpec extends AnyFlatSpec { "A Stack (when not empty)" must "allow me to pop" in {} it must "not be empty" in {} "A Stack (when not full)" must "allow me to push" in {} it must "not be full" in {} }
Invoking
testNames
on thisAnyFlatSpec
will yield a set that contains the following two test name strings:"A Stack (when not empty) must allow me to pop" "A Stack (when not empty) must not be empty" "A Stack (when not full) must allow me to push" "A Stack (when not full) must not be full"
- Definition Classes
- AnyFlatSpecLike → Suite
- val they: TheyWord
Supports test (and shared test) registration in
AnyFlatSpec
s.Supports test (and shared test) registration in
AnyFlatSpec
s.This field enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... } ^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the
it
field, see the main documentation for this trait.- Attributes
- protected
- def toString(): String
- Definition Classes
- AnyRef → Any
- def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- 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()
- def withClue[T](clue: Any)(fun: => T): T
- Definition Classes
- Assertions
- def withFixture(test: NoArgTest): Outcome
- Attributes
- protected
- Definition Classes
- TestSuite
Deprecated Value Members
- def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) => A): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- Annotations
- @deprecated
- Deprecated
(Since version 3.1.0) The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
- def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) => B): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- Annotations
- @deprecated
- Deprecated
(Since version 3.1.0) The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
- def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) => A): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- Annotations
- @deprecated
- Deprecated
(Since version 3.1.0) The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
- def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) => B): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- Annotations
- @deprecated
- Deprecated
(Since version 3.1.0) The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
- final 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
.- Definition Classes
- AnyFlatSpecLike → Suite
- 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.