Shell
Related Doc:
package scalatest
A Shell whose run method will pass true for execute's color
parameter, and pass for all other parameters the same values as this Shell.
A Shell whose run method will pass true for execute's color
parameter, and pass for all other parameters the same values as this Shell.
A Shell whose run method will pass true for execute's durations
parameter, and pass for all other parameters the same values as this Shell.
A Shell whose run method will pass true for execute's durations
parameter, and pass for all other parameters the same values as this Shell.
A Shell whose run method will pass false for execute's shortstacks
parameter and true for its fullstacks parameter, and pass for all other parameters the same values as this Shell.
A Shell whose run method will pass false for execute's shortstacks
parameter and true for its fullstacks parameter, and pass for all other parameters the same values as this Shell.
Returns a copy of this Shell with colorPassed configuration parameter set to false.
Returns a copy of this Shell with colorPassed configuration parameter set to false.
Returns a copy of this Shell with durationsPassed configuration parameter set to false.
Returns a copy of this Shell with durationsPassed configuration parameter set to false.
Returns a copy of this Shell with shortStacksPassed configuration parameter set to false.
Returns a copy of this Shell with shortStacksPassed configuration parameter set to false.
Returns a copy of this Shell with statsPassed configuration parameter set to false.
Returns a copy of this Shell with statsPassed configuration parameter set to false.
Run the passed suite, optionally passing in a test name and config map.
Run the passed suite, optionally passing in a test name and config map.
This method will invoke execute on the passed suite, passing in
the specified (or default) testName and configMap and a set of configuration values. A
particular Shell instance will always pass the same configuration values (color,
durations, shortstacks, fullstacks, and stats) to execute each time
this method is invoked.
A Shell whose run method will pass true for execute's shortstacks
parameter and false for its fullstacks parameter, and pass for all other parameters the same values as
this Shell.
A Shell whose run method will pass true for execute's shortstacks
parameter and false for its fullstacks parameter, and pass for all other parameters the same values as
this Shell.
A Shell whose run method will pass true for execute's stats
parameter, and pass for all other parameters the same values as this Shell.
A Shell whose run method will pass true for execute's stats
parameter, and pass for all other parameters the same values as this Shell.
Trait whose instances provide a
runmethod and configuration fields that implement the ScalaTest shell: its DSL for the Scala interpreter.The main command of the ScalaTest shell is
run, which you can use to run a suite of tests. The shell also provides several commands for configuring a call torun:color(the default) - display results in color (green for success; red for failure; yellow for warning; blue for statistics)nocolor- display results without colordurations- display durations of (i.e., how long it took to run) tests and suitesnodurations(the default) - do not display durations of tests and suitesshortstacks- display short (i.e., truncated to show just the most useful portion) stack traces for all exceptionsfullstacks- display full stack trackes for all exceptionsnostacks(the default) - display no stack trace forStackDepthexceptions and a short stack trace for non-StackDepthexceptionsstats- display statistics before and after the run, such as expected test count before the run and tests succeeded, failed, pending, etc., counts after the runnostats(the default) not display statistics before or after the runThe default configuration is
color,nodurations,nostacks, andnostats.All of these commands are fields of trait
org.scalatest.Shell. Each configuration command is a field that refers to anotherShellinstance with every configuration parameter the same except for the one you've asked to change. For example,durationsprovides aShellinstance that has every parameter configured the same way, except with durations enabled. When you invokerunon that, you will get a run with durations enabled and every other configuration parameter at its default value.The other useful "command" to know about, though not technically part of the shell, is the
applyfactory method in theSuitessingleton object. This allows you to easily create composite suites out of nested suites, which you can then pass torun. This will be demonstrated later in this documentation.Using the ScalaTest shell
The package object of the
org.scalatestpackage, although it does not extendShell, declares all the same members asShell. Itsrunmethod runs with all theShellconfiguration parameters set to their default values. A good way to use the ScalaTest shell, therefore, is to import the members of packageorg.scalatest:scala> import org.scalatest._ import org.scalatest._One thing importing
org.scalatest._allows you to do is access any of ScalaTest's classes and traits by shorter names, for example:scala> class ArithmeticSuite extends FunSuite with matchers.Matchers { | test("addition works") { | 1 + 1 should equal (2) | } | ignore("subtraction works") { | 1 - 1 should equal (0) | } | test("multiplication works") { | 1 * 1 should equal (2) | } | test("division works") (pending) | } defined class ArithmeticSuiteBut importing
org.scalatest._also brings into scope the commands of theShell, so you can, for example, invokerunwithout qualification:Configuring a single run
To configure a single run, you can prefix run by one or more configuration commands, separated by dots. For example, to enable durations during a single run, you would write:
To enable statistics during a single run, you would write:
And to enable both durations and statistics during a single run, you could write:
The order doesn't matter when you are chaining multiple configuration commands. You'll get the same result whether you write
durations.stats.runorstats.durations.run.To disable color, use
nocolor:scala> nocolor.run(new ArithmeticSuite) ArithmeticSuite: - addition works - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** 1 did not equal 2 (:16)
- division works (pending)
To enable short stack traces during a single run, use
shortstacks:Changing the default configuration
If you want to change the default for multiple runs, you can import the members of your favorite
Shellconfiguration. For example, if you always like to run with durations and statistics enabled, you could write:scala> import stats.durations._ import stats.durations._Now anytime you run statistics and durations will, by default, be enabled:
Running multiple suites
If you want to run multiple suites, you can use the factory method in the
Suitessingleton object. If you wrap a comma-separated list of suite instances insideSuites(...), for example, you'll get a suite instance that contains no tests, but whose nested suites includes the suite instances you placed between the parentheses. You can placeSuitesinsideSuitesto any level of depth, creating a tree of suites to pass torun. Here's a (contrived) example in whichArithmeticSuiteis executed four times:Running a single test
The
runcommand also allows you to specify the name of a test to run and/or a config map. You can run a particular test in a suite, for example, by specifying the test name after the suite instance in your call torun, like this: