sealed trait Shell extends AnyRef
Trait whose instances provide a run
method 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 to run
:
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 forStackDepth
exceptions and a short stack trace for non-StackDepth
exceptionsstats
- 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 run
The default configuration is color
, nodurations
, nostacks
, and nostats
.
All of these commands are fields of trait org.scalatest.Shell
. Each configuration command is a field that refers to
another Shell
instance with every configuration parameter
the same except for the one you've asked to change. For example, durations
provides a
Shell
instance that has every parameter configured the same way, except with durations enabled. When you invoke
run
on 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 apply
factory method in the Suites
singleton object. This allows you to easily create composite suites out of nested suites, which you can then pass to run
. This
will be demonstrated later in this documentation.
Using the ScalaTest shell
The package object of the org.scalatest
package, although it does not extend Shell
, declares all the
same members as Shell
. Its run
method runs with all the Shell
configuration parameters set
to their default values. A good way to use the ScalaTest shell, therefore, is to import the members of package org.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 ArithmeticSuite
But importing org.scalatest._
also brings into scope the commands of the Shell
, so you can, for
example, invoke run
without qualification:
scala> run(new ArithmeticSuite) ArithmeticSuite: - addition works - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** 1 did not equal 2 (:16) - division works (pending)
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:
scala> durations.run(new ArithmeticSuite) ArithmeticSuite: - addition works (102 milliseconds) - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** (36 milliseconds) 1 did not equal 2 (:16) - division works (pending)
To enable statistics during a single run, you would write:
scala> stats.run(new ArithmeticSuite) Run starting. Expected test count is: 3 ArithmeticSuite: - addition works - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** 1 did not equal 2 (:16) - division works (pending) Run completed in 386 milliseconds. Total number of tests run: 2 Suites: completed 1, aborted 0 Tests: succeeded 1, failed 1, ignored 1, pending 1 *** 1 TEST FAILED ***
And to enable both durations and statistics during a single run, you could write:
scala> durations.stats.run(new ArithmeticSuite) Run starting. Expected test count is: 3 ArithmeticSuite: - addition works (102 milliseconds) - subtraction works !!! IGNORED !!! - multiplication works *** FAILED (36 milliseconds)*** 1 did not equal 2 (:16) - division works (pending) Run completed in 386 milliseconds. Total number of tests run: 2 Suites: completed 1, aborted 0 Tests: succeeded 1, failed 1, ignored 1, pending 1 *** 1 TEST FAILED ***
The order doesn't matter when you are chaining multiple configuration commands. You'll get the same
result whether you write durations.stats.run
or stats.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
:
scala> shortstacks.run(new ArithmeticSuite) ArithmeticSuite: - addition works (101 milliseconds) - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** (33 milliseconds) 1 did not equal 2 (:16) org.scalatest.exceptions.TestFailedException: ... at line2$object$$iw$$iw$$iw$$iw$ArithmeticSuite$$anonfun$3.apply$mcV$sp( - division works (pending):16) at line2$object$$iw$$iw$$iw$$iw$ArithmeticSuite$$anonfun$3.apply( :16) at line2$object$$iw$$iw$$iw$$iw$ArithmeticSuite$$anonfun$3.apply( :16) at org.scalatest.FunSuite$$anon$1.apply(FunSuite.scala:992) at org.scalatest.Suite$class.withFixture(Suite.scala:1661) at line2$object$$iw$$iw$$iw$$iw$ArithmeticSuite.withFixture( :8) at org.scalatest.FunSuite$class.invokeWithFixture$1(FunSuite.scala:989) ...
Changing the default configuration
If you want to change the default for multiple runs, you can import the members of your favorite Shell
configuration. 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:
scala> run(new ArithmeticSuite) Run starting. Expected test count is: 3 ArithmeticSuite: - addition works (9 milliseconds) - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** (10 milliseconds) 1 did not equal 2 (:18) - division works (pending) Run completed in 56 milliseconds. Total number of tests run: 2 Suites: completed 1, aborted 0 Tests: succeeded 1, failed 1, ignored 1, pending 1 *** 1 TEST FAILED ***
Running multiple suites
If you want to run multiple suites, you can use the factory method in the Suites
singleton object. If you wrap a comma-separated list of suite instances inside Suites(...)
, 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 place Suites
inside Suites
to any level of depth, creating a tree of
suites to pass to run
. Here's a (contrived) example in which ArithmeticSuite
is executed four times:
scala> run(Suites(new ArithmeticSuite, new ArithmeticSuite, Suites(new ArithmeticSuite, new ArithmeticSuite))) Run starting. Expected test count is: 12 Suites: ArithmeticSuite: - addition works (0 milliseconds) - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** (1 millisecond) 1 did not equal 2 (:16) - division works (pending) ArithmeticSuite: - addition works (1 millisecond) - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** (0 milliseconds) 1 did not equal 2 (:16) - division works (pending) Suites: ArithmeticSuite: - addition works (0 milliseconds) - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** (0 milliseconds) 1 did not equal 2 (:16) - division works (pending) ArithmeticSuite: - addition works (0 milliseconds) - subtraction works !!! IGNORED !!! - multiplication works *** FAILED *** (0 milliseconds) 1 did not equal 2 (:16) - division works (pending) Run completed in 144 milliseconds. Total number of tests run: 8 Suites: completed 6, aborted 0 Tests: succeeded 4, failed 4, ignored 4, pending 4 *** 4 TESTS FAILED ***
Running a single test
The run
command 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 to run
, like this:
scala> run(new ArithmeticSuite, "addition works") ArithmeticSuite: - addition works
- Source
- Shell.scala
- Alphabetic
- By Inheritance
- Shell
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
val
color: Shell
A
Shell
whoserun
method will passtrue
forexecute
'scolor
parameter, and pass for all other parameters the same values as thisShell
.A
Shell
whoserun
method will passtrue
forexecute
'scolor
parameter, and pass for all other parameters the same values as thisShell
. -
abstract
val
durations: Shell
A
Shell
whoserun
method will passtrue
forexecute
'sdurations
parameter, and pass for all other parameters the same values as thisShell
.A
Shell
whoserun
method will passtrue
forexecute
'sdurations
parameter, and pass for all other parameters the same values as thisShell
. -
abstract
val
fullstacks: Shell
A
Shell
whoserun
method will passfalse
forexecute
'sshortstacks
parameter andtrue
for itsfullstacks
parameter, and pass for all other parameters the same values as thisShell
.A
Shell
whoserun
method will passfalse
forexecute
'sshortstacks
parameter andtrue
for itsfullstacks
parameter, and pass for all other parameters the same values as thisShell
. -
abstract
val
nocolor: Shell
Returns a copy of this
Shell
withcolorPassed
configuration parameter set tofalse
.Returns a copy of this
Shell
withcolorPassed
configuration parameter set tofalse
. -
abstract
val
nodurations: Shell
Returns a copy of this
Shell
withdurationsPassed
configuration parameter set tofalse
.Returns a copy of this
Shell
withdurationsPassed
configuration parameter set tofalse
. -
abstract
val
nostacks: Shell
Returns a copy of this
Shell
withshortStacksPassed
configuration parameter set tofalse
.Returns a copy of this
Shell
withshortStacksPassed
configuration parameter set tofalse
. -
abstract
val
nostats: Shell
Returns a copy of this
Shell
withstatsPassed
configuration parameter set tofalse
.Returns a copy of this
Shell
withstatsPassed
configuration parameter set tofalse
. -
abstract
def
run(suite: Suite, testName: String = null, configMap: ConfigMap = ConfigMap.empty): Unit
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 passedsuite
, passing in the specified (or default)testName
andconfigMap
and a set of configuration values. A particularShell
instance will always pass the same configuration values (color
,durations
,shortstacks
,fullstacks
, andstats
) toexecute
each time this method is invoked. -
abstract
val
shortstacks: Shell
A
Shell
whoserun
method will passtrue
forexecute
'sshortstacks
parameter andfalse
for itsfullstacks
parameter, and pass for all other parameters the same values as thisShell
.A
Shell
whoserun
method will passtrue
forexecute
'sshortstacks
parameter andfalse
for itsfullstacks
parameter, and pass for all other parameters the same values as thisShell
. -
abstract
val
stats: Shell
A
Shell
whoserun
method will passtrue
forexecute
'sstats
parameter, and pass for all other parameters the same values as thisShell
.A
Shell
whoserun
method will passtrue
forexecute
'sstats
parameter, and pass for all other parameters the same values as thisShell
.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )