us.abstracta.jmeter.javadsl.codegeneration.DslCodeGenerator Maven / Gradle / Ivy
Show all versions of jmeter-java-dsl Show documentation
package us.abstracta.jmeter.javadsl.codegeneration;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Collectors;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jorphan.collections.HashTree;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import us.abstracta.jmeter.javadsl.JmeterDsl;
import us.abstracta.jmeter.javadsl.core.DslTestElement;
import us.abstracta.jmeter.javadsl.core.controllers.DslIncludeController;
import us.abstracta.jmeter.javadsl.core.controllers.DslModuleController;
import us.abstracta.jmeter.javadsl.core.controllers.DslProxyControl;
import us.abstracta.jmeter.javadsl.core.controllers.DslRecordingController;
import us.abstracta.jmeter.javadsl.core.controllers.DslTestFragmentController;
import us.abstracta.jmeter.javadsl.core.engines.JmeterEnvironment;
import us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement;
/**
* Generates DSL code from JMX files.
*
* Take into account that code generation is a continuous improving process, so please report any
* unexpected or missing conversions as issues in repository, so we keep improving it.
*
* Check {@link MethodCallBuilder} for instructions on how to implement DSL code generation for new
* DSL test elements.
*
* @see MethodCallBuilder
* @since 0.45
*/
public class DslCodeGenerator implements MethodCallBuilderRegistry {
private static final Logger LOG = LoggerFactory.getLogger(DslCodeGenerator.class);
private final List builders = new ArrayList<>();
private final Map, String> dependencies = new HashMap<>();
private final Map builderOptions = new HashMap<>();
public DslCodeGenerator() {
builders.addAll(findCallBuilders(JmeterDsl.class));
dependencies.put(JmeterDsl.class, "us.abstracta.jmeter:jmeter-java-dsl");
builders.add(new DslRecordingController.CodeBuilder());
builders.add(new DslProxyControl.CodeBuilder());
builders.add(new DslModuleController.CodeBuilder());
builders.add(new DslIncludeController.CodeBuilder());
builders.addAll(findCallBuilders(DslTestFragmentController.class));
sortBuilders();
}
private List findCallBuilders(Class... dslClasses) {
Map, List> builderMethods = findBuilderMethods(
dslClasses);
return builderMethods.entrySet().stream()
.map(e -> buildCallBuilder(e.getKey(), e.getValue()))
.filter(Objects::nonNull)
.collect(Collectors.toList());
}
private Map, List> findBuilderMethods(
Class... dslClasses) {
return Arrays.stream(dslClasses)
.flatMap(c -> Arrays.stream(c.getDeclaredMethods())
.filter(m -> Modifier.isPublic(m.getModifiers()) && Modifier.isStatic(m.getModifiers())
&& BaseTestElement.class.isAssignableFrom(m.getReturnType())))
.collect(Collectors.groupingBy(m -> (Class) m.getReturnType()));
}
private MethodCallBuilder buildCallBuilder(
Class testElementClass, List builderMethods) {
String builderClass = testElementClass.getName() + "$CodeBuilder";
try {
return (MethodCallBuilder) Class.forName(builderClass)
.getConstructor(List.class)
.newInstance(builderMethods);
} catch (ClassNotFoundException e) {
LOG.debug("No code builder associated to {}", testElementClass);
return null;
} catch (NoSuchMethodException | InvocationTargetException | InstantiationException
| IllegalAccessException e) {
throw new RuntimeException("Problem instantiating builder for " + builderClass
+ ". Check builder constructor with a list of methods and registry as parameters.", e);
}
}
private void sortBuilders() {
builders.sort(Comparator.comparing(MethodCallBuilder::order));
}
/**
* Allows registering DSL classes containing builder methods, which can be used to generate DSL
* code for.
*
* This method allows you to register DSL classes from none core modules or your own custom DSL
* classes. This is the way DslGenerators can discover new DSL test elements, and their associated
* MethodCallBuilder instances, to generate code for.
*
* @param dslClasses are the classes containing builder methods.
* @return the DslCodeGenerator instance for further configuration or usage.
*/
public DslCodeGenerator addBuildersFrom(Class... dslClasses) {
builders.addAll(findCallBuilders(dslClasses));
sortBuilders();
return this;
}
/**
* Allows registering MethodCallBuilders that are not associated to a DSL builder method.
*
* This is helpful when some element has no DSL builder method counterpart, but still there is a
* way to convert the element (eg: ignoring it all together, only converting children, etc).
*
* @param builders list of MethodCallBuilders to register into the generator.
* @return the DslCodeGenerator instance for further configuration or usage.
* @since 0.50
*/
public DslCodeGenerator addBuilders(MethodCallBuilder... builders) {
this.builders.addAll(Arrays.asList(builders));
sortBuilders();
return this;
}
/**
* Allows registering libraries required to use a specific class.
*
* @param dependencyClass is the class to register a library for.
* @param dependencyLocator the jbang
* library locator for the library containing the class.
* @return the DslCodeGenerator instance for further configuration or usage.
* @since 0.62
*/
public DslCodeGenerator addDependency(Class dependencyClass, String dependencyLocator) {
dependencies.put(dependencyClass, dependencyLocator);
return this;
}
/**
* Generates DSL code from JMX file.
*
* @param file is the JMX file from which DSL code will be generated.
* @return the generated DSL MethodCall used to generate code from.
* @throws IOException when there is some problem reading the file.
*/
public String generateCodeFromJmx(File file) throws IOException {
return TestClassTemplate.fromTestPlanMethodCall(buildMethodCallFromJmxFile(file), dependencies)
.solve();
}
public MethodCall buildMethodCallFromJmxFile(File file) throws IOException {
JmeterEnvironment env = new JmeterEnvironment();
HashTree tree = env.loadTree(new File(file.getPath()));
TestElement testPlanElem = (TestElement) tree.getArray()[0];
MethodCallContext ctx = new MethodCallContext(testPlanElem, tree.getTree(testPlanElem), null,
this);
builderOptions.forEach(ctx::setEntry);
return ctx.buildMethodCall();
}
@Override
public Optional findBuilderMatchingContext(MethodCallContext context) {
return builders.stream()
.filter(b -> b.matches(context))
.findAny();
}
@Override
public T findBuilderByClass(Class builderClass) {
return builders.stream()
.filter(builderClass::isInstance)
.map(builderClass::cast)
.findAny()
.orElse(null);
}
public DslCodeGenerator setBuilderOption(String optionName, Object optionValue) {
builderOptions.put(optionName, optionValue);
return this;
}
}