JayStGelais/gatling-gradle-plugin

Gatling Gradle Plugin

The gatling gradle plugin provides the ability to run gatling scenarios directly from a gradle build. The plugin utilizes the gatling cli provided by gatling.

Using the Plugin

The following gradle configuration will execute the gatling scenarios "MyAwesomeSimulation" and "MyCoolSimulation" using bodies in the "bodies" directory, data in the "data" directory, and the configuration file "resources/gatling.conf". Reports will be stores in the "reports" directory. The plugin will also check for KOed requests, and compare request times to previous request times.

apply plugin: 'scala'

buildscript {
    repositories {
        jcenter()
    }

    dependencies {
        classpath 'com.commercehub:gatling-gradle-plugin:2.0'
    }

}

repositories {
    jcenter()
}

ext {
    SCALA_VERSION = "2.11.7"
    GATLING_VERSION = "2.2.0-M3"
}

dependencies {
    compile "org.scala-lang:scala-library:${SCALA_VERSION}"
    testCompile "io.gatling:gatling-http:${GATLING_VERSION}"
    testCompile "io.gatling:gatling-core:${GATLING_VERSION}"
    testCompile "io.gatling.highcharts:gatling-charts-highcharts:${GATLING_VERSION}"
    testCompile "io.gatling:gatling-app:${GATLING_VERSION}"
}


apply plugin: 'gatling'

gatling {
    checkForKOs = true
    koThreshold = 0

    metrics {
        graphiteUrl = "http://my.graphite.server.com"
        metricPrefix = 'my-namespace'
    }
}

import com.commercehub.gradle.plugin.GatlingTask
task loadTest(type: GatlingTask, dependsOn: ['testClasses']) {
    gatlingSimulation = 'MyGatlingTest'
    metrics {
        metricsToCheck = ['myapp:pageresponsetime']
        daysToCheck = 5
        degradationTolerance = 0.50
    }
    jvmOptions {
        minHeapSize = "1024m"
        maxHeapSize = "1024m"
        systemProperty 'some.custom.setting', 'value'
    }
}

Running the following command will execute the gatling task defined above:

gradle(w) loadTest

GatlingTest Task Configuration

All task paramters except for sourceSet, gatlingSimulation and jvmOptions can be configured at the 'gatling' extension level to provide global defaults.

• sourceSet : Project source set containing gatling simulation to run. Defaults to project.sourceSets.test.
• gatlingSimulation : The list of scenarios to run.
• failBuild : Sets whether or not a failed load test should fail/stop the build. Defaults to true.
• checkForKOs : Set whether or not to check for KOed requests. Defaults to true.
• koThreshold : Number of KOs that will be allowed before the build is considered failed. Defaults to 0.
• gatlingDataDir : The directory containing gatling data files. Defaults to $projectRoot/data.
• gatlingBodiesDir : The directory containing gatling bodies files. Defaults to $projectRoot/user-files/request-bodies.
• gatlingReportsDir : The directory where gatling reports will be dropped. Defaults to $projectRoot/build/reports.
• gatlingConfFile : The gatling conf file to use. Defaults to $projectRoot/resources/gatling.conf.
• metrics : Nested configuration closure configuring performance metrics checks.
• jvmOptions : Nested configuration of type JavaForkOptions

Configuring checking of performance metrics in graphite

• graphiteUrl : The graphite base url.
• graphiteMetricPrefix : prefix to add to the graphite metric.
• metricsToCheck : The list of graphite metrics to check. Metrics in this list will be pre-pended with. gatling.<graphiteMetricPrefix>.<gatlingSimulation(lowercase)>.
• numberOfDaysToCheck : Number of previous days to compare the current run to. If this value is 0, no check will occur. Must be a positive integer. Defaults to 0.
• degradationTolerance : Percentage threshold for which the current average response times for a metric cannot exceed historical averages. Defaults to 0.5, for 50%.