com.lazerycode.jmeter

Class JMeterAbstractMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.lazerycode.jmeter.JMeterAbstractMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

JMeterGUIMojo, JMeterMojo

public abstract class JMeterAbstractMojo
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	binDir Other directories will be created by this plugin and used by JMeter
protected File	customPropertiesFile Absolute path to JMeter custom (test dependent) properties file.
protected boolean	ignoreResultFailures Sets whether FailureScanner should ignore failures in JMeter result file.
protected String	jmeterConfigArtifact All property files are stored in this artifact, comes with JMeter library
protected Set<JMeterPlugins>	jmeterPlugins Value class that wraps all remote configurations.
protected JMeterProcessJVMSettings	jMeterProcessJVMSettings Value class that wraps all JMeter Process JVM settings.
protected File	libDir
protected File	libExtDir
protected String	logConfigFilename Name of advanced logging configuration file that is in the Defaults to "logkit.xml"
protected File	logsDir
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: FATAL_ERROR, ERROR, WARN, INFO, DEBUG (They are not case sensitive); If you try to set an invalid log level it will be ignored
protected List<org.apache.maven.artifact.Artifact>	pluginArtifacts Get a list of artifacts used by this plugin
protected PropertyHandler	pluginProperties
protected Map<String,String>	propertiesGlobal JMeter Global Properties that override those given in jmeterProps.
protected Map<String,String>	propertiesJMeter Absolute path to JMeter custom (test dependent) properties file.
protected boolean	propertiesReplacedByCustomFiles Replace the default JMeter properties with any custom properties files supplied.
protected Map<String,String>	propertiesSaveService JMeter Properties that are merged with precedence into default JMeter file in saveservice.properties
protected Map<String,String>	propertiesSystem (Java) System properties set for the test run.
protected Map<String,String>	propertiesUpgrade JMeter Properties that are merged with precedence into default JMeter file in upgrade.properties
protected Map<String,String>	propertiesUser JMeter Properties that are merged with precedence into default JMeter file in user.properties user.properties takes precedence over jmeter.properties
protected ProxyConfiguration	proxyConfig Value class that wraps all proxy configurations.
protected RemoteConfiguration	remoteConfig Value class that wraps all remote configurations.
protected File	resultsDir
protected String	resultsDirectory Set the directory that JMeter results are saved to.
protected String	resultsFileFormat Set the format of the results generated by JMeter Valid values are: xml, csv (XML set by default).
protected String	resultsFileNameDateFormat Set the format of the timestamp that is appended to the results filename.
protected boolean	resultsOutputIsCSVFormat
protected boolean	skipTests Skip the JMeter tests
protected boolean	suppressJMeterOutput Suppress JMeter output
protected JMeterArgumentsArray	testArgs
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 Test 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 File	workDir Place where the JMeter files will be generated.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
JMeterAbstractMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureAdvancedLogging()
protected void	generateJMeterDirectoryTree() Generate the directory tree utilised by JMeter.
protected org.apache.maven.artifact.Artifact	getArtifactNamed(String artifactName) Search the list of plugin artifacts for an artifact with a specific name
protected void	initialiseJMeterArgumentsArray(boolean disableGUI) Generate the initial JMeter Arguments array that is used to create the command line that we pass to JMeter.
protected boolean	isArtifactAJMeterDependency(org.apache.maven.artifact.Artifact artifact) Work out if an artifact is a JMeter dependency
protected boolean	isArtifactAnExplicitDependency(org.apache.maven.artifact.Artifact artifact) Check if the given artifact is needed by an explicit dependency (a dependency, that is explicitly defined in the pom of the project using the jmeter-maven-plugin).
protected boolean	isArtifactMarkedAsAJMeterPlugin(org.apache.maven.artifact.Artifact artifact)
protected void	populateJMeterDirectoryTree() Create the JMeter directory tree and copy all compile time JMeter dependencies into it.
protected void	propertyConfiguration()
protected void	setJMeterResultFileFormat()

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

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

execute

Field Detail

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 Test files. Relative to testFilesDirectory.

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

resultsFileFormat

@Parameter(defaultValue="xml")
protected String resultsFileFormat

Set the format of the results generated by JMeter Valid values are: xml, csv (XML set by default).

resultsDirectory

@Parameter
protected String resultsDirectory

Set the directory that JMeter results are saved to.

propertiesJMeter

@Parameter
protected Map<String,String> propertiesJMeter

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

propertiesSaveService

@Parameter
protected Map<String,String> propertiesSaveService

JMeter Properties that are merged with precedence into default JMeter file in saveservice.properties

propertiesUpgrade

@Parameter
protected Map<String,String> propertiesUpgrade

JMeter Properties that are merged with precedence into default JMeter file in upgrade.properties

propertiesUser

@Parameter
protected Map<String,String> propertiesUser

JMeter Properties that are merged with precedence into default JMeter file in user.properties user.properties takes precedence over jmeter.properties

propertiesGlobal

@Parameter
protected Map<String,String> propertiesGlobal

JMeter Global Properties that override those given in jmeterProps.
This sets local and remote properties (JMeter's definition of global properties is actually remote properties) and overrides any local/remote properties already set

propertiesSystem

@Parameter
protected Map<String,String> propertiesSystem

(Java) System properties set for the test run. Properties are merged with precedence into default JMeter file system.properties

customPropertiesFile

@Parameter
protected File customPropertiesFile

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

propertiesReplacedByCustomFiles

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

Replace the default JMeter properties with any custom properties files supplied. (If set to false any custom properties files will be merged with the default JMeter properties files, custom properties will overwrite default ones)

proxyConfig

@Parameter
protected ProxyConfiguration proxyConfig

Value class that wraps all proxy configurations.

remoteConfig

@Parameter
protected RemoteConfiguration remoteConfig

Value class that wraps all remote configurations.

jmeterPlugins

@Parameter
protected Set<JMeterPlugins> jmeterPlugins

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: FATAL_ERROR, ERROR, WARN, INFO, DEBUG (They are not case sensitive); If you try to set an invalid log level it will be ignored

logConfigFilename

@Parameter(defaultValue="logkit.xml")
protected String logConfigFilename

Name of advanced logging configuration file that is in the Defaults to "logkit.xml"

ignoreResultFailures

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

Sets whether FailureScanner should ignore failures in JMeter result file. Failures are for example failed requests

suppressJMeterOutput

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

Suppress JMeter output

pluginArtifacts

@Parameter(defaultValue="${plugin.artifacts}",
           required=true,
           readonly=true)
protected List<org.apache.maven.artifact.Artifact> pluginArtifacts

Get a list of artifacts used by this plugin

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="false")
protected boolean skipTests

Skip the JMeter tests

workDir

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

Place where the JMeter files will be generated.

binDir

protected File binDir

Other directories will be created by this plugin and used by JMeter

libDir

protected File libDir

libExtDir

protected File libExtDir

logsDir

protected File logsDir

resultsDir

protected File resultsDir

jmeterConfigArtifact

protected final String jmeterConfigArtifact

All property files are stored in this artifact, comes with JMeter library

See Also:

Constant Field Values

testArgs

protected JMeterArgumentsArray testArgs

pluginProperties

protected PropertyHandler pluginProperties

resultsOutputIsCSVFormat

protected boolean resultsOutputIsCSVFormat

Constructor Detail

JMeterAbstractMojo

public JMeterAbstractMojo()

Method Detail

generateJMeterDirectoryTree

protected void generateJMeterDirectoryTree()

Generate the directory tree utilised by JMeter.

propertyConfiguration

protected void propertyConfiguration()
                              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

populateJMeterDirectoryTree

protected void populateJMeterDirectoryTree()
                                    throws org.apache.maven.plugin.MojoExecutionException

Create the JMeter directory tree and copy all compile time JMeter dependencies into it. Generic compile time artifacts are copied into the libDir ApacheJMeter_* artifacts are copied into the libExtDir Runtime dependencies set by the user are also copied into the libExtDir

Throws:

org.apache.maven.plugin.MojoExecutionException

isArtifactMarkedAsAJMeterPlugin

protected boolean isArtifactMarkedAsAJMeterPlugin(org.apache.maven.artifact.Artifact artifact)

isArtifactAnExplicitDependency

protected boolean isArtifactAnExplicitDependency(org.apache.maven.artifact.Artifact artifact)

Check if the given artifact is needed by an explicit dependency (a dependency, that is explicitly defined in the pom of the project using the jmeter-maven-plugin).

Parameters:

artifact - Artifact to examine

Returns:

true if the given artifact is needed by a explicit dependency.

isArtifactAJMeterDependency

protected boolean isArtifactAJMeterDependency(org.apache.maven.artifact.Artifact artifact)

Work out if an artifact is a JMeter dependency

Parameters:

artifact - Artifact to examine

Returns:

true if a Jmeter dependency, false if a plugin dependency.

getArtifactNamed

protected org.apache.maven.artifact.Artifact getArtifactNamed(String artifactName)
                                                       throws org.apache.maven.plugin.MojoExecutionException

Search the list of plugin artifacts for an artifact with a specific name

Parameters:

artifactName -

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

initialiseJMeterArgumentsArray

protected void initialiseJMeterArgumentsArray(boolean disableGUI)
                                       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

setJMeterResultFileFormat

protected void setJMeterResultFileFormat()

configureAdvancedLogging

protected void configureAdvancedLogging()
                                 throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException