it

xk6-it

Reusable xk6 integration tests

This repository contains xk6 integration tests and the test k6 extensions required for them.

[!CAUTION] xk6 internal

The k6 extensions in this repository are used for xk6 integration testing. These extensions are not intended for end users.

Usage

The preferred use of xk6-it is git cloning in a CI workflow. The integration tests can be run immediately after cloning the repository (see Tasks section).

Another possible use is to embed this repository in the git repository that will use it. The most convenient way of embedding is to use git-subrepo, but git subtree or git submodule can also be used.

Prerequisites

The following must be installed to run integration tests:

• xk6
• go toolkit
• Bats (Bash Automated Testing System)
• jq (Command-line JSON processor)

Run

All integration tests can be run with a single command:

bats test

The output will be something like:

test/build.bats
 ✓ ⚙ build.bats K6_VERSION=; XK6_K6_REPO=
 ✓ no args
 ✓ version arg
 ✓ --k6-version version
 ✓ K6_VERSION=version
 ✓ --k6-repo module
 ✓ XK6_K6_REPO=module
 ✓ --output dir
 ✓ -o dir
 ✓ --with module
 ✓ --with module=.
 ✓ --with module=local
 ✓ --with module=remote
 ✓ --replace module=local
 ✓ --replace module=remote
 ✓ --with module1=local1 --with module2=local2 --with module3=local3
test/lint.bats
 ✓ ⚙ lint.bats K6_VERSION=; XK6_K6_REPO=
 ✓ it
 ✓ base32
 ✓ ascii85
 ✓ base64-as-base32
 ✓ base64
 ✓ crc32
 ✓ sha1
 ✓ sha256
 ✓ sha512
test/run.bats
 ✓ ⚙ run.bats K6_VERSION=; XK6_K6_REPO=
 ✓ no arg
 ✓ subdirectory
 ✓ --with module=local
 ✓ --with module
test/special.bats
 ✓ ⚙ special.bats XK6_K6_REPO=
 ✓ latest
 ✓ master
 ✓ hash

Configuration

The tests can be configured with the following environment variables:

Filtering

Tests can be filtered by the following tags (using the bats --filter-tags flag):

Detailed filtering can be achieved by combining the above tags. For example, selecting all smoke tests except smoke tests for the xk6 run command:

bats --filter-tags 'xk6:smoke,!xk6:run' test

Tasks

The usual tasks can be performed using GNU make. The Makefile defines a target for each task. To execute a task, the name of the task must be specified as an argument to the make command.

make taskname

Help on the available targets and their descriptions can be obtained by issuing the make command without any arguments.

make

More detailed help can be obtained for individual tasks using the cdo command:

cdo taskname --help

Authoring the Makefile

The Makefile is generated from the task list defined in the README.md file using the cdo tool. If a contribution has been made to the task list, the Makefile must be regenerated using the makefile target.

make makefile

it - Run the integration tests

The bats tool is used to run the integration tests.

bats test

test - Test the test extensions

Integration testing of extensions used for testing using the bats tool.

bats -r ext

security - Run security and vulnerability checks

The gosec tool is used for security checks. The govulncheck tool is used to check the vulnerability of dependencies.

gosec -quiet ./...
govulncheck ./...

lint - Run the linter

The golangci-lint tool is used for static analysis of the source code. It is advisable to run it before committing the changes.

golangci-lint run ./...

doc - Update documentation

Update the documentation files.

mdcode update

makefile - Generate the Makefile

cdo --makefile Makefile

all - Run all

Performs the most important tasks. It can be used to check whether the CI workflow will run successfully.

Requires : lint, security, test, it, doc, makefile

Development Environment

We use Development Containers to provide a reproducible development environment. We recommend that you do the same. In this way, it is guaranteed that the appropriate version of the tools required for development will be available.