The total number of tests that are expected to run when this Suite's run method is invoked.
The total number of tests that are expected to run when this Suite's run method is invoked.
a Filter with which to filter tests to count based on their tags
An immutable IndexedSeq of this SuiteMixin object's nested Suites.
An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites,
this method returns an empty IndexedSeq.
The fully qualified name of the class that can be used to rerun this suite.
The fully qualified name of the class that can be used to rerun this suite.
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
the Args for this run
a Status object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.
if args is null.
Runs a test.
Runs a test.
the name of one test to execute.
the Args for this run
a Status object that indicates when the test started by this method has completed, and whether or not it failed .
if any of testName or args is null.
Runs zero to many of this suite's tests.
Runs zero to many of this suite's tests.
an optional name of one test to run. If None, all relevant tests should be run.
I.e., None acts like a wildcard that means run all relevant tests in this Suite.
the Args for this run
a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
if either testName or args is null.
This suite's style name.
This suite's style name.
This lifecycle method provides a string that is used to determine whether this suite object's style is one of the chosen styles for the project.
A string ID for this Suite that is intended to be unique among all suites reported during a run.
A string ID for this Suite that is intended to be unique among all suites reported during a run.
The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
this Suite object's ID.
A user-friendly suite name for this Suite.
A user-friendly suite name for this Suite.
This trait's
implementation of this method returns the simple name of this object's class. This
trait's implementation of runNestedSuites calls this method to obtain a
name for Reports to pass to the suiteStarting, suiteCompleted,
and suiteAborted methods of the Reporter.
this Suite object's suite name.
A Map whose keys are String names of tagged tests and
whose associated values are the Set of tag names for the test.
A Map whose keys are String names of tagged tests and
whose associated values are the Set of tag names for the test. If a test has no associated tags, its name
does not appear as a key in the returned Map. If this Suite contains no tests with tags, this
method returns an empty Map.
Subclasses may override this method to define and/or discover tags in a custom manner, but overriding method implementations
should never return an empty Set as a value. If a test has no tags, its name should not appear as a key in the
returned Map.
Provides a TestData instance for the passed test name, given the passed config map.
Provides a TestData instance for the passed test name, given the passed config map.
This method is used to obtain a TestData instance to pass to withFixture(NoArgTest)
and withFixture(OneArgTest) and the beforeEach and afterEach methods
of trait BeforeAndAfterEach.
the name of the test for which to return a TestData instance
the config map to include in the returned TestData
a TestData instance for the specified test, which includes the specified config map
A Set of test names.
A Set of test names. If this Suite contains no tests, this method returns an empty Set.
Although subclass and subtrait implementations of this method may return a Set whose iterator produces String
test names in a well-defined order, the contract of this method does not required a defined order. Subclasses are free to
implement this method and return test names in either a defined or undefined order.
Runs the passed test function with a fixture established by this method.
Runs the passed test function with a fixture established by this method.
This method should set up the fixture needed by the tests of the
current suite, invoke the test function, and if needed, perform any clean
up needed after the test completes. Because the NoArgTest function
passed to this method takes no parameters, preparing the fixture will require
side effects, such as initializing an external database.
the no-arg test function to run with a fixture
Defines a method to be run after all of this suite's tests and nested suites have been run.
Defines a method to be run after all of this suite's tests and nested suites have been run.
This trait's implementation
of run invokes the overloaded form of this method that
takes a configMap (which has been deprecated) after executing
all tests and nested suites. This trait's implementation of that afterAll(ConfigMap) method simply invokes this
afterAll() method. Thus this method can be used to tear down a test fixture
needed by the entire suite, when you don't need anything from the configMap.
This trait's implementation of this method does nothing.
Defines a method to be run before any of this suite's tests or nested suites are run.
Defines a method to be run before any of this suite's tests or nested suites are run.
This trait's implementation
of run invokes the overloaded form of this method that
takes a configMap (which has been deprecated) before executing
any tests or nested suites. This trait's implementation of that beforeAll(ConfigMap)
method simply invokes this beforeAll()
method. Thus this method can be used to set up a test fixture
needed by the entire suite, when you don't need anything from the configMap.
This trait's implementation of this method does nothing.
Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.
Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.
The default value is false, which means beforeAll and afterAll will not be invoked
if there are no tests expected. Whether tests are expected is determined by invoking expectedTestCount passing in
the passed filter. Because this count does not include tests excluded based on tags, such as ignored tests, this prevents
any side effects in beforeAll or afterAll if no tests will ultimately be executed anyway.
If you always want to see the side effects even if no tests are expected, override this val and set it to true.
Execute a suite surrounded by calls to beforeAll and afterAll.
Execute a suite surrounded by calls to beforeAll and afterAll.
This trait's implementation of this method ("this method") invokes beforeAll(ConfigMap)
before executing any tests or nested suites and afterAll(ConfigMap)
after executing all tests and nested suites. It runs the suite by invoking super.run, passing along
the parameters passed to it.
If any invocation of beforeAll completes abruptly with an exception, this
method will complete abruptly with the same exception. If any call to
super.run completes abruptly with an exception, this method
will complete abruptly with the same exception, however, before doing so, it will
invoke afterAll. If afterAll also completes abruptly with an exception, this
method will nevertheless complete abruptly with the exception previously thrown by super.run.
If super.run returns normally, but afterAll completes abruptly with an
exception, this method will complete abruptly with the same exception.
This method does not invoke either beforeAll or afterAll if runTestsInNewInstance is true so
that any side effects only happen once per test if OneInstancePerTest is being used. In addition, if no tests
are expected, then beforeAll and afterAll will be invoked only if the
invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected flag is true. By default, this flag is false, so that if
all tests are excluded (such as if the entire suite class has been marked with @Ignore), then side effects
would happen only if at least one test will ultimately be executed in this suite or its nested suites.
an optional name of one test to run. If None, all relevant tests should be run.
I.e., None acts like a wildcard that means run all relevant tests in this Suite.
the Args for this run
a Status object that indicates when the test started by this method has completed, and whether or not it failed .
This overloaded form of afterAll has been deprecated and will
be removed in a future version of ScalaTest. Please use the afterAll(ConfigMap) method
of trait BeforeAndAfterAllConfigMap instead.
This overloaded form of afterAll has been deprecated and will
be removed in a future version of ScalaTest. Please use the afterAll(ConfigMap) method
of trait BeforeAndAfterAllConfigMap instead.
Please use the afterAll(ConfigMap) method of trait BeforeAndAfterAllConfigMap instead.
This overloaded form of beforeAll has been deprecated and will
be removed in a future version of ScalaTest. Please use the beforeAll(ConfigMap) method
of trait BeforeAndAfterAllConfigMap instead.
This overloaded form of beforeAll has been deprecated and will
be removed in a future version of ScalaTest. Please use the beforeAll(ConfigMap) method
of trait BeforeAndAfterAllConfigMap instead.
Please use the beforeAll(ConfigMap) method of trait BeforeAndAfterAllConfigMap instead.
Trait that can be mixed into suites that need methods invoked before and after executing the suite.
This trait allows code to be executed before and/or after all the tests and nested suites of a suite are run. This trait overrides
runand calls thebeforeAllmethod, then callssuper.run. After thesuper.runinvocation completes, whether it returns normally or completes abruptly with an exception, this trait'srunmethod will invokeafterAll.Trait
BeforeAndAfterAlldefinesbeforeAllandafterAllmethods that take no parameters. This trait's implementation of these methods do nothing.For example, the following
ExampleSpecmixes inBeforeAndAfterAlland inbeforeAll, creates and writes to a temp file, taking the name of the temp file from theconfigMap. This sameconfigMapis then passed to therunmethods of the nested suites,OneSpec,TwoSpec,RedSpec, andBlueSpec, so those suites can access the filename and, therefore, the file's contents. After all of the nested suites have executed,afterAllis invoked, which again grabs the file name from theconfigMapand deletes the file. Each of these five test classes extend traitTempFileExistsSpec, which defines a test that ensures the temp file exists. (Note: if you're unfamiliar with thewithFixture(OneArgTest)approach to shared fixtures, check out the documentation for traitfixture.FlatSpec.)Running the above class in the interpreter will give an error if you don't supply a mapping for
"tempFileName"in the config map:If you do supply a mapping for
"tempFileName"in the config map, you'll see that the temp file is available to all the tests:scala> new ExampleSpec execute (configMap = ConfigMap("tempFileName" -> "tmp.txt")) ExampleSpec: OneSpec: The temp file - should exist in OneSpec TwoSpec: The temp file - should exist in TwoSpec RedSpec: The temp file - should exist in RedSpec BlueSpec: The temp file - should exist in BlueSpec The temp file - should exist in ExampleSpecNote: As of 2.0.M5, this trait uses the newly added
Statusresult ofSuite's "run" methods to ensure that the code inafterAllis executed after all the tests and nested suites are executed even if aDistributoris passed.Note that it is not guaranteed that
afterAllis invoked from the same thread asbeforeAll, so if there's any shared state betweenbeforeAllandafterAllyou'll need to make sure they are synchronized correctly.