org

scalatest

package scalatest

ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

Source
package.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. scalatest
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait Alerter extends AnyRef

    Trait providing an apply method to which alert messages about a running suite of tests can be reported.

  2. trait Alerting extends AnyRef

    Trait that contains the alert method, which can be used to send an alert to the reporter.

  3. trait AppendedClues extends AnyRef

    Trait providing an implicit conversion that allows clues to be placed after a block of code.

  4. case class Args(reporter: Reporter, stopper: Stopper = Stopper.default, filter: Filter = Filter.default, configMap: ConfigMap = ConfigMap.empty, distributor: Option[Distributor] = scala.None, tracker: Tracker = Tracker.default, chosenStyles: Set[String] = scala.this.Predef.Set.empty[String], runTestInNewInstance: Boolean = false, distributedTestSorter: Option[DistributedTestSorter] = scala.None, distributedSuiteSorter: Option[DistributedSuiteSorter] = scala.None) extends Product with Serializable

    Arguments bundle passed to four of ScalaTest's lifecycle methods: run, runNestedSuites, runTests, and runTest.

  5. type Assertion = scalatest.compatible.Assertion

  6. trait Assertions extends TripleEquals

    Trait that contains ScalaTest's basic assertion methods.

  7. trait AsyncTestRegistration extends AnyRef

    Trait declaring methods that can be used to register by-name test functions that have result type Future[Assertion].

  8. trait AsyncTestSuite extends Suite with RecoverMethods with CompleteLastly

    The base trait of ScalaTest's asynchronous testing styles, which defines a withFixture lifecycle method that accepts as its parameter a test function that returns a FutureOutcome.

  9. trait AsyncTestSuiteMixin extends SuiteMixin

    Trait defining abstract "lifecycle" methods that are implemented in AsyncTestSuite and can be overridden in stackable modification traits.

  10. abstract class AsyncWordSpec extends AsyncWordSpecLike

    Enables testing of asynchronous code without blocking, using a style consistent with traditional WordSpec tests.

  11. trait AsyncWordSpecLike extends AsyncTestSuite with AsyncTestRegistration with ShouldVerb with MustVerb with CanVerb with Informing with Notifying with Alerting with Documenting

    Implementation trait for class AsyncWordSpec, which facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.

  12. trait BeforeAndAfter extends SuiteMixin

    Trait that can be mixed into suites that need code executed before and after running each test.

  13. trait BeforeAndAfterAll extends SuiteMixin

    Stackable trait that can be mixed into suites that need methods invoked before and after executing the suite.

  14. trait BeforeAndAfterAllConfigMap extends SuiteMixin

    Trait that can be mixed into suites that need methods that make use of the config map invoked before and/or after executing the suite.

  15. trait BeforeAndAfterEach extends SuiteMixin

    Stackable trait that can be mixed into suites that need code executed before and/or after running each test.

  16. trait BeforeAndAfterEachTestData extends SuiteMixin

    Stackable trait that can be mixed into suites that need code that makes use of test data (test name, tags, config map, etc.) executed before and/or after running each test.

  17. trait CancelAfterFailure extends TestSuiteMixin

    Trait that when mixed into a TestSuite cancels any remaining tests in that TestSuite instance after a test fails.

  18. case class Canceled(exception: TestCanceledException) extends Exceptional with Product with Serializable

    Outcome for a test that was canceled, containing an exception describing the cause of the cancelation.

  19. trait Checkpoints extends AnyRef

    Trait providing class Checkpoint, which enables multiple assertions to be performed within a test, with any failures accumulated and reported together at the end of the test.

  20. trait CompleteLastly extends AnyRef

    Trait that provides a complete-lastly construct, which ensures cleanup code in lastly is executed whether the code passed to complete completes abruptly with an exception or successfully results in a Future, FutureOutcome, or other type with an implicit Futuristic instance.

  21. final class CompositeStatus extends Status with Serializable

    Composite Status that aggregates its completion and failed states of set of other Statuses passed to its constructor.

  22. class ConfigMap extends Map[String, Any] with MapLike[String, Any, ConfigMap] with Serializable

    A map of configuration data.

  23. trait DiagrammedAssertions extends Assertions

    Sub-trait of Assertions that override assert and assume methods to include a diagram showing the values of expression in the error message when the assertion or assumption fails.

  24. trait DiagrammedExpr[T] extends AnyRef

    A trait that represent an expression recorded by DiagrammedExprMacro, which includes the following members:

  25. trait DistributedSuiteSorter extends AnyRef

    A sorter for the events of a run's distributed suites.

  26. trait DistributedTestSorter extends AnyRef

    A sorter for the events of a suite's distributed tests.

  27. trait Distributor extends AnyRef

    Trait whose instances facilitate parallel execution of Suites.

  28. class DoNotDiscover extends Annotation with Annotation with ClassfileAnnotation

  29. trait Documenter extends AnyRef

    Trait to which markup text tests can be reported.

  30. trait Documenting extends AnyRef

    Trait that contains a markup method, which can be used to send markup to the Reporter.

  31. final case class DynaTags(suiteTags: Map[String, Set[String]], testTags: Map[String, Map[String, Set[String]]]) extends Product with Serializable

    Dynamic tags for a run.

  32. trait EitherValues extends AnyRef

    Trait that provides an implicit conversion that adds left.value and right.value methods to Either, which will return the selected value of the Either if defined, or throw TestFailedException if not.

  33. case class Entry[K, V](key: K, value: V) extends Product with Serializable

    A case class implementation of java.util.Map.Entry to make it easier to test Java Maps with ScalaTest Matchers.

  34. sealed abstract class Exceptional extends Outcome

    Superclass for the two outcomes of running a test that contain an exception: Failed and Canceled.

  35. case class Failed(exception: Throwable) extends Exceptional with Product with Serializable

    Outcome for a test that failed, containing an exception describing the cause of the failure.

  36. final class Filter extends Serializable

    Filter whose apply method determines which of the passed tests to run and ignore based on tags to include and exclude passed as as class parameters.

  37. class Finders extends Annotation with Annotation with ClassfileAnnotation

  38. trait FixtureContext extends scalatest.compatible.Assertion

    Marker trait for fixture-context objects, that enables them to be used in testing styles that require type Assertion

  39. class FutureOutcome extends AnyRef

    Wrapper class for Future[Outcome] that presents a more convenient API for manipulation in withFixture methods in async styles.

  40. trait GivenWhenThen extends AnyRef

    Trait that contains methods named given, when, then, and and, which take a string message and implicit Informer, and forward the message to the informer.

  41. class Ignore extends Annotation with Annotation with ClassfileAnnotation

  42. trait Informer extends AnyRef

    Trait to which custom information about a running suite of tests can be reported.

  43. trait Informing extends AnyRef

    Trait that contains the info method, which can be used to send info to the reporter.

  44. trait Inside extends AnyRef

    Trait containing the inside construct, which allows you to make statements about nested object graphs using pattern matching.

  45. trait Inspectors extends AnyRef

    Provides nestable inspector methods (or just inspectors) that enable assertions to be made about collections.

  46. trait LoneElement extends AnyRef

    Trait that provides an implicit conversion that adds to collection types a loneElement method, which will return the value of the lone element if the collection does indeed contain one and only one element, or throw TestFailedException if not.

  47. trait Matchers extends Assertions with Tolerance with ShouldVerb with MatcherWords with Explicitly

    Trait that provides a domain specific language (DSL) for expressing assertions in tests using the word should.

  48. trait MustMatchers extends Assertions with Tolerance with MustVerb with MatcherWords with Explicitly

    Trait that provides a domain specific language (DSL) for expressing assertions in tests using the word must.

  49. trait NonImplicitAssertions extends Assertions

    Trait that can be mixed into a Suite to disable the implicit conversions provided by default in trait Assertions, which trait Suite extends.

  50. trait Notifier extends AnyRef

    Trait providing an apply method to which status updates about a running suite of tests can be reported.

  51. trait Notifying extends AnyRef

    Trait that contains the note method, which can be used to send a status notification to the reporter.

  52. trait OneInstancePerTest extends SuiteMixin

    Trait that facilitates a style of testing in which each test is run in its own instance of the suite class to isolate each test from the side effects of the other tests in the suite.

  53. trait OptionValues extends AnyRef

    Trait that provides an implicit conversion that adds a value method to Option, which will return the value of the option if it is defined, or throw TestFailedException if not.

  54. sealed abstract class Outcome extends Product with Serializable

    Superclass for the possible outcomes of running a test.

  55. trait OutcomeOf extends AnyRef

    Trait that contains the outcomeOf method, which executes a passed code block and transforms the outcome into an Outcome, using the same mechanism used by ScalaTest to produce an Outcome when executing a test.

  56. trait ParallelTestExecution extends OneInstancePerTest

    Trait that causes that the tests of any suite it is mixed into to be run in parallel if a Distributor is passed to runTests.

  57. trait PartialFunctionValues extends AnyRef

    Trait that provides an implicit conversion that adds a valueAt method to PartialFunction, which will return the value (result) of the function applied to the argument passed to valueAt, or throw TestFailedException if the partial function is not defined at the argument.

  58. trait Payloads extends AnyRef

    Trait facilitating the inclusion of a payload in a thrown ScalaTest exception.

  59. sealed trait PendingStatement extends AnyRef

    Trait mixed into the result type of the pending statement of trait Assertions, which always throws TestPendingException.

  60. trait PrivateMethodTester extends AnyRef

    Trait that facilitates the testing of private methods.

  61. class PropSpec extends PropSpecLike

    A suite of property-based tests.

  62. trait PropSpecLike extends TestSuite with TestRegistration with Informing with Notifying with Alerting with Documenting

    Implementation trait for class PropSpec, which represents a suite of property-based tests.

  63. trait RandomTestOrder extends OneInstancePerTest

    Trait that causes tests to be run in pseudo-random order.

  64. trait RecoverMethods extends AnyRef

    Offers two methods for transforming futures when exceptions are expected.

  65. trait Reporter extends AnyRef

    Trait whose instances collect the results of a running suite of tests and presents those results in some way to the user.

  66. trait ResourcefulReporter extends Reporter

    Subtrait of Reporter that contains a dispose method for releasing any finite, non-memory resources, such as file handles, held by the Reporter.

  67. trait Retries extends AnyRef

    Provides methods that can be used in withFixture implementations to retry tests in various scenarios.

  68. class Sequential extends Suite with SequentialNestedSuiteExecution

    A Suite class mixing in SequentialNestedSuiteExecution that takes zero to many Suites, which will be returned from its nestedSuites method.

  69. trait SequentialNestedSuiteExecution extends SuiteMixin

    Trait that causes the nested suites of any suite it is mixed into to be run sequentially even if a Distributor is passed to runNestedSuites.

  70. final class StatefulStatus extends Status with Serializable

    Status implementation that can change its state over time.

  71. sealed trait Status extends AnyRef

    The result status of running a test or a suite, which is used to support parallel and asynchronous execution of tests.

  72. class Stepwise extends Suite with StepwiseNestedSuiteExecution

    A Suite class that takes zero to many Suites, which will be returned from its nestedSuites method and executed in “stepwise” fashion by its runNestedSuites method.

  73. trait StepwiseNestedSuiteExecution extends SuiteMixin

    Trait that causes the nested suites of any suite it is mixed into to be run sequentially even if a Distributor is passed to runNestedSuites.

  74. trait Stopper extends AnyRef

    Trait whose instances can accept a stop request and indicate whether a stop has already been requested.

  75. trait Suite extends Assertions with Serializable

    A suite of tests.

  76. trait SuiteMixin extends AnyRef

    Trait defining abstract "lifecycle" methods that are implemented in Suite and can be overridden in stackable modification traits.

  77. class Suites extends Suite

    A Suite class that takes zero to many Suites in its constructor, which will be returned from its nestedSuites method.

  78. class Tag extends AnyRef

    Class whose subclasses can be used to tag tests in style traits in which tests are defined as functions.

  79. class TagAnnotation extends Annotation with Annotation with ClassfileAnnotation

  80. trait TestData extends AnyRef

    A bundle of information about the current test.

  81. trait TestRegistration extends AnyRef

    Trait declaring methods that can be used to register by-name test functions that have any result type.

  82. trait TestSuite extends Suite

    The base trait of ScalaTest's synchronous testing styles, which defines a withFixture lifecycle method that accepts as its parameter a test function that returns an Outcome.

  83. trait TestSuiteMixin extends SuiteMixin

  84. trait TestsBeforeNestedSuites extends Suite

  85. final class Tracker extends AnyRef

    Class that tracks the progress of a series of Ordinals produced by invoking next and nextNewOldPair on the current Ordinal.

  86. trait TryValues extends AnyRef

    Trait that provides an implicit conversion that adds success and failure methods to scala.util.Try, enabling you to make assertions about the value of a Success or the exception of a Failure.

  87. class WordSpec extends WordSpecLike

    Facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.

  88. trait WordSpecLike extends TestSuite with TestRegistration with ShouldVerb with MustVerb with CanVerb with Informing with Notifying with Alerting with Documenting

    Implementation trait for class WordSpec, which facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.

  89. class WrapWith extends Annotation with Annotation with ClassfileAnnotation

  90. abstract class AsyncFeatureSpec extends AsyncFeatureSpecLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  91. type AsyncFeatureSpecLike = scalatest.featurespec.AsyncFeatureSpecLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.featurespec.AsyncFeatureSpecLike instead

  92. abstract class AsyncFlatSpec extends AsyncFlatSpecLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  93. type AsyncFlatSpecLike = scalatest.flatspec.AsyncFlatSpecLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.flatspec.AsyncFlatSpecLike instead

  94. abstract class AsyncFreeSpec extends AsyncFreeSpecLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  95. type AsyncFreeSpecLike = scalatest.freespec.AsyncFreeSpecLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.freespec.AsyncFreeSpecLike instead

  96. abstract class AsyncFunSpec extends AsyncFunSpecLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  97. type AsyncFunSpecLike = scalatest.funspec.AsyncFunSpecLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.funspec.AsyncFunSpecLike instead

  98. abstract class AsyncFunSuite extends AsyncFunSuiteLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  99. type AsyncFunSuiteLike = scalatest.funsuite.AsyncFunSuiteLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.funsuite.AsyncFunSuiteLike instead

  100. class FeatureSpec extends FeatureSpecLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  101. type FeatureSpecLike = AnyFeatureSpecLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.funsuite.AnyFeatureSpecLike instead

  102. class FlatSpec extends FlatSpecLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  103. type FlatSpecLike = AnyFlatSpecLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.flatspec.AnyFlatSpecLike instead

  104. class FreeSpec extends FreeSpecLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  105. type FreeSpecLike = AnyFreeSpecLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.freespec.AnyFreeSpecLike instead

  106. class FunSpec extends FunSpecLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  107. type FunSpecLike = AnyFunSpecLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.funsuite.AnyFunSpecLike instead

  108. class FunSuite extends FunSuiteLike

    This class is deprecated and will be removed in future version of ScalaTest, please use org.

  109. type FunSuiteLike = AnyFunSuiteLike

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.funsuite.AnyFunSuiteLike instead

  110. type PendingNothing = PendingStatement

    Annotations
    @deprecated
    Deprecated

    Please use PendingStatement instead

  111. trait Rerunner extends AnyRef

    Trait whose instances can rerun tests or other entities (such as suites).

Value Members

  1. object AppendedClues extends AppendedClues

    Companion object that facilitates the importing of AppendedClues members as an alternative to mixing it in.

  2. object Assertions extends Assertions

    Companion object that facilitates the importing of Assertions members as an alternative to mixing it in.

  3. object Canceled extends Serializable

    Companion object to class Canceled that provides, in addition to the extractor and factory method provided by the compiler given its companion is a case class, a second factory method that produces a Canceled outcome given a string message.

  4. object Checkpoints extends Checkpoints

    Companion object that facilitates the importing the members of trait Checkpoints as an alternative to mixing it in.

  5. object CompleteLastly extends CompleteLastly

    Companion object that facilitates the importing of CompleteLastly members as an alternative to mixing it in.

  6. object ConfigMap extends Serializable

    Companion object to class ConfigMap containing factory methods.

  7. object DiagrammedAssertions extends DiagrammedAssertions

    Companion object that facilitates the importing of DiagrammedAssertions members as an alternative to mixing it in.

  8. object DiagrammedExpr

    DiagrammedExpr companion object that provides factory methods to create different sub types of DiagrammedExpr

  9. object EitherValues extends EitherValues

    Companion object that facilitates the importing of ValueEither members as an alternative to mixing it in.

  10. object Exceptional extends Serializable

    Companion object to class Exceptional that provides a factory method and an extractor that enables patterns that match both Failed and Canceled outcomes and extracts the contained exception and a factory method.

  11. object Expectations extends Expectations

  12. object Failed extends Serializable

  13. object FailedStatus extends Status with Serializable

    Singleton status that represents an already completed run with at least one failed test or aborted suite.

  14. object Filter extends Serializable

  15. object FutureOutcome

    Companion object to FutureOutcomes that contains factory methods for creating already-completed FutureOutcomes.

  16. object Inside extends Inside

    Companion object that facilitates the importing of the inside construct as an alternative to mixing it in.

  17. object Inspectors extends Inspectors

    Companion object that facilitates the importing of Inspectors members as an alternative to mixing it in.

  18. object LoneElement extends LoneElement

    Companion object that facilitates the importing of LoneElement members as an alternative to mixing it in.

  19. object Matchers extends Matchers

    Companion object that facilitates the importing of Matchers members as an alternative to mixing it the trait.

  20. object MustMatchers extends MustMatchers

    Companion object that facilitates the importing of Matchers members as an alternative to mixing it the trait.

  21. object NonImplicitAssertions extends NonImplicitAssertions

    Companion object that facilitates the importing of the members of trait Assertions without importing the implicit conversions it provides by default.

  22. object OptionValues extends OptionValues

    Companion object that facilitates the importing of OptionValues members as an alternative to mixing it in.

  23. object Outcome extends Serializable

    Companion object for trait Outcome that contains an implicit method that enables collections of Outcomes to be flattened into a collections of contained exceptions.

  24. object OutcomeOf extends OutcomeOf

    Companion object that facilitates the importing of OutcomeOf's method as an alternative to mixing it in.

  25. object PartialFunctionValues extends PartialFunctionValues

    Companion object that facilitates the importing of PartialFunctionValues members as an alternative to mixing it in.

  26. object Payloads extends Payloads

    Companion object that facilitates the importing of Payloads members as an alternative to mixing it in.

  27. object Pending extends Outcome with Product with Serializable

    Outcome for a test that was pending, which contains an optional string giving more information on what exactly is needed for the test to become non-pending.

  28. object PrivateMethodTester extends PrivateMethodTester

    Companion object that facilitates the importing of PrivateMethodTester members as an alternative to mixing it in.

  29. object RecoverMethods extends RecoverMethods

    Companion object that facilitates the importing of RecoverMethods's method as an alternative to mixing it in.

  30. object Retries extends Retries

    Companion object to trait Retries that enables its members to be imported as an alternative to mixing them in.

  31. val ScalaTestVersion: String

    The version number of ScalaTest.

    The version number of ScalaTest.

    returns

    the ScalaTest version number.

  32. object Sequential extends Serializable

    Companion object to class Sequential that offers an apply factory method for creating a Sequential instance.

  33. object Stepwise extends Serializable

    Companion object to class Stepwise that offers an apply factory method for creating a Stepwise instance.

  34. object Stopper

    Companion object to Stopper that holds a factory method that produces a new Stopper whose stopRequested method returns false until after its requestStop has been invoked.

  35. object Succeeded extends Outcome with scalatest.compatible.Assertion with Product with Serializable

    Outcome for a test that succeeded.

  36. object SucceededStatus extends Status with Serializable

    Singleton status that represents an already completed run with no tests failed and no suites aborted.

  37. object Suites extends Serializable

    Companion object to class Suites that offers an apply factory method for creating a Suites instance.

  38. object Tag

    Companion object for Tag, which offers a factory method.

  39. object Tracker

  40. object TryValues extends TryValues

    Companion object that facilitates the importing of TryValues members as an alternative to mixing it in.

  41. package compatible

  42. package concurrent

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

  43. package enablers

  44. package events

  45. package exceptions

  46. package featurespec

  47. package fixture

    Package fixture deprecated types.

  48. package flatspec

  49. package freespec

  50. package funspec

  51. package funsuite

  52. package matchers

  53. package path

  54. package prop

    Scalatest support for Property-based testing.

  55. package tagobjects

  56. package time

  57. package tools

  58. package words

Inherited from AnyRef

Inherited from Any

Ungrouped