Runs a suite of tests, with optional GUI.
Runs a suite of tests, with optional GUI. See the main documentation for this singleton object for the details.
Runs a suite of tests, with optional GUI.
Runs a suite of tests, with optional GUI. See the main documentation for this singleton object for the details.
The difference between this method and main
is simply that this method will block until the run
has completed, aborted, or been stopped, and return true
if all tests executed and passed. In other
words, if any test fails, or if any suite aborts, or if the run aborts or is stopped, this method will
return false
. This value is used, for example, by the ScalaTest ant task to determine whether
to continue the build if haltOnFailure
is set to true
.
true if all tests were executed and passed.
Application that runs a suite of tests. The application accepts command line arguments that specify optional config map (key-value pairs), an optional runpath, zero to many
Reporter
s, optional lists of tags to include and/or exclude, zero to manySuite
class names, zero to many "members-only"Suite
paths, zero to many "wildcard"Suite
paths, and zero to many TestNG XML config file paths. All of these arguments are described in more detail below. Here's a summary:The simplest way to start
Runner
is to specify the directory containing your compiled tests as the sole element of the runpath, for example:Given the previous command,
Runner
will discover and execute allSuite
s in thecompiled_tests
directory and its subdirectories, and show results in graphical user interface (GUI).Specifying the config map
A config map contains pairs consisting of a string key and a value that may be of any type. (Keys that start with "org.scalatest." are reserved for ScalaTest. Configuration values that are themselves strings may be specified on the
Runner
command line. Each configuration pair is denoted with a "-D", followed immediately by the key string, an "=", and the value string. For example:Specifying a runpath
A runpath is the list of filenames, directory paths, and/or URLs that
Runner
uses to load classes for the running test. If runpath is specified,Runner
creates a custom class loader to load classes available on the runpath. The graphical user interface reloads the test classes anew for each run by creating and using a new instance of the custom class loader for each run. The classes that comprise the test may also be made available on the classpath, in which case no runpath need be specified.The runpath is specified with the -p option. The -p must be followed by a space, a double quote (
"
), a white-space-separated list of paths and URLs, and a double quote. If specifying only one element in the runpath, you can leave off the double quotes, which only serve to combine a white-space separated list of strings into one command line argument. If you have path elements that themselves have a space in them, you must place a backslash (\) in front of the space. Here's an example:Specifying reporters
Reporters can be specified on the command line in any of the following ways:
-g[configs...]
- causes display of a graphical user interface that allows tests to be run and results to be investigated-f[configs...] <filename>
- causes test results to be written to the named file-u <directory>
- causes test results to be written to xml files in the named directory-o[configs...]
- causes test results to be written to the standard output-e[configs...]
- causes test results to be written to the standard error-r[configs...] <reporterclass>
- causes test results to be reported to an instance of the specified fully qualifiedReporter
class nameThe
[configs...]
parameter, which is used to configure reporters, is described in the next section.The
-r
option causes the reporter specified in<reporterclass>
to be instantiated. Each reporter class specified with a -r option must be public, implementorg.scalatest.Reporter
, and have a public no-arg constructor. Reporter classes must be specified with fully qualified names. The specified reporter classes may be deployed on the classpath. If a runpath is specified with the-p
option, the specified reporter classes may also be loaded from the runpath. All specified reporter classes will be loaded and instantiated via their no-arg constructor.For example, to run a suite named
MySuite
from themydir
directory using two reporters, the graphical reporter and a file reporter writing to a file named"test.out"
, you would type:The
-g
,-o
, or-e
options can appear at most once each in any single command line. Multiple appearances of-f
and-r
result in multiple reporters unless the specified<filename>
or<reporterclass>
is repeated. If any of-g
,-o
,-e
,<filename>
or<reporterclass>
are repeated on the command line, theRunner
will print an error message and not run the tests.Runner
adds the reporters specified on the command line to a dispatch reporter, which will dispatch each method invocation to each contained reporter.Runner
will pass the dispatch reporter to executed suites. As a result, every specified reporter will receive every report generated by the running suite of tests. If no reporters are specified, a graphical runner will be displayed that provides a graphical report of executed suites.Configuring Reporters
Each reporter option on the command line can include configuration characters. Configuration characters are specified immediately following the
-g
,-o
,-e
,-f
, or-r
. The following configuration characters, which cause reports to be dropped, are valid for any reporter:N
- dropTestStarting
eventsC
- dropTestSucceeded
eventsX
- dropTestIgnored
eventsE
- dropTestPending
eventsH
- dropSuiteStarting
eventsL
- dropSuiteCompleted
eventsO
- dropInfoProvided
eventsA dropped event will not be delivered to the reporter at all. So the reporter will not know about it and therefore not present information about the event in its report. For example, if you specify
-oN
, the standard output reporter will never receive anyTestStarting
events and will therefore never report them. The purpose of these configuration parameters is to allow users to selectively remove events they find add clutter to the report without providing essential information.The following three reporter configuration parameters may additionally be used on standard output (-o), standard error (-e), and file (-f) reporters:
W
- without colorD
- show all durationsS
- show short stack tracesF
- show full stack tracesIf you specify a W, D, S, or F for any reporter other than standard output, standard error, or file reporters,
Runner
will complain with an error message and not perform the run.Configuring a standard output, error, or file reporter with
D
will cause that reporter to print a duration for each test and suite. When running in the default mode, a duration will only be printed for the entire run.Configuring a standard output, error, or file reporter with
F
will cause that reporter to print full stack traces for all exceptions, includingTestFailedExceptions
. EveryTestFailedException
contains a stack depth of the line of test code that failed so that users won't need to search through a stack trace to find it. When running in the default, mode, these reporters will only show full stack traces when other exceptions are thrown, such as an exception thrown by production code. When aTestFailedException
is thrown in default mode, only the source filename and line number of the line of test code that caused the test to fail are printed along with the error message, not the full stack trace.By default, a standard output, error, or file reporter inserts ansi escape codes into the output printed to change and later reset terminal colors. Information printed as a result of run starting, completed, and stopped events is printed in cyan. Information printed as a result of ignored or pending test events is shown in yellow. Information printed as a result of test failed, suite aborted, or run aborted events is printed in red. All other information is printed in green. The purpose of these colors is to facilitate speedy reading of the output, especially the finding of failed tests, which can get lost in a sea of passing tests. Configuring a standard output, error, or file reporter into without-color mode ('W') will turn off this behavior. No ansi codes will be inserted.
For example, to run a suite using two reporters, the graphical reporter configured to present every reported event and a standard error reporter configured to present everything but test starting, test succeeded, test ignored, test pending, suite starting, suite completed, and info provided events, you would type:
scala -classpath scalatest-<version>.jar -p mydir -g -eNDXEHLO -s MySuite
Note that no white space is allowed between the reporter option and the initial configuration parameters. So
"-e NDXEHLO"
will not work,"-eNDXEHLO"
will work.Specifying tags to include and exclude
You can specify tag names of tests to include or exclude from a run. To specify tags to include, use
-n
followed by a white-space-separated list of tag names to include, surrounded by double quotes. (The double quotes are not needed if specifying just one tag.) Similarly, to specify tags to exclude, use-l
followed by a white-space-separated list of tag names to exclude, surrounded by double quotes. (As before, the double quotes are not needed if specifying just one tag.) If tags to include is not specified, then all tests except those mentioned in the tags to exclude (and in theorg.scalatest.Ignore
tag), will be executed. (In other words, the absence of a-n
option is like a wildcard, indicating all tests be included.) If tags to include is specified, then only those tests whose tags are mentioned in the argument following-n
and not mentioned in the tags to exclude, will be executed. For more information on test tags, see the documentation forSuite
. Here are some examples:-n CheckinTests
-n FunctionalTests -l SlowTests
-n "CheckinTests FunctionalTests" -l "SlowTests NetworkTests"
Executing
Suite
s in parallelWith the proliferation of multi-core architectures, and the often parallelizable nature of tests, it is useful to be able to run tests in parallel. If you include
-c
on the command line,Runner
will pass aDistributor
to theSuite
s you specify with-s
.Runner
will set up a thread pool to execute anySuite
s passed to theDistributor
'sput
method in parallel. TraitSuite
's implementation ofrunNestedSuites
will place any nestedSuite
s into thisDistributor
. Thus, if you have aSuite
of tests that must be executed sequentially, you should overriderunNestedSuites
as described in the documentation forDistributor
.The
-c
option may optionally be appended with a number (e.g. "-c10
" -- no intervening space) to specify the number of threads to be created in the thread pool. If no number (or 0) is specified, the number of threads will be decided based on the number of processors available.Specifying
Suite
sSuites are specified on the command line with a -s followed by the fully qualified name of a
Suite
subclass, as in:Each specified suite class must be public, a subclass of
org.scalatest.Suite
, and contain a public no-arg constructor.Suite
classes must be specified with fully qualified names. The specifiedSuite
classes may be loaded from the classpath. If a runpath is specified with the-p
option, specifiedSuite
classes may also be loaded from the runpath. All specifiedSuite
classes will be loaded and instantiated via their no-arg constructor.The runner will invoke
execute
on each instantiatedorg.scalatest.Suite
, passing in the dispatch reporter to eachexecute
method.Runner
is intended to be used from the command line. It is included inorg.scalatest
package as a convenience for the user. If this package is incorporated into tools, such as IDEs, which take over the role of runner, objectorg.scalatest.tools.Runner
may be excluded from that implementation of the package. All other public types declared in packageorg.scalatest.tools.Runner
should be included in any such usage, however, so client software can count on them being available.Specifying "members-only" and "wildcard"
Suite
pathsIf you specify
Suite
path names with-m
or-w
,Runner
will automatically discover and execute accessibleSuite
s in the runpath that are either a member of (in the case of-m
) or enclosed by (in the case of-w
) the specified path. As used in this context, a path is a portion of a fully qualified name. For example, the fully qualifed namecom.example.webapp.MySuite
contains pathscom
,com.example
, andcom.example.webapp
. The fully qualifed namecom.example.webapp.MyObject.NestedSuite
contains pathscom
,com.example
,com.example.webapp
, andcom.example.webapp.MyObject
. An accessibleSuite
is a public class that extendsorg.scalatest.Suite
and defines a public no-arg constructor. Note thatSuite
s defined inside classes and traits do not have no-arg constructors, and therefore won't be discovered.Suite
s defined inside singleton objects, however, do get a no-arg constructor by default, thus they can be discovered.For example, if you specify
-m com.example.webapp
on the command line, and you've placedcom.example.webapp.RedSuite
andcom.example.webapp.BlueSuite
on the runpath, thenRunner
will instantiate and execute both of thoseSuite
s. The difference between-m
and-w
is that for-m
, onlySuite
s that are direct members of the named path will be discovered. For-w
, anySuite
s whose fully qualified name begins with the specified path will be discovered. Thus, ifcom.example.webapp.controllers.GreenSuite
exists on the runpath, invokingRunner
with-w com.example.webapp
will causeGreenSuite
to be discovered, because its fully qualifed name begins with"com.example.webapp"
. But if you invokeRunner
with-m com.example.webapp
,GreenSuite
will not be discovered because it is directly a member ofcom.example.webapp.controllers
, notcom.example.webapp
.If you specify no
-s
,-m
, or-w
arguments on the command line toRunner
, it will discover and execute all accessibleSuite
s in the runpath.Specifying TestNG XML config file paths
If you specify one or more file paths with
-b
(b for Beust, the last name of TestNG's creator),Runner
will create aorg.scalatest.testng.TestNGWrapperSuite
, passing in aList
of the specified paths. When executed, theTestNGWrapperSuite
will create oneTestNG
instance and pass each specified file path to it for running. If you include-b
arguments, you must include TestNG's jar file on the class path or runpath. The-b
argument will enable you to run existingTestNG
tests, including tests written in Java, as part of a ScalaTest run. You need not use-b
to run suites written in Scala that extendTestNGSuite
. You can simply run such suites with-s
,-m
, or -w parameters.Specifying JUnit tests
JUnit tests, including ones written in Java, may be run by specifying
-j classname
, where the classname is a valid JUnit class such as a TestCase, TestSuite, or a class implementing a static suite() method returning a TestSuite.To use this option you must include a JUnit jar file on your classpath.