FreeSpec

A sister class to org.scalatest.FreeSpec 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.

Class path.FreeSpec behaves similarly to class org.scalatest.FreeSpec, except that tests are isolated based on their path. The purpose of path.FreeSpec is to facilitate writing specification-style tests for mutable objects in a clear, boilerpate-free way. To test mutable objects, you need to mutate them. Using a path class, you can make a statement in text, then implement that statement in code (including mutating state), and nest and combine these test/code pairs in any way you wish. Each test will only see the side effects of code that is in blocks that enclose the test. Here's an example:

import org.scalatest.path
import org.scalatest.matchers.Matchers
import scala.collection.mutable.ListBuffer

class ExampleSpec extends path.FreeSpec with Matchers {

  "A ListBuffer" - {

    val buf = ListBuffer.empty[Int] // This implements "A ListBuffer"

    "should be empty when created" in {

      // This test sees:
      //   val buf = ListBuffer.empty[Int]
      // So buf is: ListBuffer()

      buf should be ('empty)
    }

    "when 1 is appended" - {

      buf += 1 // This implements "when 1 is appended", etc...

      "should contain 1" in {

        // This test sees:
        //   val buf = ListBuffer.empty[Int]
        //   buf += 1
        // So buf is: ListBuffer(1)

        buf.remove(0) should equal (1)
        buf should be ('empty)
      }

      "when 2 is appended" - {

        buf += 2

        "should contain 1 and 2" in {

          // This test sees:
          //   val buf = ListBuffer.empty[Int]
          //   buf += 1
          //   buf += 2
          // So buf is: ListBuffer(1, 2)

          buf.remove(0) should equal (1)
          buf.remove(0) should equal (2)
          buf should be ('empty)
        }

        "when 2 is removed" - {

          buf -= 2

          "should contain only 1 again" in {

            // This test sees:
            //   val buf = ListBuffer.empty[Int]
            //   buf += 1
            //   buf += 2
            //   buf -= 2
            // So buf is: ListBuffer(1)

            buf.remove(0) should equal (1)
            buf should be ('empty)
          }
        }

        "when 3 is appended" - {

          buf += 3

          "should contain 1, 2, and 3" in {

            // This test sees:
            //   val buf = ListBuffer.empty[Int]
            //   buf += 1
            //   buf += 2
            //   buf += 3
            // So buf is: ListBuffer(1, 2, 3)

            buf.remove(0) should equal (1)
            buf.remove(0) should equal (2)
            buf.remove(0) should equal (3)
            buf should be ('empty)
          }
        }
      }

      "when 88 is appended" - {

        buf += 88

        "should contain 1 and 88" in {

          // This test sees:
          //   val buf = ListBuffer.empty[Int]
          //   buf += 1
          //   buf += 88
          // So buf is: ListBuffer(1, 88)

          buf.remove(0) should equal (1)
          buf.remove(0) should equal (88)
          buf should be ('empty)
        }
      }
    }

    "should have size 0 when created" in {

      // This test sees:
      //   val buf = ListBuffer.empty[Int]
      // So buf is: ListBuffer()

      buf should have size 0
    }
  }
}

Note that the above class is organized by writing a bit of specification text that opens a new block followed by, at the top of the new block, some code that "implements" or "performs" what is described in the text. This is repeated as the mutable object (here, a ListBuffer), is prepared for the enclosed tests. For example:

"A ListBuffer" - {
  val buf = ListBuffer.empty[Int]

Or:

"when 2 is appended" - {
  buf += 2

Note also that although each test mutates the ListBuffer, none of the other tests observe those side effects:

"should contain 1" in {

  buf.remove(0) should equal (1)
  // ...
}

"when 2 is appended" - {

  buf += 2

  "should contain 1 and 2" in {

    // This test does not see the buf.remove(0) from the previous test,
    // so the first element in the ListBuffer is again 1
    buf.remove(0) should equal (1)
    buf.remove(0) should equal (2)

This kind of isolation of tests from each other is a consequence of running each test in its own instance of the test class, and can also be achieved by simply mixing OneInstancePerTest into a regular org.scalatest.FreeSpec. However, path.FreeSpec takes isolation one step further: a test in a path.FreeSpec does not observe side effects performed outside tests in earlier blocks that do not enclose it. Here's an example:

"when 2 is removed" - {

  buf -= 2

  // ...
}

"when 3 is appended" - {

  buf += 3

  "should contain 1, 2, and 3" in {

    // This test does not see the buf -= 2 from the earlier "when 2 is removed" block,
    // because that block does not enclose this test, so the second element in the
    // ListBuffer is still 2
    buf.remove(0) should equal (1)
    buf.remove(0) should equal (2)
    buf.remove(0) should equal (3)

Running the full ExampleSpec, shown above, in the Scala interpeter would give you:

scala> import org.scalatest._
import org.scalatest._

scala> run(new ExampleSpec)
ExampleSpec:
A ListBuffer
- should be empty when created
  when 1 is appended
  - should contain 1
    when 2 is appended
    - should contain 1 and 2
      when 2 is removed
      - should contain only 1 again
      when 3 is appended
      - should contain 1, 2, and 3
    when 88 is appended
    - should contain 1 and 88
- should have size 0 when created

Note: class path.FreeSpec's approach to isolation was inspired in part by the specsy framework, written by Esko Luontola.

Shared fixtures

A test fixture is objects or other artifacts (such as files, sockets, database connections, etc.) used by tests to do their work. If a fixture is used by only one test, then the definitions of the fixture objects can be local to the method. If multiple tests need to share an immutable fixture, you can simply assign them to instance variables. If multiple tests need to share mutable fixture objects or vars, there's one and only one way to do it in a path.FreeSpec: place the mutable objects lexically before the test. Any mutations needed by the test must be placed lexically before and/or after the test. As used here, "Lexically before" means that the code needs to be executed during construction of that test's instance of the test class to reach the test (or put another way, the code is along the "path to the test.") "Lexically after" means that the code needs to be executed to exit the constructor after the test has been executed.

The reason lexical placement is the one and only one way to share fixtures in a path.FreeSpec is because all of its lifecycle methods are overridden and declared final. Thus you can't override withFixture, because it is final, or mix in BeforeAndAfter or BeforeAndAfterEach, because both override runTest, which is final in a path.FreeSpec. In short:

In a `path.FreeSpec`, if you need some code to execute before a test, place that code lexically before the test. If you need some code to execute after a test, place that code lexically after the test.

The reason the life cycle methods are final, by the way, is to prevent users from attempting to combine a path.FreeSpec's approach to isolation with other ways ScalaTest provides to share fixtures or execute tests, because doing so could make the resulting test code hard to reason about. A path.FreeSpec's execution model is a bit magical, but because it executes in one and only one way, users should be able to reason about the code. To help you visualize how a path.FreeSpec is executed, consider the following variant of ExampleSpec that includes print statements:

import org.scalatest.path
import org.scalatest.matchers.Matchers
import scala.collection.mutable.ListBuffer

class ExampleSpec extends path.FreeSpec with Matchers {

  println("Start of: ExampleSpec")
  "A ListBuffer" - {

    println("Start of: A ListBuffer")
    val buf = ListBuffer.empty[Int]

    "should be empty when created" in {

      println("In test: should be empty when created; buf is: " + buf)
      buf should be ('empty)
    }

    "when 1 is appended" - {

      println("Start of: when 1 is appended")
      buf += 1

      "should contain 1" in {

        println("In test: should contain 1; buf is: " + buf)
        buf.remove(0) should equal (1)
        buf should be ('empty)
      }

      "when 2 is appended" - {

        println("Start of: when 2 is appended")
        buf += 2

        "should contain 1 and 2" in {

          println("In test: should contain 1 and 2; buf is: " + buf)
          buf.remove(0) should equal (1)
          buf.remove(0) should equal (2)
          buf should be ('empty)
        }

        "when 2 is removed" - {

          println("Start of: when 2 is removed")
          buf -= 2

          "should contain only 1 again" in {

            println("In test: should contain only 1 again; buf is: " + buf)
            buf.remove(0) should equal (1)
            buf should be ('empty)
          }

          println("End of: when 2 is removed")
        }

        "when 3 is appended" - {

          println("Start of: when 3 is appended")
          buf += 3

          "should contain 1, 2, and 3" in {

            println("In test: should contain 1, 2, and 3; buf is: " + buf)
            buf.remove(0) should equal (1)
            buf.remove(0) should equal (2)
            buf.remove(0) should equal (3)
            buf should be ('empty)
          }
          println("End of: when 3 is appended")
        }

        println("End of: when 2 is appended")
      }

      "when 88 is appended" - {

        println("Start of: when 88 is appended")
        buf += 88

        "should contain 1 and 88" in {

          println("In test: should contain 1 and 88; buf is: " + buf)
          buf.remove(0) should equal (1)
          buf.remove(0) should equal (88)
          buf should be ('empty)
        }

        println("End of: when 88 is appended")
      }

      println("End of: when 1 is appended")
    }

    "should have size 0 when created" in {

      println("In test: should have size 0 when created; buf is: " + buf)
      buf should have size 0
    }

    println("End of: A ListBuffer")
  }
  println("End of: ExampleSpec")
  println()
}

Running the above version of ExampleSpec in the Scala interpreter will give you output similar to:

scala> import org.scalatest._
import org.scalatest._

scala> run(new ExampleSpec)
ExampleSpec:
Start of: ExampleSpec
Start of: A ListBuffer
In test: should be empty when created; buf is: ListBuffer()
End of: A ListBuffer
End of: ExampleSpec

Start of: ExampleSpec
Start of: A ListBuffer
Start of: when 1 is appended
In test: should contain 1; buf is: ListBuffer(1)
ExampleSpec:
End of: when 1 is appended
End of: A ListBuffer
End of: ExampleSpec

Start of: ExampleSpec
Start of: A ListBuffer
Start of: when 1 is appended
Start of: when 2 is appended
In test: should contain 1 and 2; buf is: ListBuffer(1, 2)
End of: when 2 is appended
End of: when 1 is appended
End of: A ListBuffer
End of: ExampleSpec

Start of: ExampleSpec
Start of: A ListBuffer
Start of: when 1 is appended
Start of: when 2 is appended
Start of: when 2 is removed
In test: should contain only 1 again; buf is: ListBuffer(1)
End of: when 2 is removed
End of: when 2 is appended
End of: when 1 is appended
End of: A ListBuffer
End of: ExampleSpec

Start of: ExampleSpec
Start of: A ListBuffer
Start of: when 1 is appended
Start of: when 2 is appended
Start of: when 3 is appended
In test: should contain 1, 2, and 3; buf is: ListBuffer(1, 2, 3)
End of: when 3 is appended
End of: when 2 is appended
End of: when 1 is appended
End of: A ListBuffer
End of: ExampleSpec

Start of: ExampleSpec
Start of: A ListBuffer
Start of: when 1 is appended
Start of: when 88 is appended
In test: should contain 1 and 88; buf is: ListBuffer(1, 88)
End of: when 88 is appended
End of: when 1 is appended
End of: A ListBuffer
End of: ExampleSpec

Start of: ExampleSpec
Start of: A ListBuffer
In test: should have size 0 when created; buf is: ListBuffer()
End of: A ListBuffer
End of: ExampleSpec

A ListBuffer
- should be empty when created
  when 1 is appended
  - should contain 1
    when 2 is appended
    - should contain 1 and 2
      when 2 is removed
      - should contain only 1 again
      when 3 is appended
      - should contain 1, 2, and 3
    when 88 is appended
    - should contain 1 and 88
- should have size 0 when created

Note that each test is executed in order of appearance in the path.FreeSpec, and that only those println statements residing in blocks that enclose the test being run are executed. Any println statements in blocks that do not form the "path" to a test are not executed in the instance of the class that executes that test.

== How it executes == To provide its special brand of test isolation, path.FreeSpec executes quite differently from its sister class in org.scalatest. An org.scalatest.FreeSpec registers tests during construction and executes them when run is invoked. An org.scalatest.path.FreeSpec, by contrast, runs each test in its own instance while that instance is being constructed. During construction, it registers not the tests to run, but the results of running those tests. When run is invoked on a path.FreeSpec, it reports the registered results and does not run the tests again. If run is invoked a second or third time, in fact, a path.FreeSpec will each time report the same results registered during construction. If you want to run the tests of a path.FreeSpec anew, you'll need to create a new instance and invoke run on that. A path.FreeSpec will create one instance for each "leaf" node it contains. The main kind of leaf node is a test, such as:

// One instance will be created for each test
"should be empty when created" in {
  buf should be ('empty)
}

However, an empty scope (a scope that contains no tests or nested scopes) is also a leaf node:

 // One instance will be created for each empty scope
"when 99 is added" - {
  // A scope is "empty" and therefore a leaf node if it has no
  // tests or nested scopes, though it may have other code (which
  // will be executed in the instance created for that leaf node)
  buf += 99
}

The tests will be executed sequentially, in the order of appearance. The first test (or empty scope, if that is first) will be executed when a class that mixes in path.FreeSpec is instantiated. Only the first test will be executed during this initial instance, and of course, only the path to that test. Then, the first time the client uses the initial instance (by invoking one of run, expectedTestsCount, tags, or testNames on the instance), the initial instance will, before doing anything else, ensure that any remaining tests are executed, each in its own instance. To ensure that the correct path is taken in each instance, and to register its test results, the initial path.FreeSpec instance must communicate with the other instances it creates for running any subsequent leaf nodes. It does so by setting a thread-local variable prior to creating each instance (a technique suggested by Esko Luontola). Each instance of path.FreeSpec checks the thread-local variable. If the thread-local is not set, it knows it is an initial instance and therefore executes every block it encounters until it discovers, and executes the first test (or empty scope, if that's the first leaf node). It then discovers, but does not execute the next leaf node, or discovers there are no other leaf nodes remaining to execute. It communicates the path to the next leaf node, if any, and the result of running the test it did execute, if any, back to the initial instance. The initial instance repeats this process until all leaf nodes have been executed and all test results registered. == Ignored tests == You mark a test as ignored in an org.scalatest.path.FreeSpec in the same manner as in an org.scalatest.FreeSpec. Please see the Ignored tests section in its documentation for more information. Note that a separate instance will be created for an ignored test, and the path to the ignored test will be executed in that instance, but the test function itself will not be executed. Instead, a TestIgnored event will be fired. == Informers == You output information using Informers in an org.scalatest.path.FreeSpec in the same manner as in an org.scalatest.FreeSpec. Please see the Informers section in its documentation for more information. == Pending tests == You mark a test as pending in an org.scalatest.path.FreeSpec in the same manner as in an org.scalatest.FreeSpec. Please see the Pending tests section in its documentation for more information. Note that a separate instance will be created for a pending test, and the path to the ignored test will be executed in that instance, as well as the test function (up until it completes abruptly with a TestPendingException). == Tagging tests == You can place tests into groups by tagging them in an org.scalatest.path.FreeSpec in the same manner as in an org.scalatest.FreeSpec. Please see the Tagging tests section in its documentation for more information. Note that one difference between this class and its sister class org.scalatest.FreeSpec is that because tests are executed at construction time, rather than each time run is invoked, an org.scalatest.path.FreeSpec will always execute all non-ignored tests. When run is invoked on a path.FreeSpec, if some tests are excluded based on tags, the registered results of running those tests will not be reported. (But those tests will have already run and the results registered.) By contrast, because an org.scalatest.FreeSpec only executes tests after run has been called, and at that time the tags to include and exclude are known, only tests selected by the tags will be executed. In short, in an org.scalatest.FreeSpec, tests not selected by the tags to include and exclude specified for the run (via the Filter passed to run) will not be executed. In an org.scalatest.path.FreeSpec, by contrast, all non-ignored tests will be executed, each during the construction of its own instance, and tests not selected by the tags to include and exclude specified for a run will not be reported. (One upshot of this is that if you have tests that you want to tag as being slow so you can sometimes exclude them during a run, you probably don't want to put them in a path.FreeSpec. Because in a path.Freespec the slow tests will be run regardless, with only their registered results not being reported if you exclude slow tests during a run.) == Shared tests == You can factor out shared tests in an org.scalatest.path.FreeSpec in the same manner as in an org.scalatest.FreeSpec. Please see the Shared tests section in its documentation for more information. == Nested suites == Nested suites are not allowed in a path.FreeSpec. Because a path.FreeSpec executes tests eagerly at construction time, registering the results of those test runs and reporting them later when run is invoked, the order of nested suites versus test runs would be different in a org.scalatest.path.FreeSpec than in an org.scalatest.FreeSpec. In org.scalatest.FreeSpec's implementation of run, nested suites are executed then tests are executed. A org.scalatest.path.FreeSpec with nested suites would execute these in the opposite order: first tests then nested suites. To help make path.FreeSpec code easier to reason about by giving readers of one less difference to think about, nested suites are not allowed. If you want to add nested suites to a path.FreeSpec, you can instead wrap them all in a Suites object. They will be executed in the order of appearance (unless a Distributor is passed, in which case they will execute in parallel). == Durations == Many ScalaTest events include a duration that indicates how long the event being reported took to execute. For example, a TestSucceeded event provides a duration indicating how long it took for that test to execute. A SuiteCompleted event provides a duration indicating how long it took for that entire suite of tests to execute. In the test completion events fired by a path.FreeSpec (TestSucceeded, TestFailed, or TestPending), the durations reported refer to the time it took for the tests to run. This time is registered with the test results and reported along with the test results each time run is invoked. By contrast, the suite completion events fired for a path.FreeSpec represent the amount of time it took to report the registered results. (These events are not fired by path.FreeSpec, but instead by the entity that invokes run on the path.FreeSpec.) As a result, the total time for running the tests of a path.FreeSpec, calculated by summing the durations of all the individual test completion events, may be greater than the duration reported for executing the entire suite.

Annotations: @Finders()

Linear Supertypes

FreeSpecLike, Documenting, Alerting, Notifying, Informing, OneInstancePerTest, SuiteMixin, Suite, Serializable, Serializable, Assertions, TripleEquals, TripleEqualsSupport, AnyRef, Any

Instance Constructors

new FreeSpec()

Type Members

class AssertionsHelper extends AnyRef

Definition Classes
Assertions
class CheckingEqualizer[L] extends AnyRef

Definition Classes
TripleEqualsSupport
class Equalizer[L] extends AnyRef

Definition Classes
TripleEqualsSupport
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.
trait NoArgTest extends () ⇒ Outcome with TestData

Attributes
protected
Definition Classes
Suite
final class ResultOfTaggedAsInvocationOnString extends AnyRef

Class that supports the registration of tagged tests.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

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

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

Definition Classes
TripleEqualsSupport
final def ##(): Int

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

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

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

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

Definition Classes
TripleEqualsSupport
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 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
FreeSpecLike → Alerting
final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

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

Supports shared test registration in path.FreeSpecs.
Supports shared test registration in path.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 sister trait org.scalatest.FreeSpec.
Attributes
protected
Definition Classes
FreeSpecLike
def cancel(cause: Throwable): Nothing

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

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

Definition Classes
Assertions
def cancel(): Nothing

Definition Classes
Assertions
def clone(): AnyRef

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

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

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

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

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

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

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

Definition Classes
TripleEquals → TripleEqualsSupport
implicit def convertToFreeSpecStringWrapper(s: String): 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
Definition Classes
FreeSpecLike
def defaultEquality[A]: Equality[A]

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def execute: Unit

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

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

The total number of tests that are expected to run when this path.FreeSpec's run method is invoked.
The total number of tests that are expected to run when this path.FreeSpec'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
FreeSpecLike → SuiteMixin → Suite
def fail(cause: Throwable): Nothing

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

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

Definition Classes
Assertions
def fail(): Nothing

Definition Classes
Assertions
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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 path.FreeSpec, 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
FreeSpecLike → Informing
def intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T]): T

Definition Classes
Assertions
final def isInstanceOf[T0]: Boolean

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

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

Definition Classes
TripleEquals → TripleEqualsSupport
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 path.FreeSpec, 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
FreeSpecLike → Documenting
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
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 path.FreeSpec. Because a path.FreeSpec 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.path.FreeSpec than in an org.scalatest.FreeSpec. In an org.scalatest.FreeSpec, nested suites are executed then tests are executed. In an org.scalatest.path.FreeSpec 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.

Definition Classes
FreeSpecLike → SuiteMixin → Suite
def newInstance: FreeSpecLike

Definition Classes
FreeSpecLike → OneInstancePerTest
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
FreeSpecLike → Notifying
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pending: Assertion with PendingStatement

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

Definition Classes
Assertions
def rerunner: Option[String]

Definition Classes
Suite
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
FreeSpecLike → 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.
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 path.FreeSpec. Because a path.FreeSpec 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.path.FreeSpec than in an org.scalatest.FreeSpec. In an org.scalatest.FreeSpec, nested suites are executed then tests are executed. In an org.scalatest.path.FreeSpec 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
FreeSpecLike → SuiteMixin → Suite
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
FreeSpecLike → OneInstancePerTest → SuiteMixin → Suite
Exceptions thrown
NullArgumentException
if any of testName, reporter, stopper, or configMap is null.
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
FreeSpecLike → OneInstancePerTest → SuiteMixin → Suite
final val styleName: String

Suite style name.
Suite style name.

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

Definition Classes
Assertions
def suiteId: String

Definition Classes
Suite
def suiteName: String

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

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

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

Definition Classes
FreeSpecLike → SuiteMixin → Suite
final def testNames: Set[String]

An immutable Set of test names.
An immutable Set of test names. If this FreeSpec 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 FreeSpec:
```
import org.scalatest.path

class StackSpec extends path.FreeSpec {
  "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
FreeSpecLike → SuiteMixin → Suite
def toString(): String

Returns a user friendly string for this suite, composed of the simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite contains nested suites, the result of invoking toString on each of the nested suites, separated by commas and surrounded by parentheses.
Returns a user friendly string for this suite, composed of the simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite contains nested suites, the result of invoking toString on each of the nested suites, separated by commas and surrounded by parentheses.
returns
a user-friendly string for this suite

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

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

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

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

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

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

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

Definition Classes
Assertions
final def withFixture(test: NoArgTest): Outcome

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

Definition Classes
FreeSpecLike → SuiteMixin → Suite

class FreeSpec extends FreeSpecLike

Shared fixtures

Instance Constructors

new FreeSpec()

Type Members

class AssertionsHelper extends AnyRef

class CheckingEqualizer[L] extends AnyRef

class Equalizer[L] extends AnyRef

final class FreeSpecStringWrapper extends AnyRef

trait NoArgTest extends () ⇒ Outcome with TestData

final class ResultOfTaggedAsInvocationOnString extends AnyRef

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

def !==(right: Null): TripleEqualsInvocation[Null]

def !==[T](right: T): TripleEqualsInvocation[T]

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

def ===(right: Null): TripleEqualsInvocation[Null]

def ===[T](right: T): TripleEqualsInvocation[T]

def alert: Alerter

final def asInstanceOf[T0]: T0

def assert(condition: Boolean, clue: Any): Assertion

def assert(condition: Boolean): Assertion

def assertCompiles(code: String): Assertion

def assertDoesNotCompile(code: String): Assertion

def assertResult(expected: Any)(actual: Any): Assertion

def assertResult(expected: Any, clue: Any)(actual: Any): Assertion

def assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T]): Assertion

def assertTypeError(code: String): Assertion

val assertionsHelper: AssertionsHelper

def assume(condition: Boolean, clue: Any): Assertion

def assume(condition: Boolean): Assertion

val behave: BehaveWord

def cancel(cause: Throwable): Nothing

def cancel(message: String, cause: Throwable): Nothing

def cancel(message: String): Nothing

def cancel(): Nothing

def clone(): AnyRef

def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]

def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]

def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): CanEqual[A, B]

def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]

def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): CanEqual[A, B]

def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

implicit def convertToEqualizer[T](left: T): Equalizer[T]

implicit def convertToFreeSpecStringWrapper(s: String): FreeSpecStringWrapper

def defaultEquality[A]: Equality[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def execute: Unit

final def execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit

final def expectedTestCount(filter: Filter): Int

def fail(cause: Throwable): Nothing

def fail(message: String, cause: Throwable): Nothing

def fail(message: String): Nothing

def fail(): Nothing

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def info: Informer

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

final def isInstanceOf[T0]: Boolean

def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): CanEqual[A, B]

def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]

def markup: Documenter

final def ne(arg0: AnyRef): Boolean

final def nestedSuites: IndexedSeq[Suite]

def newInstance: FreeSpecLike

def note: Notifier

final def notify(): Unit

final def notifyAll(): Unit

def pending: Assertion with PendingStatement

def pendingUntilFixed(f: ⇒ Unit): Assertion with PendingStatement

def rerunner: Option[String]

final def run(testName: Option[String], args: Args): Status