Code Monkey home page Code Monkey logo

gradle-gatling-plugin's Introduction

Gatling Plugin for Gradle

Installation

Follow the steps described at Gradle Plugin Portal page.

Compatibility

Plugin versioning

Since Gatling v3.0.0 this plugin’s major version follows Gatling 's major version for making things easier.

Source code layout

Since Gatling v3.0.0 and corresponding plugin version v3.x.x there were breaking changes introduced for source code layout. Check corresponding section for details and original Gatling issue explaining the scope of changes.

Source files layout

Plugin creates dedicated Gradle sourceSet named gatling. This source set is used for storing simulations and Gatling configs. Following directories are configured by default.

Directory Purpose

src/gatling/simulations

Simulation sources (Scala code)

src/gatling/resources

Resources (feeders, configuration, bodies, etc)

Using Gradle API file locations can be customized.

builld.gradle
sourceSets {
  gatling {
    scala.srcDir "folder1" (1)
    // or
    scala.srcDirs = ["folder1"] (2)

    resources.srcDir "folder2" (3)
    // or
    resources.srcDirs = ["folder2"] (4)
  }
}

  1. append folder1 as an extra simulations folder.

  2. use folder1 as a single source of simulations.

  3. append folder2 as an extra Gatling resources folder.

  4. use folder2 as a single source of Gatling resources.

Plugin configuration

The plugin defines the following extension properties in the gatling closure

Property name Type Default value Description

toolVersion

String

'3.2.1'

Gatling version

logLevel

String

'WARN'

The default Gatling console log level if no logback.xml present in the configutation folder

includeMainOutput

Boolean

true

Include main source set output to gatlingCompile

includeTestOutput

Boolean

true

Include test source set output to gatlingCompile

scalaVersion

String

'2.12.8'

scala version that fits your Gatling tool version

jvmArgs

List<String>

 
['-server', '-Xmx1G',
'-XX:+UseG1GC', '-XX:MaxGCPauseMillis=30',
'-XX:G1HeapRegionSize=16m',
'-XX:InitiatingHeapOccupancyPercent=75',
'-XX:+ParallelRefProcEnabled',
'-XX:+PerfDisableSharedMem',
'-XX:+AggressiveOpts',
'-XX:+OptimizeStringConcat',
'-XX:+HeapDumpOnOutOfMemoryError']

Additional arguments passed to JVM when executing Gatling simulations

systemProperties

Map<String, Object>

 
['java.net.preferIPv4Stack': true,
'java.net.preferIPv6Addresses': false]

Additional systems properties passed to JVM together with caller JVM system properties

simulations

Closure

 
{ include "**/*Simulation*.scala" }

Simulations filter. See Gradle docs for details.

Examples

Overriding Gatling version, JVM arguments and system properties
gatling {
  toolVersion = '3.2.1'
  jvmArgs = [ '-server', '-Xms512M', '-Xmx512M' ]
  systemProperties = ['file.encoding': 'UTF-8']
}
Filtering simulations
gatling {
  simulations = {
    include "**/package1/*Simu.scala"    (1)
    include "**/package2/*Simulation.scala"  (2)
  }
}

  1. all Scala files from plugin simulation dir subfolder package1 ending with Simu.

  2. all Scala files from plugin simulation dir subfolder package2 ending with Simulation.

Gatling configuration

Override gatling.conf

To override default parameters of Gatling just put own version of gatling.conf into src/gatling/resources.

Logging

Gatling uses logback to customize its output. To change logging behaviour, put your logback.xml into resources folder, src/gatling/resources.

If no custom logback.xml provided, by default plugin will implicitly use following configuration.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
      <immediateFlush>false</immediateFlush>
    </encoder>
  </appender>
  <root level="${logLevel}"> (1)
    <appender-ref ref="CONSOLE"/>
  </root>
</configuration>

  1. logLevel is configured via plugin extension, WARN by default.

Dependency management

