com.lazerycode.jmeter.configuration.JMeterArgumentsArray Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmeter-maven-plugin Show documentation
Show all versions of jmeter-maven-plugin Show documentation
A plugin to allow you to run JMeter tests with Maven.
package com.lazerycode.jmeter.configuration;
import org.apache.commons.io.FilenameUtils;
import org.apache.maven.plugin.MojoExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.List;
import java.util.TreeSet;
import static com.lazerycode.jmeter.configuration.JMeterCommandLineArguments.*;
import static com.lazerycode.jmeter.utility.UtilityFunctions.isNotSet;
import static com.lazerycode.jmeter.utility.UtilityFunctions.isSet;
/**
* Creates an arguments array to pass to the JMeter object to run tests.
*
* @author Mark Collin
*/
public class JMeterArgumentsArray {
private static final Logger LOGGER = LoggerFactory.getLogger(JMeterArgumentsArray.class);
private final String jMeterHome;
private boolean disableTests;
private final TreeSet argumentList = new TreeSet<>();
private DateTimeFormatter dateFormat = DateTimeFormatter.BASIC_ISO_DATE;
private ProxyConfiguration proxyConfiguration;
private boolean timestampResults = false;
private boolean appendTimestamp = false;
private String resultFileExtension = ".jtl";
private String remoteStartServerList;
private List customPropertiesFiles = new ArrayList<>();
private String testFile;
private String resultsLogFileName;
private String jmeterLogFileName;
private String logsDirectory;
private String resultsDirectory;
private String reportDirectory;
private LogLevel overrideRootLogLevel;
/**
* Create an instance of JMeterArgumentsArray
*
* @param disableGUI If GUI should be disabled or not
* @param jMeterHomeDirectory The JMETER_HOME directory, what JMeter bases its classpath on
* @throws MojoExecutionException Exception
*/
public JMeterArgumentsArray(boolean disableGUI, String jMeterHomeDirectory) throws MojoExecutionException {
if (isNotSet(jMeterHomeDirectory)) {
throw new MojoExecutionException("Unable to set JMeter Home Directory...");
}
jMeterHome = jMeterHomeDirectory;
argumentList.add(JMETER_HOME_OPT);
if (disableGUI) {
argumentList.add(NONGUI_OPT);
disableTests = false;
} else {
disableTests = true;
}
}
public JMeterArgumentsArray setRemoteStop() {
argumentList.add(REMOTE_STOP);
return this;
}
public JMeterArgumentsArray setRemoteStart() {
argumentList.add(REMOTE_OPT);
return this;
}
public JMeterArgumentsArray setRemoteStartServerList(String serverList) {
if (isNotSet(serverList)) return this;
remoteStartServerList = serverList;
argumentList.add(REMOTE_OPT_PARAM);
return this;
}
public JMeterArgumentsArray setProxyConfig(ProxyConfiguration configuration) {
if (configuration == null) return this;
this.proxyConfiguration = configuration;
if (isSet(proxyConfiguration.getHost())) {
argumentList.add(PROXY_HOST);
argumentList.add(PROXY_PORT);
}
if (isSet(proxyConfiguration.getUsername())) {
argumentList.add(PROXY_USERNAME);
}
if (isSet(proxyConfiguration.getPassword())) {
argumentList.add(PROXY_PASSWORD);
}
if (isSet(proxyConfiguration.getHostExclusions())) {
argumentList.add(NONPROXY_HOSTS);
}
return this;
}
public JMeterArgumentsArray addACustomPropertiesFiles(List customPropertiesFiles) {
if (isNotSet(customPropertiesFiles)) return this;
for (File customPropertiesFile : customPropertiesFiles) {
this.customPropertiesFiles.add(customPropertiesFile.getAbsolutePath());
argumentList.add(PROPFILE2_OPT);
}
return this;
}
public JMeterArgumentsArray setLogRootOverride(String requestedLogLevel) {
if (isNotSet(requestedLogLevel)) {
return this;
}
for (LogLevel logLevel : LogLevel.values()) {
if (logLevel.toString().equalsIgnoreCase(requestedLogLevel)) {
overrideRootLogLevel = logLevel;
argumentList.add(LOGLEVEL);
return this;
}
}
LOGGER.warn("Unknown log level {}", requestedLogLevel);
return this;
}
public JMeterArgumentsArray setResultsDirectory(String resultsDirectory) {
this.resultsDirectory = resultsDirectory;
return this;
}
public JMeterArgumentsArray setLogsDirectory(String logsDirectory) {
this.logsDirectory = logsDirectory;
return this;
}
public JMeterArgumentsArray setResultsTimestamp(boolean addTimestamp) {
timestampResults = addTimestamp;
return this;
}
public JMeterArgumentsArray setResultsFileNameDateFormat(String dateFormat) {
if (isSet(dateFormat)) {
try {
this.dateFormat = DateTimeFormatter.ofPattern(dateFormat);
} catch (Exception ex) {
LOGGER.error("'" + dateFormat + "' is an invalid DateTimeFormat. Defaulting to Standard ISO_8601.", ex);
}
}
return this;
}
public JMeterArgumentsArray appendTimestamp(boolean append) {
appendTimestamp = append;
return this;
}
public JMeterArgumentsArray setResultFileOutputFormatIsCSV(boolean isCSVFormat) {
if (isCSVFormat) {
resultFileExtension = ".csv";
} else {
resultFileExtension = ".jtl";
}
return this;
}
public JMeterArgumentsArray setTestFile(File value, File testFilesDirectory) {
if (isNotSet(value)) return this;
testFile = value.getAbsolutePath();
String resultFilename = FilenameUtils.removeExtension(testFilesDirectory.toURI().relativize(value.toURI()).getPath().replace("\\", "/").replace("/", "_")
);
resultsLogFileName = resultsDirectory + File.separator;
if (timestampResults) {
//TODO investigate when timestamp is generated.
if (appendTimestamp) {
resultsLogFileName += String.format("%s-%s%s", resultFilename, LocalDateTime.now().format(dateFormat), resultFileExtension);
} else {
resultsLogFileName += String.format("%s-%s%s", LocalDateTime.now().format(dateFormat), resultFilename, resultFileExtension);
}
} else {
resultsLogFileName += resultFilename + resultFileExtension;
}
if (isSet(logsDirectory)) {
jmeterLogFileName = logsDirectory + File.separator + value.getName() + ".log";
argumentList.add(JMLOGFILE_OPT);
}
argumentList.add(TESTFILE_OPT);
argumentList.add(LOGFILE_OPT);
disableTests = false;
return this;
}
public JMeterArgumentsArray setReportsDirectory(String reportDirectory) {
argumentList.add(REPORT_AT_END_OPT);
argumentList.add(REPORT_OUTPUT_FOLDER_OPT);
this.reportDirectory = reportDirectory;
return this;
}
public JMeterArgumentsArray setServerMode(String exportedHostname, int port) {
argumentList.add(SERVER_OPT);
disableTests = true;
if (isSet(logsDirectory)) {
if (null == exportedHostname) {
exportedHostname = "localhost";
}
jmeterLogFileName = logsDirectory + File.separator + String.format("%s_%s.log", exportedHostname, port);
argumentList.add(JMLOGFILE_OPT);
}
return this;
}
public String getResultsLogFileName() {
return resultsLogFileName;
}
/**
* Generate an arguments array representing the command line options you want to send to JMeter.
* The order of the array is determined by the order the values in JMeterCommandLineArguments are defined.
*
* @return An array representing the command line sent to JMeter
* @throws MojoExecutionException Exception
*/
public List buildArgumentsArray() throws MojoExecutionException {
if (!argumentList.contains(TESTFILE_OPT) && !disableTests) {
throw new MojoExecutionException("No test(s) specified!");
}
List argumentsArray = new ArrayList<>();
for (JMeterCommandLineArguments argument : argumentList) {
switch (argument) {
case NONGUI_OPT:
argumentsArray.add(NONGUI_OPT.getCommandLineArgument());
break;
case TESTFILE_OPT:
argumentsArray.add(TESTFILE_OPT.getCommandLineArgument());
argumentsArray.add(testFile);
break;
case LOGFILE_OPT:
argumentsArray.add(LOGFILE_OPT.getCommandLineArgument());
argumentsArray.add(resultsLogFileName);
break;
case JMETER_HOME_OPT:
argumentsArray.add(JMETER_HOME_OPT.getCommandLineArgument());
argumentsArray.add(jMeterHome);
break;
case LOGLEVEL:
argumentsArray.add(LOGLEVEL.getCommandLineArgument());
argumentsArray.add(overrideRootLogLevel.toString());
break;
case PROPFILE2_OPT:
for (String customPropertiesFile : customPropertiesFiles) {
argumentsArray.add(PROPFILE2_OPT.getCommandLineArgument());
argumentsArray.add(customPropertiesFile);
}
break;
case REMOTE_OPT:
argumentsArray.add(REMOTE_OPT.getCommandLineArgument());
break;
case PROXY_HOST:
argumentsArray.add(PROXY_HOST.getCommandLineArgument());
argumentsArray.add(proxyConfiguration.getHost());
break;
case PROXY_PORT:
argumentsArray.add(PROXY_PORT.getCommandLineArgument());
argumentsArray.add(proxyConfiguration.getPort());
break;
case PROXY_USERNAME:
argumentsArray.add(PROXY_USERNAME.getCommandLineArgument());
argumentsArray.add(proxyConfiguration.getUsername());
break;
case PROXY_PASSWORD:
argumentsArray.add(PROXY_PASSWORD.getCommandLineArgument());
argumentsArray.add(proxyConfiguration.getPassword());
break;
case NONPROXY_HOSTS:
argumentsArray.add(NONPROXY_HOSTS.getCommandLineArgument());
argumentsArray.add(proxyConfiguration.getHostExclusions());
break;
case REMOTE_STOP:
argumentsArray.add(REMOTE_STOP.getCommandLineArgument());
break;
case REMOTE_OPT_PARAM:
argumentsArray.add(REMOTE_OPT_PARAM.getCommandLineArgument());
argumentsArray.add(remoteStartServerList);
break;
case JMLOGFILE_OPT:
argumentsArray.add(JMLOGFILE_OPT.getCommandLineArgument());
argumentsArray.add(jmeterLogFileName);
break;
case REPORT_AT_END_OPT:
argumentsArray.add(REPORT_AT_END_OPT.getCommandLineArgument());
break;
case REPORT_OUTPUT_FOLDER_OPT:
argumentsArray.add(REPORT_OUTPUT_FOLDER_OPT.getCommandLineArgument());
argumentsArray.add(reportDirectory);
break;
case SERVER_OPT:
argumentsArray.add(SERVER_OPT.getCommandLineArgument());
break;
case SYSTEM_PROPFILE:
case JMETER_PROPERTY:
case JMETER_GLOBAL_PROP:
case SYSTEM_PROPERTY:
case VERSION_OPT:
case PROPFILE_OPT:
case REPORT_GENERATING_OPT:
case HELP_OPT:
//Unhandled options, they will be ignored
break;
}
}
return argumentsArray;
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy