JourneyPart
Used to constructs parts of a Journey as listed in journeys.conf. The JourneyPart is defined within a performance test using uk.gov.hmrc.performance.simulation.JourneySetup.setup.
To create a JourneyPart with uk.gov.hmrc.performance.simulation.JourneySetup.setup:
setup("login", "Login") withRequests (navigateToLoginPage, submitLogin)
Value parameters
- description
-
Description of the journey part surfaced in the gatling report.
- id
-
A unique id which should match the parts listed in journeys.conf
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Used internally by uk.gov.hmrc.performance.simulation.JourneySetup.journeys to chain the requests and actions included in the JourneyPart.
Used internally by uk.gov.hmrc.performance.simulation.JourneySetup.journeys to chain the requests and actions included in the JourneyPart.
Applies conditionallyRun when a condition is specified in JourneyPart using toRunIf.
Attributes
- Returns
-
Requests and Actions of the JourneyPart as a
ChainBuilder
Checks whether to run a setup step depending on whether the actual sessionKey value matches the expected value. The expected value can also be a Gatling sessionKey as the underlying doIfEquals method implicitly converts it into an Expression[Any].
Checks whether to run a setup step depending on whether the actual sessionKey value matches the expected value. The expected value can also be a Gatling sessionKey as the underlying doIfEquals method implicitly converts it into an Expression[Any].
Value parameters
- sessionKey
-
the sessionKey to obtain the actual value.
- value
-
the expected value to compare.
Attributes
- Returns
-
JourneyPart
Chains ActionBuilders to a setup. ActionBuilder is what is passed to the DSL exec() method.
Chains ActionBuilders to a setup. ActionBuilder is what is passed to the DSL exec() method.
For example, to add a PauseBuilder to a setup
val pause = new PauseBuilder(10 milliseconds, None)
setup("pause-action", "pauses for 10 milliseconds") withActions(pause)
Since, HttpRequestBuilder is also an ActionBuilder, these can be chained together.
In the below example navigateToLoginPage and submitLogin are of type HttpRequestBuilder
val pause = new PauseBuilder(1 milliseconds, None)
setup("login", "Login") withActions(navigateToLoginPage, pause, submitLogin)
To include a ChainBuilder, use .actionBuilders to covert it into a List[ActionBuilder] and pass it to withActions as below.
In the below example, sessionSetup is of type List[ActionBuilder]
setup("session-setup", "Setting Session Value") withActions(sessionSetup:_*)
Value parameters
- actions
-
of type
ActionBuilder
Attributes
- Returns
-
JourneyPart for chaining additional requests, actions, and conditional runs
Chains HttpRequestBuilder to uk.gov.hmrc.performance.simulation.JourneySetup.setup.
Chains HttpRequestBuilder to uk.gov.hmrc.performance.simulation.JourneySetup.setup.
setup("login-page", "Navigate to login page") withRequests navigateToLoginPage
Value parameters
- requests
-
of type
HttpRequestBuilder
Attributes
- Returns
-
JourneyPart for chaining additional requests, actions, and conditional runs
Inherited methods
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product