FreeSpecStringWrapper

Register some text that may surround one or more tests. The passed passed function value may contain surrounding text registrations (defined with dash (-)) and/or tests (defined with in). This class's implementation of this method will decide whether to register the text (passed to the constructor of FreeSpecStringWrapper) and invoke the passed function based on whether or not this is part of the current "test path." For the details on this process, see the How it executes section of the main documentation for trait org.scalatest.freespec.PathAnyFreeSpec.

Supports ignored test registration.

For example, this method supports syntax such as the following:

"complain on peek" ignore { ... }
                  ^

For more information and examples of this method's use, see the Ignored tests section in the main documentation for sister trait org.scalatest.freespec.AnyFreeSpec. 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.

Supports test registration.

For example, this method supports syntax such as the following:

"complain on peek" in { ... }
                  ^

This trait's implementation of this method will decide whether to register the text (passed to the constructor of FreeSpecStringWrapper) and invoke the passed function based on whether or not this is part of the current "test path." For the details on this process, see the How it executes section of the main documentation for trait org.scalatest.freespec.PathAnyFreeSpec.

Supports pending test registration.

For example, this method supports syntax such as the following:

"complain on peek" is (pending)
                  ^

For more information and examples of this method's use, see the Pending tests section in the main documentation for sister trait org.scalatest.freespec.AnyFreeSpec. Note that this trait's implementation of this method will decide whether to register the text (passed to the constructor of FreeSpecStringWrapper) and invoke the passed function based on whether or not this is part of the current "test path." For the details on this process, see the How it executes section of the main documentation for trait org.scalatest.freespec.PathAnyFreeSpec.

Supports tagged test registration.

For example, this method supports syntax such as the following:

"complain on peek" taggedAs(SlowTest) in { ... }
                  ^

For more information and examples of this method's use, see the Tagging tests section in the main documentation for sister trait org.scalatest.freespec.AnyFreeSpec.