org

scalatest

package scalatest

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

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 AppendedClues extends AnyRef

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

  2. 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.

  3. trait Assertions extends LegacyTripleEquals

    Trait that contains ScalaTest's basic assertion methods.

  4. trait BeforeAndAfter extends SuiteMixin

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

  5. trait BeforeAndAfterAll extends SuiteMixin

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

  6. 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.

  7. trait BeforeAndAfterEach extends SuiteMixin

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

  8. 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.

  9. trait CancelAfterFailure extends SuiteMixin

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

  10. case class Canceled(ex: TestCanceledException) extends Exceptional with Product with Serializable

  11. trait Checkpoints extends AnyRef

    Trait to define class Checkpoint, which allows multiple failure conditions within a test to be collected prior to failure being reported.

  12. final class CompositeStatus extends Status

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

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

    A map of configuration data.

  14. final class ConfigMapWrapperSuite extends Suite

    Wrapper Suite that passes an instance of the config map to the constructor of the wrapped Suite when run is invoked.

  15. trait DistributedSuiteSorter extends AnyRef

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

  16. trait DistributedTestSorter extends AnyRef

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

  17. trait Distributor extends AnyRef

    Trait whose instances facilitate parallel execution of Suites.

  18. trait DoNotDiscover extends Annotation

    Annotation used to indicate that an otherwise discoverable test class should not be discovered.

  19. abstract class DocSpec extends DocSpecLike

  20. trait DocSpecLike extends Suite with Informing

  21. trait Documenter extends (String) ⇒ Unit

    Trait to which markup text tests can be reported.

  22. trait Documenting extends AnyRef

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

  23. 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.

  24. 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.

  25. abstract class Exceptional extends Outcome

  26. case class Failed(ex: Throwable) extends Exceptional with Product with Serializable

  27. trait FailureOf extends AnyRef

    Trait that contains the failureOf method, which captures an exception thrown by a passed code block and returns it wrapped in a Some, or returns None if no exception is thrown.

  28. class FeatureSpec extends FeatureSpecLike

    A suite of tests in which each test represents one scenario of a feature.

  29. trait FeatureSpecLike extends Suite with Informing with Documenting

    Implementation trait for class FeatureSpec, which represents a suite of tests in which each test represents one scenario of a feature.

  30. final class Filter extends (Set[String], Map[String, Set[String]]) ⇒ List[(String, Boolean)]

    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.

  31. trait Finders extends Annotation

    Annotation used to mark a trait or class as defining a testing style that has a org.scalatest.finders.Finder implementation, which IDEs and other tools can use to discover tests and scopes.

  32. class FlatSpec extends FlatSpecLike

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

  33. trait FlatSpecLike extends Suite with ShouldVerb with MustVerb with CanVerb with Informing with Documenting

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

  34. class FreeSpec extends FreeSpecLike

    Facilitates a “behavior-driven” style of development (BDD), in which tests are nested inside text clauses denoted with the dash operator (-).

  35. trait FreeSpecLike extends Suite with Informing with Documenting

    Implementation trait for class FreeSpec, which facilitates a “behavior-driven” style of development (BDD), in which tests are nested inside text clauses denoted with the dash operator (-).

  36. class FunSpec extends FunSpecLike

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

  37. trait FunSpecLike extends Suite with Informing with Documenting

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

  38. class FunSuite extends FunSuiteLike

    A suite of tests in which each test is represented as a function value.

  39. trait FunSuiteLike extends Suite with Informing with Documenting

    Implementation trait for class FunSuite, which represents a suite of tests in which each test is represented as a function value.

  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. trait Ignore extends Annotation

    Annotation used to tag a test, or suite of tests, as ignored.

  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

    This class is part of the ScalaTest matchers DSL.

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

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

  48. type MustMatchers = scalatest.matchers.MustMatchers

    Convenience type alias allowing MustMatchers to be used without qualification or another import after a wildcard import of org.scalatest.

  49. trait NonImplicitAssertions extends Assertions

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

  50. 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.

  51. 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.

  52. sealed abstract class Outcome extends AnyRef

  53. trait OutcomeOf extends AnyRef

  54. 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.

  55. 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.

  56. trait Payloads extends AnyRef

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

  57. case class Pending(ex: Option[String] = scala.None) extends Outcome with Product with Serializable

  58. final class PendingNothing extends AnyRef

    Type that is used as the return type of the pending method in class Suite, which always completes abruptly with a TestPendingException.

  59. trait PrivateMethodTester extends AnyRef

    Trait that facilitates the testing of private methods.

  60. class PropSpec extends PropSpecLike

    A suite of property-based tests.

  61. trait PropSpecLike extends Suite with Informing with Documenting

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

  62. 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.

  63. 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.

  64. class Sequential extends Suite with SequentialNestedSuiteExecution

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

  65. 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.

  66. trait SeveredStackTraces extends SuiteMixin

    Trait that causes StackDepth exceptions thrown by a running test (such as TestFailedExceptions) to have the exception's stack trace severed at the stack depth.

  67. sealed trait Shell extends AnyRef

    Trait whose instances provide a run method and configuration fields that implement the ScalaTest shell: its DSL for the Scala interpreter.

  68. type ShouldMatchers = scalatest.matchers.ShouldMatchers

    Convenience type alias allowing ShouldMatchers to be used without qualification or another import after a wildcard import of org.scalatest.

  69. class Spec extends SpecLike

    Facilitates a “behavior-driven” style of development (BDD), in which tests are methods, optionally nested inside singleton objects defining textual scopes.

  70. trait SpecLike extends Suite with Informing with Documenting

    Implementation trait for class Spec, which facilitates a “behavior-driven” style of development (BDD), in which tests are methods, optionally nested inside singleton objects defining textual scopes.

  71. final class StatefulStatus extends Status

    Status implementation that can change its state over time.

  72. trait Status extends AnyRef

    The result status of running a test or a suite.

  73. 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.

  74. 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.

  75. trait Stopper extends AnyRef

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

  76. trait Suite extends Assertions with AbstractSuite with Serializable

    A suite of tests.

  77. trait SuiteMixin extends AnyRef

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

  78. class Suites extends Suite

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

  79. class Tag extends AnyRef

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

  80. trait TagAnnotation extends Annotation

    Annotation used to annotate annotation interfaces that define tags for ScalaTest tests.

  81. trait TestData extends AnyRef

    A bundle of information about the current test.

  82. trait TimesOnInt extends AnyRef

    Trait providing an implicit conversion that adds a times method to Ints that will repeat a given side-effecting operation multiple times.

  83. 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.

  84. trait TryValues 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.

  85. 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.

  86. trait WordSpecLike extends Suite with ShouldVerb with MustVerb with CanVerb with Informing 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.

  87. trait WrapWith extends Annotation

    Annotation to associate a wrapper suite with a non-Suite class, so it can be run via ScalaTest.

  88. trait AbstractSuite extends AnyRef

    AbstractSuite has been deprecated and will be removed in a future version of ScalaTest. Please change occurances of AbstractSuite where serving as a base class for stackable traits to SuiteMixin. This is just a name change for stackable traits extending AbstractSuite. If AbstractSuite was being used in any other way, change AbstractSuite to Suite.

  89. type DuplicateTestNameException = scalatest.exceptions.DuplicateTestNameException

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.DuplicateTestNameException to org.scalatest.exceptions.DuplicateTestNameException.

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.DuplicateTestNameException to org.scalatest.exceptions.DuplicateTestNameException.

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.DuplicateTestNameException instead.

  90. type ModifiableMessage[T <: Throwable] = scalatest.exceptions.ModifiableMessage[T]

    This trait has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.ModifiableMessageXXX to org.scalatest.exceptions.ModifiableMessageXXX.

    This trait has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.ModifiableMessageXXX to org.scalatest.exceptions.ModifiableMessageXXX.

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.ModifiableMessageXXX instead.

  91. type NotAllowedException = scalatest.exceptions.NotAllowedException

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.NotAllowedException to org.scalatest.exceptions.NotAllowedException.

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.NotAllowedException to org.scalatest.exceptions.NotAllowedException.

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.NotAllowedException instead.

  92. trait Rerunner extends AnyRef

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

  93. class Specs extends Suite

    A Suite class that takes zero to many (likely specification-style) Suites, which will be returned from its nestedSuites method.

  94. type StackDepth = scalatest.exceptions.StackDepth

    This trait has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.StackDepth to org.scalatest.exceptions.StackDepth.

    This trait has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.StackDepth to org.scalatest.exceptions.StackDepth.

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.StackDepth instead.

  95. type StackDepthException = scalatest.exceptions.StackDepthException

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.StackDepthException to org.scalatest.exceptions.StackDepthException.

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.StackDepthException to org.scalatest.exceptions.StackDepthException.

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.StackDepthException instead.

  96. type TestFailedException = scalatest.exceptions.TestFailedException

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.TestFailedException to org.scalatest.exceptions.TestFailedException.

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.TestFailedException to org.scalatest.exceptions.TestFailedException.

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.TestFailedException instead.

  97. type TestPendingException = scalatest.exceptions.TestPendingException

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.TestPendingException to org.scalatest.exceptions.TestPendingException.

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.TestPendingException to org.scalatest.exceptions.TestPendingException.

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.TestPendingException instead.

  98. type TestRegistrationClosedException = scalatest.exceptions.TestRegistrationClosedException

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.TestRegistrationClosedException to org.scalatest.exceptions.TestRegistrationClosedException.

    This class has been moved to the org.scalatest.exceptions package. The deprecated type alias that has been left in its place will be removed in a future version of ScalaTest. Please change any uses of org.scalatest.TestRegistrationClosedException to org.scalatest.exceptions.TestRegistrationClosedException.

    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.TestRegistrationClosedException instead.

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

  4. object Checkpoints extends Checkpoints

    Companion object to Checkpoints.

  5. object ConfigMap extends Serializable

    Companion object to class ConfigMap containing factory methods.

  6. object EitherValues extends EitherValues

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

  7. object Exceptional

  8. object FailedStatus extends Status

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

  9. object FailureOf extends FailureOf

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

  10. object Filter

  11. object Inside extends Inside

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

  12. object Inspectors extends Inspectors

  13. object Matchers extends Matchers

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

  14. 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.

  15. object Omitted extends Outcome with Product with Serializable

  16. object OptionValues extends OptionValues

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

  17. object Outcome

  18. object OutcomeOf extends OutcomeOf

  19. object PartialFunctionValues extends PartialFunctionValues

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

  20. object PrivateMethodTester extends PrivateMethodTester

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

  21. object Sequential extends Serializable

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

  22. object Stepwise extends Serializable

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

  23. 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.

  24. object Succeeded extends Outcome with Product with Serializable

  25. object SucceededStatus extends Status

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

  26. object Suites extends Serializable

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

  27. object Tag

    Companion object for Tag, which offers a factory method.

  28. object TimesOnInt extends TimesOnInt

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

  29. object Tracker

  30. object TryValues extends TryValues

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

  31. lazy val color: Shell

    Returns a copy of this Shell with colorPassed configuration parameter set to true.

  32. package concurrent

  33. lazy val durations: Shell

    Returns a copy of this Shell with durationsPassed configuration parameter set to true.

  34. package enablers

  35. package events

  36. package exceptions

  37. package fixture

  38. lazy val fullstacks: Shell

    Returns a copy of this Shell with fullStacksPassed configuration parameter set to true.

  39. package junit

  40. package matchers

  41. package mock

  42. lazy val nocolor: Shell

    Returns a copy of this Shell with colorPassed configuration parameter set to false.

  43. lazy val nodurations: Shell

    Returns a copy of this Shell with durationsPassed configuration parameter set to false.

  44. lazy val nostacks: Shell

    Returns a copy of this Shell with shortStacksPassed configuration parameter set to false.

  45. lazy val nostats: Shell

    Returns a copy of this Shell with statsPassed configuration parameter set to false.

  46. package path

  47. package prop

    Package object to hold deprecated type aliases for exception classes moved from org.

  48. object run

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

  49. package selenium

  50. lazy val shortstacks: Shell

    Returns a copy of this Shell with shortStacksPassed configuration parameter set to true.

  51. lazy val stats: Shell

    Returns a copy of this Shell with statsPassed configuration parameter set to true.

  52. package tagobjects

  53. package tags

  54. package testng

  55. package time

  56. package tools

  57. package words

Deprecated Value Members

  1. object Specs extends Serializable

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

Inherited from AnyRef

Inherited from Any

Ungrouped