ambimax/docker-bats

Docker image for bats testing with batteries included

• local testing
• CI/CD testing like Github Actions
• Support for Makefile, docker, docker-compose within bats tests
• Includes bats-assert and bats-file libraries

See workspace/ for examples!

Contributions are welcome, see Github Repository

Usage with npm

Install bats globally

curl -o install-bats.sh https://raw.githubusercontent.com/ambimax/docker-bats/main/scripts/install-bats.sh; \
sudo bash install-bats.sh

Run your tests on command line

bats -r tests/

Usage with Github Action

Add steps to your Github Action job:

    - name: Install bats
      run: curl -o install-bats.sh https://raw.githubusercontent.com/ambimax/docker-bats/main/scripts/install-bats.sh && sudo bash install-bats.sh

    - name: Run tests
      run: bats -r tests/

Usage with docker

Run all tests within tests folder:

docker run --rm --volume "${PWD}:/workspace" ambimax/bats -r workspace/tests/

Run single test within tests folder:

docker run --rm --volume "${PWD}:/workspace" ambimax/bats workspace/tests/test.bats

Get bats options

docker run --rm --volume "${PWD}:/workspace" ambimax/bats -h

Use docker in tests (when using a tests/ folder in current directory)

docker run --rm \
    --tty \
    --entrypoint bash \
    --volume "${PWD}:/workspace" \
    --volume "/var/run/docker.sock:/var/run/docker.sock" \
    "ambimax/bats:1.2.2" bats -r /workspace/tests/

Libraries

The following libraries are included

• bats-support
• bats-assert
• bats-file (docker container only)

Load all libraries

All libraries are loaded by default

#!/bin/usr/env bats

@test "Build image" {
    run echo "test"
    assert_output 'test'
}

bats-assert

bats-assert is a helper library providing common assertions for Bats.

#!/bin/usr/env bats

@test 'assert()' {
  touch '/tmp/testfile.log'
  assert [ -e '/tmp/testfile.log' ]
}

@test 'assert_output()' {
  run echo 'want'
  assert_output 'want'
}

bats-file

Only available within docker container

bats-file is a helper library providing common filesystem related assertions and helpers for Bats.

#!/bin/usr/env bats

@test 'assert_file_executable' {
  assert_file_executable /path/to/executable-file
}

See workspace/ for more examples!

Tutorials

• Testing with bash bats, 02/1919

Authors

• Tobias Schifftner, Ambimax GmbH