Skip to content
This repository has been archived by the owner on Jan 27, 2023. It is now read-only.
/ run-gatling Public archive

GitHub Action to easily integrate Gatling performance tests to GitHub workflows.

License

Notifications You must be signed in to change notification settings

liatrio/run-gatling

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

run-gatling

This action sets up Gatling in your workflow and allows continuous testing (CT) of an app's performances.

Context

In the DevOps world, performance engineering is often thought as critical. Yet somehow, it is also greatly overlooked or done too late in the Software Development Lifecycle (SDLC).

This action tries to solve that exact problem by enabling development teams to take ownership of their applications' performances. It leverages the "as Code" performance testing tool Gatling and the power of GitHub Actions allowing developer to write their tests, version them, and integrate them within the CI/CT workflow.

Usage

- uses: liatrio/[email protected]
  with:
    # Java Version to use
    # Default: '17'
    javaVersion: ''

    # Java Distribution to use
    # Default: 'microsoft'
    javaDistribution: ''

    # Path to the Gatling Test Suite's pom.xml file
    # Default: './test'
    pomPath: ''

    # Class of the simulation to run ('myPackage.MySimulationClass')
    # Default: ''
    # (Optionnal)
    # Note: If the Test Suite contains more than one simulation,
    #       you may want to configure the Maven plugin to run 
    #       multiple simulations. Otherwise, you will have to fill this
    #       parameter with the specific simulation to execute.
    simulationClass: ''

Scenarios

Execute tests

- uses: liatrio/[email protected]
  with:
    pomPath: my_test_suite/path

Execute a specific simulation

- uses: liatrio/[email protected]
  with:
    pomPath: my_test_suite/path
    simulationClass: simulationsPkg.MySimulationClass