RandomTestOrder

The total number of tests that are expected to run when this Suite's run method is invoked.

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.

Runs zero to many of this suite's nested suites.

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.

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.

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.

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.

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.

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.

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.

Construct a new instance of this Suite.

This trait's implementation of runTests invokes this method to create a new instance of this Suite for each test. This trait's implementation of this method uses reflection to call this.getClass.newInstance. This approach will succeed only if this Suite's class has a public, no-arg constructor. In most cases this is likely to be true, because to be instantiated by ScalaTest's Runner a Suite needs a public, no-arg constructor. However, this will not be true of any Suite defined as an inner class of another class or trait, because every constructor of an inner class type takes a reference to the enclosing instance. In such cases, and in cases where a Suite class is explicitly defined without a public, no-arg constructor, you will need to override this method to construct a new instance of the Suite in some other way.

Here's an example of how you could override newInstance to construct a new instance of an inner class:

import org.scalatest._

class Outer {
  class InnerSuite extends Suite with RandomTestOrder {
    def testOne() {}
    def testTwo() {}
    override def newInstance = new InnerSuite
  }
}

Modifies the behavior of super.run to facilitate pseudo-random order test execution.

If both testName and args.distributedTestSorter are defined, this trait's implementation of this method will create a "test-specific reporter" whose apply method will invoke the apply method of the DistributedTestSorter, which takes a test name as well as the event. It will then invoke super.run passing along the same testName and an Args object that is the same except with the original reporter replaced by the test-specific reporter.

If either testName or args.distributedTestSorter is empty, it will create TestSortingReporter and override args's reporter and distributedTestSorter with it. It then call super.run to delegate the run to super's implementation, and to collect all children suites in suiteRunQueue. After super.run completed, it then shuffle the order of the suites collected in suiteRunQueue and run them.

Modifies the behavior of super.runTest to facilitate pseudo-random order test execution.

If runTestInNewInstance is false, this is the test-specific (distributed) instance, so this trait's implementation of this method simply invokes super.runTest, passing along the same testName and args object, delegating responsibility for actually running the test to the super implementation. After super.runTest returns (or completes abruptly by throwing an exception), it notifies args.distributedTestSorter that it has completed running the test by invoking completedTest on it, passing in the testName.

If runTestInNewInstance is true, it notifies args.distributedTestSorter that it is distributing the test by invoking distributingTest on it, passing in the testName. The test execution will be deferred to be run in pseudo-random order later.

Note: this trait's implementation of this method is final to ensure that any other desired runTest behavior is executed by the same thread that executes the test. For example, if you were to mix in BeforeAndAfter after RandomTestOrder, the before and after code would be executed by the general instance on the main test thread, rather than by the test-specific instance on the distributed thread. Marking this method final ensures that traits like BeforeAndAfter can only be &lquot;super&rquot; to RandomTestOrder and, therefore, that its before and after code will be run by the same distributed thread that runs the test itself.

Modifies the behavior of super.runTests to facilitate running each test in its own instance of this Suite's class.

This trait's implementation of runTest uses the runTestInNewInstance flag of the passed Args object to determine whether this instance is the general instance responsible for running all tests in the suite (runTestInNewInstance is false), or a test-specific instance responsible for running just one test (runTestInNewInstance is true). Note that these Boolean values are reverse those used by runTest, because runTests always inverts the Boolean value of runTestInNewInstance when invoking runTest.

If runTestInNewInstance is false, this trait's implementation of this method will invoke super.runTests, passing along testName and args, but with the runTestInNewInstance flag set to true. By setting runTestInNewInstance to true, runTests is telling runTest to create a new instance to run each test.

If runTestInNewInstance is true, this trait's implementation of this method will invoke runTest directly, passing in testName.get and the args object, with the runTestInNewInstance flag set to false. By setting runTestInNewInstance to false, runTests is telling runTest that this is the test-specific instance, so it should just run the specified test.

A maximum amount of time to wait for out-of-order events generated by running the tests of this Suite in parallel while sorting the events back into a more user-friendly, sequential order.

The default implementation of this method returns the value specified via -T to Suite, or 2 seconds, if no -T was supplied.