The Docker Bench Test is a Bats test set that contains tests for dozens of common best-practices around deploying Docker containers in production. These Bats tests are created from Docker Bench for Security scripts. Will try to keep them in sync.
Switch branches/tags
Nothing to show
Clone or download
Alexei Ledenev
Alexei Ledenev fix build
Latest commit e9c0a38 Sep 12, 2016

README.md

Docker Bench Test

Circle CI Docker

The Docker Bench Test is a Bats test set that contains tests for dozens of common best-practices around deploying Docker containers in production. The tests are fully automated, are inspired by the CIS Docker 1.11 Benchmark and based on Docker Bench for Security.

We are making this available as an open-source utility so the Docker community can have an easy way to self-assess their hosts and docker containers against this benchmark.

Reasons behind this project

Docker security team released a great open source project: Docker Bench for Security. With Docker Bench Test we have the following goals:

  1. Produce a machine readable test results in standard format. Using Bats allows us to produce test results in TAP format.
  2. Allow running selected subset of all avaiable tests.
  3. Split single container level script into multiple tests. Generate test per container. Thus if one container of tens is not configured properly, only tests for this container will fail.
  4. Reduce number of Info statuses. Info status means that additional manual evaluation is required. Replace manual inspection with predefined "expected" configuration.

System Requirements

Docker Bench Test requires Docker 1.10.0 or later in order to run.

The distribution specific Dockerfiles may also help if the distribution you're using haven't yet shipped Docker version 1.10.0 or later.

Running Docker Bench Bats tests

Bats is a TAP-compliant testing framework for Bash. It provides a simple way to verify that the UNIX programs you write behave as expected.

Docker Bench Test* contains all checks from Docker Bench for Security as Bats tests. Container level (and image level) tests are automatically generated for all containers available on host. It's possible to run all or only selected test(s), if you like.

By default TAP test results are reported, but it's possible to produce a "pretty" printed output too.

Use the following command to run Docker Bench Bats tests:

Help documentation for docker-bench-test.sh

Basic usage: docker-bench-test.sh [-c] [-p|-t] [-o path] <test> [<test> ...]

Command line switches are optional. The following switches are recognized.
-c  --Displays number of tests. No further functions are performed.
-g  --Generates all CIS Bats tests without execution. No further functions are performed.
-p  --Show results in pretty format.
-t  --Show results in TAP format. This is the default format.
-r  --Create test results files: tests_<timestamp>.tap in test result folder.
-o  --Specify test result folder. Default to /var/docker-bench-test/results.
-h  --Displays this help message. No further functions are performed.

Example: docker-bench-test.sh -t -o /var/docker-bench-test/results

Note:: You need to run docker-bench-test.sh on Docker host as root user.

Running Docker Bench Test tests from Docker image

Then run docker-bench-tests container (as bellow). Test results will be saved into /var/docker-bench-test folder in TAP format. Test results file is named accoring to the tests_<timestamp>.tap pattern. Latest test results will be always saved to tests_latest.tap

docker run -it --net host --pid host --cap-add audit_control \
    -v /var/lib:/var/lib \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v /usr/lib/systemd:/usr/lib/systemd \
    -v /var/docker-bench-test:/var/docker-bench-test \
    -v /etc:/host/etc \
    --label docker_bench_test \
    gaiaadm/docker-bench-test

Build Docker Bench Test Docker image

First, clone and compile your docker-bench-test Docker image.

git clone https://github.com/gaia-adm/docker-bench-test.git
cd docker-bench-test
git submodule init
git submodule update
docker build -t docker-bench-test .

or use Docker Compose:

git clone https://github.com/gaia-adm/docker-bench-test.git
cd docker-bench-test
git submodule init
git submodule update
docker-compose run --rm docker-bench-test

Also, this script can also be simply run from your base host by running:

git clone https://github.com/gaia-adm/docker-bench-test.git
cd docker-bench-test
git submodule init
git submodule update
sh docker-bench-test.sh