Open source load testing tool and SaaS for ambitious engineering teams.
It's as easy as:
name: Main Workflow
on: [push]
jobs:
build:
name: Run k6 test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run k6 local test
uses: grafana/[email protected]
with:
filename: my-load-test.js
flags: --vus 50 --duration 10sname: Main Workflow
on: [push]
jobs:
build:
name: Run k6 test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run k6 cloud test
uses: grafana/[email protected]
with:
filename: my-load-test.js
flags: --vus 50 --duration 10s
cloud: true
token: ${{ secrets.K6_CLOUD_API_TOKEN }}steps:
- name: Run k6 local test
uses: grafana/[email protected]
with:
filename: my-script-file.jsSets the filename of the test script to execute. This property is relative to the workspace directory. If omitted, it defaults to test.js.
environment: test
steps:
- name: Run k6 cloud test
uses: grafana/[email protected]
with:
cloud: true
token: ${{ secrets.K6_CLOUD_API_TOKEN }}Enables execution in Grafana Cloud k6. Additional details on the k6 cloud offering are available at https://grafana.com/docs/grafana-cloud/k6/.
You can use a Grafana Cloud k6 personal API token, or a Grafana Stack API token. For more details, refer to Authenticate on the CLI.
steps:
- name: Run k6 local test
uses: grafana/[email protected]
with:
flags: --vus 50 --duration 10sAny additional arguments or flags to pass to the k6 CLI. The full list of possible options is available at https://grafana.com/docs/k6/latest/using-k6/k6-options/reference/.
For additional information, and help getting started, see https://grafana.com/docs/k6/latest/get-started/running-k6/.
Environment variables can be added the same way as you do it locally, using the flags action option:
steps:
- name: Run k6 local test
uses: grafana/[email protected]
with:
filename: my-script-file.js
flags: --env MY_VAR=42Or can be scoped to the action step:
steps:
- name: Run k6 local test
uses: grafana/[email protected]
with:
filename: my-script-file.js
env:
MY_VAR: 42You might want to host the system under test (SUT) within the workflow for testing. If you have dockerized your application or SUT, you can use service containers to make it available for testing within the same job.
The following example runs the application on port 3333. It passes the URL of the SUT as an environment variable to the k6 test and then runs the test.
name: Testing QuickPizza
on: push
jobs:
runner-job:
runs-on: ubuntu-latest
services:
quickpizza:
image: ghcr.io/grafana/quickpizza-local:0.4.0
ports:
- 3333:3333
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run local k6 test
uses: grafana/[email protected]
with:
filename: script.js
env:
BASE_URL: "http://quickpizza:3333"For non-Dockerized apps, you can download the k6 binary and run the k6 test from the same step as the app starts:
name: Main Workflow
on: [push]
jobs:
build:
name: Run k6 test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install k6
run: |
curl https://github.com/grafana/k6/releases/download/v0.47.0/k6-v0.47.0-linux-amd64.tar.gz -L | tar xvz --strip-components 1
- name: Install packages
run: |
npm install
- name: Start server and run tests
run: |
npm start & npx wait-on http://localhost:3000
./k6 run test.jsThanks to Amy Hoad for contributing on the solution for this.