Run Integration Tests Against docker-compose
Spin up dependencies in compose, run integration tests against them, and tear down so tests run identically locally and in CI.
Task
Add docker compose up -d --wait && npx vitest run integration/ ; docker compose down -v to the test suite so regressions are caught automatically on every pull request.
When to use this
A refactor passes existing tests but breaks docker compose up -d --wait && npx vitest run integration/ ; docker compose down -v, shipping a silent regression to users.
Prerequisites
- A test runner configured (Vitest or Jest)
- Source code with testable units
Steps
1. Configure docker compose up -d --wait && npx vitest run integration/ ; docker compose down -v in the project configuration file with the recommended defaults.
docker compose up -d --wait && npx vitest run integration/ ; docker compose down -v
Expected output: The configuration is accepted and docker compose up -d --wait && npx vitest run integration/ ; docker compose down -v runs without errors on the first invocation.
2. Run the check locally to verify docker compose up -d --wait && npx vitest run integration/ ; docker compose down -v produces the expected result before pushing.
pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so docker compose up -d --wait && npx vitest run integration/ ; docker compose down -v blocks merge on failure.
- name: Run add integration test docker compose
run: pnpm test
Expected output: Pull requests with failing docker compose up -d --wait && npx vitest run integration/ ; docker compose down -v are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Cover the regression path
Start by measuring the problem. Spin up dependencies in compose, run integration tests against them, and tear down so tests run identically locally and in CI. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run docker compose up -d –wait && npx vitest run integration/ ; docker compose down -v against the current codebase and inspect the output before wiring it into CI.
docker compose up -d --wait && npx vitest run integration/ ; docker compose down -vKeep tests maintainable
Once the gate is in place, make failures actionable. A failing docker compose up -d –wait && npx vitest run integration/ ; docker compose down -v should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.