Packages

c

org.scalatest.flatspec

FixtureAsyncFlatSpec

abstract class FixtureAsyncFlatSpec extends FixtureAsyncFlatSpecLike

A sister class to org.scalatest.flatspec.AsyncFlatSpec that can pass a fixture object into its tests.

Recommended Usage: Use class FixtureAsyncFlatSpec in situations for which AsyncFlatSpec would be a good choice, when all or most tests need the same fixture objects that must be cleaned up afterwards. Note: FixtureAsyncFlatSpec is intended for use in special situations, with class AsyncFlatSpec used for general needs. For more insight into where FixtureAsyncFlatSpec fits in the big picture, see the withFixture(OneArgAsyncTest) subsection of the Shared fixtures section in the documentation for class AsyncFlatSpec.

Class FixtureAsyncFlatSpec behaves similarly to class org.scalatest.flatspec.AsyncFlatSpec, 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 OneArgAsyncTest, which is a nested trait defined as a member of this class. OneArgAsyncTest 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(OneArgAsyncTest), passing in the test code to run via the OneArgAsyncTest argument. The withFixture(OneArgAsyncTest) 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.AsyncFlatSpec:

  • define the type of the fixture parameter by specifying type FixtureParam
  • define the withFixture(OneArgAsyncTest) 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(NoArgAsyncTest), it is a good idea to let withFixture(NoArgAsyncTest) invoke the test function instead of invoking the test function directly. To do so, you'll need to convert the OneArgAsyncTest to a NoArgAsyncTest. You can do that by passing the fixture object to the toNoArgAsyncTest method of OneArgAsyncTest. In other words, instead of writing “test(theFixture)”, you'd delegate responsibility for invoking the test function to the withFixture(NoArgAsyncTest) method of the same instance by writing:

withFixture(test.toNoArgAsyncTest(theFixture))

Here's a complete example:

package org.scalatest.examples.asyncflatspec.oneargasynctest

import org.scalatest._
import scala.concurrent.Future
import scala.concurrent.ExecutionContext

// Defining actor messages
sealed abstract class StringOp
case object Clear extends StringOp
case class Append(value: String) extends StringOp
case object GetValue

class StringActor { // Simulating an actor
  private final val sb = new StringBuilder
  def !(op: StringOp): Unit =
    synchronized {
      op match {
        case Append(value) => sb.append(value)
        case Clear => sb.clear()
      }
    }
  def ?(get: GetValue.type)(implicit c: ExecutionContext): Future[String] =
    Future {
      synchronized { sb.toString }
    }
}

class ExampleSpec extends flatspec.FixtureAsyncFlatSpec {

  type FixtureParam = StringActor

  def withFixture(test: OneArgAsyncTest): FutureOutcome = {

    val actor = new StringActor
    complete {
      actor ! Append("ScalaTest is ") // set up the fixture
      withFixture(test.toNoArgAsyncTest(actor))
    } lastly {
      actor ! Clear // ensure the fixture will be cleaned up
    }
  }

  "Testing" should "be easy" in { actor =>
    actor ! Append("easy!")
    val futureString = actor ? GetValue
    futureString map { s =>
      assert(s == "ScalaTest is easy!")
    }
  }

  it should "be fun" in { actor =>
    actor ! Append("fun!")
    val futureString = actor ? GetValue
    futureString map { s =>
      assert(s == "ScalaTest is fun!")
    }
  }

}

If a test fails, the future returned by the OneArgAsyncTest function will result in an org.scalatest.Failed wrapping the exception describing the failure. To ensure clean up happens even if a test fails, you should invoke the test function and do the cleanup using complete-lastly, as shown in the previous example. The complete-lastly syntax, defined in CompleteLastly, which is extended by AsyncTestSuite, ensures the second, cleanup block of code is executed, whether the the first block throws an exception or returns a future. If it returns a future, the cleanup will be executed when the future completes.

Sharing fixtures across classes

If multiple test classes need the same fixture, you can define the FixtureParam and withFixture(OneArgAsyncTest) 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.asyncflatspec.sharing

import java.util.concurrent.ConcurrentHashMap
import org.scalatest._
import DbServer._
import java.util.UUID.randomUUID
import scala.concurrent.Future

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: FixtureAsyncTestSuite =>

  type FixtureParam = Db

  // Allow clients to populate the database after
  // it is created
  def populateDb(db: Db) {}

  def withFixture(test: OneArgAsyncTest): FutureOutcome = {
    val dbName = randomUUID.toString
    val db = createDb(dbName) // create the fixture
    complete {
      populateDb(db) // setup the fixture
      withFixture(test.toNoArgAsyncTest(db)) // "loan" the fixture to the test
    } lastly {
      removeDb(dbName) // ensure the fixture will be cleaned up
    }
  }
}

