org.scalatest.PropSpec

A suite of property-based tests.

Recommended Usage: Trait PropSpec is a good fit for teams that want to write tests exclusively in terms of property checks, and is also a good choice for writing the occasional test matrix when a different style trait is chosen as the main unit testing style.

Here's an example PropSpec:

package org.scalatest.examples.propspec

import org.scalatest._
import prop._
import scala.collection.immutable._

class SetSpec extends PropSpec with TableDrivenPropertyChecks with ShouldMatchers {

  val examples =
    Table(
      "set",
      BitSet.empty,
      HashSet.empty[Int],
      TreeSet.empty[Int]
    )

  property("an empty Set should have size 0") {
    forAll(examples) { set =>
      set.size should be (0)
    }
  }

  property("invoking head on an empty set should produce NoSuchElementException") {
    forAll(examples) { set =>
      evaluating { set.head } should produce [NoSuchElementException]
    }
  }
}

You can run a PropSpec by invoking execute on it. This method, which prints test results to the standard output, is intended to serve as a convenient way to run tests from within the Scala interpreter. For example, to run SetSpec from within the Scala interpreter, you could write:

scala> new SetSpec execute

And you would see:

SetSpec:
- an empty Set should have size 0
- invoking head on an empty Set should produce NoSuchElementException

Or, to run just the “an empty Set should have size 0” method, you could pass that test's name, or any unique substring of the name, such as "size 0" or even just "0". Here's an example:

scala> new SetSpec execute "size 0"
SetSpec:
- an empty Set should have size 0

You can also pass to execute a config map of key-value pairs, which will be passed down into suites and tests, as well as other parameters that configure the run itself. For more information on running in the Scala interpreter, see the documentation for execute (below) and the ScalaTest shell.

The execute method invokes a run method that takes two parameters. This run method, which actually executes the suite, will usually be invoked by a test runner, such as run, tools.Runner, a build tool, or an IDE.

“property” is a method, defined in PropSpec, which will be invoked by the primary constructor of SetSpec. You specify the name of the test as a string between the parentheses, and the test code itself between curly braces. The test code is a function passed as a by-name parameter to property, which registers it for later execution.

A PropSpec's lifecycle has two phases: the registration phase and the ready phase. It starts in registration phase and enters ready phase the first time run is called on it. It then remains in ready phase for the remainder of its lifetime.

Tests can only be registered with the property method while the PropSpec is in its registration phase. Any attempt to register a test after the PropSpec has entered its ready phase, i.e., after run has been invoked on the PropSpec, will be met with a thrown TestRegistrationClosedException. The recommended style of using PropSpec is to register tests during object construction as is done in all the examples shown here. If you keep to the recommended style, you should never see a TestRegistrationClosedException.

Ignored tests

To support the common use case of temporarily disabling a test, with the good intention of resurrecting the test at a later time, PropSpec provides registration methods that start with ignore instead of property. Here's an example:

package org.scalatest.examples.suite.ignore

import org.scalatest._
import prop._
import scala.collection.immutable._

class SetSpec extends PropSpec with TableDrivenPropertyChecks with ShouldMatchers {

  val examples =
    Table(
      "set",
      BitSet.empty,
      HashSet.empty[Int],
      TreeSet.empty[Int]
    )

  ignore("an empty Set should have size 0") {
    forAll(examples) { set =>
      set.size should be (0)
    }
  }

  property("invoking head on an empty set should produce NoSuchElementException") {
    forAll(examples) { set =>
      evaluating { set.head } should produce [NoSuchElementException]
    }
  }
}

If you run this version of SetSuite with:

scala> new SetSpec execute

It will run only the second test and report that the first test was ignored:

SetSuite:
- an empty Set should have size 0 !!! IGNORED !!!
- invoking head on an empty Set should produce NoSuchElementException

Informers

One of the parameters to PropSpec's run method is a Reporter, which will collect and report information about the running suite of tests. Information about suites and tests that were run, whether tests succeeded or failed, and tests that were ignored will be passed to the Reporter as the suite runs. Most often the reporting done by default by PropSpec's methods will be sufficient, but occasionally you may wish to provide custom information to the Reporter from a test. For this purpose, an Informer that will forward information to the current Reporter is provided via the info parameterless method. You can pass the extra information to the Informer via its apply method. The Informer will then pass the information to the Reporter via an InfoProvided event. Here's an example that shows both a direct use as well as an indirect use through the methods of GivenWhenThen:

package org.scalatest.examples.propspec.info

import org.scalatest._
import prop._
import collection.mutable

class SetSuite extends PropSpec with TableDrivenPropertyChecks with GivenWhenThen {

  val examples =
    Table(
      "set",
      mutable.BitSet.empty,
      mutable.HashSet.empty[Int],
      mutable.LinkedHashSet.empty[Int]
    )

  property("an element can be added to an empty mutable Set") {

    forAll(examples) { set =>

      info("—————-")

      Given("an empty mutable " + set.getClass.getSimpleName)
      assert(set.isEmpty)

      When("an element is added")
      set += 99

      Then("the Set should have size 1")
      assert(set.size === 1)

      And("the Set should contain the added element")
      assert(set.contains(99))
    }
  }
}

If you run this PropSpec from the interpreter, you will see the following output:

scala> new SetSuite execute
SetSuite:
- an element can be added to an empty mutable Set
  + ----------------
  + Given an empty mutable BitSet
  + When an element is added
  + Then the Set should have size 1
  + And the Set should contain the added element
  + ----------------
  + Given an empty mutable HashSet
  + When an element is added
  + Then the Set should have size 1
  + And the Set should contain the added element
  + ----------------
  + Given an empty mutable LinkedHashSet
  + When an element is added
  + Then the Set should have size 1
  + And the Set should contain the added element

Pending tests

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, 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, has not yet been implemented.

You can mark tests pending in PropSpec like this:

import org.scalatest._
import prop._
import scala.collection.immutable._

class SetSpec extends PropSpec with TableDrivenPropertyChecks with ShouldMatchers {

  val examples =
    Table(
      "set",
      BitSet.empty,
      HashSet.empty[Int],
      TreeSet.empty[Int]
    )

  property("an empty Set should have size 0") (pending)

  property("invoking head on an empty set should produce NoSuchElementException") {
    forAll(examples) { set =>
      evaluating { set.head } should produce [NoSuchElementException]
    }
  }
}

(Note: "(pending)" is the body of the test. Thus the test contains just one statement, an invocation of the pending method, which throws TestPendingException.) If you run this version of SetSuite with:

scala> new SetSuite execute

It will run both tests, but report that first test is pending. You'll see:

SetSuite:
- An empty Set should have size 0 (pending)
- Invoking head on an empty Set should produce NoSuchElementException

One difference between an ignored test and a pending one is that an ignored test is intended to be used during a significant refactorings of the code under test, when tests break and you don't want to spend the time to fix all of them immediately. You can mark some of those broken tests as ignored temporarily, so that you can focus the red bar on just failing tests you actually want to fix immediately. Later you can go back and fix the ignored tests. In other words, by ignoring some failing tests temporarily, you can more easily notice failed tests that you actually want to fix. By contrast, a pending test is intended to be used before a test and/or the code under test is written. Pending indicates you've decided to write a test for a bit of behavior, but either you haven't written the test yet, or have only written part of it, or perhaps you've written the test but don't want to implement the behavior it tests until after you've implemented a different bit of behavior you realized you need first. Thus ignored tests are designed to facilitate refactoring of existing code whereas pending tests are designed to facilitate the creation of new code.

One other difference between ignored and pending tests is that ignored tests are implemented as a test tag that is excluded by default. Thus an ignored test is never executed. By contrast, a pending test is implemented as a test that throws TestPendingException (which is what calling the pending method does). Thus the body of pending tests are executed up until they throw TestPendingException. The reason for this difference is that it enables your unfinished test to send InfoProvided messages to the reporter before it completes abruptly with TestPendingException, as shown in the previous example on Informers that used the GivenWhenThen trait.

Tagging tests

A PropSpec's tests may be classified into groups by tagging them with string names. As with any suite, when executing a PropSpec, groups of tests can optionally be included and/or excluded. To tag a PropSpec's tests, you pass objects that extend class org.scalatest.Tag to methods that register tests. Class Tag takes one parameter, a string name. If you have created tag annotation interfaces as described in the Tag documentation, then you will probably want to use tag names on your test functions that match. To do so, simply pass the fully qualified names of the tag interfaces to the Tag constructor. For example, if you've defined tag annotation interfaces with fully qualified names, com.mycompany.tags.SlowTest and com.mycompany.tags.DbTest, then you could create matching tags for PropSpecs like this:

package org.scalatest.examples.propspec.tagging

import org.scalatest.Tag

object SlowTest extends Tag("com.mycompany.tags.SlowTest")
object DbTest extends Tag("com.mycompany.tags.DbTest")

Given these definitions, you could place PropSpec tests into groups like this:

import org.scalatest._
import prop._
import scala.collection.immutable._

class SetSpec extends PropSpec with TableDrivenPropertyChecks with ShouldMatchers {

  val examples =
    Table(
      "set",
      BitSet.empty,
      HashSet.empty[Int],
      TreeSet.empty[Int]
    )

  property("an empty Set should have size 0", SlowTest) {
    forAll(examples) { set =>
      set.size should be (0)
    }
  }

  property("invoking head on an empty set should produce NoSuchElementException",
      SlowTest, DbTest) {

    forAll(examples) { set =>
      evaluating { set.head } should produce [NoSuchElementException]
    }
  }
}

This code marks both tests with the com.mycompany.tags.SlowTest tag, and the second test with the com.mycompany.tags.DbTest tag.

The run method takes a Filter, whose constructor takes an optional Set[String] called tagsToInclude and a Set[String] called tagsToExclude. 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 tagsToExclude, will be run.

Shared fixtures

A test fixture is composed of the objects and other artifacts (files, sockets, database connections, etc.) tests use to do their work. When multiple tests need to work with the same fixtures, it is important to try and avoid duplicating the fixture code across those tests. The more code duplication you have in your tests, the greater drag the tests will have on refactoring the actual production code. ScalaTest recommends several techniques to eliminate such code duplication, and provides several traits to help. Each technique is geared towards helping you reduce code duplication without introducing instance vars, shared mutable objects, or other dependencies between tests. Eliminating shared mutable state across tests will make your test code easier to reason about and more amenable for parallel test execution.

The techniques in “PropSpec” are identical to those in FunSuite, but with test replaced by “property”. The following table summarizes the options with a link to the relevant documentation for trait FunSuite:

Technique	Recommended uses
get-fixture methods	Use when you need the same mutable fixture objects in multiple tests, and don't need to clean up after.
fixture-context objects	Use when you need different combinations of mutable fixture objects in different tests, and don't need to clean up after.
`OneInstancePerTest`	Use when porting JUnit tests to ScalaTest, or if you prefer JUnit's approach to test isolation: running each test in its own instance of the test class.
`withFixture(NoArgTest)`	Use when you need to perform side effects at the beginning and end of all or most tests, or want to stack traits that perform such side-effects.
loan-fixture methods	Use when different tests need different fixtures that must be cleaned up afterwords.
`withFixture(OneArgTest)`	Use when all or most tests need the same fixtures that must be cleaned up afterwords.
`BeforeAndAfter`	Use when you need to perform the same side-effects before and/or after tests, rather than at the beginning or end of tests.
`BeforeAndAfterEach`	Use when you want to stack traits that perform the same side-effects before and/or after tests, rather than at the beginning or end of tests.

Using `PropSpec` to implement a test matrix

Using fixture-context objects in a PropSpec is a good way to implement a test matrix. What is the matrix? A test matrix is a series of tests that you need to run on a series of subjects. For example, The Scala API contains many implementations of trait Set. Every implementation must obey the contract of Set. One property of any Set is that an empty Set should have size 0, another is that invoking head on an empty Set should give you a NoSuchElementException, and so on. Already you have a matrix, where rows are the properties and the columns are the set implementations:

	`BitSet`	`HashSet`	`TreeSet`
An empty Set should have size 0	pass	pass	pass
Invoking head on an empty set should produce NoSuchElementException	pass	pass	pass

One way to implement this test matrix is to define a trait to represent the columns (in this case, BitSet, HashSet, and TreeSet) as elements in a single-dimensional Table. Each element in the Table represents one Set implementation. Because different properties may require different fixture instances for those implementations, you can define a trait to hold the examples, like this:

trait SetExamples extends Tables {

  def examples = Table("set", bitSet, hashSet, treeSet)

  def bitSet: BitSet
  def hashSet: HashSet[Int]
  def treeSet: TreeSet[Int]
}

Given this trait, you could provide empty sets in one implementation of SetExamples, and non-empty sets in another. Here's how you might provide empty set examples:

class EmptySetExamples extends SetExamples {
  def bitSet = BitSet.empty
  def hashSet = HashSet.empty[Int]
  def treeSet = TreeSet.empty[Int]
}

And here's how you might provide set examples with one item each:

class SetWithOneItemExamples extends SetExamples {
  def bitSet = BitSet(1)
  def hashSet = HashSet(1)
  def treeSet = TreeSet(1)
}

Armed with these example classes, you can define checks of properties that require empty or non-empty set fixtures by using instances of these classes as fixture-context objects. In other words, the columns of the test matrix are implemented as elements of a one-dimensional table of fixtures, the rows are implemented as property clauses of a PropSpec.

Here's a complete example that checks the two properties mentioned previously:

package org.scalatest.examples.propspec.matrix

import org.scalatest._
import org.scalatest.prop._
import scala.collection.immutable._

trait SetExamples extends Tables {

  def examples = Table("set", bitSet, hashSet, treeSet)

  def bitSet: BitSet
  def hashSet: HashSet[Int]
  def treeSet: TreeSet[Int]
}

class EmptySetExamples extends SetExamples {
  def bitSet = BitSet.empty
  def hashSet = HashSet.empty[Int]
  def treeSet = TreeSet.empty[Int]
}

class SetSpec extends PropSpec with TableDrivenPropertyChecks with ShouldMatchers {

  property("an empty Set should have size 0") {
    new EmptySetExamples {
      forAll(examples) { set =>
        set.size should be (0)
      }
    }
  }

  property("invoking head on an empty set should produce NoSuchElementException") {
    new EmptySetExamples {
      forAll(examples) { set =>
        evaluating { set.head } should produce [NoSuchElementException]
      }
    }
  }
}

One benefit of this approach is that the compiler will help you when you need to add either a new row or column to the matrix. In either case, you'll need to ensure all cells are checked to get your code to compile.

Shared tests

Sometimes you may want to run the same test code on different fixture objects. In other words, you may want to write tests that are "shared" by different fixture objects. You accomplish this in a PropSpec in the same way you would do it in a FunSuite, exception instead of test you say property, and instead of testsFor you say propertiesFor. For more information, see the Shared tests section of FunSuite's documentation.

Self Type: PropSpec

Linear Supertypes

Suite, Serializable, AbstractSuite, Assertions, AnyRef, Any

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

PropSpec
Suite
Serializable
AbstractSuite
Assertions
AnyRef
Any

Visibility

Public
All

Type Members

class Equalizer extends AnyRef

Class used via an implicit conversion to enable any two objects to be compared with === in assertions in tests.
trait NoArgTest extends () ⇒ Unit with TestData

A test function taking no arguments, which also provides a test name and config map.

Value Members

