Packages

case class JourneyPart(id: String, description: String) extends Product with Serializable

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)
id

A unique id which should match the parts listed in journeys.conf

description

Description of the journey part surfaced in the gatling report.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JourneyPart
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JourneyPart(id: String, description: String)

    id

    A unique id which should match the parts listed in journeys.conf

    description

    Description of the journey part surfaced in the gatling report.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val ab: ListBuffer[ActionBuilder]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def builder: ChainBuilder

    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.

    returns

    Requests and Actions of the JourneyPart as a ChainBuilder

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. var conditionallyRun: (ChainBuilder) => ChainBuilder
  9. val description: String
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. val id: String
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toRunIf(sessionKey: Expression[String], value: String): JourneyPart

    Checks whether to run a setup step depending on whether the actual sessionKey value matches the expected value.

    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].

    sessionKey

    the sessionKey to obtain the actual value.

    value

    the expected value to compare.

    returns

    JourneyPart

  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. def withActions(actions: ActionBuilder*): JourneyPart

    Chains ActionBuilders to a setup.

    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:_*)
    actions

    of type ActionBuilder

    returns

    JourneyPart for chaining additional requests, actions, and conditional runs

  25. def withRequests(requests: HttpRequestBuilder*): JourneyPart

    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
    requests

    of type HttpRequestBuilder

    returns

    JourneyPart for chaining additional requests, actions, and conditional runs

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped