org.scalatest.fixture

AsyncPropSpecLike

trait AsyncPropSpecLike extends AsyncSuite with AsyncTestRegistration

Implementation trait for class fixture.PropSpec, which is a sister class to org.scalatest.PropSpec that can pass a fixture object into its tests.

fixture.PropSpec is a class, not a trait, to minimize compile time given there is a slight compiler overhead to mixing in traits compared to extending classes. If you need to mix the behavior of fixture.PropSpec into some other class, you can use this trait instead, because class fixture.PropSpec does nothing more than extend this trait and add a nice toString implementation.

See the documentation of the class for a detailed overview of fixture.PropSpec.

Self Type
AsyncPropSpecLike
Annotations
@Finders()
Linear Supertypes
AsyncTestRegistration, AsyncSuite, scalatest.AsyncSuite, Suite, scalatest.Suite, Serializable, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AsyncPropSpecLike
  2. AsyncTestRegistration
  3. AsyncSuite
  4. AsyncSuite
  5. Suite
  6. Suite
  7. Serializable
  8. Serializable
  9. Assertions
  10. TripleEquals
  11. TripleEqualsSupport
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class AssertionsHelper extends AnyRef

    Definition Classes
    Assertions
  2. class CheckingEqualizer[L] extends AnyRef

    Definition Classes
    TripleEqualsSupport
  3. class Equalizer[L] extends AnyRef

    Definition Classes
    TripleEqualsSupport
  4. abstract type FixtureParam

    Attributes
    protected
    Definition Classes
    Suite
  5. trait NoArgAsyncTest extends () ⇒ Future[Outcome] with TestData

    Definition Classes
    AsyncSuite
  6. trait NoArgTest extends () ⇒ Outcome with TestData

    Attributes
    protected
    Definition Classes
    Suite
  7. trait OneArgAsyncTest extends (AsyncSuite.FixtureParam) ⇒ Future[Outcome] with TestData

    Definition Classes
    AsyncSuite
  8. trait OneArgTest extends (FixtureParam) ⇒ Outcome with TestData

    Attributes
    protected
    Definition Classes
    Suite
  9. class ResultOfIgnoreInvocation extends AnyRef

  10. class ResultOfPropertyInvocation extends AnyRef

Abstract Value Members

  1. implicit abstract def executionContext: ExecutionContext

    Definition Classes
    AsyncSuite
  2. abstract def withAsyncFixture(test: OneArgAsyncTest): Future[Outcome]

    Definition Classes
    AsyncSuite

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def assert(condition: Boolean, clue: Any): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  14. def assert(condition: Boolean): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  15. def assertCompiles(code: String): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  16. def assertDoesNotCompile(code: String): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  17. def assertResult(expected: Any)(actual: Any): Assertion

    Definition Classes
    Assertions
  18. def assertResult(expected: Any, clue: Any)(actual: Any): Assertion

    Definition Classes
    Assertions
  19. def assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T]): Assertion

    Definition Classes
    Assertions
  20. def assertTypeError(code: String): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  21. val assertionsHelper: AssertionsHelper

    Definition Classes
    Assertions
  22. def assume(condition: Boolean, clue: Any): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  23. def assume(condition: Boolean): Assertion

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  24. def cancel(cause: Throwable): Nothing

    Definition Classes
    Assertions
  25. def cancel(message: String, cause: Throwable): Nothing

    Definition Classes
    Assertions
  26. def cancel(message: String): Nothing

    Definition Classes
    Assertions
  27. def cancel(): Nothing

    Definition Classes
    Assertions
  28. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  30. implicit def convertAssertionToFutureAssertion(assertion: Assertion): Future[Assertion]

    Definition Classes
    AsyncSuite
  31. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  32. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  33. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  34. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  35. implicit def convertPendingToFixtureFunction(f: ⇒ PendingStatement): (FixtureParam) ⇒ 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
  36. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  37. implicit def convertToEqualizer[T](left: T): Equalizer[T]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  38. implicit def convertToFuture(o: Any): Future[Any]

    Definition Classes
    AsyncSuite
  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: Unit

    Definition Classes
    Suite
  43. final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit

    Definition Classes
    Suite
  44. def expectedTestCount(filter: Filter): Int

    Definition Classes
    Suite
  45. def fail(cause: Throwable): Nothing

    Definition Classes
    Assertions
  46. def fail(message: String, cause: Throwable): Nothing

    Definition Classes
    Assertions
  47. def fail(message: String): Nothing

    Definition Classes
    Assertions
  48. def fail(): 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(testName: String, testTags: Tag*): ResultOfIgnoreInvocation

    Register a property-based test to ignore, which has the specified name, optional tags, and function value that takes no arguments.

    Register a property-based test to ignore, which has the specified name, optional tags, and function value that takes no arguments. This method will register the test for later ignoring via an invocation of one of the run methods. This method exists to make it easy to ignore an existing test by changing the call to test to ignore without deleting or commenting out the actual test code. The test will not be run, but a report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on this PropSpec instance.

    testName

    the name of the test

    testTags

    the optional list of tags for this test

    Attributes
    protected
    Exceptions thrown
    DuplicateTestNameException

    if a test with the same name has been registered previously

    NotAllowedException

    if testName had been registered previously

    TestRegistrationClosedException

    if invoked after run has been invoked on this suite

  53. def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T]): T

    Definition Classes
    Assertions
  54. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  55. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  56. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]

    Definition Classes
    TripleEquals → TripleEqualsSupport
  57. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  58. def nestedSuites: IndexedSeq[scalatest.Suite]

    Definition Classes
    Suite
  59. final def notify(): Unit

    Definition Classes
    AnyRef
  60. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  61. def parallelAsyncTestExecution: Boolean

    Attributes
    protected[org.scalatest]
    Definition Classes
    AsyncSuite
  62. def pending: Assertion with PendingStatement

    Definition Classes
    Assertions
  63. def pendingUntilFixed(f: ⇒ Unit): Assertion with PendingStatement

    Definition Classes
    Assertions
  64. def propertiesFor(unit: Unit): Unit

    Registers shared tests.

    Registers shared tests.

    This method enables the following syntax for shared tests in a fixture.PropSpec:

    propertiesFor(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 tests. For examples of shared tests, see the Shared tests section in the main documentation for trait PropSpec.

    unit

    a Unit

    Attributes
    protected
  65. def property(testName: String, testTags: Tag*): ResultOfPropertyInvocation

    Register a property-based test with the specified name, optional tags, and function value that takes no arguments.

    Register a property-based test with the specified name, optional tags, and function value that takes no arguments. This method will register the test for later execution via an invocation of one of the run methods. The passed test name must not have been registered previously on this PropSpec instance.

    testName

    the name of the test

    testTags

    the optional list of tags for this test

    Attributes
    protected
    Exceptions thrown
    DuplicateTestNameException

    if a test with the same name has been registered previously

    NotAllowedException

    if testName had been registered previously

    NullArgumentException

    if testName or any passed test tag is null

    TestRegistrationClosedException

    if invoked after run has been invoked on this suite

  66. final def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) ⇒ Future[Assertion]): Unit

    Definition Classes
    AsyncPropSpecLike → AsyncTestRegistration
  67. final def registerTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) ⇒ Future[Assertion]): Unit

    Definition Classes
    AsyncPropSpecLike → AsyncTestRegistration
  68. def rerunner: Option[String]

    Definition Classes
    Suite
  69. def run(testName: Option[String], args: Args): Status

    Definition Classes
    AsyncPropSpecLike → Suite
  70. def runNestedSuites(args: Args): Status

    Attributes
    protected
    Definition Classes
    Suite
  71. 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.

    testName

    the name of one test to run.

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

    if testName is defined but a test with that name does not exist on this fixture.PropSpec

    NullArgumentException

    if any of testName or args is null.

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

    Run zero to many of this fixture.PropSpecLike's tests.

    Run zero to many of this fixture.PropSpecLike'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 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 FunSpec.

    args

    the Args to which results will be reported

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

    if any of testName or args is null.

  73. final val styleName: String

    Suite style name.

    Suite style name.

    returns

    org.scalatest.fixture.PropSpec

    Definition Classes
    AsyncPropSpecLike → Suite → Suite
  74. final val succeed: Succeeded.type

    Definition Classes
    Assertions
  75. def suiteId: String

    Definition Classes
    Suite
  76. def suiteName: String

    Definition Classes
    Suite
  77. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  78. def tags: Map[String, Set[String]]

    A Map whose keys are String tag names to which tests in this fixture.PropSpec 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 fixture.PropSpec belong, and values the Set of test names that belong to each tag. If this fixture.PropSpec 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
    AsyncPropSpecLike → Suite
  79. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData

    Definition Classes
    AsyncPropSpecLike → Suite
  80. def testNames: Set[String]

    An immutable Set of test names.

    An immutable Set of test names. If this fixture.PropSpec 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.

    returns

    the Set of test names

    Definition Classes
    AsyncPropSpecLike → Suite
  81. def toString(): String

    Definition Classes
    AnyRef → Any
  82. def trap[T](f: ⇒ T): Throwable

    Definition Classes
    Assertions
  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 withAsyncFixture(test: NoArgAsyncTest): Future[Outcome]

    Definition Classes
    AsyncSuite
  89. def withClue[T](clue: Any)(fun: ⇒ T): T

    Definition Classes
    Assertions
  90. final def withFixture(test: OneArgTest): Outcome

    Definition Classes
    AsyncSuite → Suite
  91. final def withFixture(test: NoArgTest): Outcome

    Definition Classes
    AsyncSuite → Suite

Inherited from AsyncTestRegistration

Inherited from AsyncSuite

Inherited from scalatest.AsyncSuite

Inherited from Suite

Inherited from scalatest.Suite

Inherited from Serializable

Inherited from Serializable

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped