org

scalatest

package scalatest

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

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, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker, chosenStyles: Set[String], runTestInNewInstance: Boolean, distributedTestSorter: Option[DistributedTestSorter], distributedSuiteSorter: Option[DistributedSuiteSorter]) extends Product with Serializable

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

  3. trait Assertions extends AnyRef

    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 BeforeAndAfterEach extends SuiteMixin

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

  7. trait CancelAfterFailure extends SuiteMixin

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

  8. class CompositeStatus extends Status

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

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

  10. trait DistributedSuiteSorter extends AnyRef

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

  11. trait DistributedTestSorter extends AnyRef

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

  12. trait Distributor extends AnyRef

    Trait whose instances facilitate parallel execution of Suites.

  13. trait DoNotDiscover extends Annotation

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

  14. trait Documenter extends (String) ⇒ Unit

    Trait to which markup text tests can be reported.

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

    Dynamic tags for a run.

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

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

  18. trait FeatureSpec extends Suite

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

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

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

  21. trait FlatSpec extends Suite with ShouldVerb with MustVerb with CanVerb

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

  22. trait FreeSpec extends Suite

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

  23. trait FunSpec extends Suite

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

  24. trait FunSuite extends Suite

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

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

  26. trait Ignore extends Annotation

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

  27. trait Informer extends AnyRef

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

  28. trait Inside extends AnyRef

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

  29. type MustMatchers = MustMatchers

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

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

    Definition Classes
    package

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

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

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

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

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

  35. trait Payloads extends AnyRef

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

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

  37. trait PrivateMethodTester extends AnyRef

    Trait that facilitates the testing of private methods.

  38. trait PropSpec extends Suite

    A suite of property-based tests.

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

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

  41. trait SequentialNestedSuiteExecution extends SuiteMixin

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

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

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

  44. type ShouldMatchers = ShouldMatchers

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

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

    Definition Classes
    package

  45. trait Spec extends Suite

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

  46. class Specs extends Suite

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

  47. class StatefulStatus extends Status

    Status implementation that can change its state over time.

  48. trait Status extends AnyRef

    The result status of running a test or a suite.

  49. trait Stopper extends AnyRef

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

  50. trait Suite extends Assertions with AbstractSuite with Serializable

    A suite of tests.

  51. trait SuiteMixin extends AnyRef

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

  52. class Suites extends Suite

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

  53. class Tag extends AnyRef

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

  54. trait TagAnnotation extends Annotation

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

  55. trait TestData extends AnyRef

    A bundle of information about the current test.

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

  57. class Tracker extends AnyRef

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

  58. trait WordSpec extends Suite with ShouldVerb with MustVerb with CanVerb

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

  59. trait WrapWith extends Annotation

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

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

  61. type DuplicateTestNameException = 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.

    Definition Classes
    package
    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.DuplicateTestNameException instead.

  62. type ModifiableMessage [T <: Throwable] = 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.

    Definition Classes
    package
    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.ModifiableMessageXXX instead.

  63. type NotAllowedException = 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.

    Definition Classes
    package
    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.NotAllowedException instead.

  64. trait Rerunner extends AnyRef

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

  65. type StackDepth = 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.

    Definition Classes
    package
    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.StackDepth instead.

  66. type StackDepthException = 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.

    Definition Classes
    package
    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.StackDepthException instead.

  67. type TestFailedException = 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.

    Definition Classes
    package
    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.TestFailedException instead.

  68. type TestPendingException = 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.

    Definition Classes
    package
    Annotations
    @deprecated
    Deprecated

    Please use org.scalatest.exceptions.TestPendingException instead.

  69. type TestRegistrationClosedException = 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.

    Definition Classes
    package
    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 EitherValues extends EitherValues

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

  4. object FailedStatus extends Status

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

  5. object FailureOf extends FailureOf

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

  6. object Filter extends AnyRef

  7. object GivenWhenThen extends GivenWhenThen

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

  8. object Inside extends Inside

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

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

  10. object OptionValues extends OptionValues

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

  11. object PartialFunctionValues extends PartialFunctionValues

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

  12. object PrivateMethodTester extends PrivateMethodTester

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

  13. object Reporter extends AnyRef

    Companion object to Reporter that holds a deprecated implicit conversion.

  14. object Rerunner extends AnyRef

    Companion object to Rerunner that holds a deprecated implicit conversion.

  15. object Specs extends Serializable

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

  16. object Stopper extends AnyRef

    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.

  17. object SucceededStatus extends Status

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

  18. object Suites extends Serializable

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

  19. object Tag extends AnyRef

    Companion object for Tag, which offers a factory method.

  20. object TimesOnInt extends TimesOnInt

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

  21. object Tracker extends AnyRef

  22. lazy val color : Shell

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

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

    Definition Classes
    package

  23. package concurrent

  24. lazy val durations : Shell

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

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

    Definition Classes
    package

  25. package events

  26. package exceptions

  27. package fixture

  28. lazy val fullstacks : Shell

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

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

    Definition Classes
    package

  29. package junit

  30. package matchers

  31. package mock

  32. lazy val nocolor : Shell

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

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

    Definition Classes
    package

  33. lazy val nodurations : Shell

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

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

    Definition Classes
    package

  34. lazy val nostacks : Shell

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

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

    Definition Classes
    package

  35. lazy val nostats : Shell

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

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

    Definition Classes
    package

  36. package path

  37. package prop

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

  38. object run extends AnyRef

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

  39. package selenium

  40. lazy val shortstacks : Shell

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

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

    Definition Classes
    package

  41. lazy val stats : Shell

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

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

    Definition Classes
    package

  42. package testng

  43. package time

  44. package tools

  45. package verb