pi-hole-mirror/test/README.md

Recommended way to run tests

The test suite is implemented with BATS and runs inside distro-specific Docker containers.

Requirements

• Docker (with buildx support)
• Bash shell

Run tests

From the repository root, run:

bash test/run.sh --distro debian_12

test/run.sh will:

• Build the distro test image from test/_<distro>.Dockerfile
• Run the mock/function BATS suite in a fresh container
• Run the fresh-install BATS suite in a separate fresh container

Available distros

If you are unsure which distro names are valid, run:

bash test/run.sh --help

The help output includes the current list of supported distros.

Optional: override BATS library versions

test/run.sh accepts optional environment variable overrides when building test images:

• BATS_CORE_VER
• BATS_SUPPORT_VER
• BATS_ASSERT_VER
• BATS_MOCK_VER
• BATS_FILE_VER

Example:

BATS_CORE_VER=v1.14.0 DISTRO=debian_12 bash test/run.sh