Gatling

by gatling

sourcereadmeimage

Plugin to run load test using Gatling Enterprise tests from Harness.

Example

kind: pipeline
type: docker
name: default

steps:
- name: Run load tests
  image: gatlingcorp/enterprise-runner
  settings:
    SIMULATION_ID: '00000000-0000-0000-0000-000000000000'
    GATLING_ENTERPRISE_API_TOKEN: 'my-api-token'
    archs:
      - amd64

Properties

• GATLING_ENTERPRISE_API_TOKEN

  stringrequired

  The API token used to authenticate with Gatling Enterprise

  Secret recommended

  Default: none

• SIMULATION_ID

  stringrequired

  The ID of the simulation as configured on Gatling Enterprise

  Default: none

• EXTRA_SYSTEM_PROPERTIES

  stringoptional

  Additional Java system properties, will be merged with the simulation’s configured system properties. Must be formatted as a JSON object containing the desired key/value pairs. Values can be strings, numbers or booleans

  Default: {}

• EXTRA_ENVIRONMENT_VARIABLES

  stringoptional

  Additional environment variables, will be merged with the simulation’s configured environment variables. Must be formatted as a JSON object containing the desired key/value pairs. Values can be strings, numbers or booleans

  Default: {}

• OVERRIDE_LOAD_GENERATORS

  stringoptional

  Overrides the simulation’s load generators configuration. Must be formatted as a JSON object. Keys are the load generator IDs, which can be retrieved from the public API (using the /pools route). Weights are optional

  Default: {}

• FAIL_ACTION_ON_RUN_FAILURE

  booleanoptional

  If true, the Action will fail if the simulation run ends in an error (including failed assertions). if set to false and the simulation ends in an error, some of the outputs may be missing (e.g. there will be no assertion results if the simulation crashed before the end)

  Default: true

• WAIT_FOR_RUN_END

  booleanoptional

  If true, the runner will wait for the end of te simulation run on Gatling Enterprise before terminating. if set to false, some of the outputs may be missing (there will be no status nor assertion results)

  Default: true

• OUTPUT_DOT_ENV_FILE_PATH

  stringoptional

  path to a dotenv file where output values will be written

  Default: gatlingEnterprise.env

• RUN_SUMMARY_ENABLED

  booleanoptional

  Assuming wait_for_run_end is also true, will regularly log a summary of the ongoing run to the console until it finishes

  Default: true

• RUN_SUMMARY_INITIAL_REFRESH_INTERVAL

  numberoptional

  Initial interval before displaying a new summary of the ongoing run in the console, in seconds. Should be a multiple of 5 (otherwise it will be rounded up). Only used a limited number of times (set by run_summary_initial_refresh_count) before switching to the interval set by run_summary_refresh_interval

  Default: 5

• RUN_SUMMARY_INITIAL_REFRESH_COUNT

  numberoptional

  Number of times to use run_summary_initial_refresh_interval as the interval before displaying a new summary of the ongoing run in the console. After that, run_summary_refresh_interval will be used. This allows to avoid spamming the log output once the test run is well underway

  Default: 12

• RUN_SUMMARY_REFRESH_INTERVAL

  numberoptional

  Interval before displaying a new summary of the ongoing run in the console, in seconds. Should be a multiple of 5 (otherwise it will be rounded up)

  Default: 60