org.scalatest.featurespec

FixtureAsyncFeatureSpec

abstract class FixtureAsyncFeatureSpec extends FixtureAsyncFeatureSpecLike

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

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

Class FixtureAsyncFeatureSpec behaves similarly to class org.scalatest.featurespec.AsyncFeatureSpec, 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.featurespec.AsyncFeatureSpec:

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.asyncfeaturespec.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 featurespec.FixtureAsyncFeatureSpec {

  type FixtureParam = StringActor

  def withFixture(test: OneArgAsyncTest): FutureOutcome = {

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

  Feature("Simplicity") {
    Scenario("User needs to read test code written by others") { actor =>
      actor ! Append("encourage clear code!")
      val futureString = actor ? GetValue
      futureString map { s =>
        assert(s === "ScalaTest is designed to encourage clear code!")
      }
    }

    Scenario("User needs to understand what the tests are doing") { actor =>
      actor ! Append("be easy to reason about!")
      val futureString = actor ? GetValue
      futureString map { s =>
        assert(s === "ScalaTest is designed to be easy to reason about!")
      }
    }
  }
}

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.asyncfeaturespec.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 featurespec.FixtureAsyncFeatureSpec with DbFixture {

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

  Feature("Simplicity") {
    Scenario("Testing should be easy to write") { db =>
      Future {
        db.append("easy to write!")
        assert(db.toString === "ScalaTest is easy to write!")
      }
    }

    Scenario("Testing should be fun") { db =>
      Future {
        db.append("fun to write!")
        assert(db.toString === "ScalaTest is fun to write!")
      }
    }

    // This test doesn't need a Db
    Scenario("Testing code should be clear") { () =>
      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
FixtureAsyncFeatureSpec.scala
Linear Supertypes
FixtureAsyncFeatureSpecLike, Documenting, Alerting, Notifying, Informing, FixtureAsyncTestRegistration, FixtureAsyncTestSuite, AsyncTestSuite, CompleteLastly, RecoverMethods, FixtureSuite, Suite, Serializable, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FixtureAsyncFeatureSpec
  2. FixtureAsyncFeatureSpecLike
  3. Documenting
  4. Alerting
  5. Notifying
  6. Informing
  7. FixtureAsyncTestRegistration
  8. FixtureAsyncTestSuite
  9. AsyncTestSuite
  10. CompleteLastly
  11. RecoverMethods
  12. FixtureSuite
  13. Suite
  14. Serializable
  15. Serializable
  16. Assertions
  17. TripleEquals
  18. TripleEqualsSupport
  19. AnyRef
  20. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FixtureAsyncFeatureSpec()

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. class ResultOfIgnoreInvocation extends AnyRef

    Definition Classes
    FixtureAsyncFeatureSpecLike

  8. class ResultOfScenarioInvocation extends AnyRef

    Definition Classes
    FixtureAsyncFeatureSpecLike

Abstract Value Members

  1. abstract def withFixture(test: OneArgAsyncTest): FutureOutcome

    Definition Classes
    FixtureAsyncTestSuite

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Definition Classes
    TripleEqualsSupport

  4. def !==(right: Null): TripleEqualsInvocation[Null]

    Definition Classes
    TripleEqualsSupport

  5. def !==[T](right: T): TripleEqualsInvocation[T]

    Definition Classes
    TripleEqualsSupport

  6. final def ##(): Int

    Definition Classes
    AnyRef → Any

  7. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  8. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  9. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Definition Classes
    TripleEqualsSupport

  10. def ===(right: Null): TripleEqualsInvocation[Null]

    Definition Classes
    TripleEqualsSupport

  11. def ===[T](right: T): TripleEqualsInvocation[T]

    Definition Classes
    TripleEqualsSupport

  12. def Feature(description: String)(fun: ⇒ Unit)(implicit pos: Position): Unit

    Describe a “subject” being specified and tested by the passed function value.

    Describe a “subject” being specified and tested by the passed function value. The passed function value may contain more describers (defined with describe) and/or tests (defined with it). This trait's implementation of this method will register the description string and immediately invoke the passed function.

    description

    the description text

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike

  13. def Scenario(specText: String, testTags: Tag*): ResultOfScenarioInvocation

    Register a test with the given spec text, optional tags, and test function value that takes no arguments.

    Register a test with the given spec text, optional tags, and test function value that takes no arguments. An invocation of this method is called an “example.”

    This method will register the test for later execution via an invocation of one of the execute methods. The name of the test will be a concatenation of the text of all surrounding describers, from outside in, and the passed spec text, with one space placed between each item. (See the documenation for testNames for an example.) The resulting test name must not have been registered previously on this FixtureAsyncFeatureSpec instance.

    specText

    the specification text, which will be combined with the descText of any surrounding describers to form the test name

    testTags

    the optional list of tags for this test

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike
    Exceptions thrown
    DuplicateTestNameException

    if a test with the same name has been registered previously

    NullArgumentException

    if specText or any passed test tag is null

    TestRegistrationClosedException

    if invoked after run has been invoked on this suite

  14. def ScenariosFor(unit: Unit): Unit

    Registers shared scenarios.

    Registers shared scenarios.

    This method enables the following syntax for shared scenarios in a FixtureAsyncFeatureSpec:

    ScenariosFor(nonEmptyStack(lastValuePushed))

    This method just provides syntax sugar intended to make the intent of the code clearer. Because the parameter passed to it is type Unit, the expression will be evaluated before being passed, which is sufficient to register the shared scenarios. For examples of shared scenarios, see the Shared scenarios section in the main documentation for trait AnyFeatureSpec.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike

  15. 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 FixtureAsyncFeatureSpec 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
    FixtureAsyncFeatureSpecLike → Alerting

  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  17. def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )

  18. def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )

  19. def assertCompiles(code: String)(implicit pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )

  20. def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )

  21. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    Assertions

  22. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    Assertions

  23. def assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): Assertion

    Definition Classes
    Assertions

  24. def assertTypeError(code: String)(implicit pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )

  25. def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )

  26. def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )

  27. def cancel(cause: Throwable)(implicit pos: Position): Nothing

    Definition Classes
    Assertions

  28. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Definition Classes
    Assertions

  29. def cancel(message: String)(implicit pos: Position): Nothing

    Definition Classes
    Assertions

  30. def cancel()(implicit pos: Position): Nothing

    Definition Classes
    Assertions

  31. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def complete[T](completeBlock: ⇒ T)(implicit futuristic: Futuristic[T]): ResultOfCompleteInvocation[T]

    Definition Classes
    CompleteLastly

  33. implicit def convertAssertionToFutureAssertion(assertion: compatible.Assertion): Future[compatible.Assertion]

    Definition Classes
    AsyncTestSuite

  34. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport

  35. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport

  36. implicit def convertPendingToFixtureFunction(f: ⇒ PendingStatement): (FixtureParam) ⇒ compatible.Assertion

    Implicitly converts a function that takes no parameters and results in PendingStatement to a function from FixtureParam to Any, to enable pending tests to registered as by-name parameters by methods that require a test function that takes a FixtureParam.

    Implicitly converts a function that takes no parameters and results in PendingStatement to a function from FixtureParam to Any, to enable pending tests to registered as by-name parameters by methods that require a test function that takes a FixtureParam.

    This method makes it possible to write pending tests as simply (pending), without needing to write (fixture => pending).

    f

    a function

    returns

    a function of FixtureParam => Any

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike

  37. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

    Definition Classes
    TripleEquals → TripleEqualsSupport

  38. implicit def convertToEqualizer[T](left: T): Equalizer[T]

    Definition Classes
    TripleEquals → TripleEqualsSupport

  39. def defaultEquality[A]: Equality[A]

    Definition Classes
    TripleEqualsSupport

  40. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  41. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  42. final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit

    Definition Classes
    Suite

  43. implicit def executionContext: ExecutionContext

    Definition Classes
    AsyncTestSuite

  44. def expectedTestCount(filter: Filter): Int

    Definition Classes
    Suite

  45. def fail(cause: Throwable)(implicit pos: Position): Nothing

    Definition Classes
    Assertions

  46. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing

    Definition Classes
    Assertions

  47. def fail(message: String)(implicit pos: Position): Nothing

    Definition Classes
    Assertions

  48. def fail()(implicit pos: Position): Nothing

    Definition Classes
    Assertions

  49. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  50. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  51. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  52. def ignore(specText: String, testTags: Tag*): ResultOfIgnoreInvocation

    Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.

    Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments. This method will register the test for later ignoring via an invocation of one of the execute methods. This method exists to make it easy to ignore an existing test by changing the call to it to ignore without deleting or commenting out the actual test code. The test will not be executed, but a report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers, from outside in, and the passed spec text, with one space placed between each item. (See the documenation for testNames for an example.) The resulting test name must not have been registered previously on this FixtureAsyncFeatureSpec instance.

    specText

    the specification text, which will be combined with the descText of any surrounding describers to form the test name

    testTags

    the optional list of tags for this test

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike
    Exceptions thrown
    DuplicateTestNameException

    if a test with the same name has been registered previously

    NullArgumentException

    if specText or any passed test tag is null

    TestRegistrationClosedException

    if invoked after run has been invoked on this suite

  53. 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
    FixtureAsyncFeatureSpecLike → Informing

  54. def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): T

    Definition Classes
    Assertions

  55. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  56. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport

  57. 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
    FixtureAsyncFeatureSpecLike → Documenting

  58. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  59. def nestedSuites: IndexedSeq[Suite]

    Definition Classes
    Suite

  60. 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 FixtureAsyncFeatureSpec 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
    FixtureAsyncFeatureSpecLike → Notifying

  61. final def notify(): Unit

    Definition Classes
    AnyRef

  62. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  63. def parallelAsyncTestExecution: Boolean

    Attributes
    protected[org.scalatest]
    Definition Classes
    AsyncTestSuite

  64. def pending: Assertion with PendingStatement

    Definition Classes
    Assertions

  65. def pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement

    Definition Classes
    Assertions

  66. def recoverToExceptionIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[T]

    Definition Classes
    RecoverMethods

  67. def recoverToSucceededIf[T <: AnyRef](future: Future[Any])(implicit classTag: ClassTag[T], exCtx: ExecutionContext, pos: Position): Future[Assertion]

    Definition Classes
    RecoverMethods

  68. final def registerAsyncTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) ⇒ Future[compatible.Assertion])(implicit pos: Position): Unit

    Definition Classes
    FixtureAsyncFeatureSpecLike → FixtureAsyncTestRegistration

  69. final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) ⇒ Future[compatible.Assertion])(implicit pos: Position): Unit

    Definition Classes
    FixtureAsyncFeatureSpecLike → FixtureAsyncTestRegistration

  70. def rerunner: Option[String]

    Definition Classes
    Suite

  71. def run(testName: Option[String], args: Args): Status

    Definition Classes
    FixtureAsyncFeatureSpecLike → Suite

  72. def runNestedSuites(args: Args): Status

    Attributes
    protected
    Definition Classes
    Suite

  73. 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 run

    returns

    a Status object that indicates when the test started by this method has completed, and whether or not it failed .

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike → AsyncTestSuite → Suite
    Exceptions thrown
    NullArgumentException

    if testName, reporter, stopper, or configMap is null.

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

    Run zero to many of this FixtureAsyncFeatureSpec's tests.

    Run zero to many of this FixtureAsyncFeatureSpec'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 passed in 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 FixtureAsyncFeatureSpec.

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

    if any of testName or args is null.

  75. final val succeed: Assertion

    Definition Classes
    Assertions

  76. def suiteId: String

    Definition Classes
    Suite

  77. def suiteName: String

    Definition Classes
    Suite

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

    Definition Classes
    AnyRef

  79. def tags: Map[String, Set[String]]

    A Map whose keys are String tag names to which tests in this FixtureAsyncFeatureSpec 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 FixtureAsyncFeatureSpec belong, and values the Set of test names that belong to each tag. If this FixtureAsyncFeatureSpec 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
    FixtureAsyncFeatureSpecLike → Suite

  80. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData

    Definition Classes
    FixtureAsyncFeatureSpecLike → Suite

  81. def testNames: Set[String]

    An immutable Set of test names.

    An immutable Set of test names. If this FixtureAsyncFeatureSpec 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
    FixtureAsyncFeatureSpecLike → Suite

  82. 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
    FixtureAsyncFeatureSpec → AnyRef → Any

  83. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport

  84. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport

  85. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  87. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  88. def withClue[T](clue: Any)(fun: ⇒ T): T

    Definition Classes
    Assertions

  89. 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 feature(description: String)(fun: ⇒ Unit)(implicit pos: Position): Unit

    The feature (starting with lowercase 'f') method has been deprecated and will be removed in a future version of ScalaTest. Please use Feature (starting with an uppercase 'F') instead.

    The feature (starting with lowercase 'f') method has been deprecated and will be removed in a future version of ScalaTest. Please use Feature (starting with an uppercase 'F') instead.

    This method has been renamed for consistency with ScalaTest's Given, When, and Then methods, which were changed to uppper case when Scala deprecated then as an identifier, and Cucumber, one of the main original inspirations for FeatureSpec.

    This can be rewritten automatically with autofix: https://github.com/scalatest/autofix/tree/master/3.1.x.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The feature (starting with lowercase 'f') method has been deprecated and will be removed in a future version of ScalaTest. Please use Feature (starting with an uppercase 'F') instead. This can be rewritten automatically with autofix: https://github.com/scalatest/autofix/tree/master/3.1.x

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

  6. def scenario(specText: String, testTags: Tag*): ResultOfScenarioInvocation

    The scenario (starting with lowercase 's') method has been deprecated and will be removed in a future version of ScalaTest. Please use Scenario (starting with an uppercase 'S') instead.

    The scenario (starting with lowercase 's') method has been deprecated and will be removed in a future version of ScalaTest. Please use Scenario (starting with an uppercase 'S') instead.

    This method has been renamed for consistency with ScalaTest's Given, When, and Then methods, which were changed to uppper case when Scala deprecated then as an identifier, and Cucumber, one of the main original inspirations for FeatureSpec.

    This can be rewritten automatically with autofix: https://github.com/scalatest/autofix/tree/master/3.1.x.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The scenario (starting with lowercase 's') method has been deprecated and will be removed in a future version of ScalaTest. Please use Scenario (starting with an uppercase 'S') instead. This can be rewritten automatically with autofix: https://github.com/scalatest/autofix/tree/master/3.1.x

  7. def scenariosFor(unit: Unit): Unit

    The scenariosFor (starting with lowercase 's') method has been deprecated and will be removed in a future version of ScalaTest. Please use ScenariosFor (starting with an uppercase 'S') instead.

    The scenariosFor (starting with lowercase 's') method has been deprecated and will be removed in a future version of ScalaTest. Please use ScenariosFor (starting with an uppercase 'S') instead.

    This method has been renamed for consistency with ScalaTest's Given, When, and Then methods, which were changed to uppper case when Scala deprecated then as an identifier, and Cucumber, one of the main original inspirations for FeatureSpec.

    This can be rewritten automatically with autofix: https://github.com/scalatest/autofix/tree/master/3.1.x.

    Attributes
    protected
    Definition Classes
    FixtureAsyncFeatureSpecLike
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The scenariosFor (starting with lowercase 's') method has been deprecated and will be removed in a future version of ScalaTest. Please use ScenariosFor (starting with an uppercase 'S') instead. This can be rewritten automatically with autofix: https://github.com/scalatest/autofix/tree/master/3.1.x

  8. 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
    FixtureAsyncFeatureSpecLike → 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 FixtureAsyncFeatureSpecLike

Inherited from Documenting

Inherited from Alerting

Inherited from Notifying

Inherited from Informing

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 Serializable

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped