Class used via an implicit conversion to enable any two objects to be compared with
=== in assertions in tests.
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 test function taking no arguments, which also provides a test name and config map.
Class that supports the registration of tagged tests.
Assert that an Option[String] is None.
Assert that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestFailedException with the String
value of the Some included in the TestFailedException's
detail message.
This form of assert is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b)
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
Assert that an Option[String] is None.
Assert that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestFailedException with the String
value of the Some, as well as the
String obtained by invoking toString on the
specified clue,
included in the TestFailedException's detail message.
This form of assert is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b, "extra info reported if assertion fails")
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
An objects whose toString method returns a message to include in a failure report.
Assert that a boolean condition, described in String
message, is true.
Assert that a boolean condition, described in String
message, is true.
If the condition is true, this method returns normally.
Else, it throws TestFailedException with the
String obtained by invoking toString on the
specified clue as the exception's detail message.
the boolean condition to assert
An objects whose toString method returns a message to include in a failure report.
Assert that a boolean condition is true.
Assert that a boolean condition is true.
If the condition is true, this method returns normally.
Else, it throws TestFailedException.
the boolean condition to assert
Assume that an Option[String] is None.
Assume that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestCanceledException with the String
value of the Some included in the TestCanceledException's
detail message.
This form of assume is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b)
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
Assume that an Option[String] is None.
Assume that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestCanceledException with the String
value of the Some, as well as the
String obtained by invoking toString on the
specified clue,
included in the TestCanceledException's detail message.
This form of assume is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assume(a === b, "extra info reported if assertion fails")
For more information on how this mechanism works, see the documentation for
Equalizer.
the Option[String] to assert
An objects whose toString method returns a message to include in a failure report.
Assume that a boolean condition, described in String
message, is true.
Assume that a boolean condition, described in String
message, is true.
If the condition is true, this method returns normally.
Else, it throws TestCanceledException with the
String obtained by invoking toString on the
specified clue as the exception's detail message.
the boolean condition to assume
An objects whose toString method returns a message to include in a failure report.
Assume that a boolean condition is true.
Assume that a boolean condition is true.
If the condition is true, this method returns normally.
Else, it throws TestCanceledException.
the boolean condition to assert
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.
Throws TestCanceledException, with the passed
Throwable cause, to indicate a test failed.
Throws TestCanceledException, with the passed
Throwable cause, to indicate a test failed.
The getMessage method of the thrown TestCanceledException
will return cause.toString.
a Throwable that indicates the cause of the cancellation.
Throws TestCanceledException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
Throws TestCanceledException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
A message describing the failure.
A Throwable that indicates the cause of the failure.
Throws TestCanceledException, with the passed
String message as the exception's detail
message, to indicate a test was canceled.
Throws TestCanceledException, with the passed
String message as the exception's detail
message, to indicate a test was canceled.
A message describing the cancellation.
Throws TestCanceledException to indicate a test was canceled.
Throws TestCanceledException to indicate a test was canceled.
Implicit conversion from Any to Equalizer, used to enable
assertions with === comparisons.
Implicit conversion from Any to Equalizer, used to enable
assertions with === comparisons.
For more information on this mechanism, see the documentation for Equalizer.
Because trait Suite mixes in Assertions, this implicit conversion will always be
available by default in ScalaTest Suites. This is the only implicit conversion that is in scope by default in every
ScalaTest Suite. Other implicit conversions offered by ScalaTest, such as those that support the matchers DSL
or invokePrivate, must be explicitly invited into your test code, either by mixing in a trait or importing the
members of its companion object. The reason ScalaTest requires you to invite in implicit conversions (with the exception of the
implicit conversion for === operator) is because if one of ScalaTest's implicit conversions clashes with an
implicit conversion used in the code you are trying to test, your program won't compile. Thus there is a chance that if you
are ever trying to use a library or test some code that also offers an implicit conversion involving a === operator,
you could run into the problem of a compiler error due to an ambiguous implicit conversion. If that happens, you can turn off
the implicit conversion offered by this convertToEqualizer method simply by overriding the method in your
Suite subclass, but not marking it as implicit:
// In your Suite subclass override def convertToEqualizer(left: Any) = new Equalizer(left)
the object whose type to convert to Equalizer.
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.
Executes this Suite, printing results to the standard output.
Executes this Suite, printing results to the standard output.
This method, which simply invokes the other overloaded form of execute with default parameter values,
is intended for use only as a mini-DSL for the Scala interpreter. It allows you to execute a Suite in the
interpreter with a minimum of finger typing:
scala> new SetSpec execute An empty Set - should have size 0 - should produce NoSuchElementException when head is invoked !!! IGNORED !!!
If you do ever want to invoke execute outside the Scala interpreter, it is best style to invoke it with
empty parens to indicate it has a side effect, like this:
// Use empty parens form in regular code (outside the Scala interpreter) (new ExampleSuite).execute()
Executes one or more tests in this Suite, printing results to the standard output.
Executes one or more tests in this Suite, printing results to the standard output.
This method invokes run on itself, passing in values that can be configured via the parameters to this
method, all of which have default values. This behavior is convenient when working with ScalaTest in the Scala interpreter.
Here's a summary of this method's parameters and how you can use them:
The testName parameter
If you leave testName at its default value (of null), this method will pass None to
the testName parameter of run, and as a result all the tests in this suite will be executed. If you
specify a testName, this method will pass Some(testName) to run, and only that test
will be run. Thus to run all tests in a suite from the Scala interpreter, you can write:
scala> new ExampleSuite execute
(The above syntax actually invokes the overloaded parameterless form of execute, which calls this form with its default parameter values.)
To run just the test named "my favorite test" in a suite from the Scala interpreter, you would write:
scala> new ExampleSuite execute ("my favorite test")
Or:
scala> new ExampleSuite execute (testName = "my favorite test")
The configMap parameter
If you provide a value for the configMap parameter, this method will pass it to run. If not, the default value
of an empty Map will be passed. For more information on how to use a config map to configure your test suites, see
the config map section in the main documentation for this trait. Here's an example in which you configure
a run with the name of an input file:
scala> new ExampleSuite execute (configMap = Map("inputFileName" -> "in.txt")
The color parameter
If you leave the color parameter unspecified, this method will configure the reporter it passes to run to print
to the standard output in color (via ansi escape characters). If you don't want color output, specify false for color, like this:
scala> new ExampleSuite execute (color = false)
The durations parameter
If you leave the durations parameter unspecified, this method will configure the reporter it passes to run to
not print durations for tests and suites to the standard output. If you want durations printed, specify true for durations,
like this:
scala> new ExampleSuite execute (durations = true)
The shortstacks and fullstacks parameters
If you leave both the shortstacks and fullstacks parameters unspecified, this method will configure the reporter
it passes to run to not print stack traces for failed tests if it has a stack depth that identifies the offending
line of test code. If you prefer a short stack trace (10 to 15 stack frames) to be printed with any test failure, specify true for
shortstacks:
scala> new ExampleSuite execute (shortstacks = true)
For full stack traces, set fullstacks to true:
scala> new ExampleSuite execute (fullstacks = true)
If you specify true for both shortstacks and fullstacks, you'll get full stack traces.
The stats parameter
If you leave the stats parameter unspecified, this method will not fire RunStarting and either RunCompleted
or RunAborted events to the reporter it passes to run.
If you specify true for stats, this method will fire the run events to the reporter, and the reporter will print the
expected test count before the run, and various statistics after, including the number of suites completed and number of tests that
succeeded, failed, were ignored or marked pending. Here's how you get the stats:
scala> new ExampleSuite execute (stats = true)
To summarize, this method will pass to run:
testName - None if this method's testName parameter is left at its default value of null, else Some(testName).reporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set()
for tagsToExcludeconfigMap - the configMap passed to this methoddistributor - Nonetracker - a new TrackerNote: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this method isn't named run is that it takes advantage of
default arguments, and you can't mix overloaded methods and default arguments in Scala. (If named run,
this method would have the same name but different arguments than the main run method that
takes seven arguments. Thus it would overload and couldn't be used with default argument values.)
Design note: This method has two "features" that may seem unidiomatic. First, the default value of testName is null.
Normally in Scala the type of testName would be Option[String] and the default value would
be None, as it is in this trait's run method. The null value is used here for two reasons. First, in
ScalaTest 1.5, execute was changed from four overloaded methods to one method with default values, taking advantage of
the default and named parameters feature introduced in Scala 2.8.
To not break existing source code, testName needed to have type String, as it did in two of the overloaded
execute methods prior to 1.5. The other reason is that execute has always been designed to be called primarily
from an interpeter environment, such as the Scala REPL (Read-Evaluate-Print-Loop). In an interpreter environment, minimizing keystrokes is king.
A String type with a null default value lets users type suite.execute("my test name") rather than
suite.execute(Some("my test name")), saving several keystrokes.
The second non-idiomatic feature is that shortstacks and fullstacks are all lower case rather than
camel case. This is done to be consistent with the Shell, which also uses those forms. The reason
lower case is used in the Shell is to save keystrokes in an interpreter environment. Most Unix commands, for
example, are all lower case, making them easier and quicker to type. In the ScalaTest
Shell, methods like shortstacks, fullstacks, and nostats, etc., are
designed to be all lower case so they feel more like shell commands than methods.
the name of one test to run.
a Map of key-value pairs that can be used by the executing Suite of tests.
a boolean that configures whether output is printed in color
a boolean that configures whether test and suite durations are printed to the standard output
a boolean that configures whether short stack traces should be printed for test failures
a boolean that configures whether full stack traces should be printed for test failures
a boolean that configures whether test and suite statistics are printed to the standard output
Expect that the value passed as expected equals the value passed as actual.
Expect that the value passed as expected equals the value passed as actual.
If the actual value equals the expected value
(as determined by ==), expectResult returns
normally. Else, expect throws a
TestFailedException whose detail message includes the expected and actual values.
the expected value
the actual value, which should equal the passed expected value
Expect that the value passed as expected equals the value passed as actual.
Expect that the value passed as expected equals the value passed as actual.
If the actual equals the expected
(as determined by ==), expectResult returns
normally. Else, if actual is not equal to expected, expectResult throws a
TestFailedException whose detail message includes the expected and actual values, as well as the String
obtained by invoking toString on the passed clue.
the expected value
An object whose toString method returns a message to include in a failure report.
the actual value, which should equal the passed expected value
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.
a Filter with which to filter tests to count based on their tags
Throws TestFailedException, with the passed
Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passed
Throwable cause, to indicate a test failed.
The getMessage method of the thrown TestFailedException
will return cause.toString.
a Throwable that indicates the cause of the failure.
Throws TestFailedException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passed
String message as the exception's detail
message and Throwable cause, to indicate a test failed.
A message describing the failure.
A Throwable that indicates the cause of the failure.
Throws TestFailedException, with the passed
String message as the exception's detail
message, to indicate a test failed.
Throws TestFailedException, with the passed
String message as the exception's detail
message, to indicate a test failed.
A message describing the failure.
Throws TestFailedException to indicate a test failed.
Throws TestFailedException to indicate a test failed.
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 at any other
time, it will throw an exception. This method can be called safely by any thread.
Intercept and return an exception that's expected to be thrown by the passed function value.
Intercept and return an exception that's expected to
be thrown by the passed function value. The thrown exception must be an instance of the
type specified by the type parameter of this method. This method invokes the passed
function. If the function throws an exception that's an instance of the specified type,
this method returns that exception. Else, whether the passed function returns normally
or completes abruptly with a different exception, this method throws TestFailedException.
Note that the type specified as this method's type parameter may represent any subtype of
AnyRef, not just Throwable or one of its subclasses. In
Scala, exceptions can be caught based on traits they implement, so it may at times make sense
to specify a trait that the intercepted exception's class must mix in. If a class instance is
passed for a type that could not possibly be used to catch an exception (such as String,
for example), this method will complete abruptly with a TestFailedException.
the function value that should throw the expected exception
an implicit Manifest representing the type of the specified
type parameter.
the intercepted exception, if it is of the expected type
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 or
Specs 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.
Construct a new instance of this Suite.
Construct a new instance of this Suite.
This trait's implementation of runTests invokes this method to create
a new instance of this Suite for each test. This trait's implementation
of this method uses reflection to call this.getClass.newInstance. This
approach will succeed only if this Suite's class has a public, no-arg
constructor. In most cases this is likely to be true, because to be instantiated
by ScalaTest's Runner a Suite needs a public, no-arg
constructor. However, this will not be true of any Suite defined as
an inner class of another class or trait, because every constructor of an inner
class type takes a reference to the enclosing instance. In such cases, and in
cases where a Suite class is explicitly defined without a public,
no-arg constructor, you will need to override this method to construct a new
instance of the Suite in some other way.
Here's an example of how you could override newInstance to construct
a new instance of an inner class:
import org.scalatest.Suite
class Outer { class InnerSuite extends Suite with OneInstancePerTest { def testOne() {} def testTwo() {} override def newInstance = new InnerSuite } }
Throws TestPendingException to indicate a test is pending.
Throws TestPendingException to indicate a test is pending.
A pending test is one that has been given a name but is not yet implemented. The purpose of pending tests is to facilitate a style of testing in which documentation of behavior is sketched out before tests are written to verify that behavior (and often, the before the behavior of the system being tested is itself implemented). Such sketches form a kind of specification of what tests and functionality to implement later.
To support this style of testing, a test can be given a name that specifies one
bit of behavior required by the system being tested. The test can also include some code that
sends more information about the behavior to the reporter when the tests run. At the end of the test,
it can call method pending, which will cause it to complete abruptly with TestPendingException.
Because tests in ScalaTest can be designated as pending with TestPendingException, both the test name and any information
sent to the reporter when running the test can appear in the report of a test run. (In other words,
the code of a pending test is executed just like any other test.) However, because the test completes abruptly
with TestPendingException, the test will be reported as pending, to indicate
the actual test, and possibly the functionality it is intended to test, has not yet been implemented.
Note: This method always completes abruptly with a TestPendingException. Thus it always has a side
effect. Methods with side effects are usually invoked with parentheses, as in pending(). This
method is defined as a parameterless method, in flagrant contradiction to recommended Scala style, because it
forms a kind of DSL for pending tests. It enables tests in suites such as FunSuite or FunSpec
to be denoted by placing "(pending)" after the test name, as in:
test("that style rules are not laws") (pending)
Readers of the code see "pending" in parentheses, which looks like a little note attached to the test name to indicate
it is pending. Whereas "(pending()) looks more like a method call, "(pending)" lets readers
stay at a higher level, forgetting how it is implemented and just focusing on the intent of the programmer who wrote the code.
Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else
throw TestFailedException.
Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else
throw TestFailedException.
This method can be used to temporarily change a failing test into a pending test in such a way that it will
automatically turn back into a failing test once the problem originally causing the test to fail has been fixed.
At that point, you need only remove the pendingUntilFixed call. In other words, a
pendingUntilFixed surrounding a block of code that isn't broken is treated as a test failure.
The motivation for this behavior is to encourage people to remove pendingUntilFixed calls when
there are no longer needed.
This method facilitates a style of testing in which tests are written before the code they test. Sometimes you may
encounter a test failure that requires more functionality than you want to tackle without writing more tests. In this
case you can mark the bit of test code causing the failure with pendingUntilFixed. You can then write more
tests and functionality that eventually will get your production code to a point where the original test won't fail anymore.
At this point the code block marked with pendingUntilFixed will no longer throw an exception (because the
problem has been fixed). This will in turn cause pendingUntilFixed to throw TestFailedException
with a detail message explaining you need to go back and remove the pendingUntilFixed call as the problem orginally
causing your test code to fail has been fixed.
a block of code, which if it completes abruptly, should trigger a TestPendingException
The fully qualified class name of the rerunner to rerun this suite.
The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.
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.
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.
the Args for this run
a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.
This overloaded form of run has been deprecated and will be removed in a future
version of ScalaTest. Please use the run method that takes two parameters instead.
This overloaded form of run has been deprecated and will be removed in a future
version of ScalaTest. Please use the run method that takes two parameters instead.
This final implementation of this method constructs a Args instance from the passed
reporter, stopper, filter, configMap, distributor,
and tracker, and invokes the overloaded run method that takes two parameters,
passing in the specified testName and the newly constructed Args. This method
implementation enables existing code that called into the old run method to continue to work
during the deprecation cycle. Subclasses and subtraits that overrode this method, however, will need to
be changed to use the new two-parameter form instead.
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 Suite.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be executed
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.
a Tracker tracking Ordinals being fired by the current thread.
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 or
Specs 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.
the Args for this run
a Status object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.
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.
the name of one test to execute.
the Args for this run
a Status object that indicates when the test started by this method has completed, and whether or not it failed .@throws NullPointerException if any of testName, reporter, stopper, or configMap
is null.
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.
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.
the Args for this run
a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
Suite style name.
Suite style name.
A string ID for this Suite that is intended to be unique among all suites reported during a run.
A string ID for this Suite that is intended to be unique among all suites reported during a run.
This trait's
implementation of this method returns the fully qualified name of this object's class.
Each suite reported during a run will commonly be an instance of a different Suite class,
and in such cases, this default implementation of this method will suffice. However, in special cases
you may need to override this method to ensure it is unique for each reported suite. For example, if you write
a Suite subclass that reads in a file whose name is passed to its constructor and dynamically
creates a suite of tests based on the information in that file, you will likely need to override this method
in your Suite subclass, perhaps by appending the pathname of the file to the fully qualified class name.
That way if you run a suite of tests based on a directory full of these files, you'll have unique suite IDs for
each reported suite.
The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
this Suite object's ID.
A user-friendly suite name for this Suite.
A user-friendly suite name for this Suite.
This trait's
implementation of this method returns the simple name of this object's class. This
trait's implementation of runNestedSuites calls this method to obtain a
name for Reports to pass to the suiteStarting, suiteCompleted,
and suiteAborted methods of the Reporter.
this Suite object's suite name.
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.
Provides a TestData instance for the passed test name, given the passed config map.
Provides a TestData instance for the passed test name, given the passed config map.
This method is used to obtain a TestData instance to pass to withFixture(NoArgTest)
and withFixture(OneArgTest) and the beforeEach and afterEach methods
of trait BeforeAndAfterEach.
the name of the test for which to return a TestData instance
the config map to include in the returned TestData
a TestData instance for the specified test, which includes the specified config map
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.
Executes the block of code passed as the second parameter, and, if it
completes abruptly with a ModifiableMessage exception,
prepends the "clue" string passed as the first parameter to the beginning of the detail message
of that thrown exception, then rethrows it.
Executes the block of code passed as the second parameter, and, if it
completes abruptly with a ModifiableMessage exception,
prepends the "clue" string passed as the first parameter to the beginning of the detail message
of that thrown exception, then rethrows it. If clue does not end in a white space
character, one space will be added
between it and the existing detail message (unless the detail message is
not defined).
This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:
withClue("(Employee's name was: " + employee.name + ")") { intercept[IllegalArgumentException] { employee.getTask(-1) } }
If an invocation of intercept completed abruptly with an exception, the resulting message would be something like:
(Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown
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.
unused
This expect method has been deprecated; Please use expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
To get rid of the deprecation warning, simply replace expect with
expectResult. The name expect will be used for a different purposes in
a future version of ScalaTest.
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
To get rid of the deprecation warning, simply replace expect with
expectResult. The name expect will be used for a different purposes in
a future version of ScalaTest.
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of expectResult instead.
A sister trait to
org.scalatest.FreeSpecthat 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.Trait
path.FreeSpecbehaves similarly to traitorg.scalatest.FreeSpec, except that tests are isolated based on their path. The purpose ofpath.FreeSpecis 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 trait, 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: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:Or:
Note also that although each test mutates the
ListBuffer, none of the other tests observe those side effects: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
OneInstancePerTestinto a regularorg.scalatest.FreeSpec. However,path.FreeSpectakes isolation one step further: a test in apath.FreeSpecdoes not observe side effects performed outside tests in earlier blocks that do not enclose it. Here's an example:Running the full
ExampleSpec, shown above, in the Scala interpeter would give you:Note: trait
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 apath.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.FreeSpecis because all of its lifecycle methods are overridden and declaredfinal. Thus you can't overridewithFixture, because it isfinal, or mix inBeforeAndAfterorBeforeAndAfterEach, because both overriderunTest, which isfinalin apath.FreeSpec. In short: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. Apath.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 apath.FreeSpecis executed, consider the following variant ofExampleSpecthat includes print statements:Running the above version of
ExampleSpecin the Scala interpreter will give you output similar to:Note that each test is executed in order of appearance in the
path.FreeSpec, and that only thoseprintlnstatements residing in blocks that enclose the test being run are executed. Anyprintlnstatements 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.FreeSpecexecutes quite differently from its sister trait inorg.scalatest. Anorg.scalatest.FreeSpecregisters tests during construction and executes them whenrunis invoked. Anorg.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. Whenrunis invoked on apath.FreeSpec, it reports the registered results and does not run the tests again. Ifrunis invoked a second or third time, in fact, apath.FreeSpecwill each time report the same results registered during construction. If you want to run the tests of apath.FreeSpecanew, you'll need to create a new instance and invokerunon that.A
path.FreeSpecwill create one instance for each "leaf" node it contains. The main kind of leaf node is a test, such as:However, an empty scope (a scope that contains no tests or nested scopes) is also a leaf node:
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.FreeSpecis 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 ofrun,expectedTestsCount,tags, ortestNameson 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.FreeSpecinstance 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 ofpath.FreeSpecchecks 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.FreeSpecin the same manner as in anorg.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
TestIgnoredevent will be fired.Informers
You output information using
Informers in anorg.scalatest.path.FreeSpecin the same manner as in anorg.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.FreeSpecin the same manner as in anorg.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.FreeSpecin the same manner as in anorg.scalatest.FreeSpec. Please see the Tagging tests section in its documentation for more information.Note that one difference between this trait and its sister trait
org.scalatest.FreeSpecis that because tests are executed at construction time, rather than each time run is invoked, anorg.scalatest.path.FreeSpecwill always execute all non-ignored tests. Whenrunis invoked on apath.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 anorg.scalatest.FreeSpeconly executes tests afterrunhas 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 theFilterpassed torun) will not be executed. In anorg.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 apath.FreeSpec. Because in apath.Freespecthe 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.FreeSpecin the same manner as in anorg.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 apath.FreeSpecexecutes tests eagerly at construction time, registering the results of those test runs and reporting them later whenrunis invoked, the order of nested suites versus test runs would be different in aorg.scalatest.path.FreeSpecthan in anorg.scalatest.FreeSpec. Inorg.scalatest.FreeSpec's implementation ofrun, nested suites are executed then tests are executed. Aorg.scalatest.path.FreeSpecwith nested suites would execute these in the opposite order: first tests then nested suites. To help makepath.FreeSpeccode 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 apath.FreeSpec, you can instead wrap them all in aSuitesorSpecsobject. 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
TestSucceededevent provides a duration indicating how long it took for that test to execute. ASuiteCompletedevent 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, orTestPending), 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 timerunis invoked. By contrast, the suite completion events fired for apath.FreeSpecrepresent the amount of time it took to report the registered results. (These events are not fired bypath.FreeSpec, but instead by the entity that invokesrunon thepath.FreeSpec.) As a result, the total time for running the tests of apath.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.