Class that facilitates the testing of classes, traits, and libraries designed to be used by multiple threads concurrently.
A PatienceConfigParam that specifies the amount of time to sleep after
a retry.
Configuration object for asynchronous constructs, such as those provided by traits Eventually and
AsyncAssertions.
Abstract class defining a family of configuration parameters for traits Eventually and AsyncAssertions.
A PatienceConfigParam that specifies the maximum amount of time to wait for an asynchronous operation to
complete.
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
A List of this Suite object's nested Suites.
A List of this Suite object's nested Suites. If this Suite contains no nested Suites,
this method returns an empty List.
Runs this suite of tests.
Runs this suite of tests.
an optional name of one test to execute. If None, all relevant tests should be executed.
I.e., None acts like a wildcard that means execute all relevant tests in this Suite.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be executed
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.
a Tracker tracking Ordinals being fired by the current thread.
if any passed parameter is null.
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
a Tracker tracking Ordinals being fired by the current thread.
if any passed parameter is null.
Runs a test.
Runs a test.
the name of one test to execute.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Map of key-value pairs that can be used by the executing Suite of tests.
a Tracker tracking Ordinals being fired by the current thread.
if any of testName, reporter, stopper, configMap,
or tracker 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 Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which instances of this Suite class
that are responsible for executing individual tests contained in this Suite, or groups of this Suite's
tests, may be placed so as to be run
by another entity, such as concurrently by a pool of threads.
a Tracker tracking Ordinals being fired by the current thread.
if any of testName, reporter, stopper, groupsToInclude,
groupsToExclude, or configMap is null.
Suite style name.
Suite style name.
A Map whose keys are String tag names with which tests in this Suite are marked, and
whose values are the Set of test names marked with each tag.
A Map whose keys are String tag names with which tests in this Suite are marked, and
whose values are the Set of test names marked with each tag. If this Suite contains no tags, this
method returns an empty Map.
Subclasses may implement 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 tag has no tests, its name should not appear as a key in the
returned Map.
An Set of test names.
An 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.
Gets the current value of the clock.
Gets the current value of the clock. Primarily useful in assert statements.
the current tick value
Returns an Interval configuration parameter containing the passed value, which
specifies the amount of time to sleep after a retry.
Returns an Interval configuration parameter containing the passed value, which
specifies the amount of time to sleep after a retry.
Check if the clock has been frozen by any threads.
Check if the clock has been frozen by any threads. (The only way a thread can freeze the clock is by calling withClockFrozen.)
Implicit PatienceConfig value providing default configuration values.
Implicit PatienceConfig value providing default configuration values.
To change the default configuration, override or hide this def with another implicit
PatienceConfig containing your desired default configuration values.
Scales the passed Span by the Double factor returned
by spanScaleFactor.
Scales the passed Span by the Double factor returned
by spanScaleFactor.
The Span is scaled by invoking its scaledBy method,
thus this method has the same behavior:
The value returned by spanScaleFactor can be any positive number or zero,
including a fractional number. A number greater than one will scale the Span
up to a larger value. A fractional number will scale it down to a smaller value. A
factor of 1.0 will cause the exact same Span to be returned. A
factor of zero will cause Span.ZeroLength to be returned.
If overflow occurs, Span.Max will be returned. If underflow occurs,
Span.ZeroLength will be returned.
if the value returned from spanScaleFactor
is less than zero
The factor by which the scaled method will scale Spans.
The default implementation of this method...
The factor by which the scaled method will scale Spans.
The default implementation of this method...
Create a new thread that will execute the given function.
Create a new thread that will execute the given function. If the test is started, then the thread will run the function immediately. If it is not yet started, the Thread will wait to run the function until all threads are up and ready to go.
the name of the thread
the function to be executed by the thread
Create a new thread that will execute the given function.
Create a new thread that will execute the given function. If the test is started, then the thread will run the function immediately. If it is not yet started, the Thread will wait to run the function until all threads are up and ready to go.
the function to be executed by the thread
Returns a Timeout configuration parameter containing the passed value, which
specifies the maximum amount to wait for an asynchronous operation to complete.
Returns a Timeout configuration parameter containing the passed value, which
specifies the maximum amount to wait for an asynchronous operation to complete.
Force the current thread to block until the thread clock reaches the specified value, at which point the current thread is unblocked.
Force the current thread to block until the thread clock reaches the specified value, at which point the current thread is unblocked.
Register a function to be executed after the simulation has finished.
Register a function to be executed after the simulation has finished.
Run the passed function, ensuring the clock does not advance while the function is running (has not yet returned or thrown an exception).
Run the passed function, ensuring the clock does not advance while the function is running (has not yet returned or thrown an exception).
Creates and initializes a private instance variable with a new Conductor,
ensuring it is visible to any thread, invokes the passed test function,
and invokes conduct on the Conductor, if it
was not already invoked by the test.
Creates and initializes a private instance variable with a new Conductor,
ensuring it is visible to any thread, invokes the passed test function,
and invokes conduct on the Conductor, if it
was not already invoked by the test.
This trait is stackable with other traits that override withFixture(NoArgTest), because
instead of invoking the test function directly, it delegates responsibility for invoking the test
function to super.withFixture(NoArgTest).
the no-arg test function to run with a fixture
Trait that provides each test with access to a new
Conductorvia methods.Here's an example of the use of this trait to test the
ArrayBlockingQueueconcurrency abstraction fromjava.util.concurrent:For an explanation of how these tests work, see the documentation for
Conductor.