com.lazerycode.jmeter.mojo

Class AbstractJMeterMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.lazerycode.jmeter.mojo.AbstractJMeterMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

CheckResultsMojo, ConfigureJMeterMojo, RunJMeterGUIMojo, RunJMeterMojo, RunJMeterServer

public abstract class AbstractJMeterMojo
extends org.apache.maven.plugin.AbstractMojo

JMeter Maven plugin. This is a base class for the JMeter mojos.

Author:

Tim McCune

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	appendResultsTimestamp Append the results timestamp to the filename (It will be prepended by default if testResultsTimestamp is set to true)
protected File	confFilesDirectory Path under which .conf files are stored.
protected List<File>	customPropertiesFiles Absolute path to JMeter custom (test dependent) properties file.
protected String	eventScheduleScript Perfana: schedule script with events, one event per line, such as: PT1M|scale-down|replicas=2
protected boolean	generateReports Generate JMeter Reports (this will force your .jtl's into .csv mode)
protected static String	JMETER_ARTIFACT_NAME
protected static String	JMETER_ARTIFACT_PREFIX
protected static String	JMETER_CONFIG_ARTIFACT_NAME
protected static String	JMETER_GROUP_ID
protected File	jmeterDirectory Place where the JMeter files will be generated.
protected JMeterProcessJVMSettings	jMeterProcessJVMSettings Value class that wraps all JMeter Process JVM settings.
protected static String	JORPHAN_ARTIFACT_NAME
protected static String	LINE_SEPARATOR
protected File	logsDirectory Set the directory that JMeter logs are saved to.
protected org.apache.maven.plugin.MojoExecution	mojoExecution The information extracted from the Mojo being currently executed
protected String	overrideRootLogLevel Set a root log level to override all log levels used by JMeter Valid log levels are: ERROR, WARN, INFO, DEBUG (They are not case sensitive); If you try to set an invalid log level it will be ignored
protected String	perfanaAnnotations Perfana: test run annotiations passed via environment variable
protected String	perfanaApplication Perfana: Name of application that is being tested.
protected String	perfanaApplicationRelease Perfana: the release number of the application.
protected boolean	perfanaAssertResultsEnabled Perfana: Parse the Perfana test asserts and fail build it not ok.
protected String	perfanaCIBuildResultsUrl Perfana: Build results url where to find the results of this load test.
protected String	perfanaConstantLoadTimeInSeconds Perfana: Constant load time in seconds.
protected boolean	perfanaEnabled Perfana: Enable calls to Perfana.
protected Map<String,Properties>	perfanaEventProperties Perfana: properties for perfana event implementations
protected String	perfanaRampupTimeInSeconds Perfana: Rampup time in seconds.
protected String	perfanaTestEnvironment Perfana: Test environment for this test.
protected String	perfanaTestRunId Perfana: Test run id.
protected String	perfanaTestType Perfana: Test type for this test.
protected String	perfanaUrl Perfana: Perfana url.
protected Properties	perfanaVariables Perfana: test run variables passed via environment variable
protected String	postTestPauseInSeconds Set a pause in seconds after each test that is run.
protected File	projectBuildDirectory The project build directory
protected ProxyConfiguration	proxyConfig Value class that wraps all proxy configurations.
protected RemoteConfiguration	remoteConfig Value class that wraps all remote configurations.
protected File	reportDirectory Set the directory that JMeter reports are saved to.
protected File	resultsDirectory Set the directory that JMeter results are saved to.
protected String	resultsFileNameDateFormat Set the format of the timestamp that is appended to the results filename.
protected org.apache.maven.settings.Settings	settings Maven settings
protected boolean	skipTests Skip the JMeter tests
protected boolean	suppressJMeterOutput Suppress JMeter output
protected String	testConfigFile The filename used to store the results config
protected File	testFilesBuildDirectory Set the directory that JMeter test files are copied into as part of the build.
protected File	testFilesDirectory Path under which JMX files are stored.
protected List<String>	testFilesExcluded Sets the list of exclude patterns to use in directory scan for JMX files.
protected List<String>	testFilesIncluded Sets the list of include patterns to use in directory scan for JMX files.
protected boolean	testResultsTimestamp Timestamp the test results.
protected boolean	useMavenProxy Use maven proxy configuration if no specific proxy configuration provided

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractJMeterMojo()

Method Summary

Modifier and Type	Method and Description
protected JMeterArgumentsArray	computeJMeterArgumentsArray(boolean disableGUI, boolean isCSVFormat) Generate the initial JMeter Arguments array that is used to create the command line that we pass to JMeter.
protected abstract void	doExecute()
void	execute()
protected void	loadMavenProxy() Try to load the active maven proxy.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SEPARATOR

protected static final String LINE_SEPARATOR

See Also:

Constant Field Values

JMETER_ARTIFACT_PREFIX

protected static final String JMETER_ARTIFACT_PREFIX

See Also:

Constant Field Values

JMETER_ARTIFACT_NAME

protected static final String JMETER_ARTIFACT_NAME

See Also:

Constant Field Values

JMETER_CONFIG_ARTIFACT_NAME

protected static final String JMETER_CONFIG_ARTIFACT_NAME

See Also:

Constant Field Values

JORPHAN_ARTIFACT_NAME

protected static final String JORPHAN_ARTIFACT_NAME

See Also:

Constant Field Values

JMETER_GROUP_ID

protected static final String JMETER_GROUP_ID

See Also:

Constant Field Values

testFilesIncluded

@Parameter
protected List<String> testFilesIncluded

Sets the list of include patterns to use in directory scan for JMX files. Relative to testFilesDirectory.

testFilesExcluded

@Parameter
protected List<String> testFilesExcluded

Sets the list of exclude patterns to use in directory scan for JMX files. Relative to testFilesDirectory.

confFilesDirectory

@Parameter(defaultValue="${basedir}/src/test/conf")
protected File confFilesDirectory

Path under which .conf files are stored.

testFilesDirectory

@Parameter(defaultValue="${basedir}/src/test/jmeter")
protected File testFilesDirectory

Path under which JMX files are stored.

testResultsTimestamp

@Parameter(defaultValue="true")
protected boolean testResultsTimestamp

Timestamp the test results.

appendResultsTimestamp

@Parameter(defaultValue="false")
protected boolean appendResultsTimestamp

Append the results timestamp to the filename (It will be prepended by default if testResultsTimestamp is set to true)

resultsFileNameDateFormat

@Parameter
protected String resultsFileNameDateFormat

Set the format of the timestamp that is appended to the results filename. (This assumes that testResultsTimestamp is set to 'true') For formatting see http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html

resultsDirectory

@Parameter(defaultValue="${project.build.directory}/jmeter/results")
protected File resultsDirectory

Set the directory that JMeter results are saved to.

generateReports

@Parameter(defaultValue="true")
protected boolean generateReports

Generate JMeter Reports (this will force your .jtl's into .csv mode)

reportDirectory

@Parameter(defaultValue="${project.build.directory}/jmeter/reports")
protected File reportDirectory

Set the directory that JMeter reports are saved to.

testFilesBuildDirectory

@Parameter(defaultValue="${project.build.directory}/jmeter/testFiles")
protected File testFilesBuildDirectory

Set the directory that JMeter test files are copied into as part of the build.

logsDirectory

@Parameter(defaultValue="${project.build.directory}/jmeter/logs")
protected File logsDirectory

Set the directory that JMeter logs are saved to.

customPropertiesFiles

@Parameter
protected List<File> customPropertiesFiles

Absolute path to JMeter custom (test dependent) properties file.

useMavenProxy

@Parameter
protected boolean useMavenProxy

Use maven proxy configuration if no specific proxy configuration provided

settings

@Parameter(defaultValue="${settings}",
           readonly=true)
protected org.apache.maven.settings.Settings settings

Maven settings

proxyConfig

@Parameter
protected ProxyConfiguration proxyConfig

Value class that wraps all proxy configurations.

remoteConfig

@Parameter
protected RemoteConfiguration remoteConfig

Value class that wraps all remote configurations.

jMeterProcessJVMSettings

@Parameter
protected JMeterProcessJVMSettings jMeterProcessJVMSettings

Value class that wraps all JMeter Process JVM settings.

overrideRootLogLevel

@Parameter
protected String overrideRootLogLevel

Set a root log level to override all log levels used by JMeter Valid log levels are: ERROR, WARN, INFO, DEBUG (They are not case sensitive); If you try to set an invalid log level it will be ignored

suppressJMeterOutput

@Parameter(defaultValue="false")
protected boolean suppressJMeterOutput

Suppress JMeter output

mojoExecution

@Parameter(defaultValue="${mojoExecution}",
           required=true,
           readonly=true)
protected org.apache.maven.plugin.MojoExecution mojoExecution

The information extracted from the Mojo being currently executed

skipTests

@Parameter(defaultValue="${skipTests}")
protected boolean skipTests

Skip the JMeter tests

postTestPauseInSeconds

@Parameter(defaultValue="0")
protected String postTestPauseInSeconds

Set a pause in seconds after each test that is run.

testConfigFile

@Parameter(defaultValue="${project.build.directory}/config.json")
protected String testConfigFile

The filename used to store the results config

jmeterDirectory

@Parameter(defaultValue="${project.build.directory}/jmeter")
protected File jmeterDirectory

Place where the JMeter files will be generated.

projectBuildDirectory

@Parameter(defaultValue="${project.build.directory}")
protected File projectBuildDirectory

The project build directory

perfanaApplication

@Parameter(defaultValue="UNKNOWN_APPLICATION")
protected String perfanaApplication

Perfana: Name of application that is being tested.

perfanaTestType

@Parameter(defaultValue="UNKNOWN_TEST_TYPE")
protected String perfanaTestType

Perfana: Test type for this test.

perfanaTestEnvironment

@Parameter(defaultValue="UNKNOWN_TEST_ENVIRONMENT")
protected String perfanaTestEnvironment

Perfana: Test environment for this test.

perfanaTestRunId

@Parameter(defaultValue="UNKNOWN_TEST_RUN_ID")
protected String perfanaTestRunId

Perfana: Test run id.

perfanaCIBuildResultsUrl

@Parameter
protected String perfanaCIBuildResultsUrl

Perfana: Build results url where to find the results of this load test.

perfanaUrl

@Parameter(defaultValue="UNKNOWN_PERFANA_URL")
protected String perfanaUrl

Perfana: Perfana url.

perfanaApplicationRelease

@Parameter(defaultValue="UNKNOWN_APPLICATION_RELEASE")
protected String perfanaApplicationRelease

Perfana: the release number of the application.

perfanaRampupTimeInSeconds

@Parameter(defaultValue="0")
protected String perfanaRampupTimeInSeconds

Perfana: Rampup time in seconds.

perfanaConstantLoadTimeInSeconds

@Parameter(defaultValue="120")
protected String perfanaConstantLoadTimeInSeconds

Perfana: Constant load time in seconds.

perfanaAssertResultsEnabled

@Parameter(defaultValue="false")
protected boolean perfanaAssertResultsEnabled

Perfana: Parse the Perfana test asserts and fail build it not ok.

perfanaEnabled

@Parameter(defaultValue="false")
protected boolean perfanaEnabled

Perfana: Enable calls to Perfana.

perfanaAnnotations

@Parameter
protected String perfanaAnnotations

Perfana: test run annotiations passed via environment variable

perfanaVariables

@Parameter
protected Properties perfanaVariables

Perfana: test run variables passed via environment variable

perfanaEventProperties

@Parameter
protected Map<String,Properties> perfanaEventProperties

Perfana: properties for perfana event implementations

eventScheduleScript

@Parameter
protected String eventScheduleScript

Perfana: schedule script with events, one event per line, such as: PT1M|scale-down|replicas=2

Constructor Detail

AbstractJMeterMojo

public AbstractJMeterMojo()

Method Detail

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

doExecute

protected abstract void doExecute()
                           throws org.apache.maven.plugin.MojoExecutionException,
                                  org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

computeJMeterArgumentsArray

protected JMeterArgumentsArray computeJMeterArgumentsArray(boolean disableGUI,
                                                           boolean isCSVFormat)
                                                    throws org.apache.maven.plugin.MojoExecutionException

Generate the initial JMeter Arguments array that is used to create the command line that we pass to JMeter.

Throws:

org.apache.maven.plugin.MojoExecutionException

loadMavenProxy

protected void loadMavenProxy()

Try to load the active maven proxy.