us.abstracta.jmeter.javadsl.java.DslJsr223Sampler Maven / Gradle / Ivy
Show all versions of jmeter-java-dsl Show documentation
package us.abstracta.jmeter.javadsl.java;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.jmeter.protocol.java.sampler.JSR223Sampler;
import org.apache.jmeter.samplers.Entry;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.threads.JMeterContextService;
import org.apache.jmeter.util.JSR223TestElement;
import org.apache.jorphan.collections.HashTree;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import us.abstracta.jmeter.javadsl.core.BuildTreeContext;
import us.abstracta.jmeter.javadsl.core.samplers.BaseSampler.SamplerChild;
import us.abstracta.jmeter.javadsl.core.samplers.DslSampler;
import us.abstracta.jmeter.javadsl.core.testelements.DslJsr223TestElement;
import us.abstracta.jmeter.javadsl.java.DslJsr223Sampler.SamplerVars;
/**
* Allows sampling java APIs and custom logic.
*
* This is a very powerful component, but using it makes code harder to maintain. When there is
* another sampler available that satisfy your needs use it instead of this one.
*
* By default, provided script will be interpreted as groovy script, which is the default setting
* for JMeter. If you need, you can use any of JMeter provided scripting languages (beanshell,
* javascript, jexl, etc.) by setting the {@link #language(String)} property.
*
* @since 0.22
*/
public class DslJsr223Sampler extends DslJsr223TestElement implements
DslSampler {
private static final String DEFAULT_NAME = "JSR223 Sampler";
protected final List children = new ArrayList<>();
public DslJsr223Sampler(String name, String script) {
super(name, DEFAULT_NAME, script);
}
public DslJsr223Sampler(String name, SamplerScript script) {
super(name, DEFAULT_NAME, script);
}
public DslJsr223Sampler(String name, Class scriptClass) {
super(name, DEFAULT_NAME, scriptClass);
}
/**
* Allows specifying children test elements for the sampler, which allows for example extracting
* information from response, assert response contents, etc.
*
* @param children list of test elements to add as children of this sampler.
* @return the sampler for further configuration or usage.
*/
public DslJsr223Sampler children(SamplerChild... children) {
this.children.addAll(Arrays.asList(children));
return this;
}
@Override
protected JSR223TestElement buildJsr223TestElement() {
return new JSR223Sampler();
}
@Override
protected DslLambdaSampler buildLambdaTestElement() {
name = !DEFAULT_NAME.equals(name) ? name : "Lambda Sampler";
return new DslLambdaSampler();
}
public static class DslLambdaSampler extends Jsr223DslLambdaTestElement implements
Sampler {
private static final Logger LOG = LoggerFactory.getLogger(DslLambdaSampler.class);
@Override
public SampleResult sample(Entry entry) {
SampleResult result = new SampleResult();
result.setSampleLabel(getName());
result.setSuccessful(true);
result.setResponseCodeOK();
result.setResponseMessageOK();
result.setSamplerData("Script: " + getScriptId());
result.setDataType(SampleResult.TEXT);
result.sampleStart();
try {
run(new SamplerVars(this, result));
} catch (Exception e) {
LOG.error("Problem in lambda script {}, message: {}", getName(), e, e);
result.setSuccessful(false);
result.setResponseCode("500");
result.setResponseMessage(e.toString());
}
result.sampleEnd();
return result;
}
}
@Override
public HashTree buildTreeUnder(HashTree parent, BuildTreeContext context) {
HashTree ret = super.buildTreeUnder(parent, context);
children.forEach(c -> context.buildChild(c, ret));
return ret;
}
/**
* Allows to use any java code as script.
*
* @see DslJsr223Sampler.SamplerVars for a list of provided variables in script execution
*/
public interface SamplerScript extends
DslJsr223TestElement.Jsr223Script {
}
public static class SamplerVars extends DslJsr223TestElement.Jsr223ScriptVars {
public final SampleResult sampleResult;
public SamplerVars(TestElement element, SampleResult result) {
super(element, JMeterContextService.getContext());
this.sampleResult = result;
}
}
public static class CodeBuilder extends Jsr223TestElementCallBuilder {
public CodeBuilder(List builderMethods) {
super(JSR223Sampler.class, DEFAULT_NAME, builderMethods);
}
}
}