performance-test-runner/uk.gov.hmrc.performance/uk.gov.hmrc.performance.simulation/JourneySetup

JourneySetup

uk.gov.hmrc.performance.simulation.JourneySetup

trait JourneySetup extends JourneyConfiguration, PerftestConfiguration

A trait to setup the Journeys used in Simulation.

Attributes

Graph
Supertypes: trait PerftestConfiguration

trait JourneyConfiguration

trait Configuration

class Object

trait Matchable

class Any
Show all
Known subtypes: trait PerformanceTestRunner

Members list

Value members

Concrete methods

Builds uk.gov.hmrc.performance.simulation.Journey for each journey defined in journeys.conf

Attributes

Returns: a Seq of uk.gov.hmrc.performance.simulation.Journey for all the journeys defined in journeys.conf

Creates JourneyPart which allows to chain HttpRequestBuilder and ActionBuilder.

Value parameters

description: description of the setup. This value is used in Gatling's scenario description which is surfaced in gatling report.
id: Unique identifier for the setup. This should match an entry in the parts provided in journeys.conf

Attributes

Returns: JourneyPart

Calculates the load for the provided journeys and constructs the injection steps using Gatling's open injection model: https://gatling.io/docs/current/general/simulation_setup/#open-model.

Value parameters

journeys: Seq of journeys as defined in journeys.conf

Attributes

Returns: Sequence of PopulationBuilder with calculated injection step injected into io.gatling.core.structure.ScenarioBuilder

Inherited methods

Attributes

Inherited from:: JourneyConfiguration

Maps the journeys defined in journeys.conf to a Seq of uk.gov.hmrc.performance.conf.JourneyDefinition and returns the journeys to be executed based on the provided labels. The labels field is defined in application.conf.

Value parameters

labels: An optional parameter with a Set of labels for which the journeys should be executed.

Attributes

Returns: Seq of JourneyDefinition to be executed for the provided labels.
Inherited from:: JourneyConfiguration

Generates a new description for a journey based on the description, run-if, and skip-if fields in journeys.conf

Example:

For the below example journey in journey.conf:

hello-world-4 = {
 description = "Hello world journey 4"
 load = 0.1
 feeder = data/helloworld.csv
 parts = [
   home
 ]
 run-if = ["label-B"]
 skip-if = ["label-A", "label-C"]
}

the generated description would be:

Hello world journey 4 - runIf [label-B] and skipIf [label-A,label-C]

Value parameters

journeyDescription: Value from the description field of a journey in journeys.conf
runIf: Labels included in run-if field of a journey in journeys.conf
skipIf: Labels included in skip-if field of a journey in journeys.conf