Open source load testing tool and SaaS for ambitious engineering teams.
Getting started
It's as easy as:
Local test
name: Main Workflow
on: [push]
jobs:
build:
name: Run k6 test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Run k6 local test
uses: grafana/[email protected]
with:
filename: my-load-test.js
flags: --vus 50 --duration 10sCloud test
name: Main Workflow
on: [push]
jobs:
build:
name: Run k6 test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- 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 }}Inputs
Filename
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.
Cloud
environment: test
steps:
- name: Run k6 cloud test
uses: grafana/[email protected]
with:
cloud: true
token: ${{ secrets.K6_CLOUD_API_TOKEN }}Enables execution in the k6 cloud. Additional details on the k6 cloud offering are available at https://k6.io/docs/cloud/. You'll need to specify the name of the environment where K6_CLOUD_API_TOKEN secret has been defined.
Flags
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://k6.io/docs/using-k6/options.
For additional information, and help getting started, see https://k6.io
Environment Variables
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: 42Side-by-side with the System under Test
Unfortunately, running the local system under test and k6 at the same time is currently not supported by the marketplace action. However, this is easily accomplished by downloading the k6 binary and running it from the same step as the server start:
name: Main Workflow
on: [push]
jobs:
build:
name: Run k6 test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Install k6
run: |
curl https://github.com/loadimpact/k6/releases/download/v0.26.2/k6-v0.26.2-linux64.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.