org.threadly.load

Class StepResultCollectionUtils

java.lang.Object

org.threadly.load.StepResultCollectionUtils

public class StepResultCollectionUtils
extends java.lang.Object

Some utilities for when dealing with a collection of StepResult's. One of the most notable is getFailedResult(Collection) which is an easy way to know if a set of test steps completed without error.

Constructor Summary

Constructors

Constructor and Description
StepResultCollectionUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<StepResult>	getAllFailedResults(java.util.Collection<? extends java.util.concurrent.Future<? extends StepResult>> futures) Looks through collection of futures looking for any StepResult's that are in a failure state.
static StepResult	getFailedResult(java.util.Collection<? extends java.util.concurrent.Future<? extends StepResult>> futures) Looks through collection of futures looking for any StepResult's that are in a failure state.
static double	getRunTimeAverage(java.util.Collection<? extends java.util.concurrent.Future<? extends StepResult>> futures, java.util.concurrent.TimeUnit timeUnit) Calculates the average runtime per test step.
static java.util.Map<java.lang.Double,StepResult>	getRunTimePercentiles(java.util.Collection<? extends java.util.concurrent.Future<? extends StepResult>> futures, double... percentiles) Sort through results to get step run time percentiles.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StepResultCollectionUtils

public StepResultCollectionUtils()

Method Detail

getFailedResult

public static StepResult getFailedResult(java.util.Collection<? extends java.util.concurrent.Future<? extends StepResult>> futures)
                                  throws java.lang.InterruptedException

Looks through collection of futures looking for any StepResult's that are in a failure state. Once it finds the first one it returns it. If this was a parallel step, it is possible there are additional failures not returned (it just returns the first failure it finds). This call blocks until all the test steps have completed, and if none are in a failure state, it will return null.

Parameters:

futures - Future collection to iterate over and inspect

Returns:

Failed TestResult or null if no failures occurred

Throws:

java.lang.InterruptedException - Thrown if the thread is interrupted while waiting for StepResult

getAllFailedResults

public static java.util.List<StepResult> getAllFailedResults(java.util.Collection<? extends java.util.concurrent.Future<? extends StepResult>> futures)
                                                      throws java.lang.InterruptedException

Looks through collection of futures looking for any StepResult's that are in a failure state. Unlike getFailedResult(Collection), which stops searching after it finds the first failure, this will find ALL failed results. Thus ensuring that every test case has finished before returning.

Parameters:

futures - Future collection to iterate over and inspect

Returns:

Failed List of TestResult's that failed (collection will be empty if no failures occurred)

Throws:

java.lang.InterruptedException - Thrown if the thread is interrupted while waiting for StepResult

getRunTimeAverage

public static double getRunTimeAverage(java.util.Collection<? extends java.util.concurrent.Future<? extends StepResult>> futures,
                                       java.util.concurrent.TimeUnit timeUnit)
                                throws java.lang.InterruptedException

Calculates the average runtime per test step. This totals the time spent in processing each test step, then divides by the total number of test steps to get the average time in nanoseconds. If the test is running during this call it will block until all test steps have completed (or were canceled).

Parameters:

futures - Future collection to iterate over and inspect

timeUnit - Time unit that the resulting time should be returned in

Returns:

Average nanoseconds spent per test step

Throws:

java.lang.InterruptedException - Thrown if the thread is interrupted while waiting for StepResult

getRunTimePercentiles

public static java.util.Map<java.lang.Double,StepResult> getRunTimePercentiles(java.util.Collection<? extends java.util.concurrent.Future<? extends StepResult>> futures,
                                                                               double... percentiles)
                                                                        throws java.lang.InterruptedException

Sort through results to get step run time percentiles.

Parameters:

futures - Future collection to iterate over and inspect

percentiles - Percentile points requested, must be provided, must be between 0 and 100 (inclusive)

Returns:

Map which key maps to percentile, and value maps to the result

Throws:

java.lang.InterruptedException - Thrown if thread is interrupted while waiting for results to complete