This is a wrapper around the Gatling load testing framework, with preconfigured injection steps, protocols and assertions.

Add the below library to your Scala dependencies (e.g. Dependencies.scala):

"uk.gov.hmrc" %% "performance-test-runner" % "6.0.0" % Test

Add the below plugin to your plugins.sbt:

addSbtPlugin("io.gatling" % "gatling-sbt" % "4.1.5")

Your tests will need both the performance-test-runner library AND the gatling-sbt plugin. This library is available for Scala 2.13 only.

Refer to the getting-started guide for implementing your first simulation.

This repository uses Scalafmt, a code formatter for Scala. The formatting rules configured for this repository are defined within .scalafmt.conf.

To apply formatting to this repository using the configured rules in .scalafmt.conf execute:

sbt scalafmtAll scalafmtSbt

To check files have been formatted as expected execute:

sbt scalafmtCheckAll scalafmtSbtCheck

Visit the official Scalafmt documentation to view a complete list of tasks which can be run.

If you are upgrading to v6.0.0 of performance-test-runner, you can now remove dependencies that previously needed adding manually.

If you are using v6.0.0 of performance-test-runner, you can remove the following from your dependencies (e.g. Dependencies.scala) as these are now added by the library:

"io.gatling"            % "gatling-test-framework"    % "x.x.x" % Test,
"io.gatling.highcharts" % "gatling-charts-highcharts" % "x.x.x" % Test,
"com.typesafe"          % "config"                    % "x.x.x" % Test

This code is open source software licensed under the Apache 2.0 License.