Packages

t

org.scalatest.freespec

FixtureAnyFreeSpecLike

trait FixtureAnyFreeSpecLike extends FixtureTestSuite with FixtureTestRegistration with Informing with Notifying with Alerting with Documenting

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

FixtureAnyFreeSpec 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 FixtureAnyFreeSpec into some other class, you can use this trait instead, because class FixtureAnyFreeSpec does nothing more than extend this trait and add a nice toString implementation.

See the documentation of the class for a detailed overview of FixtureAnyFreeSpec.

Self Type
FixtureAnyFreeSpecLike
Annotations
@Finders()
Source
FixtureAnyFreeSpecLike.scala
Linear Supertypes
Documenting, Alerting, Notifying, Informing, FixtureTestRegistration, FixtureTestSuite, TestSuite, FixtureSuite, Suite, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any
Known Subclasses
FixtureAnyFreeSpec
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FixtureAnyFreeSpecLike
  2. Documenting
  3. Alerting
  4. Notifying
  5. Informing
  6. FixtureTestRegistration
  7. FixtureTestSuite
  8. TestSuite
  9. FixtureSuite
  10. Suite
  11. Serializable
  12. Assertions
  13. TripleEquals
  14. TripleEqualsSupport
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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

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

    This class provides much of the syntax for FixtureAnyFreeSpec, however, it does not add the verb methods (should, must, and can) to String. Instead, these are added via the ShouldVerb, MustVerb, and CanVerb traits, which FixtureAnyFreeSpec mixes in, to avoid a conflict with implicit conversions provided in Matchers and MustMatchers.

    Attributes
    protected
  5. trait NoArgTest extends () => Outcome with TestData
    Attributes
    protected
    Definition Classes
    TestSuite
  6. trait OneArgTest extends (FixtureTestSuite.FixtureParam) => Outcome with TestData
    Attributes
    protected
    Definition Classes
    FixtureTestSuite
  7. final class ResultOfTaggedAsInvocationOnString extends AnyRef

    Class that supports the registration of tagged tests.

    Class that supports the registration of tagged tests.

    Instances of this class are returned by the taggedAs method of class FreeSpecStringWrapper.

    Attributes
    protected

Abstract Value Members

  1. abstract def withFixture(test: OneArgTest): Outcome
    Attributes
    protected
    Definition Classes
    FixtureTestSuite

Concrete Value Members

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

    Returns 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 FixtureAnyFreeSpec 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
    FixtureAnyFreeSpecLike → Alerting
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. macro def assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  13. macro def assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  14. macro def assertCompiles(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  15. macro def assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  16. def assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  17. def assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  18. def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
    Definition Classes
    Assertions
  19. macro def assertTypeError(code: String)(implicit pos: Position): Assertion
    Definition Classes
    Assertions
  20. macro def assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  21. macro def assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
    Definition Classes
    Assertions
  22. val behave: BehaveWord

    Supports shared test registration in FixtureAnyFreeSpecs.

    Supports shared test registration in FixtureAnyFreeSpecs.

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

    Attributes
    protected
  23. def cancel(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  24. def cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  25. def cancel(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  26. def cancel()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  27. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  28. def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  29. def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  30. def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  31. implicit def convertToEqualizer[T](left: T): Equalizer[T]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  32. implicit def convertToFreeSpecStringWrapper(s: String)(implicit pos: Position): 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
  33. def defaultEquality[A]: Equality[A]
    Definition Classes
    TripleEqualsSupport
  34. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  36. final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit
    Definition Classes
    Suite
  37. def expectedTestCount(filter: Filter): Int
    Definition Classes
    Suite
  38. def fail(cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  39. def fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  40. def fail(message: String)(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  41. def fail()(implicit pos: Position): Nothing
    Definition Classes
    Assertions
  42. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  43. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. 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
    FixtureAnyFreeSpecLike → Informing
  46. def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T], pos: Position): T
    Definition Classes
    Assertions
  47. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  48. def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  49. 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
    FixtureAnyFreeSpecLike → Documenting
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    Suite
  52. 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 FixtureAnyFreeSpec 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
    FixtureAnyFreeSpecLike → Notifying
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  55. def pending: Assertion with PendingStatement
    Definition Classes
    Assertions
  56. def pendingUntilFixed(f: => Unit)(implicit pos: Position): Assertion with PendingStatement
    Definition Classes
    Assertions
  57. final def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Any)(implicit pos: Position): Unit
    Definition Classes
    FixtureAnyFreeSpecLike → FixtureTestRegistration
  58. final def registerTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) => Any)(implicit pos: Position): Unit
    Definition Classes
    FixtureAnyFreeSpecLike → FixtureTestRegistration
  59. def rerunner: Option[String]
    Definition Classes
    Suite
  60. def run(testName: Option[String], args: Args): Status
    Definition Classes
    FixtureAnyFreeSpecLike → Suite
  61. def runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    Suite
  62. 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
    FixtureAnyFreeSpecLike → TestSuite → Suite
    Exceptions thrown

    NullArgumentException if testName or is null.

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

    Run zero to many of this FixtureAnyFreeSpec's tests.

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

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

    NullArgumentException if testName or args is null.

  64. final val succeed: Assertion
    Definition Classes
    Assertions
  65. def suiteId: String
    Definition Classes
    Suite
  66. def suiteName: String
    Definition Classes
    Suite
  67. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  68. def tags: Map[String, Set[String]]

    A Map whose keys are String tag names to which tests in this FixtureAnyFreeSpec 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 FixtureAnyFreeSpec belong, and values the Set of test names that belong to each tag. If this FixtureAnyFreeSpec 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
    FixtureAnyFreeSpecLike → Suite
  69. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
    Definition Classes
    FixtureAnyFreeSpecLike → Suite
  70. def testNames: Set[String]

    An immutable Set of test names.

    An immutable Set of test names. If this FixtureAnyFreeSpec 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
    FixtureAnyFreeSpecLike → Suite
  71. def toString(): String
    Definition Classes
    AnyRef → Any
  72. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  73. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  76. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  77. def withClue[T](clue: Any)(fun: => T): T
    Definition Classes
    Assertions
  78. def withFixture(test: NoArgTest): Outcome
    Attributes
    protected
    Definition Classes
    TestSuite

Deprecated Value Members

  1. def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) => A): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  2. def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) => B): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  3. def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) => A): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  4. def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) => B): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

  5. final val styleName: String

    The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.

    The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.

    This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0 will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for styleName.

    Definition Classes
    FixtureAnyFreeSpecLike → 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 Documenting

Inherited from Alerting

Inherited from Notifying

Inherited from Informing

Inherited from FixtureTestRegistration

Inherited from FixtureTestSuite

Inherited from TestSuite

Inherited from FixtureSuite

Inherited from Suite

Inherited from Serializable

Inherited from Assertions

Inherited from TripleEquals

Inherited from TripleEqualsSupport

Inherited from AnyRef

Inherited from Any

Ungrouped