Switch from `docker-compose` to `docker compose` command. by fressi-elastic · Pull Request #2085 · elastic/rally

fressi-elastic · 2026-03-31T13:33:37Z

Summary

Replaces the legacy Compose v1 binary with the Docker CLI plugin everywhere it mattered for Rally, and tightens the dev/test Docker story so CI and local runs stay reliable.

Changes

Use docker compose instead of docker-compose in DockerLauncher, integration prerequisites (it/conftest.py), release-docker-test.sh, CCR recipe scripts, and contributor docs so the project matches Compose V2 / current Docker installs.
Rework docker/docker-compose-tests.yml: remove the top-level version, build the Rally image from the dev Dockerfile with a stable default image name/tag, upgrade the test Elasticsearch image to 8.19.13, turn off security for the test node, replace the ES healthcheck (cluster health, not red), increase retries, and leave host port mapping commented to avoid clashes.
Refactor Docker dev image integration tests (it/docker_dev_image_test.py): module-scoped compose env/teardown, cases-driven scenarios, and docker compose run with captured stdout/stderr for clearer failures and debug logging.
list tracks in the docker dev image IT: Removed the golden file (it/resources/docker_dev_image_list_tracks_stdout.golden.json) and RALLY_UPDATE_DOCKER_LIST_TRACKS_GOLDEN. The test now uses assert_list_tracks_contains(expected_track_names), which returns a closure checked against docker compose run stdout, with an inline list of stable default-repo track names (elastic/logs, geonames, http_logs, nyc_taxis, so_vector). This matches review feedback to avoid brittle full-output goldens and unclear maintenance for track authors.
CI / image build resilience: Buildkite dev and release Docker pipelines use larger GCP machine types and one automatic retry on build steps; dev/release Dockerfiles retry pbzip2 download/build on transient failures.
Dependencies: bump the docker PyPI package to ≥7.1.0 (and lockfile), and pin pip to 26.0.1 in pyproject.toml / uv.lock; unit tests for DockerLauncher updated for the new command string.

Dependency rationale

docker (docker-py) ≥7.1.0: Matches expectations of current Docker Engine APIs; 6.x is a poor fit for newer daemons. Rationale is also noted inline in pyproject.toml.
pip==26.0.1: Pins the interpreter used for python -m pip install when loading track dependencies so CI and local installs stay reproducible. Rationale is also noted inline in pyproject.toml.

Copilot

Pull request overview

Updates the repository to use Docker Compose v2 (docker compose) instead of the legacy docker-compose binary to avoid dependency conflicts with Rally’s tooling.

Changes:

Replace docker-compose invocations with docker compose across launcher code, tests, scripts, recipes, and docs.
Refactor the Docker dev image integration test to be table-driven (multiple commands) and run via subprocess.
Update the Docker Compose integration test stack configuration (Elasticsearch image/env/healthcheck).

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tests/mechanic/launcher_test.py	Update expected subprocess command strings to `docker compose`.
release-docker-test.sh	Use `docker compose` in prerequisites check and integration test orchestration.
recipes/ccr/stop.sh	Switch stop commands to `docker compose`.
recipes/ccr/start.sh	Switch start commands to `docker compose`.
it/docker_dev_image_test.py	Refactor docker image IT into table-driven cases and switch to `docker compose`.
it/conftest.py	Update integration test prerequisite check to `docker compose version`.
esrally/mechanic/launcher.py	Update DockerLauncher compose command builder to `docker compose`.
docs/developing.rst	Update developer docs to reference `docker compose`.
docker/docker-compose-tests.yml	Update ES container image/config and healthcheck used by docker-compose based integration tests.
CONTRIBUTING.md	Update contribution docs to reference `docker compose`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docker/docker-compose-tests.yml

it/docker_dev_image_test.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

gbanasiak

I've noticed the following warnings, please address them:

it/docker_dev_image_test.py::test_docker_compose[help] WARN[0000] The "RALLY_DOCKER_IMAGE" variable is not set. Defaulting to a blank string.
--
WARN[0000] The "RALLY_VERSION_TAG" variable is not set. Defaulting to a blank string.
WARN[0000] The "TEST_COMMAND" variable is not set. Defaulting to a blank string.
[+] Running 5/5
✔ Container rally        Removed                                                                                                                          0.0s
✔ Container es01         Removed                                                                                                                          0.0s
✔ Volume docker_esdata1  Removed                                                                                                                          0.0s
✔ Volume docker_rally    Removed                                                                                                                          0.0s
✔ Network rally-tests    Removed                                                                                                                          0.1s
PASSED

