Packages

t

org.scalatest.freespec

PathAnyFreeSpecLike

trait PathAnyFreeSpecLike extends Suite with OneInstancePerTest with Informing with Notifying with Alerting with Documenting

Implementation trait for class PathAnyFreeSpec, which is a sister class to org.scalatest.freespec.AnyFreeSpec that isolates tests by running each test in its own instance of the test class, and for each test, only executing the path leading to that test.

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

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

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

Type Members

  1. class CheckingEqualizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  2. class Equalizer[L] extends AnyRef
    Definition Classes
    TripleEqualsSupport
  3. final class FreeSpecStringWrapper extends AnyRef

    A class that via an implicit conversion (named convertToFreeSpecStringWrapper) enables methods in, is, taggedAs and ignore, as well as the dash operator (-), to be invoked on Strings.

    A class that via an implicit conversion (named convertToFreeSpecStringWrapper) enables methods in, is, taggedAs and ignore, as well as the dash operator (-), to be invoked on Strings.

    Attributes
    protected
  4. 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

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 an Alerter that during test execution will forward strings passed to its apply method to the current reporter.

    Returns an Alerter 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 while this PathAnyFreeSpec 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
    PathAnyFreeSpecLike → 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 PathAnyFreeSpecs.

    Supports shared test registration in PathAnyFreeSpecs.

    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 sister trait org.scalatest.freespec.PathAnyFreeSpec.

    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( ... ) @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 in, is, taggedAs and ignore, as well as the dash operator (-), to be invoked on Strings.

    Implicitly converts Strings to FreeSpecStringWrapper, which enables methods in, is, taggedAs and ignore, as well as the dash operator (-), 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: Any): 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. final def expectedTestCount(filter: Filter): Int

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

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

    This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.

    This trait's implementation of this method returns the size of the testNames List, minus the number of tests marked as ignored as well as any tests excluded by the passed Filter.

    This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.

    filter

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

    Definition Classes
    PathAnyFreeSpecLike → SuiteMixin → 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[_]
    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 (and other objects) passed to its apply method to the current reporter.

    Returns an Informer that during test execution will forward strings (and other objects) passed to its apply method to the current reporter. If invoked in a constructor (including within a test, since those are invoked during construction in a PathAnyFreeSpec, it will register the passed string for forwarding later when run is invoked. 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
    PathAnyFreeSpecLike → 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 (and other objects) passed to its apply method to the current reporter.

    Returns a Documenter that during test execution will forward strings (and other objects) passed to its apply method to the current reporter. If invoked in a constructor (including within a test, since those are invoked during construction in a PathAnyFreeSpec, it will register the passed string for forwarding later when run is invoked. 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
    PathAnyFreeSpecLike → Documenting
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. final def nestedSuites: IndexedSeq[Suite]

    Returns an empty list.

    Returns an empty list.

    This lifecycle method is unused by this trait. If invoked, it will return an empty list, because nested suites are not allowed in a PathAnyFreeSpec. Because a PathAnyFreeSpec executes tests eagerly at construction time, registering the results of those test runs and reporting them later, the order of nested suites versus test runs would be different in a org.scalatest.freespec.PathAnyFreeSpec than in an org.scalatest.freespec.AnyFreeSpec. In an org.scalatest.freespec.AnyFreeSpec, nested suites are executed then tests are executed. In an org.scalatest.freespec.PathAnyFreeSpec it would be the opposite. To make the code easy to reason about, therefore, this is just not allowed. If you want to add nested suites to a PathAnyFreeSpec, you can instead wrap them all in a Suites object and put them in whatever order you wish.

    This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.

    Definition Classes
    PathAnyFreeSpecLike → SuiteMixin → Suite
  52. def newInstance: PathAnyFreeSpecLike
    Definition Classes
    PathAnyFreeSpecLike → OneInstancePerTest
  53. def note: Notifier

    Returns a Notifier that during test execution will forward strings passed to its apply method to the current reporter.

    Returns a Notifier 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 while this Path.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
    PathAnyFreeSpecLike → Notifying
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  56. def pending: Assertion with PendingStatement
    Definition Classes
    Assertions
  57. def pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement
    Definition Classes
    Assertions
  58. def rerunner: Option[String]
    Definition Classes
    Suite
  59. final def run(testName: Option[String], args: Args): Status

    Runs this path.FreeSpec, reporting test results that were registered when the tests were run, each during the construction of its own instance.

    Runs this path.FreeSpec, reporting test results that were registered when the tests were run, each during the construction of its own instance.

    This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.

    If testName is None, this trait's implementation of this method will report the registered results for all tests except any excluded by the passed Filter. If testName is defined, it will report the results of only that named test. Because a path.FreeSpec is not allowed to contain nested suites, this trait's implementation of this method does not call runNestedSuites.

    This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.

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

    args

    the Args for this run

    Definition Classes
    PathAnyFreeSpecLike → SuiteMixin → 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.

  60. final def runNestedSuites(args: Args): Status

    This lifecycle method is unused by this trait, and is implemented to do nothing.

    This lifecycle method is unused by this trait, and is implemented to do nothing. If invoked, it will just return immediately.

    Nested suites are not allowed in a PathAnyFreeSpec. Because a PathAnyFreeSpec executes tests eagerly at construction time, registering the results of those test runs and reporting them later, the order of nested suites versus test runs would be different in a org.scalatest.freespec.PathAnyFreeSpec than in an org.scalatest.freespec.AnyFreeSpec. In an org.scalatest.freespec.AnyFreeSpec, nested suites are executed then tests are executed. In an org.scalatest.freespec.PathAnyFreeSpec it would be the opposite. To make the code easy to reason about, therefore, this is just not allowed. If you want to add nested suites to a path.FreeSpec, you can instead wrap them all in a Suites object and put them in whatever order you wish.

    This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.

    Attributes
    protected
    Definition Classes
    PathAnyFreeSpecLike → SuiteMixin → Suite
  61. final def runTest(testName: String, args: Args): Status

    Runs a test.

    Runs a test.

    This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.

    This trait's implementation reports the test results 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 documentation for testNames for an example.)

    This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.

    testName

    the name of one test to execute.

    args

    the Args for this run

    Attributes
    protected
    Definition Classes
    PathAnyFreeSpecLike → OneInstancePerTest → SuiteMixin → Suite
    Exceptions thrown

    NullArgumentException if any of testName, reporter, stopper, or configMap is null.

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

    This lifecycle method is unused by this trait, and will complete abruptly with UnsupportedOperationException if invoked.

    This lifecycle method is unused by this trait, and will complete abruptly with UnsupportedOperationException if invoked.

    This trait's implementation of this method is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.

    Attributes
    protected
    Definition Classes
    PathAnyFreeSpecLike → OneInstancePerTest → SuiteMixin → Suite
  63. final val succeed: Assertion
    Definition Classes
    Assertions
  64. def suiteId: String
    Definition Classes
    Suite
  65. def suiteName: String
    Definition Classes
    Suite
  66. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  67. final def tags: Map[String, Set[String]]

    A Map whose keys are String tag names to which tests in this PathAnyFreeSpec 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 PathAnyFreeSpec belong, and values the Set of test names that belong to each tag. If this PathAnyFreeSpec contains no tags, this method returns an empty Map.

    This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.

    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 is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.

    Definition Classes
    PathAnyFreeSpecLike → SuiteMixin → Suite
  68. def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
    Definition Classes
    PathAnyFreeSpecLike → SuiteMixin → Suite
  69. final def testNames: Set[String]

    An immutable Set of test names.

    An immutable Set of test names. If this PathAnyFreeSpec contains no tests, this method returns an empty Set.

    This trait's implementation of this method will first ensure that the results of all tests, each run its its own instance executing only the path to the test, are registered. For details on this process see the How it executes section in the main documentation for this trait.

    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. For example, consider this PathAnyFreeSpec:

    import org.scalatest.freespec

class StackSpec extends freespec.PathAnyFreeSpec {
  "A Stack" - {
    "when not empty" - {
      "must allow me to pop" in {}
    }
    "when not full" - {
      "must allow me to push" in {}
    }
  }
}

    Invoking testNames on this FreeSpec 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 is marked as final. For insight onto why, see the Shared fixtures section in the main documentation for this trait.

    Definition Classes
    PathAnyFreeSpecLike → SuiteMixin → Suite
  70. def toString(): String
    Definition Classes
    AnyRef → Any
  71. def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  72. implicit def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
    Definition Classes
    TripleEquals → TripleEqualsSupport
  73. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  76. def withClue[T](clue: Any)(fun: ⇒ T): T
    Definition Classes
    Assertions

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
    PathAnyFreeSpecLike → SuiteMixin → 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 OneInstancePerTest

Inherited from SuiteMixin

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