https://github.com/outstand/docker-bats
BATS image derived from buildkite/plugin-tester
https://github.com/outstand/docker-bats
bats buildkite buildkite-plugin docker-image
Last synced: 11 months ago
JSON representation
BATS image derived from buildkite/plugin-tester
- Host: GitHub
- URL: https://github.com/outstand/docker-bats
- Owner: outstand
- Created: 2022-01-14T18:16:10.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-18T14:16:14.000Z (over 4 years ago)
- Last Synced: 2025-01-21T08:11:51.906Z (over 1 year ago)
- Topics: bats, buildkite, buildkite-plugin, docker-image
- Language: Dockerfile
- Homepage: https://gallery.ecr.aws/a5k7g6j4/bats
- Size: 4.88 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BATS / Buildkite Plugin Tester [](https://buildkite.com/outstand/docker-compose-buildkite-plugin)
A base docker image for testing [Buildkite plugins](https://buildkite.com/docs/agent/v3/plugins) with BATS. It includes:
* A non-root user/group at 1000:1000. A docker group is located at gid 900.
* Docker compose v2 and compose-switch for v1 support.
* [bats-core](https://github.com/bats-core/bats-core)
* [bats-support](https://github.com/bats-core/bats-support)
* [bats-assert](https://github.com/bats-core/bats-assert)
* [@lox](https://github.com/lox)'s fork of [bats-mock](https://github.com/lox/bats-mock)
* [bats-file](https://github.com/bats-core/bats-file)
Your plugin’s code is expected to be mounted to `/plugin`, and by default the image will run the command `bats tests/`.
## Usage
For example, say you had a plugin called `git-logger`, which took a `commit` option, and called `git log` via a command hook:
```yml
steps:
- plugins:
- foo/git-logger#v1.0.0:
commit: "abc123"
```
To test this, you'd add the following `docker-compose.yml` file:
```yml
version: '3.4'
services:
tests:
image: buildkite/plugin-tester
volumes:
- ".:/plugin"
```
And you'd create the following test in `tests/command.bats`:
```bash
#!/usr/bin/env bats
load "$BATS_PATH/load.bash"
# Uncomment to enable stub debugging
# export GIT_STUB_DEBUG=/dev/tty
@test "calls git log" {
export BUILDKITE_PLUGIN_GIT_LOGGER_COMMIT="abc123"
stub git "log abc123 : echo git log output"
run $PWD/hooks/command
assert_output --partial "git log output"
assert_success
unstub git
}
```
Now you can run your tests locally:
```bash
docker compose run --rm tests
```
To set up it up in Buildkite, create a `.buildkite/pipeline.yml` file that uses the [docker-compose Buildkite Plugin](https://github.com/buildkite-plugins/docker-compose-buildkite-plugin) to run that same command on CI, for example:
```yml
steps:
- plugins:
- docker-compose#x.y.z:
run: tests
```
## Developing
To test plugin-tester itself, use the following command:
```bash
docker compose run --rm tests
```
## License
MIT (see [LICENSE](LICENSE))