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 message,
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 message 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
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.
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()
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 ==), expect returns
normally. Else, expect throws an
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 ==), expect returns
normally. Else, if actual is not equal to expected, expect throws an
TestFailedException whose detail message includes the expected and actual values, as well as the String
obtained by invoking toString on the passed message.
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
Returns the result obtained from invoking expectedTestCount on an instance of the wrapped
suite, constructed by passing an empty config map to its constructor, passing into the wrapped suite's
expectedTestCount method the specified Filter.
Returns the result obtained from invoking expectedTestCount on an instance of the wrapped
suite, constructed by passing an empty config map to its constructor, passing into the wrapped suite's
expectedTestCount method the specified Filter.
the Filter to pass to the wrapped suite's expectedTestCount method
the result of invoking expectedTestCount on an instance of wrapped suite
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.
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 the result obtained from invoking nestedSuites on an instance of the wrapped
suite, constructed by passing an empty config map to its constructor.
Returns the result obtained from invoking nestedSuites on an instance of the wrapped
suite, constructed by passing an empty config map to its constructor.
the result of invoking nestedSuites on an instance of wrapped suite
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
Constructs a new instance of the suite to wrap, whose Class is passed to this
suite's constructor, passing in the specified config map, and invokes run on
that new instance, passing in the same arguments passed to this method.
Constructs a new instance of the suite to wrap, whose Class is passed to this
suite's constructor, passing in the specified config map, and invokes run on
that new instance, passing in the same arguments passed to this method.
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 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 (passed to both the constructor of the wrapped suite and its run method).
an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
a Tracker tracking Ordinals being fired by the current thread.
Run zero to many of this Suite's nested Suites.
Run zero to many of this Suite's nested Suites.
If the passed distributor is None, this trait's
implementation of this method invokes run on each
nested Suite in the List obtained by invoking nestedSuites.
If a nested Suite's run
method completes abruptly with an exception, this trait's implementation of this
method reports that the Suite aborted and attempts to run the
next nested Suite.
If the passed distributor is defined, this trait's implementation
puts each nested Suite
into the Distributor contained in the Some, in the order in which the
Suites appear in the List returned by nestedSuites, passing
in a new Tracker obtained by invoking nextTracker on the Tracker
passed to this method.
Implementations of this method are responsible for ensuring SuiteStarting events
are fired to the Reporter before executing any nested Suite, and either SuiteCompleted
or SuiteAborted after executing any nested 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 run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
a Tracker tracking Ordinals being fired by the current thread.
Run a test.
Run a test.
This trait's implementation uses Java reflection to invoke on this object the test method identified by the passed testName.
Implementations of this method are responsible for ensuring a TestStarting event
is fired to the Reporter before executing any test, and either TestSucceeded,
TestFailed, or TestPending after executing any nested
Suite. (If a test is marked with the org.scalatest.Ignore tag, the
runTests method is responsible for ensuring a TestIgnored event is fired and that
this runTest method is not invoked for that ignored test.)
the name of one test to run.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Map of key-value pairs that can be used by the executing Suite of tests.
a Tracker tracking Ordinals being fired by the current thread.
Run zero to many of this Suite's tests.
Run zero to many of this Suite's tests.
This method takes a testName parameter that optionally specifies a test to invoke.
If testName is defined, this trait's implementation of this method
invokes runTest on this object, passing in:
testName - the String value of the testName Option passed
to this methodreporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap Map passed to this method, or one that wraps and delegates to itThis method takes a Filter, which encapsulates an optional Set of tag names that should be included
(tagsToInclude) and a Set that should be excluded (tagsToExclude), when deciding which
of this Suite's tests to run.
If tagsToInclude is None, all tests will be run
except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is defined, only tests
belonging to tags mentioned in the tagsToInclude Set, and not mentioned in the tagsToExcludeSet
will be run. However, if testName is defined, tagsToInclude and tagsToExclude are essentially ignored.
Only if testName is None will tagsToInclude and tagsToExclude be consulted to
determine which of the tests named in the testNames Set should be run. This trait's implementation
behaves this way, and it is part of the general contract of this method, so all overridden forms of this method should behave
this way as well. For more information on test tags, see the main documentation for this trait and for class Filter.
Note that this means that even if a test is marked as ignored, for example a test method in a Suite annotated with
org.scalatest.Ignore, if that test name is passed as testName to runTest, it will be invoked
despite the Ignore annotation.
If testName is None, this trait's implementation of this method
invokes testNames on this Suite to get a Set of names of tests to potentially run.
(A testNames value of None essentially acts as a wildcard that means all tests in
this Suite that are selected by tagsToInclude and tagsToExclude should be run.)
For each test in the testName Set, in the order
they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation
of this method checks whether the test should be run based on the Filter.
If so, this implementation invokes runTest, passing in:
testName - the String name of the test to run (which will be one of the names in the testNames Set)reporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to itIf a test is marked with the org.scalatest.Ignore tag, implementations
of this method are responsible for ensuring a TestIgnored event is fired for that test
and that runTest is not called for that test.
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 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 run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
a Tracker tracking Ordinals being fired by the current thread.
Suite style name.
Suite style name.
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.
Returns the result obtained from invoking tags on an instance of the wrapped
suite, constructed by passing an empty config map to its constructor.
Returns the result obtained from invoking tags on an instance of the wrapped
suite, constructed by passing an empty config map to its constructor.
the result of invoking testNames on an instance of wrapped suite
Returns the result obtained from invoking testNames on an instance of the wrapped
suite, constructed by passing an empty config map to its constructor.
Returns the result obtained from invoking testNames on an instance of the wrapped
suite, constructed by passing an empty config map to its constructor.
the result of invoking testNames on an instance of wrapped suite
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
Run the passed test function in the context of a fixture established by this method.
Run the passed test function in the context of a fixture established by this method.
This method should set up the fixture needed by the tests of the
current suite, invoke the test function, and if needed, perform any clean
up needed after the test completes. Because the NoArgTest function
passed to this method takes no parameters, preparing the fixture will require
side effects, such as reassigning instance vars in this Suite or initializing
a globally accessible external database. If you want to avoid reassigning instance vars
you can use fixture.Suite.
This trait's implementation of runTest invokes this method for each test, passing
in a NoArgTest whose apply method will execute the code of the test.
This trait's implementation of this method simply invokes the passed NoArgTest function.
the no-arg test function to run with a fixture
Wrapper
Suitethat passes an instance of the config map to the constructor of the wrappedSuitewhenrunis invoked.Each time
runis invoked on an instance ofConfigMapWrapperSuite, this suite will create a new instance of the suite to wrap, passing to the constructor the config map passed torun. This way, if the sameConfigMapWrapperSuiteinstance is run multiple times, each time with a different config map, an instance of the wrapped suite will be created for each config map. In addition to being passed to the wrapped suite's constructor, the config map passed to theConfigMapWrapperSuite'srunmethod will also be passed to therunmethod of the newly created wrapped suite instance.The config map is accessible inside a
Suitein many ways. It is passed torun,runNestedSuites,runTests, andrunTest. It is also passed towithFixture, accessible via a method onNoArgTestandOneArgTest. It is passed to an overloaded forms of thebeforeEachandafterEachmethods of traitBeforeAndAfterEach, as well as overloaded forms of thebeforeAllandafterAllmethods of traitBeforeAndAfterAll. Tests themselves can have information taken from the config map, or the entire config map, through various means. The config map may be passed into the test via aConfigMapFixture, for example. ClassConfigMapWrapperSuiterepresents one more way to get at the config map inside a suite of test:ConfigMapWrapperSuitewill pass the config map to the constructor of your suite class, bringing it easily into scope for tests and helper methods alike.Having the config map passed to the suite constructor might be more convenient in some cases, but in the case of the
org.scalatest.pathtraits, it is necessary if a test needs information from a config map. The reason is that in a path trait, the test code is executed eagerly, beforerunis invoked. The results of the tests are registered when the tests are executed, and those results are merely reported oncerunis invoked. Thus by the timerunhas been invoked, it is too late to get the config map to the tests, which have already been executed. Using aConfigMapWrapperSuitesolves that problem. By passing the config map to the constructor, it is available early enough for the running tests to use it. Here's an example: