-
- All Implemented Interfaces:
-
kotlin.Comparable,org.gradle.api.Task,org.gradle.api.internal.DynamicObjectAware,org.gradle.api.internal.IConventionAware,org.gradle.api.internal.TaskInternal,org.gradle.api.plugins.ExtensionAware,org.gradle.process.BaseExecSpec,org.gradle.process.JavaExecSpec,org.gradle.process.JavaForkOptions,org.gradle.process.ProcessForkOptions,org.gradle.util.Configurable
@DisableCachingByDefault(because = Would love to execute jmeter tests more than once;)) public class JMeterRunTask extends JMeterExecBaseTask
Task to execute jmeter through cli mode (no gui).
This is the preferred way to run performance tests.
-
-
Field Summary
Fields Modifier and Type Field Description private final RegularFilePropertyglobalPropertiesFileprivate final MapProperty<String, String>globalPropertiesprivate BooleangenerateReportprivate final DirectoryPropertycustomReportTemplateDirectoryprivate final DirectoryPropertyresultDirectoryprivate final DirectoryPropertyreportDirprivate BooleandeleteResultsprivate final ConfigurableFileCollectionjmSystemPropertyFilesprivate final MapProperty<String, String>jmSystemPropertiesprivate final RegularFilePropertymainPropertyFileprivate final ConfigurableFileCollectionadditionalPropertyFilesprivate final MapProperty<String, String>jmeterPropertiesprivate final RegularFilePropertylogOutputFileprivate final Property<String>jmxFileprivate final Property<String>maxHeap
-
Constructor Summary
Constructors Constructor Description JMeterRunTask()
-
Method Summary
Modifier and Type Method Description final RegularFilePropertygetGlobalPropertiesFile()Path to a JMeter property file which will be sent to all remote server. final MapProperty<String, String>getGlobalProperties()Dedicated user properties send to all remote server. final BooleangetGenerateReport()If truethe report will automatically be generated after executions.final UnitsetGenerateReport(@Input() Boolean generateReport)If truethe report will automatically be generated after executions.final DirectoryPropertygetCustomReportTemplateDirectory()Path to a custom report-template folder used by report generator. final DirectoryPropertygetResultDirectory()Directory where to store the results. final DirectoryPropertygetReportDir()Directory where to create the report. final BooleangetDeleteResults()Force jmeter to delete/override any existing output. final UnitsetDeleteResults(@Input() Boolean deleteResults)Force jmeter to delete/override any existing output. final ConfigurableFileCollectiongetJmSystemPropertyFiles()final MapProperty<String, String>getJmSystemProperties()final RegularFilePropertygetMainPropertyFile()Main jmeter property file. final ConfigurableFileCollectiongetAdditionalPropertyFiles()Additional property files. final MapProperty<String, String>getJmeterProperties()Dedicated properties send to local JMeter only. final RegularFilePropertygetLogOutputFile()File where jmeter log will be written to. final Property<String>getJmxFile()The jmx-file to use. final Property<String>getMaxHeap()Inherited from JMeterExtension.maxHeap final UnitsetGlobalPropertyFile(String file)final UnitsetGlobalProperties(List<String> keyValues)-
Methods inherited from class de.qualersoft.jmeter.gradleplugin.task.JMeterExecBaseTask
exec, setAdditionalPropertyFiles, setJmSystemProperties, setJmSystemPropertyFiles, setJmeterProperties, setMainPropertyFile -
Methods inherited from class org.gradle.api.internal.ConventionTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService -
Methods inherited from class org.gradle.api.DefaultTask
appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects -
Methods inherited from class org.gradle.api.tasks.JavaExec
conventionMapping, conventionMapping, getConventionMapping -
Methods inherited from class de.qualersoft.jmeter.gradleplugin.task.JMeterBaseTask
args, args, bootstrapClasspath, classpath, copyTo, copyTo, debugOptions, environment, environment, executable, getAllJvmArgs, getArgs, getArgumentProviders, getBootstrapClasspath, getClasspath, getCommandLine, getDebug, getDebugOptions, getDefaultCharacterEncoding, getEnableAssertions, getEnvironment, getErrorOutput, getExecActionFactory, getExecutable, getExecutionResult, getJavaLauncher, getJavaVersion, getJvmArgs, getJvmArgumentProviders, getMain, getMainClass, getMainModule, getMaxHeapSize, getMinHeapSize, getModularity, getObjectFactory, getProviderFactory, getStandardInput, getStandardOutput, getSystemProperties, getWorkingDir, isIgnoreExitValue, jvmArgs, jvmArgs, setAllJvmArgs, setAllJvmArgs, setArgs, setArgs, setArgsString, setBootstrapClasspath, setClasspath, setDebug, setDefaultCharacterEncoding, setEnableAssertions, setEnvironment, setErrorOutput, setExecutable, setExecutable, setIgnoreExitValue, setJvmArgs, setJvmArgs, setMain, setMaxHeapSize, setMinHeapSize, setStandardInput, setStandardOutput, setSystemProperties, setWorkingDir, setWorkingDir, systemProperties, systemProperty, workingDir -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getGlobalPropertiesFile
final RegularFileProperty getGlobalPropertiesFile()
Path to a JMeter property file which will be sent to all remote server.
Inherited from JMeterExtension.globalPropertiesFile
-
getGlobalProperties
final MapProperty<String, String> getGlobalProperties()
Dedicated user properties send to all remote server.
Inherited from JMeterExtension.globalProperties
-
getGenerateReport
final Boolean getGenerateReport()
If
truethe report will automatically be generated after executions.Remark: Consider to also enable deleteResults to avoid failures on rerun.
Defaults to
false
-
setGenerateReport
final Unit setGenerateReport(@Input() Boolean generateReport)
If
truethe report will automatically be generated after executions.Remark: Consider to also enable deleteResults to avoid failures on rerun.
Defaults to
false
-
getCustomReportTemplateDirectory
final DirectoryProperty getCustomReportTemplateDirectory()
Path to a custom report-template folder used by report generator.
Inherited from JMeterExtension.customReportTemplateDirectory.
-
getResultDirectory
final DirectoryProperty getResultDirectory()
Directory where to store the results.
Inherited from JMeterExtension.resultDir
-
getReportDir
final DirectoryProperty getReportDir()
Directory where to create the report.
Inherited from JMeterExtension.reportDir
-
getDeleteResults
final Boolean getDeleteResults()
Force jmeter to delete/override any existing output. If
falsebut output exists, jmeter fails!Defaults to
false
-
setDeleteResults
final Unit setDeleteResults(@Input() Boolean deleteResults)
Force jmeter to delete/override any existing output. If
falsebut output exists, jmeter fails!Defaults to
false
-
getJmSystemPropertyFiles
final ConfigurableFileCollection getJmSystemPropertyFiles()
-
getJmSystemProperties
final MapProperty<String, String> getJmSystemProperties()
-
getMainPropertyFile
final RegularFileProperty getMainPropertyFile()
Main jmeter property file.
Inherited from JMeterExtension.mainPropertyFile.
-
getAdditionalPropertyFiles
final ConfigurableFileCollection getAdditionalPropertyFiles()
Additional property files.
Inherited from JMeterExtension.additionalPropertyFiles. To override use
setFrom, to extend usefrom.
-
getJmeterProperties
final MapProperty<String, String> getJmeterProperties()
Dedicated properties send to local JMeter only.
Inherited from JMeterExtension.jmeterProperties.
-
getLogOutputFile
final RegularFileProperty getLogOutputFile()
File where jmeter log will be written to.
Inherited from JMeterExtension.logOutputFile.
-
getJmxFile
final Property<String> getJmxFile()
The jmx-file to use. Absolute or relative file. If relative it will be resolved against JMeterExtension.jmxRootDir. Attention: Even if optional, Run and Report tasks require it!
-
getMaxHeap
final Property<String> getMaxHeap()
Inherited from JMeterExtension.maxHeap
-
setGlobalPropertyFile
final Unit setGlobalPropertyFile(String file)
-
setGlobalProperties
final Unit setGlobalProperties(List<String> keyValues)
-
-
-
-