org.scalatest.fixture

FreeSpecLike

trait FreeSpecLike extends Suite with TestRegistration with Informing with Notifying with Alerting with Documenting

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

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

Self Type
FreeSpecLike
Annotations
@Finders()
Linear Supertypes
Documenting, Alerting, Notifying, Informing, TestRegistration, Suite, scalatest.Suite, Serializable, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FreeSpecLike
  2. Documenting
  3. Alerting
  4. Notifying
  5. Informing
  6. TestRegistration
  7. Suite
  8. Suite
  9. Serializable
  10. Serializable
  11. Assertions
  12. TripleEquals
  13. TripleEqualsSupport
  14. AnyRef
  15. 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. final class FreeSpecStringWrapper extends AnyRef

    A class that via an implicit conversion (named convertToFreeSpecStringWrapper) enables methods when, that, in, is, taggedAs and ignore to be invoked on Strings.

  6. trait NoArgTest extends () ⇒ Outcome with TestData

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

    Attributes
    protected
    Definition Classes
    Suite
  8. final class ResultOfTaggedAsInvocationOnString extends AnyRef

    Class that supports the registration of tagged tests.

Abstract Value Members

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

    Attributes
    protected
    Definition Classes
    Suite

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 alert: Alerter

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

    Returns a 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 fixture.FreeSpec 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
    FreeSpecLike → Alerting
  13. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    Assertions
    Annotations
    @macroImpl( ... )
  25. val behave: BehaveWord

    Supports shared test registration in fixture.FreeSpecs.

    Supports shared test registration in fixture.FreeSpecs.

    This field enables syntax such as the following:

    behave like nonFullStack(stackWithOneItem)
    ^
    

    For more information and examples of the use of <cod>behave, see the Shared tests section in the main documentation for trait FreeSpec.

    Attributes
    protected
  26. def cancel(cause: Throwable): Nothing

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

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

    Definition Classes
    Assertions
  29. def cancel(): Nothing

    Definition Classes
    Assertions
  30. def clone(): AnyRef

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

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

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

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

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

    Definition Classes
    TripleEquals → TripleEqualsSupport
  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 convertToFreeSpecStringWrapper(s: String): FreeSpecStringWrapper

    Implicitly converts Strings to FreeSpecStringWrapper, which enables methods when, that, in, is, taggedAs and ignore to be invoked on Strings.

    Implicitly converts Strings to FreeSpecStringWrapper, which enables methods when, that, in, is, taggedAs and ignore to be invoked on Strings.

    Attributes
    protected
  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 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
    FreeSpecLike → Informing
  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. 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
    FreeSpecLike → Documenting
  58. final def ne(arg0: AnyRef): Boolean

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

    Definition Classes
    Suite
  60. def note: Notifier

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

    Returns an 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 fixture.FreeSpec 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
    FreeSpecLike → Notifying
  61. final def notify(): Unit

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

    Definition Classes
    AnyRef
  63. def pending: Assertion with PendingStatement

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

    Definition Classes
    Assertions
  65. final def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) ⇒ Unit): Unit

    Definition Classes
    FreeSpecLike → TestRegistration
  66. final def registerTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) ⇒ Unit): Unit

    Definition Classes
    FreeSpecLike → TestRegistration
  67. def rerunner: Option[String]

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

    Definition Classes
    FreeSpecLike → Suite
  69. def runNestedSuites(args: Args): Status

    Attributes
    protected
    Definition Classes
    Suite
  70. 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
    FreeSpecLike → Suite
    Exceptions thrown
    NullArgumentException

    if testName or is null.

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

    Run zero to many of this FreeSpec's tests.

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

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

    if testName or args is null.

  72. final val styleName: String

    Suite style name.

    Suite style name.

    returns

    org.scalatest.fixture.FreeSpec

    Definition Classes
    FreeSpecLike → Suite → Suite
  73. final val succeed: Succeeded.type

    Definition Classes
    Assertions
  74. def suiteId: String

    Definition Classes
    Suite
  75. def suiteName: String

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

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

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

    Definition Classes
    FreeSpecLike → Suite
  79. def testNames: Set[String]

    An immutable Set of test names.

    An immutable Set of test names. If this fixture.FreeSpec 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
    FreeSpecLike → Suite
  80. def toString(): String

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

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

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Suite

Inherited from Documenting

Inherited from Alerting

Inherited from Notifying

Inherited from Informing

Inherited from TestRegistration

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