org.threadly.load

Class AbstractScriptBuilder

java.lang.Object

org.threadly.load.AbstractScriptBuilder

Direct Known Subclasses:

ParallelScriptBuilder, SequentialScriptBuilder

public abstract class AbstractScriptBuilder
extends java.lang.Object

Provides the shared implementation among all execution step builders. This also defines the minimum API set that all builders must implement.

Method Summary

Modifier and Type	Method and Description
org.threadly.concurrent.future.ListenableFuture<java.lang.Double>	addProgressFuture() Adds a step in the current test position which will log out the percent of completion for the entire test script.
abstract void	addStep(ScriptStep step) Add a step to this builder.
void	addSteps(AbstractScriptBuilder scriptBuilder) Adds steps for an unknown builder type.
abstract void	addSteps(ParallelScriptBuilder parallelSteps) Add a parallel series of steps to this builder.
abstract void	addSteps(SequentialScriptBuilder sequentialSteps) Add a sequential series of steps to this builder.
ExecutableScript	build() Finalizes the script and compiles into an executable form.
int	getMaximumNeededThreadCount() Call to check how many threads this script will need to execute at the current build point.
abstract boolean	hasSteps() Checks if the builder has had at least one step added to it.
abstract AbstractScriptBuilder	makeCopy() Make a copy of the script chain.
void	setMaxScriptStepRate(double stepsPerSecondLimit) Sets a new limit for the script steps to be executed at.

Methods inherited from class java.lang.Object

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

Method Detail

addProgressFuture

public org.threadly.concurrent.future.ListenableFuture<java.lang.Double> addProgressFuture()

Adds a step in the current test position which will log out the percent of completion for the entire test script. The provided future will complete once the test has reached this point in the script. The resulting double provided by the future is the percent of completion at this moment. You can easily log this by adding a FutureCallback to the returned future. If there are steps running in parallel at the time of execution for this progress future it should be noted the number is a best guess, as no locking occurs during determining the current progress. If the script is stopped (likely due to an error or step failure), this returned future will complete in an error state (ie Future.get() will throw a ExecutionException.

Returns:

A future which provide a double representing the percent of how much of the script has completed

setMaxScriptStepRate

public void setMaxScriptStepRate(double stepsPerSecondLimit)

Sets a new limit for the script steps to be executed at. This will only take place for steps which execute AFTER this point in the script. This is effectively adding a task at this point in the script that will set an limit on how fast the steps can run. If you want your entire script to adher to this limit it must be done before any steps are added. This allows you to control request rates, allowing you at run time to adjust the rate at which executions are occurring. Provide a value of zero to disable this and allow steps to execute as fast as possible.

Parameters:

stepsPerSecondLimit - Steps per second allowed to execute

hasSteps

public abstract boolean hasSteps()

Checks if the builder has had at least one step added to it. If this returns false then this builder is effectively a no-op.

Returns:

true if at least one step is attached to this builder

addStep

public abstract void addStep(ScriptStep step)

Add a step to this builder. For more specific step addition descriptions please see: SequentialScriptBuilder.addStep(ScriptStep) and ParallelScriptBuilder.addStep(ScriptStep).

Parameters:

step - Test step to add to builder

addSteps

public abstract void addSteps(SequentialScriptBuilder sequentialSteps)

Add a sequential series of steps to this builder. Since the behavior of this depends on the current step, please see a more specific step addition behavior descriptions here: SequentialScriptBuilder.addSteps(SequentialScriptBuilder) and ParallelScriptBuilder.addSteps(SequentialScriptBuilder).

Parameters:

sequentialSteps - Script steps to be added to this builder

addSteps

public abstract void addSteps(ParallelScriptBuilder parallelSteps)

Add a parallel series of steps to this builder. Since the behavior of this depends on the current step, please see a more specific step addition behavior descriptions here: SequentialScriptBuilder.addSteps(SequentialScriptBuilder) and ParallelScriptBuilder.addSteps(SequentialScriptBuilder).

Parameters:

parallelSteps - Script steps to be added to this builder

addSteps

public void addSteps(AbstractScriptBuilder scriptBuilder)

Adds steps for an unknown builder type. This does instance of checks and defers to either addSteps(ParallelScriptBuilder) or addSteps(SequentialScriptBuilder).

Parameters:

scriptBuilder - Script builder to add steps from

getMaximumNeededThreadCount

public int getMaximumNeededThreadCount()

Call to check how many threads this script will need to execute at the current build point. This can give you an idea of how intensely parallel this script is. Though it should be known that less threads may be started than this. If the rate limiting is being used, depending on how fast test steps are completing not all threads may be used.

Returns:

Number of threads to run script at it's most parallel point

makeCopy

public abstract AbstractScriptBuilder makeCopy()

Make a copy of the script chain. This is necessary if you want to add the chain multiple times to another chain. The returned chain will execute the same script step instances (so if added to a parallel builder make sure the script steps are thread safe).

Returns:

A copy builder

build

public ExecutableScript build()

Finalizes the script and compiles into an executable form.

Returns:

A script which can be started