This plugin defines three Gradle configurations gatling, gatlingCompile and gatlingRuntime. By default plugin adds Gatling libraries to gatling configuration. Configurations gatlingCompile and gatlingRuntime extend gatling, i.e. all dependencies declared in gatling will be inherited.

Also project classes (src/main) and tests classes (src/test) are added to gatlingCompile and gatlingRuntime classpath, so you can reuse existing production and test code in your simulations.

If you don’t need such behaviour, you can use flags:

Example
gatling {
  // do not include classes and resources from src/main
  includeMainOutput = false
  // do not include classes and resources from src/test
  includeTestOutput = false
}

Additional dependencies can be added by plugin’s users to any of configurations mentioned above.

Example
dependencies {
  gatling 'com.google.code.gson:gson:2.8.0' (1)
  gatlingCompile 'org.apache.commons:commons-lang3:3.4' (2)
  gatlingRuntime 'cglib:cglib-nodep:3.2.0' (3)
}

  1. adding gson library, available both in compile and runtime classpath.

  2. adding commons-lang3 to compile classpath for simulations.

  3. adding cglib to runtime classpath for simulations.

Tasks

Plugin provides GatlingRunTask that is responsible for executing Gatling simulations. Users may create own instances of this task to run particular simulations.

Following configuration options are available. Those options are similar to global gatling configurations. Options are used in a fallback manner, i.e. if option is not set the value from gatling global config is taken.

Property name Type Default value Description

jvmArgs

List<String>

null

Additional arguments passed to JVM when executing Gatling simulations

systemProperties

Map<String, Object>

null

Additional systems properties passed to JVM together with caller JVM system properties

simulations

Closure

null

Simulations filter. See Gradle docs for details.

Default tasks

Task name Type Description

gatlingClasses

-

Compiles Gatling simulation and copies resources

gatlingRun

GatlingRunTask

Executes all Gatling simulations configured by extension

gatlingRun-SimulationFQN

GatlingRunTask

Executes single Gatling simulation,
SimulationFQN should be replaced by fully qualified simulation class name.

Examples

Run all simulations
$ gradle gatlingRun
Run single simulation implemented in com.project.simu.MySimulation class
$ gradle gatlingRun-com.project.simu.MySimulation

Release a new version

  1. NodeJS and Npm must be installed.

  2. Create GitHub access token. Only repo scope is required.

  3. Install release-it

    $ npm install -g release-it @release-it/conventional-changelog

  4. Run

    $ env GITHUB_TOKEN=${....} release-it --ci patch (1) (2)

    1. paste token value from step 2

    2. can be patch, minor, major

  5. Release script will create and push tag to GitHub, create a release with a changelog in GitHub and publish plugin to Gradle plugin portal.

Troubleshooting and known issues

Spring Boot and Netty version

Caused by io.spring.dependency-management plugin and Spring platform BOM files. The dependency management plugin ensures that all declared dependencies have exactly the same versions as declared in BOM. Since Spring Boot declares own Netty version (e.g. 4.1.22.Final) - this version is applied globally for all the configurations of the Gradle project, even if configuration doesn’t use Spring.

There’s 2 ways of solving the problem, depending on the actual usage of Netty in the project

  • When production code doesn’t rely on Netty

build.gradle
ext['netty.version'] = '4.0.51.Final'

This declares Netty version globally for all transitive dependencies in your project, including Spring.

  • When production code uses Netty

build.gradle
dependencyManagement {
    gatling {
        dependencies {
            dependencySet(group: 'io.netty', version: '4.0.51.Final') {
               entry 'netty-codec-http'
               entry 'netty-codec'
               entry 'netty-handler'
               entry 'netty-buffer'
               entry 'netty-transport'
               entry 'netty-common'
               entry 'netty-transport-native-epoll'
            }
        }
    }
}

This options ensures that 4.0.51.Final will be used only for gatling configurations, leaving other dependencies unchanged.

gradle-gatling-plugin's People

Contributors

eshepelyuk avatar lkishalmi avatar atomfrede avatar atdi avatar rkondratowicz avatar ysb33r avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.