def != (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def != (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
def ## (): Int

Attributes
final
Definition Classes
AnyRef → Any
def == (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def == (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
def assert (o: Option[String]): Unit

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.
o
the Option[String] to assert

Definition Classes
Assertions
def assert (o: Option[String], clue: Any): Unit

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 clue, 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.
o
the Option[String] to assert
clue
An objects whose toString method returns a message to include in a failure report.

Definition Classes
Assertions
def assert (condition: Boolean, clue: Any): Unit

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 clue as the exception's detail message.
condition
the boolean condition to assert
clue
An objects whose toString method returns a message to include in a failure report.

Definition Classes
Assertions
def assert (condition: Boolean): Unit

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.
condition
the boolean condition to assert

Definition Classes
Assertions
def assume (o: Option[String]): Unit

Assume that an Option[String] is None.
Assume that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestCanceledException with the String value of the Some included in the TestCanceledException's detail message.
This form of assume 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.
o
the Option[String] to assert

Definition Classes
Assertions
def assume (o: Option[String], clue: Any): Unit

Assume that an Option[String] is None.
Assume that an Option[String] is None. If the condition is None, this method returns normally. Else, it throws TestCanceledException with the String value of the Some, as well as the String obtained by invoking toString on the specified clue, included in the TestCanceledException's detail message.
This form of assume is usually called in conjunction with an implicit conversion to Equalizer, using a === comparison, as in:
```
assume(a === b, "extra info reported if assertion fails")
```
For more information on how this mechanism works, see the documentation for Equalizer.
o
the Option[String] to assert
clue
An objects whose toString method returns a message to include in a failure report.

Definition Classes
Assertions
def assume (condition: Boolean, clue: Any): Unit

Assume that a boolean condition, described in String message, is true.
Assume that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException with the String obtained by invoking toString on the specified clue as the exception's detail message.
condition
the boolean condition to assume
clue
An objects whose toString method returns a message to include in a failure report.

Definition Classes
Assertions
def assume (condition: Boolean): Unit

Assume that a boolean condition is true.
Assume that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException.
condition
the boolean condition to assert

Definition Classes
Assertions
def cancel (cause: Throwable): Nothing

Throws TestCanceledException, with the passed Throwable cause, to indicate a test failed.
Throws TestCanceledException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestCanceledException will return cause.toString.
cause
a Throwable that indicates the cause of the cancellation.

Definition Classes
Assertions
def cancel (message: String, cause: Throwable): Nothing

Throws TestCanceledException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.
Throws TestCanceledException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.
message
A message describing the failure.
cause
A Throwable that indicates the cause of the failure.

Definition Classes
Assertions
def cancel (message: String): Nothing

Throws TestCanceledException, with the passed String message as the exception's detail message, to indicate a test was canceled.
Throws TestCanceledException, with the passed String message as the exception's detail message, to indicate a test was canceled.
message
A message describing the cancellation.

Definition Classes
Assertions
def cancel (): Nothing

Throws TestCanceledException to indicate a test was canceled.
Throws TestCanceledException to indicate a test was canceled.

Definition Classes
Assertions
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
implicit def convertToEqualizer (left: Any): Equalizer

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)
```
left
the object whose type to convert to Equalizer.

Attributes
implicit
Definition Classes
Assertions
def createCatchReporter (reporter: Reporter): WrapperCatchReporter

Attributes
protected[scalatest]
Definition Classes
Suite
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
AnyRef → Any
def execute : Unit

Executes this Suite, printing results to the standard output.
Executes this Suite, printing results to the standard output.
This method, which simply invokes the other overloaded form of execute with default parameter values, is intended for use only as a mini-DSL for the Scala interpreter. It allows you to execute a Suite in the interpreter with a minimum of finger typing:
```
scala> new SetSpec execute
An empty Set
- should have size 0
- should produce NoSuchElementException when head is invoked !!! IGNORED !!!
```
If you do ever want to invoke execute outside the Scala interpreter, it is best style to invoke it with empty parens to indicate it has a side effect, like this:
```
// Use empty parens form in regular code (outside the Scala interpreter)
(new ExampleSuite).execute()
```
Attributes
final
Definition Classes
Suite
def execute (testName: String = null, configMap: Map[String, Any] = Map(), color: Boolean = true, durations: Boolean = false, shortstacks: Boolean = false, fullstacks: Boolean = false, stats: Boolean = false): Unit

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
```
(The above syntax actually invokes the overloaded parameterless form of execute, which calls this form with its default parameter values.) 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 output
- stopper - a Stopper whose apply method always returns false
- filter - a Filter constructed with None for tagsToInclude and Set() for tagsToExclude
- configMap - the configMap passed to this method
- distributor - None
- tracker - a new Tracker
Note: 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.
testName
the name of one test to run.
configMap
a Map of key-value pairs that can be used by the executing Suite of tests.
color
a boolean that configures whether output is printed in color
durations
a boolean that configures whether test and suite durations are printed to the standard output
shortstacks
a boolean that configures whether short stack traces should be printed for test failures
fullstacks
a boolean that configures whether full stack traces should be printed for test failures
stats
a boolean that configures whether test and suite statistics are printed to the standard output

Attributes
final
Definition Classes
Suite
def expectResult (expected: Any)(actual: Any): Unit

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 ==), expectResult returns normally. Else, expect throws a TestFailedException whose detail message includes the expected and actual values.
expected
the expected value
actual
the actual value, which should equal the passed expected value

Definition Classes
Assertions
def expectResult (expected: Any, clue: Any)(actual: Any): Unit

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 ==), expectResult returns normally. Else, if actual is not equal to expected, expectResult throws a TestFailedException whose detail message includes the expected and actual values, as well as the String obtained by invoking toString on the passed clue.
expected
the expected value
clue
An object whose toString method returns a message to include in a failure report.
actual
the actual value, which should equal the passed expected value

Definition Classes
Assertions
def expectedTestCount (filter: Filter): Int

The total number of tests that are expected to run when this Suite's run method is invoked.
The total number of tests that are expected to run when this Suite's run method is invoked.
This trait's implementation of this method returns the sum of:
- the size of the testNames List, minus the number of tests marked as ignored and any tests that are exluded by the passed Filter
- the sum of the values obtained by invoking expectedTestCount on every nested Suite contained in nestedSuites
filter
a Filter with which to filter tests to count based on their tags

Definition Classes
Suite → AbstractSuite
def fail (cause: Throwable): Nothing

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.
cause
a Throwable that indicates the cause of the failure.

Definition Classes
Assertions
def fail (message: String, cause: Throwable): Nothing

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.
message
A message describing the failure.
cause
A Throwable that indicates the cause of the failure.

Definition Classes
Assertions
def fail (message: String): Nothing

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.
message
A message describing the failure.

Definition Classes
Assertions
def fail (): Nothing

Throws TestFailedException to indicate a test failed.
Throws TestFailedException to indicate a test failed.

Definition Classes
Assertions
def finalize (): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef
def hashCode (): Int

Definition Classes
AnyRef → Any
def ignore (testName: String, testTags: Tag*)(testFun: ⇒ Unit): Unit

Register a property-based test to ignore, which has the specified name, optional tags, and function value that takes no arguments.
Register a property-based test to ignore, which has the specified name, optional tags, and function value that takes no arguments. This method will register the test for later ignoring via an invocation of one of the run methods. This method exists to make it easy to ignore an existing test by changing the call to test to ignore without deleting or commenting out the actual test code. The test will not be run, but a report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on this PropSpec instance.
testName
the name of the test
testTags
the optional list of tags for this test
testFun
the test function

Attributes
protected
implicit def info : Informer

Returns an Informer that during test execution will forward strings (and other objects) passed to its apply method to the current reporter.
Returns an Informer that during test execution will forward strings (and other objects) passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this PropSpec is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will throw an exception. This method can be called safely by any thread.

Attributes
protected implicit
def intercept [T <: AnyRef] (f: ⇒ Any)(implicit manifest: Manifest[T]): T

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.
f
the function value that should throw the expected exception
manifest
an implicit Manifest representing the type of the specified type parameter.
returns
the intercepted exception, if it is of the expected type

Definition Classes
Assertions
def isInstanceOf [T0] : Boolean

Attributes
final
Definition Classes
Any
implicit def markup : Documenter

Returns a Documenter that during test execution will forward strings passed to its apply method to the current reporter.
Returns a Documenter that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this PropSpec is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will throw an exception. This method can be called safely by any thread.

Attributes
protected implicit
def ne (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def nestedSuites : IndexedSeq[Suite]

An immutable IndexedSeq of this Suite object's nested Suites.
An immutable IndexedSeq of this Suite object's nested Suites. If this Suite contains no nested Suites, this method returns an empty IndexedSeq. This trait's implementation of this method returns an empty List.

Definition Classes
Suite → AbstractSuite
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
Definition Classes
AnyRef
def pending : PendingNothing

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.
Definition Classes
Suite
def pendingUntilFixed (f: ⇒ Unit): Unit

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.
f
a block of code, which if it completes abruptly, should trigger a TestPendingException

Definition Classes
Suite
def propertiesFor (unit: Unit): Unit

Registers shared tests.
Registers shared tests.
This method enables the following syntax for shared tests in a PropSpec:
```
propertiesFor(nonEmptyStack(lastValuePushed))
```
This method just provides syntax sugar intended to make the intent of the code clearer. Because the parameter passed to it is type Unit, the expression will be evaluated before being passed, which is sufficient to register the shared tests. For examples of shared tests, see the Shared tests section in the main documentation for this trait.
Attributes
protected
def property (testName: String, testTags: Tag*)(testFun: ⇒ Unit): Unit

Register a property-based test with the specified name, optional tags, and function value that takes no arguments.
Register a property-based test with the specified name, optional tags, and function value that takes no arguments. This method will register the test for later execution via an invocation of one of the run methods. The passed test name must not have been registered previously on this PropSpec instance.
testName
the name of the property
testTags
the optional list of tags for this property
testFun
the property function

Attributes
protected
def rerunner : Option[String]

The fully qualified class name of the rerunner to rerun this suite.
The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.

Definition Classes
Suite → AbstractSuite
def run (testName: Option[String], args: Args): Status

Runs this suite of tests.
Runs this suite of tests.
If testName is None, this trait's implementation of this method calls these two methods on this object in this order:
- runNestedSuites(report, stopper, tagsToInclude, tagsToExclude, configMap, distributor)
- runTests(testName, report, stopper, tagsToInclude, tagsToExclude, configMap)
If testName is defined, then this trait's implementation of this method calls runTests, but does not call runNestedSuites. This behavior is part of the contract of this method. Subclasses that override run must take care not to call runNestedSuites if testName is defined. (The OneInstancePerTest trait depends on this behavior, for example.)
Subclasses and subtraits that override this run method can implement them without invoking either the runTests or runNestedSuites methods, which are invoked by this trait's implementation of this method. It is recommended, but not required, that subclasses and subtraits that override run in a way that does not invoke runNestedSuites also override runNestedSuites and make it final. Similarly it is recommended, but not required, that subclasses and subtraits that override run in a way that does not invoke runTests also override runTests (and runTest, which this trait's implementation of runTests calls) and make it final. The implementation of these final methods can either invoke the superclass implementation of the method, or throw an UnsupportedOperationException if appropriate. The reason for this recommendation is that ScalaTest includes several traits that override these methods to allow behavior to be mixed into a Suite. For example, trait BeforeAndAfterEach overrides runTestss. In a Suite subclass that no longer invokes runTests from run, the BeforeAndAfterEach trait is not applicable. Mixing it in would have no effect. By making runTests final in such a Suite subtrait, you make the attempt to mix BeforeAndAfterEach into a subclass of your subtrait a compiler error. (It would fail to compile with a complaint that BeforeAndAfterEach is trying to override runTests, which is a final method in your trait.)
testName
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.
args
the Args for this run
returns
a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.

Definition Classes
PropSpec → Suite → AbstractSuite
def run (testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Status

This overloaded form of run has been deprecated and will be removed in a future version of ScalaTest. Please use the run method that takes two parameters instead.
This overloaded form of run has been deprecated and will be removed in a future version of ScalaTest. Please use the run method that takes two parameters instead.
This final implementation of this method constructs a Args instance from the passed reporter, stopper, filter, configMap, distributor, and tracker, and invokes the overloaded run method that takes two parameters, passing in the specified testName and the newly constructed Args. This method implementation enables existing code that called into the old run method to continue to work during the deprecation cycle. Subclasses and subtraits that overrode this method, however, will need to be changed to use the new two-parameter form instead.
testName
an optional name of one test to execute. If None, all relevant tests should be executed. I.e., None acts like a wildcard that means execute all relevant tests in this Suite.
reporter
the Reporter to which results will be reported
stopper
the Stopper that will be consulted to determine whether to stop execution early.
filter
a Filter with which to filter tests based on their tags
configMap
a Map of key-value pairs that can be used by the executing Suite of tests.
distributor
an optional Distributor, into which to put nested Suites to be executed by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.
tracker
a Tracker tracking Ordinals being fired by the current thread.

Attributes
final
Definition Classes
AbstractSuite
def runNestedSuites (args: Args): Status

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.
args
the Args for this run
returns
a Status object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.

Attributes
protected
Definition Classes
Suite → AbstractSuite
def runTest (testName: String, args: Args): Status

Run a test.
Run a test. This trait's implementation runs the test registered with the name specified by testName.
testName
the name of one test to run.
args
the Args for this run
returns
a Status object that indicates when the test started by this method has completed, and whether or not it failed .

Attributes
protected
Definition Classes
PropSpec → Suite → AbstractSuite
def runTests (testName: Option[String], args: Args): Status

Run zero to many of this PropSpec's tests.
Run zero to many of this PropSpec's tests.
testName
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.
args
the Args for this run
returns
a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.

Attributes
protected
Definition Classes
PropSpec → Suite → AbstractSuite
val styleName : String

Suite style name.
Suite style name.

Attributes
final
Definition Classes
PropSpec → Suite → AbstractSuite
def suiteId : String

A string ID for this Suite that is intended to be unique among all suites reported during a run.
A string ID for this Suite that is intended to be unique among all suites reported during a run.
This trait's implementation of this method returns the fully qualified name of this object's class. Each suite reported during a run will commonly be an instance of a different Suite class, and in such cases, this default implementation of this method will suffice. However, in special cases you may need to override this method to ensure it is unique for each reported suite. For example, if you write a Suite subclass that reads in a file whose name is passed to its constructor and dynamically creates a suite of tests based on the information in that file, you will likely need to override this method in your Suite subclass, perhaps by appending the pathname of the file to the fully qualified class name. That way if you run a suite of tests based on a directory full of these files, you'll have unique suite IDs for each reported suite.
The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
returns
this Suite object's ID.

Definition Classes
Suite
def suiteName : String

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.
returns
this Suite object's suite name.

Definition Classes
Suite
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
def tags : Map[String, Set[String]]

A Map whose keys are String tag names to which tests in this PropSpec belong, and values the Set of test names that belong to each tag.
A Map whose keys are String tag names to which tests in this PropSpec belong, and values the Set of test names that belong to each tag. If this PropSpec contains no tags, this method returns an empty Map.
This trait's implementation returns tags that were passed as strings contained in Tag objects passed to methods test and ignore.
In addition, this trait's implementation will also auto-tag tests with class level annotations. For example, if you annotate @Ignore at the class level, all test methods in the class will be auto-annotated with @Ignore.

Definition Classes
PropSpec → Suite → AbstractSuite
def testDataFor (testName: String, theConfigMap: Map[String, Any] = Map.empty): TestData

Provides a TestData instance for the passed test name, given the passed config map.
Provides a TestData instance for the passed test name, given the passed config map.
This method is used to obtain a TestData instance to pass to withFixture(NoArgTest) and withFixture(OneArgTest) and the beforeEach and afterEach methods of trait BeforeAndAfterEach.
testName
the name of the test for which to return a TestData instance
theConfigMap
the config map to include in the returned TestData
returns
a TestData instance for the specified test, which includes the specified config map

Definition Classes
PropSpec → Suite
def testNames : Set[String]

An immutable Set of test names.
An immutable Set of test names. If this PropSpec contains no tests, this method returns an empty Set.
This trait's implementation of this method will return a set that contains the names of all registered tests. The set's iterator will return those names in the order in which the tests were registered.

Definition Classes
PropSpec → Suite → AbstractSuite
def toString (): String

Definition Classes
AnyRef → Any
def wait (): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long, arg1: Int): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def withClue [T] (clue: Any)(fun: ⇒ T): T

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
```
Definition Classes
Assertions
def withFixture (test: NoArgTest): Unit

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.
test
the no-arg test function to run with a fixture

Attributes
protected
Definition Classes
Suite → AbstractSuite
def expect (expected: Any)(actual: Any): Unit

This expect method has been deprecated; Please use expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
To get rid of the deprecation warning, simply replace expect with expectResult. The name expect will be used for a different purposes in a future version of ScalaTest.

Definition Classes
Assertions
Annotations
@deprecated
Deprecated
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of expectResult instead.
def expect (expected: Any, clue: Any)(actual: Any): Unit

This expect method has been deprecated; Please use expectResult instead.
This expect method has been deprecated; Please use expectResult instead.
To get rid of the deprecation warning, simply replace expect with expectResult. The name expect will be used for a different purposes in a future version of ScalaTest.

Definition Classes
Assertions
Annotations
@deprecated
Deprecated
This expect method has been deprecated. Please replace all invocations of expect with an identical invocation of expectResult instead.

PropSpec

trait PropSpec extends Suite

Ignored tests

Informers

Pending tests

Tagging tests

Shared fixtures

Using PropSpec to implement a test matrix

Shared tests

Type Members

class Equalizer extends AnyRef

trait NoArgTest extends () ⇒ Unit with TestData

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

def asInstanceOf [T0] : T0

def assert (o: Option[String]): Unit

def assert (o: Option[String], clue: Any): Unit

def assert (condition: Boolean, clue: Any): Unit

def assert (condition: Boolean): Unit

def assume (o: Option[String]): Unit

def assume (o: Option[String], clue: Any): Unit

def assume (condition: Boolean, clue: Any): Unit

def assume (condition: Boolean): Unit

def cancel (cause: Throwable): Nothing

def cancel (message: String, cause: Throwable): Nothing

def cancel (message: String): Nothing

def cancel (): Nothing

def clone (): AnyRef

implicit def convertToEqualizer (left: Any): Equalizer

def createCatchReporter (reporter: Reporter): WrapperCatchReporter

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def execute : Unit

def execute (testName: String = null, configMap: Map[String, Any] = Map(), color: Boolean = true, durations: Boolean = false, shortstacks: Boolean = false, fullstacks: Boolean = false, stats: Boolean = false): Unit

def expectResult (expected: Any)(actual: Any): Unit

def expectResult (expected: Any, clue: Any)(actual: Any): Unit

def expectedTestCount (filter: Filter): Int

def fail (cause: Throwable): Nothing

def fail (message: String, cause: Throwable): Nothing

def fail (message: String): Nothing

def fail (): Nothing

def finalize (): Unit

def getClass (): java.lang.Class[_]

def hashCode (): Int

def ignore (testName: String, testTags: Tag*)(testFun: ⇒ Unit): Unit

implicit def info : Informer

def intercept [T <: AnyRef] (f: ⇒ Any)(implicit manifest: Manifest[T]): T

def isInstanceOf [T0] : Boolean

implicit def markup : Documenter

def ne (arg0: AnyRef): Boolean

def nestedSuites : IndexedSeq[Suite]

def notify (): Unit

def notifyAll (): Unit

def pending : PendingNothing

def pendingUntilFixed (f: ⇒ Unit): Unit

def propertiesFor (unit: Unit): Unit

def property (testName: String, testTags: Tag*)(testFun: ⇒ Unit): Unit

def rerunner : Option[String]

def run (testName: Option[String], args: Args): Status

def run (testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Status

def runNestedSuites (args: Args): Status

def runTest (testName: String, args: Args): Status

def runTests (testName: Option[String], args: Args): Status

val styleName : String

def suiteId : String

def suiteName : String

def synchronized [T0] (arg0: ⇒ T0): T0

def tags : Map[String, Set[String]]

def testDataFor (testName: String, theConfigMap: Map[String, Any] = Map.empty): TestData

def testNames : Set[String]

def toString (): String

def wait (): Unit

def wait (arg0: Long, arg1: Int): Unit

def wait (arg0: Long): Unit

def withClue [T] (clue: Any)(fun: ⇒ T): T

def withFixture (test: NoArgTest): Unit

Using `PropSpec` to implement a test matrix