org.scalatest.fixture

FixtureSuite

trait FixtureSuite extends Suite

Suite that can pass a fixture object into its tests.

This trait behaves similarly to trait org.scalatest.Suite, except that tests may have a fixture parameter. The type of the fixture parameter is defined by the abstract FixtureParam type, which is declared as a member of this trait. This trait also declares an abstract withFixture method. This withFixture method takes a OneArgTest, which is a nested trait defined as a member of this trait.OneArgTest has an apply method that takes a FixtureParam. This apply method is responsible for running a test. This trait's runTest method delegates the actual running of each test to withFixture, passing in the test code to run via the OneArgTest argument. The withFixture method (abstract in this trait) is responsible for creating the fixture argument and passing it to the test function.

Subclasses of this trait must, therefore, do three things differently from a plain old org.scalatest.Suite:

Here's an example:

import org.scalatest.fixture.FixtureSuite
import java.io.FileReader
import java.io.FileWriter
import java.io.File

class MySuite extends FixtureSuite {

// 1. define type FixtureParam type FixtureParam = FileReader

// 2. define the withFixture method def withFixture(test: OneArgTest) {

val FileName = "TempFile.txt"

// Set up the temp file needed by the test val writer = new FileWriter(FileName) try { writer.write("Hello, test!") } finally { writer.close() }

// Create the reader needed by the test val reader = new FileReader(FileName)

try { // Run the test using the temp file test(reader) } finally { // Close and delete the temp file reader.close() val file = new File(FileName) file.delete() } }

// 3. write test methods that take a fixture parameter def testReadingFromTheTempFile(reader: FileReader) { var builder = new StringBuilder var c = reader.read() while (c != -1) { builder.append(c.toChar) c = reader.read() } assert(builder.toString === "Hello, test!") }

def testFirstCharOfTheTempFile(reader: FileReader) { assert(reader.read() === 'H') }

// (You can also write tests methods that don't take a fixture parameter.) def testWithoutAFixture() { without fixture { assert(1 + 1 === 2) } } }

If the fixture you want to pass into your tests consists of multiple objects, you will need to combine them into one object to use this trait. One good approach to passing multiple fixture objects is to encapsulate them in a tuple. Here's an example that takes the tuple approach:

import org.scalatest.fixture.FixtureSuite
import scala.collection.mutable.ListBuffer

class MySuite extends FixtureSuite {

type FixtureParam = (StringBuilder, ListBuffer[String])

def withFixture(test: OneArgTest) {

// Create needed mutable objects val stringBuilder = new StringBuilder("ScalaTest is ") val listBuffer = new ListBuffer[String]

// Invoke the test function, passing in the mutable objects test(stringBuilder, listBuffer) }

def testEasy(fixture: Fixture) { val (builder, buffer) = fixture builder.append("easy!") assert(builder.toString === "ScalaTest is easy!") assert(buffer.isEmpty) buffer += "sweet" }

def testFun(fixture: Fixture) { val (builder, buffer) = fixture builder.append("fun!") assert(builder.toString === "ScalaTest is fun!") assert(buffer.isEmpty) } }

When using a tuple to pass multiple fixture objects, it is usually helpful to give names to each individual object in the tuple with a pattern-match assignment, as is done at the beginning of each test method here with:

val (builder, buffer) = fixture

Another good approach to passing multiple fixture objects is to encapsulate them in a case class. Here's an example that takes the case class approach:

import org.scalatest.fixture.FixtureSuite
import scala.collection.mutable.ListBuffer

class MySuite extends FixtureSuite {

case class FixtureHolder(builder: StringBuilder, buffer: ListBuffer[String])

type FixtureParam = FixtureHolder

def withFixture(test: OneArgTest) {

// Create needed mutable objects val stringBuilder = new StringBuilder("ScalaTest is ") val listBuffer = new ListBuffer[String]

// Invoke the test function, passing in the mutable objects test(FixtureHolder(stringBuilder, listBuffer)) }

def testEasy(fixture: Fixture) { import fixture._ builder.append("easy!") assert(builder.toString === "ScalaTest is easy!") assert(buffer.isEmpty) buffer += "sweet" }

def testFun(fixture: Fixture) { fixture.builder.append("fun!") assert(fixture.builder.toString === "ScalaTest is fun!") assert(fixture.buffer.isEmpty) } }

When using a case class to pass multiple fixture objects, it can be helpful to make the names of each individual object available as a single identifier with an import statement. This is the approach taken by the testEasy method in the previous example. Because it imports the members of the fixture object, the test method code can just use them as unqualified identifiers:

def testEasy(fixture: Fixture) {
  import fixture._
  builder.append("easy!")
  assert(builder.toString === "ScalaTest is easy!")
  assert(buffer.isEmpty)
  buffer += "sweet"
}

Alternatively, you may sometimes prefer to qualify each use of a fixture object with the name of the fixture parameter. This approach, taken by the testFun method in the previous example, makes it more obvious which variables in your test method are part of the passed-in fixture:

def testFun(fixture: Fixture) {
  fixture.builder.append("fun!")
  assert(fixture.builder.toString === "ScalaTest is fun!")
  assert(fixture.buffer.isEmpty)
}

Configuring fixtures and tests

Sometimes you may want to write tests that are configurable. For example, you may want to write a suite of tests that each take an open temp file as a fixture, but whose file name is specified externally so that the file name can be can be changed from run to run. To accomplish this the OneArgTest trait has a configMapmethod, which will return a Map[String, Any] from which configuration information may be obtained. The runTest method of this trait will pass a OneArgTest to withFixturewhose configMap method returns the configMap passed to runTest. Here's an example in which the name of a temp file is taken from the passed configMap:

import org.scalatest.fixture.FixtureSuite
import java.io.FileReader
import java.io.FileWriter
import java.io.File

class MySuite extends FixtureSuite {

type FixtureParam = FileReader

def withFixture(test: OneArgTest) {

require( test.configMap.contains("TempFileName"), "This suite requires a TempFileName to be passed in the configMap" )

// Grab the file name from the configMap val FileName = test.configMap("TempFileName")

// Set up the temp file needed by the test val writer = new FileWriter(FileName) try { writer.write("Hello, test!") } finally { writer.close() }

// Create the reader needed by the test val reader = new FileReader(FileName)

try { // Run the test using the temp file test(reader) } finally { // Close and delete the temp file reader.close() val file = new File(FileName) file.delete() } }

def testReadingFromTheTempFile(reader: FileReader) { var builder = new StringBuilder var c = reader.read() while (c != -1) { builder.append(c.toChar) c = reader.read() } assert(builder.toString === "Hello, test!") }

def testFirstCharOfTheTempFile(reader: FileReader) { assert(reader.read() === 'H') } }

If you want to pass into each test the entire configMap that was passed to runTest, you can mix in trait ConfigMapFixture. See the documentation for ConfigMapFixture for the details, but here's a quick example of how it looks:

 import org.scalatest.fixture.FixtureSuite
 import org.scalatest.fixture.ConfigMapFixture

class MySuite extends FixtureSuite with ConfigMapFixture {

def testHello(configMap: Map[String, Any]) { // Use the configMap passed to runTest in the test assert(configMap.contains("hello") }

def testWorld(configMap: Map[String, Any]) { assert(configMap.contains("world") } }

Note: because a FixtureSuite's test methods are invoked with reflection at runtime, there is no good way to create a FixtureSuite containing test methods that take different fixtures. If you find you need to do this, you may want to split your class into multiple FixtureSuites, each of which contains test methods that take the common Fixture type defined in that class, or use a MultipleFixtureFunSuite.

go to: companion
known subclasses: FixtureWordSpec, FixtureSpec, FixtureFunSuite, FixtureFlatSpec, FixtureFeatureSpec
    authors:
  1. Bill Venners

Inherited
  1. Hide All
  2. Show all
  1. Suite
  2. AbstractSuite
  3. Assertions
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Type Members

  1. class Equalizer extends AnyRef

    Class used via an implicit conversion to enable any two objects to be compared with=== in assertions in tests.

  2. type FixtureParam

    The type of the fixture parameter that can be passed into tests in this suite.

    The type of the fixture parameter that can be passed into tests in this suite.

    attributes: protected abstract
  3. trait NoArgTest extends () ⇒ Unit

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

  4. trait OneArgTest extends (FixtureParam) ⇒ Unit

    Trait whose instances encapsulate a test function that takes a fixture and config map.

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  9. 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 Stringvalue 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 forEqualizer.

    o

    the Option[String] to assert

    definition classes: Assertions
  10. 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 Stringvalue of the Some, as well as theString obtained by invoking toString on the specified message, 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 forEqualizer.

    o

    the Option[String] to assert

    clue

    An objects whose toString method returns a message to include in a failure report.

    definition classes: Assertions
  11. def assert(condition: Boolean, clue: Any): Unit

    Assert that a boolean condition, described in Stringmessage, is true.

    Assert that a boolean condition, described in Stringmessage, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with theString obtained by invoking toString on the specified message 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
  12. 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
  13. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  14. 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 yourSuite 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
  15. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  16. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  17. def execute(testName: String, configMap: Map[String, Any]): Unit

    Executes the test specified as testName in this Suite with the specified configMap, printing results to the standard output.

    Executes the test specified as testName in this Suite with the specified configMap, printing results to the standard output.

    This method implementation calls run on this Suite, passing in:

    • testName - 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 specified configMap Map[String, Any]
    • distributor - None
    • tracker - a new Tracker

    This method serves as a convenient way to execute a single test, passing in some objects via the configMap, especially from within the Scala interpreter.

    Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and can be used interchangably. The reason this convenience method and its three overloaded forms aren't named run is described the documentation of the overloaded form that takes no parameters: execute().

    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.

    attributes: final
    definition classes: Suite
  18. def execute(testName: String): Unit

    Executes the test specified as testName in this Suite, printing results to the standard output.

    Executes the test specified as testName in this Suite, printing results to the standard output.

    This method implementation calls run on this Suite, passing in:

    • testName - 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 - an empty Map[String, Any]
    • distributor - None
    • tracker - a new Tracker

    This method serves as a convenient way to run a single test, especially from within the Scala interpreter.

    Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and can be used interchangably. The reason this convenience method and its three overloaded forms aren't named run is described the documentation of the overloaded form that takes no parameters: execute().

    testName

    the name of one test to run.

    attributes: final
    definition classes: Suite
  19. def execute(configMap: Map[String, Any]): Unit

    Executes this Suite with the specified configMap, printing results to the standard output.

    Executes this Suite with the specified configMap, printing results to the standard output.

    This method implementation calls run on this Suite, passing in:

    • testName - None
    • 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 specified configMap Map[String, Any]
    • distributor - None
    • tracker - a new Tracker

    This method serves as a convenient way to execute a Suite, passing in some objects via the configMap, especially from within the Scala interpreter.

    Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and can be used interchangably. The reason this convenience method and its three overloaded forms aren't named run is described the documentation of the overloaded form that takes no parameters: execute().

    configMap

    a Map of key-value pairs that can be used by the executing Suite of tests.

    attributes: final
    definition classes: Suite
  20. def execute(): Unit

    Executes this Suite, printing results to the standard output.

    Executes this Suite, printing results to the standard output.

    This method implementation calls run on this Suite, passing in:

    • testName - None
    • 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 - an empty Map[String, Any]
    • distributor - None
    • tracker - a new Tracker

    This method serves as a convenient way to execute a Suite, especially from within the Scala interpreter.

    Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and can be used interchangably. The reason this convenience method and its three overloaded forms aren't named runis because junit.framework.TestCase declares a run method that takes no arguments but returns a junit.framework.TestResult. Thatrun method would not overload with this method if it were named run, because it would have the same parameters but a different return type than the one defined in TestCase. To facilitate integration with JUnit 3, therefore, these convenience "run" methods are named execute. In particular, this allows traitorg.scalatest.junit.JUnit3Suite to extend both org.scalatest.Suite andjunit.framework.TestCase, which enables the creating of classes that can be run with either ScalaTest or JUnit 3.

    attributes: final
    definition classes: Suite
  21. def expect(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 ==), expect returns normally. Else, expect throws anTestFailedException 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
  22. def expect(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 ==), expect returns normally. Else, if actual is not equal to expected, expect throws anTestFailedException whose detail message includes the expected and actual values, as well as the Stringobtained by invoking toString on the passed message.

    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
  23. 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
    • 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: SuiteAbstractSuite
  24. def fail(cause: Throwable): Nothing

    Throws TestFailedException, with the passedThrowable cause, to indicate a test failed.

    Throws TestFailedException, with the passedThrowable cause, to indicate a test failed. The getMessage method of the thrown TestFailedExceptionwill return cause.toString().

    cause

    a Throwable that indicates the cause of the failure.

    definition classes: Assertions
  25. def fail(message: String, cause: Throwable): Nothing

    Throws TestFailedException, with the passedString message as the exception's detail message and Throwable cause, to indicate a test failed.

    Throws TestFailedException, with the passedString 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
  26. def fail(message: String): Nothing

    Throws TestFailedException, with the passedString message as the exception's detail message, to indicate a test failed.

    Throws TestFailedException, with the passedString message as the exception's detail message, to indicate a test failed.

    message

    A message describing the failure.

    definition classes: Assertions
  27. def fail(): Nothing

    Throws TestFailedException to indicate a test failed.

    Throws TestFailedException to indicate a test failed.

    definition classes: Assertions
  28. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  29. def getClass(): java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  30. def groups: Map[String, Set[String]]

    The groups methods has been deprecated and will be removed in a future version of ScalaTest.

    The groups methods has been deprecated and will be removed in a future version of ScalaTest. Please call (and override) tags instead.

    attributes: final
    definition classes: Suite
      deprecated:
  31. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  32. 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 ofAnyRef, 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
  33. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  34. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  35. def nestedSuites: List[Suite]

    A List of this Suite object's nested Suites.

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

    definition classes: SuiteAbstractSuite
  36. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  37. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  38. 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 Specto 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
  39. 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, apendingUntilFixed 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 TestFailedExceptionwith 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
  40. def run(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

    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. (TheOneInstancePerTest 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, traitBeforeAndAfterEach overrides runTestss. In a Suitesubclass that no longer invokes runTests from run, theBeforeAndAfterEach 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 BeforeAndAfterEachis 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.

    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 run by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.

    tracker

    a Tracker tracking Ordinals being fired by the current thread.

    definition classes: SuiteAbstractSuite
  41. def runNestedSuites(reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

    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 runmethod 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 Suiteinto the Distributor contained in the Some, in the order in which theSuites appear in the List returned by nestedSuites, passing in a new Tracker obtained by invoking nextTracker on the Trackerpassed 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 SuiteCompletedor SuiteAborted after executing any nested 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 run by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.

    tracker

    a Tracker tracking Ordinals being fired by the current thread.

    attributes: protected
    definition classes: SuiteAbstractSuite
  42. def runTest(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], tracker: Tracker): Unit

    Run a test.

    Run a test.

    This trait's implementation uses Java reflection to invoke on this object the test method identified by the passed testName.

    Implementations of this method are responsible for ensuring a TestStarting event is fired to the Reporter before executing any test, and either TestSucceeded,TestFailed, or TestPending after executing any nestedSuite. (If a test is marked with the org.scalatest.Ignore tag, therunTests method is responsible for ensuring a TestIgnored event is fired and that this runTest method is not invoked for that ignored test.)

    testName

    the name of one test to run.

    reporter

    the Reporter to which results will be reported

    stopper

    the Stopper that will be consulted to determine whether to stop execution early.

    configMap

    a Map of key-value pairs that can be used by the executing Suite of tests.

    tracker

    a Tracker tracking Ordinals being fired by the current thread.

    attributes: protected
    definition classes: FixtureSuiteSuiteAbstractSuite
  43. def runTests(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

    Run zero to many of this Suite's tests.

    Run zero to many of this Suite's tests.

    This method takes a testName parameter that optionally specifies a test to invoke. If testName is defined, this trait's implementation of this method invokes runTest on this object, passing in:

    • testName - the String value of the testName Option passed to this method
    • reporter - the Reporter passed to this method, or one that wraps and delegates to it
    • stopper - the Stopper passed to this method, or one that wraps and delegates to it
    • configMap - the configMap Map passed to this method, or one that wraps and delegates to it

    This method takes a Filter, which encapsulates an optional Set of tag names that should be included (tagsToInclude) and a Set that should be excluded (tagsToExclude), when deciding which of this Suite's tests to run. 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 the tagsToExcludeSetwill be run. However, if testName is defined, tagsToInclude and tagsToExclude are essentially ignored. Only if testName is None will tagsToInclude and tagsToExclude be consulted to determine which of the tests named in the testNames Set should be run. This trait's implementation behaves this way, and it is part of the general contract of this method, so all overridden forms of this method should behave this way as well. For more information on test tags, see the main documentation for this trait and for class Filter. Note that this means that even if a test is marked as ignored, for example a test method in a Suite annotated withorg.scalatest.Ignore, if that test name is passed as testName to runTest, it will be invoked despite the Ignore annotation.

    If testName is None, this trait's implementation of this method invokes testNames on this Suite to get a Set of names of tests to potentially run. (A testNames value of None essentially acts as a wildcard that means all tests in this Suite that are selected by tagsToInclude and tagsToExclude should be run.) For each test in the testName Set, in the order they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation of this method checks whether the test should be run based on the Filter. If so, this implementation invokes runTest, passing in:

    • testName - the String name of the test to run (which will be one of the names in the testNames Set)
    • reporter - the Reporter passed to this method, or one that wraps and delegates to it
    • stopper - the Stopper passed to this method, or one that wraps and delegates to it
    • configMap - the configMap passed to this method, or one that wraps and delegates to it

    If a test is marked with the org.scalatest.Ignore tag, implementations of this method are responsible for ensuring a TestIgnored event is fired for that test and that runTest is not called for that test.

    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.

    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 run by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.

    tracker

    a Tracker tracking Ordinals being fired by the current thread.

    attributes: protected
    definition classes: SuiteAbstractSuite
  44. 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
  45. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  46. def tags: Map[String, Set[String]]

    A Map whose keys are String tag names with which tests in this Suite are marked, and whose values are the Set of test names marked with each tag.

    A Map whose keys are String tag names with which tests in this Suite are marked, and whose values are the Set of test names marked with each tag. If this Suite contains no tags, this method returns an empty Map.

    This trait's implementation of this method uses Java reflection to discover any Java annotations attached to its test methods. The fully qualified name of each unique annotation that extends TagAnnotation is considered a tag. This trait's implementation of this method, therefore, places one key/value pair into to theMap for each unique tag annotation name discovered through reflection. The mapped value for each tag name key will contain the test method name, as provided via the testNames method.

    Subclasses may override this method to define and/or discover tags in a custom manner, but overriding method implementations should never return an empty Set as a value. If a tag has no tests, its name should not appear as a key in the returned Map.

    Note, the TagAnnotation annotation was introduced in ScalaTest 1.0, when "groups" were renamed to "tags." In 1.0 and 1.1, the TagAnnotation will continue to not be required by an annotation on a Suitemethod. Any annotation on a Suite method will be considered a tag until 1.2, to give users time to addTagAnnotations on any tag annotations they made prior to the 1.0 release. From 1.2 onward, only annotations themselves annotated by TagAnnotation will be considered tag annotations.

    definition classes: FixtureSuiteSuiteAbstractSuite
  47. def testNames: Set[String]

    An Set of test names.

    An Set of test names. If this Suite contains no tests, this method returns an empty Set.

    This trait's implementation of this method uses Java reflection to discover all public methods whose name starts with "test", which take either nothing or a single Informer as parameters. For each discovered test method, it assigns a test name comprised of just the method name if the method takes no parameters, or the method name plus (Informer) if the method takes a Informer. Here are a few method signatures and the names that this trait's implementation assigns them:

    def testCat() {}         // test name: "testCat"
    def testCat(Informer) {} // test name: "testCat(Informer)"
    def testDog() {}         // test name: "testDog"
    def testDog(Informer) {} // test name: "testDog(Informer)"
    def test() {}            // test name: "test"
    def test(Informer) {}    // test name: "test(Informer)"

    This trait's implementation of this method returns an immutable Set of all such names, excluding the nametestNames. The iterator obtained by invoking elements on this returned Set will produce the test names in their natural order, as determined by String'scompareTo method.

    This trait's implementation of runTests invokes this method and calls runTest for each test name in the order they appear in the returned Set's iterator. Although this trait's implementation of this method returns a Set whose iterator produces Stringtest names in a well-defined order, the contract of this method does not required a defined order. Subclasses are free to override this method and return test names in an undefined order, or in a defined order that's different from String's natural order.

    Subclasses may override this method to produce test names in a custom manner. One potential reason to override testNames is to run tests in a different order, for example, to ensure that tests that depend on other tests are run after those other tests. Another potential reason to override is allow tests to be defined in a different manner, such as methods annotated @Test annotations (as is done in JUnitSuite and TestNGSuite) or test functions registered during construction (as is done in FunSuite and Spec).

    definition classes: FixtureSuiteSuiteAbstractSuite
  48. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  49. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  50. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  51. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  52. 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 FixtureSuite.

    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: SuiteAbstractSuite
  53. def withFixture(test: OneArgTest): Unit

    Run the passed test function with a fixture created by this method.

    Run the passed test function with a fixture created by this method.

    This method should create the fixture object needed by the tests of the current suite, invoke the test function (passing in the fixture object), and if needed, perform any clean up needed after the test completes. For more detail and examples, see the main documentation for this trait.

    attributes: protected abstract