run

Singleton object providing an apply method for the ScalaTest shell and a main method for ScalaTest's simple runner.

The apply method can be used in the ScalaTest Shell (its DSL for the Scala interpreter) in this way:

scala> import org.scalatest._
import org.scalatest._

scala> class ArithmeticSuite extends FunSuite with 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

scala> run(new ArithmeticSuite)
ArithmeticSuite:
- addition works
- subtraction works !!! IGNORED !!!
- multiplication works *** FAILED ***
 1 did not equal 2 (:16)
- division works (pending)

The last command is calling the apply method on the run singleton object. In other words, you could alternatively call it this way:

scala> run.apply(new ArithmeticSuite)
ArithmeticSuite:
- addition works
- subtraction works !!! IGNORED !!!
- multiplication works *** FAILED ***
 1 did not equal 2 (:16)
- division works (pending)

The run singleton object also serves a different purpose. Its main method allows users to "run" run as a Scala application. ScalaTest's Runner application is very powerful, but doesn't provide the simplest out-of-box experience for people trying ScalaTest for the first time. For example, to run an ExampleSpec in the unnamed package from the directory where it is compiled with Runner's standard out reporter requires this command:

$ scala -cp scalatest-RELEASE.jar org.scalatest.tools.Runner -R . -o -s ExampleSpec

Running it with the run application is simpler:

$ scala -cp scalatest-RELEASE.jar org.scalatest.run ExampleSpec