Trait

org.scalatest.fixture

SpecLike

Related Doc: package fixture

Permalink

trait SpecLike extends Suite with Informing with Notifying with Alerting with Documenting

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

fixture.Spec 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.Spec into some other class, you can use this trait instead, because class fixture.Spec 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.Spec.

Self Type
SpecLike
Annotations
@Finders()
Linear Supertypes
Documenting, Alerting, Notifying, Informing, Suite, scalatest.Suite, Serializable, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpecLike
  2. Documenting
  3. Alerting
  4. Notifying
  5. Informing
  6. Suite
  7. Suite
  8. Serializable
  9. Serializable
  10. Assertions
  11. TripleEquals
  12. TripleEqualsSupport
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. class AssertionsHelper extends AnyRef

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

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

    Permalink
    Definition Classes
    TripleEqualsSupport
  4. abstract type FixtureParam

    Permalink
    Attributes
    protected
    Definition Classes
    Suite
  5. trait NoArgTest extends () ⇒ Outcome with TestData

    Permalink
    Attributes
    protected
    Definition Classes
    Suite
  6. trait OneArgTest extends (FixtureParam) ⇒ Outcome with TestData

    Permalink
    Attributes
    protected
    Definition Classes
    Suite

Abstract Value Members

  1. abstract def withFixture(test: OneArgTest): Outcome

    Permalink
    Attributes
    protected
    Definition Classes
    Suite

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  3. def !==(right: Null): TripleEqualsInvocation[Null]

    Permalink
    Definition Classes
    TripleEqualsSupport
  4. def !==[T](right: T): TripleEqualsInvocation[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  5. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  8. def ===(right: Null): TripleEqualsInvocation[Null]

    Permalink
    Definition Classes
    TripleEqualsSupport
  9. def ===[T](right: T): TripleEqualsInvocation[T]

    Permalink
    Definition Classes
    TripleEqualsSupport
  10. def alert: Alerter

    Permalink

    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 Spec 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
    SpecLike → Alerting
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. macro def assert(condition: Boolean, clue: Any): Assertion

    Permalink
    Definition Classes
    Assertions
  13. macro def assert(condition: Boolean): Assertion

    Permalink
    Definition Classes
    Assertions
  14. macro def assertCompiles(code: String): Assertion

    Permalink
    Definition Classes
    Assertions
  15. macro def assertDoesNotCompile(code: String): Assertion

    Permalink
    Definition Classes
    Assertions
  16. def assertResult(expected: Any)(actual: Any): Assertion

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

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

    Permalink
    Definition Classes
    Assertions
  19. macro def assertTypeError(code: String): Assertion

    Permalink
    Definition Classes
    Assertions
  20. val assertionsHelper: AssertionsHelper

    Permalink
    Definition Classes
    Assertions
  21. macro def assume(condition: Boolean, clue: Any): Assertion

    Permalink
    Definition Classes
    Assertions
  22. macro def assume(condition: Boolean): Assertion

    Permalink
    Definition Classes
    Assertions
  23. def cancel(cause: Throwable): Nothing

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

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

    Permalink
    Definition Classes
    Assertions
  26. def cancel(): Nothing

    Permalink
    Definition Classes
    Assertions
  27. def clone(): AnyRef

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

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

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

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

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

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  33. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

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

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  35. def defaultEquality[A]: Equality[A]

    Permalink
    Definition Classes
    TripleEqualsSupport
  36. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  37. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  38. final def execute: Unit

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

    Permalink
    Definition Classes
    Suite
  40. final def expectedTestCount(filter: Filter): Int

    Permalink

    The total number of tests that are expected to run when this Spec's run method is invoked.

    The total number of tests that are expected to run when this Spec's run method is invoked.

    This trait's implementation of this method returns the sum of:

    • the size of the testNames List, minus the number of tests marked as ignored and any tests that are exluded by the passed Filter
    • the sum of the values obtained by invoking expectedTestCount on every nested Suite contained in nestedSuites

    This trait's implementation of this method will first ensure that the discovery of scope objects and test methods has been performed.

    filter

    a Filter with which to filter tests to count based on their tags

    returns

    the expected number test count

    Definition Classes
    SpecLike → Suite
  41. def fail(cause: Throwable): Nothing

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

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

    Permalink
    Definition Classes
    Assertions
  44. def fail(): Nothing

    Permalink
    Definition Classes
    Assertions
  45. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  46. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  47. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  48. def info: Informer

    Permalink

    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
    SpecLike → Informing
  49. def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T]): T

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

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

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

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  53. def markup: Documenter

    Permalink

    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
    SpecLike → Documenting
  54. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    Suite
  56. def note: Notifier

    Permalink

    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 Spec 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
    SpecLike → Notifying
  57. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  58. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  59. def pending: Assertion with PendingStatement

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

    Permalink
    Definition Classes
    Assertions
  61. def rerunner: Option[String]

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

    Permalink

    Runs this fixture.Spec.

    Runs this fixture.Spec.

    If testName is None, this trait's implementation of this method calls these two methods on this object in this order:

    • runNestedSuites(report, stopper, tagsToInclude, tagsToExclude, configMap, distributor)
    • runTests(testName, report, stopper, tagsToInclude, tagsToExclude, configMap)

    If testName is defined, then this trait's implementation of this method calls runTests, but does not call runNestedSuites. This behavior is part of the contract of this method. Subclasses that override run must take care not to call runNestedSuites if testName is defined. (The OneInstancePerTest trait depends on this behavior, for example.)

    This trait's implementation of this method will first ensure that the discovery of scope objects and test methods has been performed.

    testName

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

    args

    the Args for this run

    returns

    a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.

    Definition Classes
    SpecLike → Suite
    Exceptions thrown

    IllegalArgumentException if testName is defined, but no test with the specified test name exists in this Suite

    NullArgumentException if any passed parameter is null.

  63. def runNestedSuites(args: Args): Status

    Permalink
    Attributes
    protected
    Definition Classes
    Suite
  64. def runTest(testName: String, args: Args): Status

    Permalink

    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 scope objects surrounding a test, from outside in, and the test method's name, with one space placed between each item. (See the documentation for testNames for an example.)

    This trait's implementation of this method will first ensure that the discovery of scope objects and test methods has been performed.

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

    NullArgumentException if testName or args is null.

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

    Permalink

    Run zero to many of this Spec's tests.

    Run zero to many of this Spec's tests.

    testName

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

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

    IllegalArgumentException if testName is defined, but no test with the specified test name exists in this Spec

    NullArgumentException if any of the passed parameters is null.

  66. final val styleName: String

    Permalink

    Suite style name.

    Suite style name.

    returns

    org.scalatest.fixture.Spec

    Definition Classes
    SpecLike → Suite → Suite
  67. final val succeed: Succeeded.type

    Permalink
    Definition Classes
    Assertions
  68. def suiteId: String

    Permalink
    Definition Classes
    Suite
  69. def suiteName: String

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

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

    Permalink

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

    This trait's implementation of this method will first ensure that the discovery of scope objects and test methods has been performed.

    Definition Classes
    SpecLike → Suite
  72. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData

    Permalink
    Definition Classes
    SpecLike → Suite
  73. def testNames: Set[String]

    Permalink

    An immutable Set of test names.

    An immutable Set of test names. If this Spec 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 name of each surrounding scope object, in order from outside in, and the name of the test method itself, with all components separated by a space. For example, consider this Spec:

    import org.scalatest.Spec
    
    class StackSpec extends Spec {
      object `A Stack` {
        object `(when not empty)` {
          def `must allow me to pop` {}
        }
        object `(when not full)` {
          def `must allow me to push` {}
        }
      }
    }
    

    Invoking testNames on this Spec will yield a set that contains the following two test name strings:

    "A Stack (when not empty) must allow me to pop"
    "A Stack (when not full) must allow me to push"
    

    This trait's implementation of this method will first ensure that the discovery of scope objects and test methods has been performed.

    returns

    the Set of test names

    Definition Classes
    SpecLike → Suite
  74. def toString(): String

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

    Permalink
    Definition Classes
    Assertions
  76. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  77. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]

    Permalink
    Definition Classes
    TripleEquals → TripleEqualsSupport
  78. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. def withClue[T](clue: Any)(fun: ⇒ T): T

    Permalink
    Definition Classes
    Assertions
  82. def withFixture(test: NoArgTest): Outcome

    Permalink
    Attributes
    protected
    Definition Classes
    Suite

Inherited from Documenting

Inherited from Alerting

Inherited from Notifying

Inherited from Informing

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