it/docker_dev_image_test.py

…er-compose-v2

…re cases.

… the same module reuses the same instance for it.

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

it/docker_dev_image_test.py

docker/docker-compose-tests.yml

pyproject.toml

- Log then pytest.fail when docker compose down fails in IT teardown - Use docker compose -f for debug logs collection - Parameterize test compose image with RALLY_DOCKER_IMAGE default - Document docker-py and pip constraints in pyproject.toml Made-with: Cursor

docker/docker-compose-tests.yml

- Use unquoted ${VAR:-default} for image and command - Allow overriding Dockerfile path via RALLY_DOCKER_FILE - Pin Elasticsearch to 7.17.0; comment xpack security env vars Made-with: Cursor

gareth-ellis

LGTM - i wonder why the list tracks test was removed. I disabled auto merge so @gbanasiak can confirm he's happy with the changes you made based on his review

it/docker_dev_image_test.py

Restore the ten paths touched by both the ES client upgrade and the docker-compose v2 migration to origin/master so the client-upgrade follow-up branch does not carry duplicate changes. pyproject.toml and uv.lock stay on the esclient-upgrade-2 versions. Made-with: Cursor

pquentin

Thank you.

pyproject.toml

CONTRIBUTING.md

docker/docker-compose-tests.yml

Extend the docker compose integration test with a list tracks case that normalizes CLI output and compares it to a golden file under it/resources/. ComposeCase.want_stdout may be a callable for custom checks; refresh the golden when the file is missing or empty, or when RALLY_UPDATE_DOCKER_LIST_TRACKS_GOLDEN=1. Log a warning before overwriting the golden. Also cover the explicit esrally-prefixed race command. Made-with: Cursor

Co-authored-by: Quentin Pradet <quentin.pradet@gmail.com>

- Pin docker-py to 7.1.0; trim dependency comments (pquentin review). - Add _docker_compose_process_env with defaults for TEST_COMMAND and RALLY_DOCKER_FILE to silence compose variable warnings on down/logs. - Fail tests when docker compose down fails (Copilot review). - Document image+build, ports, and security/xpack in docker-compose-tests.yml. - Format _RACE_FLAGS string split across lines. Made-with: Cursor

fressi-elastic · 2026-04-02T14:05:49Z

Status update (latest: `e222110b`)

Addressed open review feedback in recent commits:

Topic	Resolution
@gareth-ellis — `list tracks` removed	Restored via `list tracks` case + golden: `it/resources/docker_dev_image_list_tracks_stdout.golden.txt`; refresh with `RALLY_UPDATE_DOCKER_LIST_TRACKS_GOLDEN=1` (`5bf86121`).
@gbanasiak — Compose `WARN … variable is not set`	`_docker_compose_process_env()` sets defaults for `TEST_COMMAND` and `RALLY_DOCKER_FILE` on `down` / `logs` / `run` (`e222110b`).
Copilot — `docker compose down` failure swallowed	`tear_down_stack` now `pytest.fail` after logging (`e222110b`).
@pquentin — `docker` not pinned / long comments	`docker==7.1.0`; shortened `docker` + `pip` dependency comments (`e222110b`).
@pquentin — commented `ports` / security	Expanded YAML comments for `ports`, xpack, and CA docs pointer; `image`+`build` behavior (`e222110b`).
CONTRIBUTING.md	Updated with co-authored merge (`0000a2c1`).

Please resolve conversation threads on GitHub where this matches your expectations, or reply if something still needs changes.

- Parse docker list tracks output to a sorted JSON array; replace .golden.txt with .golden.json - Document when to enable xpack security overrides for ES 8+ and how to obtain the HTTP CA - Expand rally service comment on RALLY_DOCKER_IMAGE/RALLY_VERSION_TAG vs build fallback for release and local runs Made-with: Cursor

it/resources/docker_dev_image_list_tracks_stdout.golden.txt

it/docker_dev_image_test.py

it/resources/docker_dev_image_list_tracks_stdout.golden.json

fressi-elastic · 2026-04-02T15:55:43Z

Following review feedback, the docker dev image IT no longer uses a golden file for list tracks. The test now asserts that a small hardcoded subset of track names from the default repo (geonames, http_logs) appears in parsed stdout, which avoids brittle full-list updates and the golden maintenance/discoverability concern. Please resolve the related review threads if this matches your expectations.

Remove the docker dev image golden JSON for `list tracks` and replace it with `assert_list_tracks_contains`, which returns a stdout checker for an inline list of expected track names. This matches review feedback to avoid brittle full-output goldens and unclear update workflows. Made-with: Cursor

