Trait providing an apply
method to which alert messages about a running suite of tests can be reported.
Trait that contains the alert
method, which can be used to send an alert to the reporter.
Trait providing an implicit conversion that allows clues to be placed after a block of code.
Arguments bundle passed to four of ScalaTest's lifecycle methods: run
, runNestedSuites
,
runTests
, and runTest
.
Trait that contains ScalaTest's basic assertion methods.
Trait that can be mixed into suites that need code executed before and after running each test.
Trait that can be mixed into suites that need methods invoked before and after executing the suite.
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.
Stackable trait that can be mixed into suites that need code executed before and/or after running each test.
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.
Trait that when mixed into a Suite
cancels any remaining tests in that
Suite
instance after a test fails.
Outcome for a test that was canceled, containing an exception describing the cause of the cancelation.
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.
Composite Status
that aggregates its completion and failed states of set of other Status
es passed to its constructor.
A map of configuration data.
Wrapper Suite
that passes an instance of the config map to the constructor of the
wrapped Suite
when run
is invoked.
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.
A trait that represent an expression recorded by DiagrammedExprMacro
, which includes the following members:
A sorter for the events of a run's distributed suites.
A sorter for the events of a suite's distributed tests.
Trait whose instances facilitate parallel execution of Suite
s.
Annotation used to indicate that an otherwise discoverable test class should not be discovered.
Trait to which markup text tests can be reported.
Trait that contains a markup
method, which can be used to send markup to the Reporter
.
Dynamic tags for a run.
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.
A case class implementation of java.util.Map.Entry
to make it easier to
test Java Map
s with ScalaTest Matchers.
Superclass for the two outcomes of running a test that contain an exception: Failed
and Canceled
.
Outcome for a test that failed, containing an exception describing the cause of the failure.
A suite of tests in which each test represents one scenario of a feature.
Implementation trait for class FeatureSpec
, which represents
a suite of tests in which each test represents one scenario of a
feature.
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.
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.
Facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.”“
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.”“
Facilitates a “behavior-driven” style of development (BDD), in which tests
are nested inside text clauses denoted with the dash operator (-
).”“
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 (-
).”“
Facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.”“
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.”“
A suite of tests in which each test is represented as a function value.
Implementation trait for class FunSuite
, which represents
a suite of tests in which each test is represented as a function value.
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.
Annotation used to tag a test, or suite of tests, as ignored.
Trait to which custom information about a running suite of tests can be reported.
Trait that contains the info
method, which can be used to send info to the reporter.
Trait containing the inside
construct, which allows you to make statements about nested object graphs using pattern matching.
Provides nestable inspector methods (or just inspectors) that enable assertions to be made about collections.
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.
Trait that provides a domain specific language (DSL) for expressing assertions in tests
using the word should
.
Trait that provides a domain specific language (DSL) for expressing assertions in tests
using the word must
.
Trait that can be mixed into a Suite
to disable the lone implicit conversion provided by default in trait
Assertions
, which trait Suite
extends.
Trait providing an apply
method to which status updates about a running suite of tests can be reported.
Trait that contains the note
method, which can be used to send a status notification to the reporter.
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.
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.
Superclass for the possible outcomes of running a test.
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.
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
.
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.
Trait facilitating the inclusion of a payload in a thrown ScalaTest exception.
Type that is used as the return type of the pending
method in class
Suite
, which always completes abruptly with a
TestPendingException
.
Trait that facilitates the testing of private methods.
A suite of property-based tests.
Implementation trait for class PropSpec
, which represents
a suite of property-based tests.
Trait that causes tests to be run in pseudo-random order.
Trait whose instances collect the results of a running suite of tests and presents those results in some way to the user.
Subtrait of Reporter
that contains a dispose
method for
releasing any finite, non-memory resources, such as file handles, held by the
Reporter
.
Provides methods that can be used in withFixture
implementations to retry tests in various scenarios.
A Suite
class mixing in SequentialNestedSuiteExecution
that takes
zero to many Suite
s, which will be returned from its nestedSuites
method.
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
.
Trait that causes StackDepth
exceptions thrown by a running test (such as TestFailedException
s) to have
the exception's stack trace severed at the stack depth.
Trait whose instances provide a run
method and configuration fields that implement
the ScalaTest shell: its DSL for the Scala interpreter.
Convenience type alias allowing ShouldMatchers
to be used without qualification or another import
after a wildcard import of org.scalatest
.
Facilitates a “behavior-driven” style of development (BDD), in which tests are methods, optionally nested inside singleton objects defining textual scopes.”“
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.”“
Status implementation that can change its state over time.
The result status of running a test or a suite.
A Suite
class that takes zero to many Suite
s,
which will be returned from its nestedSuites
method and
executed in “stepwise” fashion by its runNestedSuites
method.”“
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
.
Trait whose instances can accept a stop request and indicate whether a stop has already been requested.
A suite of tests.
Trait defining abstract "lifecycle" methods that are implemented in Suite
and can
be overridden in stackable modification traits.
A Suite
class that takes zero to many Suite
s in its constructor,
which will be returned from its nestedSuites
method.
Class whose subclasses can be used to tag tests in style traits in which tests are defined as functions.
Annotation used to annotate annotation interfaces that define tags for ScalaTest tests.
A bundle of information about the current test.
Trait for test registration support.
Class that tracks the progress of a series of Ordinal
s produced by invoking
next
and nextNewOldPair
on the current Ordinal
.
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
.
Facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.”“
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.”“
Annotation to associate a wrapper suite with a non-Suite
class, so it can be run via ScalaTest.
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
.
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
.
Please use org.scalatest.exceptions.DuplicateTestNameException instead.
Trait FailureOf
has been deprecated and will be removed in a future version of ScalaTest.
Instead of the failureOf
method provided by this trait, please use the outcomeOf
method
provided by trait OutcomeOf
instead.
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
.
Please use org.scalatest.exceptions.ModifiableMessageXXX instead.
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
.
Please use org.scalatest.exceptions.NotAllowedException instead.
Trait whose instances can rerun tests or other entities (such as suites).
Class Specs
has been deprecated and will be removed in a future version of ScalaTest. Please
change all uses of Specs
to Suites
instead.
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
.
Please use org.scalatest.exceptions.StackDepth instead.
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
.
Please use org.scalatest.exceptions.StackDepthException instead.
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
.
Please use org.scalatest.exceptions.TestFailedException instead.
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
.
Please use org.scalatest.exceptions.TestPendingException instead.
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
.
Please use org.scalatest.exceptions.TestRegistrationClosedException instead.
Please use org.scalactic.TimesOnInt instead
Companion object that facilitates the importing of AppendedClues
members as
an alternative to mixing it in.
Companion object that facilitates the importing of Assertions
members as
an alternative to mixing it in.
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.
Companion object that facilitates the importing the members of trait Checkpoints
as
an alternative to mixing it in.
Companion object to class ConfigMap
containing factory methods.
Companion object that facilitates the importing of DiagrammedAssertions
members as
an alternative to mixing it in.
DiagrammedExpr
companion object that provides factory methods to create different sub types of DiagrammedExpr
Companion object that facilitates the importing of ValueEither
members as
an alternative to mixing it in.
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.
Singleton status that represents an already completed run with at least one failed test or aborted suite.
Companion object that facilitates the importing of the inside
construct as
an alternative to mixing it in.
Companion object that facilitates the importing of Inspectors
members as
an alternative to mixing it in.
Companion object that facilitates the importing of LoneElement
members as
an alternative to mixing it in.
Companion object that facilitates the importing of Matchers
members as
an alternative to mixing it the trait.
Companion object that facilitates the importing of Matchers
members as
an alternative to mixing it the trait.
Companion object that facilitates the importing of the members of trait Assertions
without importing the implicit conversions
it provides by default.
Companion object that facilitates the importing of OptionValues
members as
an alternative to mixing it in.
Companion object for trait Outcome
that contains an implicit method that enables
collections of Outcome
s to be flattened into a collections of contained exceptions.
Companion object that facilitates the importing of OutcomeOf
's method as
an alternative to mixing it in.
Companion object that facilitates the importing of PartialFunctionValues
members as
an alternative to mixing it in.
Companion object that facilitates the importing of Payloads
members as
an alternative to mixing it in.
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.
Companion object that facilitates the importing of PrivateMethodTester
members as
an alternative to mixing it in.
Companion object to trait Retries
that enables its members to be imported as an
alternative to mixing them in.
Companion object to class Sequential
that offers an apply
factory method
for creating a Sequential
instance.
Companion object to class Stepwise
that offers an apply
factory method
for creating a Stepwise
instance.
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.
Outcome for a test that succeeded.
Singleton status that represents an already completed run with no tests failed and no suites aborted.
Companion object to class Suites
that offers an apply
factory method
for creating a Suites
instance.
Companion object for Tag
, which offers a factory method.
Companion object that facilitates the importing of TryValues
members as
an alternative to mixing it in.
Returns a copy of this Shell
with colorPassed
configuration parameter set to true
.
Returns a copy of this Shell
with durationsPassed
configuration parameter set to true
.
Returns a copy of this Shell
with fullStacksPassed
configuration parameter set to true
.
Returns a copy of this Shell
with colorPassed
configuration parameter set to false
.
Returns a copy of this Shell
with durationsPassed
configuration parameter set to false
.
Returns a copy of this Shell
with shortStacksPassed
configuration parameter set to false
.
Returns a copy of this Shell
with statsPassed
configuration parameter set to false
.
Package object to hold deprecated type aliases for exception classes moved from org.
Singleton object providing an apply
method for the ScalaTest shell and a
main
method for ScalaTest's simple runner.
Returns a copy of this Shell
with shortStacksPassed
configuration parameter set to true
.
Returns a copy of this Shell
with statsPassed
configuration parameter set to true
.
The FailureOf object has been deprecated. Please use object OutcomeOf instead.
Object Specs
has been deprecated and will be removed in a future version of ScalaTest. Please
change all uses of Specs
to Suites
instead.
ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.