abstract class FixtureAnyFlatSpec extends FixtureAnyFlatSpecLike
A sister class to org.scalatest.flatspec.AnyFlatSpec
that can pass a fixture object into its tests.
Recommended Usage:
Use class FixtureAnyFlatSpec in situations for which AnyFlatSpec
would be a good choice, when all or most tests need the same fixture objects
that must be cleaned up afterwards. Note: FixtureAnyFlatSpec is intended for use in special situations, with class AnyFlatSpec used for general needs. For
more insight into where FixtureAnyFlatSpec fits in the big picture, see the withFixture(OneArgTest) subsection of the Shared fixtures section in the documentation for class AnyFlatSpec .
|
Class FixtureAnyFlatSpec
behaves similarly to class org.scalatest.flatspec.AnyFlatSpec
, except that tests may have a
fixture parameter. The type of the
fixture parameter is defined by the abstract FixtureParam
type, which is a member of this class.
This class also contains an abstract withFixture
method. This withFixture
method
takes a OneArgTest
, which is a nested trait defined as a member of this class.
OneArgTest
has an apply
method that takes a FixtureParam
.
This apply
method is responsible for running a test.
This class's runTest
method delegates the actual running of each test to withFixture(OneArgTest)
, passing
in the test code to run via the OneArgTest
argument. The withFixture(OneArgTest)
method (abstract in this class) is responsible
for creating the fixture argument and passing it to the test function.
Subclasses of this class must, therefore, do three things differently from a plain old org.scalatest.flatspec.AnyFlatSpec
:
- define the type of the fixture parameter by specifying type
FixtureParam
- define the
withFixture(OneArgTest)
method - write tests that take a fixture parameter
- (You can also define tests that don't take a fixture parameter.)
If the fixture you want to pass into your tests consists of multiple objects, you will need to combine them into one object to use this class. One good approach to passing multiple fixture objects is to encapsulate them in a case class. Here's an example:
case class FixtureParam(file: File, writer: FileWriter)
To enable the stacking of traits that define withFixture(NoArgTest)
, it is a good idea to let
withFixture(NoArgTest)
invoke the test function instead of invoking the test
function directly. To do so, you'll need to convert the OneArgTest
to a NoArgTest
. You can do that by passing
the fixture object to the toNoArgTest
method of OneArgTest
. In other words, instead of
writing “test(theFixture)
”, you'd delegate responsibility for
invoking the test function to the withFixture(NoArgTest)
method of the same instance by writing:
withFixture(test.toNoArgTest(theFixture))
Here's a complete example:
package org.scalatest.examples.flatspec.oneargtest import org.scalatest.flatspec import java.io._ class ExampleSpec extends flatspec.FixtureAnyFlatSpec { case class FixtureParam(file: File, writer: FileWriter) def withFixture(test: OneArgTest) = { // create the fixture val file = File.createTempFile("hello", "world") val writer = new FileWriter(file) val theFixture = FixtureParam(file, writer) try { writer.write("ScalaTest is ") // set up the fixture withFixture(test.toNoArgTest(theFixture)) // "loan" the fixture to the test } finally writer.close() // clean up the fixture } "Testing" should "be easy" in { f => f.writer.write("easy!") f.writer.flush() assert(f.file.length === 18) } it should "be fun" in { f => f.writer.write("fun!") f.writer.flush() assert(f.file.length === 17) } }
If a test fails because of an exception, the OneArgTest
function will result in a Failed wrapping the exception.
To ensure clean up happens even if an exception occurs, you should invoke the test function from inside a try
block and do the cleanup in a
finally
clause, as shown in the previous example.
Sharing fixtures across classes
If multiple test classes need the same fixture, you can define the FixtureParam
and withFixture(OneArgTest)
implementations
in a trait, then mix that trait into the test classes that need it. For example, if your application requires a database and your integration tests
use that database, you will likely have many test classes that need a database fixture. You can create a "database fixture" trait that creates a
database with a unique name, passes the connector into the test, then removes the database once the test completes. This is shown in the following example:
package org.scalatest.examples.fixture.flatspec.sharing import java.util.concurrent.ConcurrentHashMap import org.scalatest._ import DbServer._ import java.util.UUID.randomUUID object DbServer { // Simulating a database server type Db = StringBuffer private val databases = new ConcurrentHashMap[String, Db] def createDb(name: String): Db = { val db = new StringBuffer databases.put(name, db) db } def removeDb(name: String) { databases.remove(name) } } trait DbFixture { this: FixtureSuite => type FixtureParam = Db // Allow clients to populate the database after // it is created def populateDb(db: Db) {} def withFixture(test: OneArgTest) = { val dbName = randomUUID.toString val db = createDb(dbName) // create the fixture try { populateDb(db) // setup the fixture withFixture(test.toNoArgTest(db)) // "loan" the fixture to the test } finally removeDb(dbName) // clean up the fixture } } class ExampleSpec extends flatspec.FixtureAnyFlatSpec with DbFixture { override def populateDb(db: Db) { // setup the fixture db.append("ScalaTest is ") } "Testing" should "be easy" in { db => db.append("easy!") assert(db.toString === "ScalaTest is easy!") } it should "be fun" in { db => db.append("fun!") assert(db.toString === "ScalaTest is fun!") } // This test doesn't need a Db "Test code" should "be clear" in { () => val buf = new StringBuffer buf.append("ScalaTest code is ") buf.append("clear!") assert(buf.toString === "ScalaTest code is clear!") } }
Often when you create fixtures in a trait like DbFixture
, you'll still need to enable individual test classes
to "setup" a newly created fixture before it gets passed into the tests. A good way to accomplish this is to pass the newly
created fixture into a setup method, like populateDb
in the previous example, before passing it to the test
function. Classes that need to perform such setup can override the method, as does ExampleSpec
.
If a test doesn't need the fixture, you can indicate that by providing a no-arg instead of a one-arg function, as is done in the
third test in the previous example, “Test code should be clear
”. In other words, instead of starting your function literal
with something like “db =>
”, you'd start it with “() =>
”. For such tests, runTest
will not invoke withFixture(OneArgTest)
. It will instead directly invoke withFixture(NoArgTest)
.
Both examples shown above demonstrate the technique of giving each test its own "fixture sandbox" to play in. When your fixtures
involve external side-effects, like creating files or databases, it is a good idea to give each file or database a unique name as is
done in these examples. This keeps tests completely isolated, allowing you to run them in parallel if desired. You could mix
ParallelTestExecution
into either of these ExampleSpec
classes, and the tests would run in parallel just fine.
- Annotations
- @Finders()
- Source
- FixtureAnyFlatSpec.scala
- Alphabetic
- By Inheritance
- FixtureAnyFlatSpec
- FixtureAnyFlatSpecLike
- Documenting
- Alerting
- Notifying
- Informing
- CanVerb
- MustVerb
- ShouldVerb
- FixtureTestRegistration
- FixtureTestSuite
- TestSuite
- FixtureSuite
- Suite
- Serializable
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new FixtureAnyFlatSpec()
Type Members
- class CheckingEqualizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- class Equalizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
- abstract type FixtureParam
- Attributes
- protected
- Definition Classes
- FixtureSuite
- trait NoArgTest extends () => Outcome with TestData
- Attributes
- protected
- Definition Classes
- TestSuite
- trait OneArgTest extends (FixtureTestSuite.FixtureParam) => Outcome with TestData
- Attributes
- protected
- Definition Classes
- FixtureTestSuite
- trait StringCanWrapperForVerb extends AnyRef
- Definition Classes
- CanVerb
- trait StringMustWrapperForVerb extends AnyRef
- Definition Classes
- MustVerb
- trait StringShouldWrapperForVerb extends AnyRef
- Definition Classes
- ShouldVerb
- final class BehaviorWord extends AnyRef
Class that supports the registration of a “subject” being specified and tested via the instance referenced from
FixtureAnyFlatSpec
'sbehavior
field.Class that supports the registration of a “subject” being specified and tested via the instance referenced from
FixtureAnyFlatSpec
'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
- Definition Classes
- FixtureAnyFlatSpecLike
- final class IgnoreVerbString extends AnyRef
Class that supports registration of ignored tests via the
IgnoreWord
instance referenced fromFixtureAnyFlatSpec
'signore
field.Class that supports registration of ignored tests via the
IgnoreWord
instance referenced fromFixtureAnyFlatSpec
'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
- Definition Classes
- FixtureAnyFlatSpecLike
- final class IgnoreVerbStringTaggedAs extends AnyRef
Class that supports registration of ignored, tagged tests via the
IgnoreWord
instance referenced fromFixtureAnyFlatSpec
'signore
field.Class that supports registration of ignored, tagged tests via the
IgnoreWord
instance referenced fromFixtureAnyFlatSpec
'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
- Definition Classes
- FixtureAnyFlatSpecLike
- final class IgnoreWord extends AnyRef
Class that supports registration of ignored tests via the instance referenced from
FixtureAnyFlatSpec
'signore
field.Class that supports registration of ignored tests via the instance referenced from
FixtureAnyFlatSpec
'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
- Definition Classes
- FixtureAnyFlatSpecLike
- 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 aorg.scalatest.flatspec.FixtureAnyFlatSpec
. Aorg.scalatest.flatspec.FixtureAnyFlatSpec
needs twoin
methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes aFixtureParam
as its parameter). By constrast, aAnyFlatSpec
needs only onein
method that takes a by-name parameter. As a result,AnyFlatSpec
andorg.scalatest.flatspec.FixtureAnyFlatSpec
each provide an implicit conversion fromResultOfStringPassedToVerb
to a type that provides the appropriatein
methods.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- 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 aFixtureParam
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
- Definition Classes
- FixtureAnyFlatSpecLike
- final class ItVerbString extends AnyRef
Class that supports test registration via the instance referenced from
FixtureAnyFlatSpec
'sit
field.Class that supports test registration via the instance referenced from
FixtureAnyFlatSpec
'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
- Definition Classes
- FixtureAnyFlatSpecLike
- final class ItVerbStringTaggedAs extends AnyRef
Class that supports the registration of tagged tests via the
ItWord
instance referenced fromFixtureAnyFlatSpec
'sit
field.Class that supports the registration of tagged tests via the
ItWord
instance referenced fromFixtureAnyFlatSpec
'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
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- final class ItWord extends AnyRef
Class that supports test (and shared test) registration via the instance referenced from
FixtureAnyFlatSpec
'sit
field.Class that supports test (and shared test) registration via the instance referenced from
FixtureAnyFlatSpec
'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 traitAnyFlatSpec
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- final class TheyVerbString extends AnyRef
Class that supports test registration via the instance referenced from
FixtureAnyFlatSpec
'sit
field.Class that supports test registration via the instance referenced from
FixtureAnyFlatSpec
'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 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
- Definition Classes
- FixtureAnyFlatSpecLike
- final class TheyVerbStringTaggedAs extends AnyRef
Class that supports the registration of tagged tests via the
TheyWord
instance referenced fromFixtureAnyFlatSpec
'sthey
field.Class that supports the registration of tagged tests via the
TheyWord
instance referenced fromFixtureAnyFlatSpec
'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
it
field to register tagged tests, see the Tagging tests section in the main documentation for traitAnyFlatSpec
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- final class TheyWord extends AnyRef
Class that supports test (and shared test) registration via the instance referenced from
FixtureAnyFlatSpec
'sthey
field.Class that supports test (and shared test) registration via the instance referenced from
FixtureAnyFlatSpec
'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 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 traitAnyFlatSpec
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
Abstract Value Members
- abstract def withFixture(test: OneArgTest): Outcome
- Attributes
- protected
- Definition Classes
- FixtureTestSuite
Concrete 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 (and other objects) passed to itsapply
method to the current reporter.Returns an
Alerter
that during test execution will forward strings (and other objects) 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 thisFixtureAnyFlatSpec
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
- FixtureAnyFlatSpecLike → 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
FixtureAnyFlatSpec
s.Supports shared test registration in
FixtureAnyFlatSpec
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 traitAnyFlatSpec
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- 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 traitAnyFlatSpec
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- 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.- resultOfStringPassedToVerb
an
ResultOfStringPassedToVerb
instance
- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- 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.- resultOfTaggedAsInvocation
an
ResultOfTaggedAsInvocation
instance
- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- 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
FixtureAnyFlatSpec
s.Supports registration of ignored tests in
FixtureAnyFlatSpec
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 traitAnyFlatSpec
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- 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
- FixtureAnyFlatSpecLike → 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
FixtureAnyFlatSpec
s.Supports test (and shared test) registration in
FixtureAnyFlatSpec
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 traitAnyFlatSpec
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- 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
- FixtureAnyFlatSpecLike → 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 (and other objects) passed to itsapply
method to the current reporter.Returns a
Notifier
that during test execution will forward strings (and other objects) 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 thisFixtureAnyFlatSpec
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
- FixtureAnyFlatSpecLike → 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: (FixtureParam) => Any)(implicit pos: Position): Unit
- Definition Classes
- FixtureAnyFlatSpecLike → FixtureTestRegistration
- final def registerTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Any)(implicit pos: Position): Unit
- Definition Classes
- FixtureAnyFlatSpecLike → FixtureTestRegistration
- def rerunner: Option[String]
- Definition Classes
- Suite
- def run(testName: Option[String], args: Args): Status
- Definition Classes
- FixtureAnyFlatSpecLike → 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 test- 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
- FixtureAnyFlatSpecLike → TestSuite → Suite
- Exceptions thrown
NullArgumentException
iftestName
orargs
isnull
.
- def runTests(testName: Option[String], args: Args): Status
Run zero to many of this
FixtureAnyFlatSpec
's tests.Run zero to many of this
FixtureAnyFlatSpec
'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 with passedargs
.This method takes an
args
that contains aSet
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
with the passedargs
.- 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 thisFixtureAnyFlatSpecLike
.- 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
- FixtureAnyFlatSpecLike → Suite
- Exceptions thrown
NullArgumentException
if any oftestName
orargs
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:
"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
- Definition Classes
- FixtureAnyFlatSpecLike
- 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
- Definition Classes
- FixtureAnyFlatSpecLike
- 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
tag names to which tests in thisFixtureAnyFlatSpec
belong, and values theSet
of test names that belong to each tag.A
Map
whose keys areString
tag names to which tests in thisFixtureAnyFlatSpec
belong, and values theSet
of test names that belong to each tag. If thisFixtureAnyFlatSpec
contains no tags, this method returns an emptyMap
.This trait's implementation returns tags that were passed as strings contained in
Tag
objects passed to methodstest
andignore
.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 with @Ignore.
- Definition Classes
- FixtureAnyFlatSpecLike → Suite
- def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
- Definition Classes
- FixtureAnyFlatSpecLike → Suite
- def testNames: Set[String]
An immutable
Set
of test names.An immutable
Set
of test names. If thisFixtureAnyFlatSpec
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.
- returns
the
Set
of test names
- Definition Classes
- FixtureAnyFlatSpecLike → Suite
- val they: TheyWord
Supports test (and shared test) registration in
FixtureAnyFlatSpec
s.Supports test (and shared test) registration in
FixtureAnyFlatSpec
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 traitAnyFlatSpec
.- Attributes
- protected
- Definition Classes
- FixtureAnyFlatSpecLike
- def toString(): String
Returns a user friendly string for this suite, composed of the simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite contains nested suites, the result of invoking
toString
on each of the nested suites, separated by commas and surrounded by parentheses.Returns a user friendly string for this suite, composed of the simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite contains nested suites, the result of invoking
toString
on each of the nested suites, separated by commas and surrounded by parentheses.- returns
a user-friendly string for this suite
- Definition Classes
- FixtureAnyFlatSpec → 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
- FixtureAnyFlatSpecLike → FixtureSuite → 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.