gbanasiak

LGTM

fressi-elastic requested a review from Copilot March 31, 2026 13:33

Copilot started reviewing on behalf of fressi-elastic March 31, 2026 13:34 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

Switch from docker-compose to docker compose command.

059703c

fressi-elastic force-pushed the switch-to-docker-compose-v2 branch from 8388962 to 059703c Compare March 31, 2026 13:47

Use the original ES server version (unrelated change).

e7b2622

fressi-elastic added the dependencies Pull requests that update a dependency file label Mar 31, 2026

fressi-elastic and others added 2 commits March 31, 2026 17:02

Update it/docker_dev_image_test.py

fe06b66

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fix linters errors.

b463964

fressi-elastic force-pushed the switch-to-docker-compose-v2 branch from 00138ec to b463964 Compare March 31, 2026 15:21

gbanasiak reviewed Mar 31, 2026

View reviewed changes

it/docker_dev_image_test.py Outdated Show resolved Hide resolved

fressi-elastic added this to the 2.14.0 milestone Apr 1, 2026

fressi-elastic added 5 commits April 1, 2026 06:19

Merge branch 'master' of github.com:elastic/rally into switch-to-dock…

ceb08b9

…er-compose-v2

Address docker compose warnings.

9889eb4

Refactor test case to ensure compose command output is writen to log.

8fb13d6

Use newer version of ES and improve test case to help implementing mo…

d5854c1

…re cases.

Make sure the es01 container healthcheck works and that test cases of…

ec11387

… the same module reuses the same instance for it.

fressi-elastic requested review from a team, Copilot, gareth-ellis, gbanasiak and pquentin April 1, 2026 10:37

Copilot started reviewing on behalf of fressi-elastic April 1, 2026 10:37 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

it/docker_dev_image_test.py Outdated Show resolved Hide resolved

it/docker_dev_image_test.py Outdated Show resolved Hide resolved

docker/docker-compose-tests.yml Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

fressi-elastic force-pushed the switch-to-docker-compose-v2 branch from eb4bb06 to 7a74d1f Compare April 1, 2026 10:57

gbanasiak reviewed Apr 1, 2026

View reviewed changes

docker/docker-compose-tests.yml Outdated Show resolved Hide resolved

docker/docker-compose-tests.yml Outdated Show resolved Hide resolved

Update docker-compose-tests for Compose v2 and ES 7

fa854ec

- Use unquoted ${VAR:-default} for image and command - Allow overriding Dockerfile path via RALLY_DOCKER_FILE - Pin Elasticsearch to 7.17.0; comment xpack security env vars Made-with: Cursor

fressi-elastic enabled auto-merge (squash) April 1, 2026 15:49

gareth-ellis disabled auto-merge April 2, 2026 11:30

gareth-ellis approved these changes Apr 2, 2026

View reviewed changes

it/docker_dev_image_test.py Show resolved Hide resolved

This was referenced Apr 2, 2026

Upgrade Elasticsearch Python client to 9.x and urllib3 2.x #2089

Open

Upgrade Elasticsearch Python client to 9.x and urllib3 2.x #2024

Closed

pquentin reviewed Apr 2, 2026

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

docker/docker-compose-tests.yml Show resolved Hide resolved

fressi-elastic and others added 3 commits April 2, 2026 15:30

Update CONTRIBUTING.md

0000a2c

Co-authored-by: Quentin Pradet <quentin.pradet@gmail.com>

fressi-elastic commented Apr 2, 2026

View reviewed changes

it/resources/docker_dev_image_list_tracks_stdout.golden.txt Outdated Show resolved Hide resolved

it/docker_dev_image_test.py Outdated Show resolved Hide resolved

gbanasiak reviewed Apr 2, 2026

View reviewed changes

it/resources/docker_dev_image_list_tracks_stdout.golden.json Outdated Show resolved Hide resolved

gbanasiak approved these changes Apr 2, 2026

View reviewed changes

fressi-elastic enabled auto-merge (squash) April 2, 2026 16:40

fressi-elastic merged commit 42136c9 into elastic:master Apr 2, 2026
15 checks passed

Conversation

fressi-elastic commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Dependency rationale

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gbanasiak left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gareth-ellis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pquentin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fressi-elastic commented Apr 2, 2026

Status update (latest: e222110b)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fressi-elastic commented Apr 2, 2026

Uh oh!

gbanasiak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

fressi-elastic commented Mar 31, 2026 •

edited

Loading

gbanasiak left a comment •

edited

Loading

Status update (latest: `e222110b`)