class ExampleSpec extends flatspec.FixtureAsyncFlatSpec with DbFixture {

  override def populateDb(db: Db) { // setup the fixture
    db.append("ScalaTest is ")
  }

  "Testing" should "should be easy" in { db =>
    Future {
      db.append("easy!")
      assert(db.toString === "ScalaTest is easy!")
    }
  }

  it should "be fun" in { db =>
    Future {
      db.append("fun!")
      assert(db.toString === "ScalaTest is fun!")
    }
  }

  // This test doesn't need a Db
  "Test code" should "be clear" in { () =>
    Future {
      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 ExampleSuite.

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(OneArgAsyncTest). It will instead directly invoke withFixture(NoArgAsyncTest).

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 ExampleSuite classes, and the tests would run in parallel just fine.

Source
FixtureAsyncFlatSpec.scala
Linear Supertypes
FixtureAsyncFlatSpecLike, Documenting, Alerting, Notifying, Informing, CanVerb, MustVerb, ShouldVerb, FixtureAsyncTestRegistration, FixtureAsyncTestSuite, AsyncTestSuite, CompleteLastly, RecoverMethods, FixtureSuite, Suite, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FixtureAsyncFlatSpec
  2. FixtureAsyncFlatSpecLike
  3. Documenting
  4. Alerting
  5. Notifying
  6. Informing
  7. CanVerb
  8. MustVerb
  9. ShouldVerb
  10. FixtureAsyncTestRegistration
  11. FixtureAsyncTestSuite
  12. AsyncTestSuite
  13. CompleteLastly
  14. RecoverMethods
  15. FixtureSuite
  16. Suite
  17. Serializable
  18. Assertions
  19. TripleEquals
  20. TripleEqualsSupport
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FixtureAsyncFlatSpec()

Type Members

  1. class CheckingEqualizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  2. class Equalizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  3. abstract type FixtureParam
    Attributes
    protected
    Definition Classes
    FixtureSuite
  4. trait NoArgAsyncTest extends () => FutureOutcome with TestData
    Definition Classes
    AsyncTestSuite
  5. trait OneArgAsyncTest extends (FixtureAsyncTestSuite.FixtureParam) => FutureOutcome with TestData
    Definition Classes
    FixtureAsyncTestSuite
  6. class ResultOfCompleteInvocation[T] extends AnyRef
    Definition Classes
    CompleteLastly
  7. trait StringCanWrapperForVerb extends AnyRef
    Definition Classes
    CanVerb
  8. trait StringMustWrapperForVerb extends AnyRef
    Definition Classes
    MustVerb
  9. trait StringShouldWrapperForVerb extends AnyRef
    Definition Classes
    ShouldVerb
  10. final class BehaviorWord extends AnyRef

    Class that supports the registration of a “subject” being specified and tested via the instance referenced from FixtureAsyncFlatSpec's behavior field.

    Class that supports the registration of a “subject” being specified and tested via the instance referenced from FixtureAsyncFlatSpec's behavior 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  11. final class IgnoreVerbString extends AnyRef

    Class that supports registration of ignored tests via the IgnoreWord instance referenced from FixtureAsyncFlatSpec's ignore field.

    Class that supports registration of ignored tests via the IgnoreWord instance referenced from FixtureAsyncFlatSpec's ignore 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 changing is to ignore 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  12. final class IgnoreVerbStringTaggedAs extends AnyRef

    Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced from FixtureAsyncFlatSpec's ignore field.

    Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced from FixtureAsyncFlatSpec's ignore 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 changing is to ignore 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 trait AnyFlatSpec. For examples of tagged test registration, see the Tagging tests section in the main documentation for trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  13. final class IgnoreWord extends AnyRef

    Class that supports registration of ignored tests via the instance referenced from FixtureAsyncFlatSpec's ignore field.

    Class that supports registration of ignored tests via the instance referenced from FixtureAsyncFlatSpec's ignore 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
    FixtureAsyncFlatSpecLike
  14. 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) from ResultOfStringPassedToVerb. The ResultOfStringPassedToVerb class does not declare any methods named in, because the type passed to in differs in a AsyncFlatSpec and a org.scalatest.flatspec.FixtureAsyncFlatSpec. A org.scalatest.flatspec.FixtureAsyncFlatSpec needs two in methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a FixtureParam as its parameter). By constrast, a AsyncFlatSpec needs only one in method that takes a by-name parameter. As a result, AsyncFlatSpec and org.scalatest.flatspec.FixtureAsyncFlatSpec each provide an implicit conversion from ResultOfStringPassedToVerb to a type that provides the appropriate in methods.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  15. 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) from ResultOfTaggedAsInvocation. The ResultOfTaggedAsInvocation class does not declare any methods named in, because the type passed to in differs in a AsyncFlatSpec and a FixtureAsyncFlatSpec. A FixtureAsyncFlatSpec needs two in methods, one that takes a no-arg test function and another that takes a one-arg test function (a test that takes a FixtureParam as its parameter). By constrast, a AsyncFlatSpec needs only one in method that takes a by-name parameter. As a result, AsyncFlatSpec and FixtureAsyncFlatSpec each provide an implicit conversion from ResultOfTaggedAsInvocation to a type that provides the appropriate in methods.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  16. final class ItVerbString extends AnyRef

    Class that supports test registration via the instance referenced from FixtureAnyFlatSpec's it field.

    Class that supports test registration via the instance referenced from FixtureAnyFlatSpec's it 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  17. final class ItVerbStringTaggedAs extends AnyRef

    Class that supports the registration of tagged tests via the ItWord instance referenced from FixtureAsyncFlatSpec's it field.

    Class that supports the registration of tagged tests via the ItWord instance referenced from FixtureAsyncFlatSpec's it 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  18. final class ItWord extends AnyRef

    Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec's it field.

    Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec's it 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  19. final class TheyVerbString extends AnyRef

    Class that supports test registration via the instance referenced from FixtureAsyncFlatSpec's it field.

    Class that supports test registration via the instance referenced from FixtureAsyncFlatSpec's it 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  20. final class TheyVerbStringTaggedAs extends AnyRef

    Class that supports the registration of tagged tests via the TheyWord instance referenced from FixtureAsyncFlatSpec's they field.

    Class that supports the registration of tagged tests via the TheyWord instance referenced from FixtureAsyncFlatSpec's they 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  21. final class TheyWord extends AnyRef

    Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec's they field.

    Class that supports test (and shared test) registration via the instance referenced from FixtureAsyncFlatSpec's they 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike

