ScalaTest 1.0

This document is the API specification for ScalaTest 1.0

Class Summary
sealed abstract class Event extends scala.Ordered[Event]
A base class for the events that can be passed to the report function passed to the execute method of a Suite. Will have a sealed abstract InfoProvided message with three final concrete subclasses, RunInfoProvided, SuiteInfoProvided, TestInfoProvided. Anything that starts with Run just has runStamp and ordinal; Suite has those plus suiteStamp; Test has those plus testStamp.
sealed abstract class Formatter extends AnyRef
Abstract class for the optional formatter objects that must be passed to the Events reported during a ScalaTest run.
case final class IndentedText (val formattedText : java.lang.String, val rawText : java.lang.String, val indentationLevel : Int) extends Formatter with scala.Product
A Formatter providing information that enables reporters to create more stylized output.
case final class InfoProvided (val ordinal : Ordinal, val message : java.lang.String, val nameInfo : scala.Option[NameInfo], val aboutAPendingTest : scala.Option[Boolean], val throwable : scala.Option[java.lang.Throwable], val formatter : scala.Option[Formatter], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event used to provide information that is not appropriate to report via any other Event.
case final class NameInfo (val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val testName : scala.Option[java.lang.String]) extends scala.Product
Class that holds information about names for an InfoProvided event.
final class Ordinal (val runStamp : Int, private stamps : scala.Array[Int]) extends scala.Ordered[Ordinal]
Class used to specify a sequential order for events reported during a test run, so they can be arranged in that order in a report even if the events were fired in some other order during concurrent or distributed execution.
case final class RunAborted (val ordinal : Ordinal, val message : java.lang.String, val throwable : scala.Option[java.lang.Throwable], val duration : scala.Option[Long], val summary : scala.Option[Summary], val formatter : scala.Option[Formatter], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a runner encountered an error while attempting to run a suite of tests.
case final class RunCompleted (val ordinal : Ordinal, val duration : scala.Option[Long], val summary : scala.Option[Summary], val formatter : scala.Option[Formatter], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a runner has completed running a suite of tests.
case final class RunStarting (val ordinal : Ordinal, val testCount : Int, val configMap : scala.collection.immutable.Map[java.lang.String, Any], val formatter : scala.Option[Formatter], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a runner is about run a suite of tests.
case final class RunStopped (val ordinal : Ordinal, val duration : scala.Option[Long], val summary : scala.Option[Summary], val formatter : scala.Option[Formatter], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a runner has stopped running a suite of tests prior to completion, likely because of a stop request.
case final class SuiteAborted (val ordinal : Ordinal, val message : java.lang.String, val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val throwable : scala.Option[java.lang.Throwable], val duration : scala.Option[Long], val formatter : scala.Option[Formatter], val rerunner : scala.Option[Rerunner], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates the execution of a suite of tests has aborted, likely because of an error, prior to completion.
case final class SuiteCompleted (val ordinal : Ordinal, val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val duration : scala.Option[Long], val formatter : scala.Option[Formatter], val rerunner : scala.Option[Rerunner], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a suite of tests has completed executing.
case final class SuiteStarting (val ordinal : Ordinal, val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val formatter : scala.Option[Formatter], val rerunner : scala.Option[Rerunner], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a suite of tests is about to start executing.
case final class Summary (val testsSucceededCount : Int, val testsFailedCount : Int, val testsIgnoredCount : Int, val testsPendingCount : Int, val suitesCompletedCount : Int, val suitesAbortedCount : Int) extends scala.Product
Class each of whose instances hold summary information about one ScalaTest run.
case final class TestFailed (val ordinal : Ordinal, val message : java.lang.String, val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val testName : java.lang.String, val throwable : scala.Option[java.lang.Throwable], val duration : scala.Option[Long], val formatter : scala.Option[Formatter], val rerunner : scala.Option[Rerunner], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a suite (or other entity) has completed running a test that failed.
case final class TestIgnored (val ordinal : Ordinal, val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val testName : java.lang.String, val formatter : scala.Option[Formatter], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a suite (or other entity) has ignored a test.
case final class TestPending (val ordinal : Ordinal, val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val testName : java.lang.String, val formatter : scala.Option[Formatter], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a test is pending, i.e., it hasn't yet been implemented.
case final class TestStarting (val ordinal : Ordinal, val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val testName : java.lang.String, val formatter : scala.Option[Formatter], val rerunner : scala.Option[Rerunner], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a suite (or other entity) is about to start running a test.
case final class TestSucceeded (val ordinal : Ordinal, val suiteName : java.lang.String, val suiteClassName : scala.Option[java.lang.String], val testName : java.lang.String, val duration : scala.Option[Long], val formatter : scala.Option[Formatter], val rerunner : scala.Option[Rerunner], val payload : scala.Option[Any], val threadName : java.lang.String, val timeStamp : Long) extends Event with scala.Product
Event that indicates a suite (or other entity) has completed running a test that succeeded.
Object Summary
object IndentedText extends (java.lang.String, java.lang.String, Int) => IndentedText
object InfoProvided extends AnyRef
Companion object for the InfoProvided event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on InfoProvided objects.
case object MotionToSuppress extends Formatter with scala.Product
A Formatter that indicates reporters may wish to suppress reporting of an Event. "Suppress" means that the event won't be reported to the user.
object NameInfo extends AnyRef
Companion object for case class NameInfo.
object RunAborted extends AnyRef
Companion object for the RunAborted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on RunAborted objects.
object RunCompleted extends AnyRef
Companion object for the RunCompleted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on RunCompleted objects.
object RunStarting extends AnyRef
Companion object for the RunStarting event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on RunStarting objects.
object RunStopped extends AnyRef
Companion object for the RunStopped event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on RunStopped objects.
object SuiteAborted extends AnyRef
Companion object for the SuiteAborted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on SuiteAborted objects.
object SuiteCompleted extends AnyRef
Companion object for the SuiteCompleted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on SuiteCompleted objects.
object SuiteStarting extends AnyRef
Companion object for the SuiteStarting event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on SuiteStarting objects.
object Summary extends AnyRef
Companion object for case class Summary.
object TestFailed extends AnyRef
Companion object for the TestFailed event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestFailed objects.
object TestIgnored extends AnyRef
Companion object for the TestIgnored event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestIgnored objects.
object TestPending extends AnyRef
Companion object for the TestPending event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestPending objects.
object TestStarting extends AnyRef
Companion object for the TestStarting event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestStarting objects.
object TestSucceeded extends AnyRef
Companion object for the TestSucceeded event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestSucceeded objects.