us.abstracta.jmeter.javadsl.engines

Class BaseRemoteEngine<C extends BaseRemoteEngineApiClient,S extends TestPlanStats>

java.lang.Object

us.abstracta.jmeter.javadsl.engines.BaseRemoteEngine<C,S>

Type Parameters:

C - specifies the type of the class used to interact with the remote engine API.

S - specifies the type of test plan stats returned by this engine.

All Implemented Interfaces:

DslJmeterEngine

public abstract class BaseRemoteEngine<C extends BaseRemoteEngineApiClient,S extends TestPlanStats>
extends Object
implements DslJmeterEngine

Contains common logic to ease creation of remote engines (like BlazeMeter).

Since:

1.10

Field Summary

Fields

Modifier and Type	Field and Description
protected C	apiClient

Constructor Summary

Constructors

Constructor and Description
BaseRemoteEngine()

Method Summary

Modifier and Type	Method and Description
protected abstract C	buildClient() Builds the API client class that is required for interaction with the remote engine service.
protected TestStopper	buildTestStopper()
protected org.apache.jorphan.collections.HashTree	buildTree(DslTestPlan testPlan, BuildTreeContext context)
protected org.apache.jmeter.threads.ThreadGroup	extractFirstThreadGroup(org.apache.jorphan.collections.HashTree tree)
protected List<File>	findDependencies(org.apache.jorphan.collections.HashTree tree, BuildTreeContext ctx)
protected boolean	hasTimedOut(Duration timeout, Instant start) Allows to easily check if a given timeout has expired since a given process start time.
protected boolean	isAutoStoppableTest(org.apache.jorphan.collections.HashTree tree)
protected String	prettyDuration(Duration duration) Formats given duration into a more human friendly string format.
TestPlanStats	run(DslTestPlan testPlan)
protected abstract S	run(File jmxFile, org.apache.jorphan.collections.HashTree tree, BuildTreeContext context) Executes the given jmx file (generated from a DSL test plan) in the remote engine service.

Methods inherited from class java.lang.Object

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

Field Detail

apiClient

protected C extends BaseRemoteEngineApiClient apiClient

Constructor Detail

BaseRemoteEngine

public BaseRemoteEngine()

Method Detail

run

public TestPlanStats run(DslTestPlan testPlan)
                  throws IOException,
                         InterruptedException,
                         TimeoutException

Specified by:

run in interface DslJmeterEngine

Throws:

IOException

InterruptedException

TimeoutException

run

protected abstract S run(File jmxFile,
                         org.apache.jorphan.collections.HashTree tree,
                         BuildTreeContext context)
                  throws IOException,
                         InterruptedException,
                         TimeoutException

Executes the given jmx file (generated from a DSL test plan) in the remote engine service.

This method needs to be implemented by each remote engine containing common setup y resources resolution logic, test plan upload, test execution start, waiting for test execution to end and test plan statistics retrieval after test execution ends.

Parameters:

jmxFile - specifies the temporary file which contains a JMeter test plan generated from a JMeter DSL test plan.

tree - specifies the JMeter tree generated from the JMeter DSL test plan. This is usually helpful in case some analysis or inspection is required on the test plan for its remote execution.

context - specifies the build context which can be used to get additional information. Like file assets used by the test plan to upload to the remote engine.

Returns:

the test plan statistics collected by remote engine service.

Throws:

IOException - is thrown when there is some communication problem with the remote engine service.

InterruptedException - is thrown when the user has interrupted the execution of the test plan.

TimeoutException - is thrown when test plan is taking more time than expected executing, or some intermediary phase (test plan validation, upload, statistics retrieval, etc) takes more than expected.

buildClient

protected abstract C buildClient()

Builds the API client class that is required for interaction with the remote engine service.

Returns:

the API client instance for the remote engine usage.

buildTestStopper

protected TestStopper buildTestStopper()

buildTree

protected org.apache.jorphan.collections.HashTree buildTree(DslTestPlan testPlan,
                                                            BuildTreeContext context)

findDependencies

protected List<File> findDependencies(org.apache.jorphan.collections.HashTree tree,
                                      BuildTreeContext ctx)

isAutoStoppableTest

protected boolean isAutoStoppableTest(org.apache.jorphan.collections.HashTree tree)

extractFirstThreadGroup

protected org.apache.jmeter.threads.ThreadGroup extractFirstThreadGroup(org.apache.jorphan.collections.HashTree tree)

hasTimedOut

protected boolean hasTimedOut(Duration timeout,
                              Instant start)

Allows to easily check if a given timeout has expired since a given process start time.

Parameters:

timeout - specifies the duration after the given start, that defines if the associated process has timed out or not.

start - specifies the instant when the associated process started.

Returns:

true if the time since the given start is greater or equal to given timeout. False otherwise.

prettyDuration

protected String prettyDuration(Duration duration)

Formats given duration into a more human friendly string format.

Parameters:

duration - specifies the duration to be formatted.

Returns:

the formatted duration string.

Since:

1.11