Abstract Value Members

  1. abstract def withFixture(test: OneArgAsyncTest): FutureOutcome
    Definition Classes
    FixtureAsyncTestSuite

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
    Definition Classes
    TripleEqualsSupport
  3. def !==(right: Null): TripleEqualsInvocation[Null]
    Definition Classes
    TripleEqualsSupport
  4. def !==[T](right: T): TripleEqualsInvocation[T]
    Definition Classes
    TripleEqualsSupport
  5. final def ##: Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
    Definition Classes
    TripleEqualsSupport
  8. def ===(right: Null): TripleEqualsInvocation[Null]
    Definition Classes
    TripleEqualsSupport
  9. def ===[T](right: T): TripleEqualsInvocation[T]
    Definition Classes
    TripleEqualsSupport
  10. def alert: Alerter

    Returns an Alerter that during test execution will forward strings (and other objects) passed to its apply method to the current reporter.

    Returns an Alerter that during test execution will forward strings (and other objects) passed to its apply 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 this FixtureAsyncFlatSpec 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
    FixtureAsyncFlatSpecLike → Alerting
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  13. macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  14. macro def assertCompiles(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  15. macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  16. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  17. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  18. def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
    Definition Classes
    Assertions
  19. macro def assertTypeError(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  20. macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  21. macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  22. val behave: BehaveWord

    Supports shared test registration in FixtureAsyncFlatSpecs.

    Supports shared test registration in FixtureAsyncFlatSpecs.

    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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  23. 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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  24. def cancel(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  25. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  26. def cancel(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  27. def cancel()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  28. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  29. def complete[T](completeBlock: => T)(implicit futuristic: Futuristic[T]): ResultOfCompleteInvocation[T]
    Definition Classes
    CompleteLastly
  30. implicit def convertAssertionToFutureAssertion(assertion: compatible.Assertion): Future[compatible.Assertion]
    Definition Classes
    AsyncTestSuite
  31. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  32. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  33. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  34. implicit def convertToEqualizer[T](left: T): Equalizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  35. implicit def convertToInAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb): InAndIgnoreMethods

    Implicitly converts an object of type ResultOfStringPassedToVerb to an InAndIgnoreMethods, to enable in and ignore methods to be invokable on that object.

    Implicitly converts an object of type ResultOfStringPassedToVerb to an InAndIgnoreMethods, to enable in and ignore methods to be invokable on that object.

    resultOfStringPassedToVerb

    an ResultOfStringPassedToVerb instance

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  36. implicit def convertToInAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation): InAndIgnoreMethodsAfterTaggedAs

    Implicitly converts an object of type ResultOfTaggedAsInvocation to an InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore methods to be invokable on that object.

    Implicitly converts an object of type ResultOfTaggedAsInvocation to an InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore methods to be invokable on that object.

    resultOfTaggedAsInvocation

    an ResultOfTaggedAsInvocation instance

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  37. implicit def convertToStringCanWrapper(o: String)(implicit position: Position): StringCanWrapperForVerb
    Definition Classes
    CanVerb
  38. implicit def convertToStringMustWrapperForVerb(o: String)(implicit position: Position): StringMustWrapperForVerb
    Definition Classes
    MustVerb
  39. implicit def convertToStringShouldWrapperForVerb(o: String)(implicit position: Position): StringShouldWrapperForVerb
    Definition Classes
    ShouldVerb
  40. def defaultEquality[A]: Equality[A]
    Definition Classes
    TripleEqualsSupport
  41. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  43. final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit
    Definition Classes
    Suite
  44. implicit def executionContext: ExecutionContext
    Definition Classes
    AsyncTestSuite
  45. def expectedTestCount(filter: Filter): Int
    Definition Classes
    Suite
  46. def fail(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  47. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  48. def fail(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  49. def fail()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  50. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  51. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  52. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  53. val ignore: IgnoreWord

    Supports registration of ignored tests in FixtureAsyncFlatSpecs.

    Supports registration of ignored tests in FixtureAsyncFlatSpecs.

    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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  54. def info: Informer

    Returns an Informer that during test execution will forward strings passed to its apply method to the current reporter.

    Returns an Informer that during test execution will forward strings passed to its apply 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, as recordedEvents of the test completed event, such as TestSucceeded. 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
    FixtureAsyncFlatSpecLike → Informing
  55. def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): T
    Definition Classes
    Assertions
  56. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  57. val it: ItWord

    Supports test (and shared test) registration in FixtureAsyncFlatSpecs.

    Supports test (and shared test) registration in FixtureAsyncFlatSpecs.

    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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  58. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  59. def markup: Documenter

    Returns a Documenter that during test execution will forward strings passed to its apply method to the current reporter.

    Returns a Documenter that during test execution will forward strings passed to its apply 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, as recordedEvents of the test completed event, such as TestSucceeded. 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
    FixtureAsyncFlatSpecLike → Documenting
  60. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    Suite
  62. def note: Notifier

    Returns a Notifier that during test execution will forward strings (and other objects) passed to its apply method to the current reporter.

    Returns a Notifier that during test execution will forward strings (and other objects) passed to its apply 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 this FixtureAsyncFlatSpec 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
    FixtureAsyncFlatSpecLike → Notifying
  63. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  65. def parallelAsyncTestExecution: Boolean
    Attributes
    protected[scalatest]
    Definition Classes
    AsyncTestSuite
  66. def pending: Assertion with PendingStatement
    Definition Classes
    Assertions
  67. def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
    Definition Classes
    Assertions
  68. def recoverToExceptionIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[T]
    Definition Classes
    RecoverMethods
  69. def recoverToSucceededIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[compatible.Assertion]
    Definition Classes
    RecoverMethods
  70. final def registerAsyncTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Future[compatible.Assertion])(implicit pos: Position): Unit
    Definition Classes
    FixtureAsyncFlatSpecLike → FixtureAsyncTestRegistration
  71. final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Future[compatible.Assertion])(implicit pos: Position): Unit
    Definition Classes
    FixtureAsyncFlatSpecLike → FixtureAsyncTestRegistration
  72. def rerunner: Option[String]
    Definition Classes
    Suite
  73. def run(testName: Option[String], args: Args): Status
    Definition Classes
    FixtureAsyncFlatSpecLike → Suite
  74. def runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    Suite
  75. 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 for testNames 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
    FixtureAsyncFlatSpecLike → AsyncTestSuite → Suite
    Exceptions thrown

    NullArgumentException if testName or args is null.

  76. def runTests(testName: Option[String], args: Args): Status

    Run zero to many of this FixtureAsyncFlatSpec's tests.

    Run zero to many of this FixtureAsyncFlatSpec's tests.

    This method takes a testName parameter that optionally specifies a test to invoke. If testName is Some, this trait's implementation of this method invokes runTest on this object with passed args.

    This method takes an args that contains a Set of tag names that should be included (tagsToInclude), and a Set that should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute. If tagsToInclude is empty, all tests will be executed except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is non-empty, only tests belonging to tags mentioned in tagsToInclude, and not mentioned in tagsToExclude will be executed. However, if testName is Some, tagsToInclude and tagsToExclude are essentially ignored. Only if testName is None will tagsToInclude and tagsToExclude be consulted to determine which of the tests named in the testNames Set should be run. For more information on trait tags, see the main documentation for this trait.

    If testName is None, this trait's implementation of this method invokes testNames on this Suite to get a Set of names of tests to potentially execute. (A testNames value of None essentially acts as a wildcard that means all tests in this Suite that are selected by tagsToInclude and tagsToExclude should be executed.) For each test in the testName Set, in the order they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation of this method checks whether the test should be run based on the tagsToInclude and tagsToExclude Sets. If so, this implementation invokes runTest with the passed args.

    testName

    an optional name of one test to execute. If None, all relevant tests should be executed. I.e., None acts like a wildcard that means execute all relevant tests in this FixtureAsyncFlatSpecLike.

    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
    FixtureAsyncFlatSpecLike → Suite
    Exceptions thrown

    NullArgumentException if any of testName or args is null.

  77. 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 in ShouldVerb, a must method provided in MustVerb, and a can method provided in CanVerb. When invoked, this function registers the subject description (the parameter to the function) and returns a BehaveWord.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  78. 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 in ShouldVerb, a must method provided in MustVerb, and a can method provided in CanVerb. When invoked, this function registers the subject description (the first parameter to the function) and returns a ResultOfStringPassedToVerb initialized with the verb and rest parameters (the second and third parameters to the function, respectively).

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  79. final val succeed: Assertion
    Definition Classes
    Assertions
  80. def suiteId: String
    Definition Classes
    Suite
  81. def suiteName: String
    Definition Classes
    Suite
  82. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  83. def tags: Map[String, Set[String]]

    A Map whose keys are String tag names to which tests in this FixtureAsyncFlatSpec belong, and values the Set of test names that belong to each tag.

    A Map whose keys are String tag names to which tests in this FixtureAsyncFlatSpec belong, and values the Set of test names that belong to each tag. If this FixtureAsyncFlatSpec contains no tags, this method returns an empty Map.

    This trait's implementation returns tags that were passed as strings contained in Tag objects passed to methods test and ignore.

    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
    FixtureAsyncFlatSpecLike → Suite
  84. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
    Definition Classes
    FixtureAsyncFlatSpecLike → Suite
  85. def testNames: Set[String]

    An immutable Set of test names.

    An immutable Set of test names. If this FixtureAsyncFlatSpec contains no tests, this method returns an empty Set.

    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
    FixtureAsyncFlatSpecLike → Suite
  86. val they: TheyWord

    Supports test (and shared test) registration in FixtureAsyncFlatSpecs.

    Supports test (and shared test) registration in FixtureAsyncFlatSpecs.

    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 trait AnyFlatSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFlatSpecLike
  87. 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
    FixtureAsyncFlatSpec → AnyRef → Any
  88. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  89. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  90. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  91. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  92. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  93. def withClue[T](clue: Any)(fun: => T): T
    Definition Classes
    Assertions
  94. def withFixture(test: NoArgAsyncTest): FutureOutcome
    Definition Classes
    AsyncTestSuite

Deprecated Value Members

  1. 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.

  2. 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.

  3. 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.

  4. 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.

  5. 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
    FixtureAsyncFlatSpecLike → 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.

Inherited from FixtureAsyncFlatSpecLike

Inherited from Documenting

Inherited from Alerting

Inherited from Notifying

Inherited from Informing

Inherited from CanVerb

Inherited from MustVerb

Inherited from ShouldVerb

Inherited from FixtureAsyncTestRegistration

Inherited from FixtureAsyncTestSuite

Inherited from AsyncTestSuite

Inherited from CompleteLastly

Inherited from RecoverMethods

Inherited from FixtureSuite

Inherited from Suite

Inherited from Serializable

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped