Add support for compose v2 with ComposeContainer #5608

eddumelendez · 2022-07-24T05:09:35Z

Compose V2 offers arm images to perform docker compose commands. It will be available using ComposeContainer

public static ComposeContainer environment =
    new ComposeContainer(new File("src/test/resources/compose-test.yml"))
            .withExposedService("redis-1", REDIS_PORT, Wait.forListeningPort())
            .waitingFor("db-1", Wait.forLogMessage("started", 1));

ComposeContainer behaves similar to DockerComposeContainer with just one hint, service names should use - rather than _.

Why a new class?

During development we were evaluating different approaches such as introducing a new flag to opt-in to v2. However, we decided to move most of the config to an internal class ComposeDelegate which can be used in the future for new version of ComposeContainer instead of adding more branches to the existing DockerComposeContainer.

[Compose V2](https://www.docker.com/blog/announcing-compose-v2-general-availability/) offers arm images to perform `docker compose` commands. It should be enabled ```java public static DockerComposeContainer environment = new DockerComposeContainer(new File("src/test/resources/compose-test.yml")) .withComposeV2() .withExposedService("redis-1", REDIS_PORT, Wait.forListeningPort()) .waitingFor("db-1", Wait.forLogMessage("started", 1)); ```

eddumelendez · 2022-07-24T05:27:38Z

withComposeV2() should be called before .withExposedService("redis-1", REDIS_PORT, Wait.forListeningPort()) otherwise the name generated will contain underscores instead of hyphens. I was thinking on adding new constructors instead of withComposeV2()

new DockerComposeContainer(Compose.V2, new File("src/test/resources/compose-test.yml"))

eddumelendez · 2022-07-28T20:24:57Z

following @kiview suggestion. pr has been updated to opt-in for compose v2 via config property

kiview

Looks generally fine, just a couple of minor remarks. Did you already try it with a local compose?

core/src/main/java/org/testcontainers/utility/TestcontainersConfiguration.java

docs/features/configuration.md

docs/modules/docker_compose.md

core/src/test/java/org/testcontainers/junit/DockerComposeV2Test.java

Co-authored-by: Kevin Wittek <kiview@users.noreply.github.com>

core/src/main/java/org/testcontainers/containers/DockerComposeContainer.java

core/src/main/java/org/testcontainers/utility/TestcontainersConfiguration.java

core/src/test/java/org/testcontainers/containers/DockerComposeOverridesTest.java

Waize · 2023-05-02T04:06:19Z

Hi @kiview !

Is there any news on this PR here?
According to the docker docs, the compose V1 will be removed in June 2023 from all Docker Desktop versions: https://docs.docker.com/compose/compose-v2/.
That could mean, that any Windows user can not use Testcontainers anymore, am I right?

Is there any way to get this PR merged soon? :)

ismailsimsek · 2023-05-03T18:38:17Z

following option did worked for me, using .withOptions("--compatibility")

Are you using the latest state on the main branch? I've added there .withOptions("--compatibility") to the AbstractWebTest class and the DockerCompose setup, which #4565.

rieckpil/testing-spring-boot-applications-masterclass#305 (comment)

This reverts commit 337e0c7.

kiview

Let's update the PR description with the reasons behind the design decision to introduce a new class for Docker Compose V2 and hence have users explicitly switch to using V2 through this 👍

core/src/main/java/org/testcontainers/containers/ComposeContainer.java

kiview · 2023-05-26T09:21:14Z

docs/modules/docker_compose.md

+```java
+public static ComposeContainer environment =
+    new ComposeContainer(new File("src/test/resources/compose-test.yml"))
+            .withExposedService("redis-1", REDIS_PORT, Wait.forListeningPort())


We need an explicit note, that users need to be aware of using - instead of _ for V2 services in their code.

…ner.java Co-authored-by: Kevin Wittek <kiview@users.noreply.github.com>

pan3793 · 2023-07-06T06:17:50Z

@eddumelendez what is the schedule for the next release?

From July 2023 Compose V1 stopped receiving updates. It’s also no longer available in new releases of Docker Desktop.

https://docs.docker.com/compose/migrate/

PandarinDev · 2023-07-06T15:35:22Z

Also interested in the ETA on the next release as we'd love to have this fix available in a published version.

Waize · 2023-07-24T06:55:22Z

Hi @eddumelendez . Are there any news for the ETA on the next release?

eddumelendez requested a review from a team as a code owner July 24, 2022 05:09

github-actions bot added the type/docs label Jul 24, 2022

eddumelendez added the area/docker-compose label Jul 24, 2022

eddumelendez assigned eddumelendez and kiview Jul 26, 2022

eddumelendez added 2 commits July 28, 2022 14:44

Add configuration property to enable compose v2 compatibility

9f3983b

Add docs

2f4c569

eddumelendez added 2 commits July 28, 2022 17:18

Fix tests

cb139d5

Fix assumption

69dbf78

kiview requested changes Jul 29, 2022

View reviewed changes

eddumelendez and others added 4 commits July 29, 2022 15:15

Update docs/modules/docker_compose.md

7f9e995

Co-authored-by: Kevin Wittek <kiview@users.noreply.github.com>

Autodetect compose v2

48b15a9

Add testcontainers prefix to config property

2cdfb5c

Merge branch 'master' into composev2

deb5f2b

eddumelendez requested a review from kiview July 29, 2022 21:27

Fix test

afbc537

eddumelendez force-pushed the composev2 branch from 8b8ffb8 to afbc537 Compare July 29, 2022 23:44

Fix test

01f28f8

eddumelendez added this to the next milestone Jul 30, 2022

bsideup reviewed Aug 2, 2022

View reviewed changes

core/src/main/java/org/testcontainers/containers/DockerComposeContainer.java Outdated Show resolved Hide resolved

bsideup reviewed Aug 2, 2022

View reviewed changes

core/src/main/java/org/testcontainers/containers/DockerComposeContainer.java Outdated Show resolved Hide resolved

bsideup reviewed Aug 2, 2022

View reviewed changes

core/src/main/java/org/testcontainers/containers/DockerComposeContainer.java Outdated Show resolved Hide resolved

Fix comments

e8e07c5

eddumelendez mentioned this pull request Aug 3, 2022

LocalDockerCompose does not support Docker Compose v2 #5596

Closed

bsideup reviewed Aug 4, 2022

View reviewed changes

core/src/main/java/org/testcontainers/containers/DockerComposeContainer.java Outdated Show resolved Hide resolved

bsideup reviewed Aug 4, 2022

View reviewed changes

core/src/main/java/org/testcontainers/utility/TestcontainersConfiguration.java Outdated Show resolved Hide resolved

bsideup reviewed Aug 4, 2022

View reviewed changes

core/src/test/java/org/testcontainers/containers/DockerComposeOverridesTest.java Outdated Show resolved Hide resolved

eddumelendez mentioned this pull request Apr 29, 2023

Remove link usage in DockerComposeContainer #6946

Closed

eddumelendez added 2 commits April 29, 2023 08:46

Merge branch 'main' into composev2

196d180

Drop link in favor of networks

337e0c7

eddumelendez added 5 commits May 9, 2023 22:14

Merge branch 'main' into composev2

601148e

Add test for identifier in uppercase

0840644

Revert "Drop link in favor of networks"

6a39b89

This reverts commit 337e0c7.

Merge branch 'main' into composev2

c2dcc88

Fix test

39b37d7

kiview previously approved these changes May 26, 2023

View reviewed changes

eddumelendez added this to the next milestone Jun 20, 2023

Update core/src/main/java/org/testcontainers/containers/ComposeContai…

a078382

…ner.java Co-authored-by: Kevin Wittek <kiview@users.noreply.github.com>

eddumelendez dismissed kiview’s stale review via a078382 June 20, 2023 21:30

eddumelendez added 4 commits June 20, 2023 15:30

Merge branch 'main' into composev2

4c7ca00

Add note

9317f81

Update docker version

3e21972

Update labeler.yml

7e2f2da

eddumelendez merged commit 7112db5 into main Jun 21, 2023
85 of 86 checks passed

eddumelendez deleted the composev2 branch June 21, 2023 03:24

This was referenced Jun 21, 2023

DockerComposeContainer does not work with local docker-compose v2 #4565

Closed

[Bug]: docker/compose:1.29.2 image is amd64 and requires QEMU emulator to work on Arm #5524

Closed

jacomago mentioned this pull request Aug 21, 2023

Adds testing to the github ci ChannelFinder/ChannelFinderService#88

Merged

This was referenced Aug 24, 2023

ContainerLaunchException with Docker Compose V2 testcontainers/testcontainers-scala#200

Closed

Migrate to Docker Compose v2 testcontainers/testcontainers-scala#260

Merged

jackyyyyyssss mentioned this pull request Dec 15, 2023

[Improvement][E2E] support e2e compose v2 fix code style apache/dolphinscheduler#15325

Merged

kiview mentioned this pull request Dec 21, 2023

chore: update docker compose image #7989

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for compose v2 with ComposeContainer #5608

Add support for compose v2 with ComposeContainer #5608

eddumelendez commented Jul 24, 2022 •

edited

eddumelendez commented Jul 24, 2022 •

edited

eddumelendez commented Jul 28, 2022

kiview left a comment

Waize commented May 2, 2023 •

edited

ismailsimsek commented May 3, 2023

kiview left a comment

kiview May 26, 2023

pan3793 commented Jul 6, 2023

PandarinDev commented Jul 6, 2023

Waize commented Jul 24, 2023

Add support for compose v2 with ComposeContainer #5608

Add support for compose v2 with ComposeContainer #5608

Conversation

eddumelendez commented Jul 24, 2022 • edited

Why a new class?

eddumelendez commented Jul 24, 2022 • edited

eddumelendez commented Jul 28, 2022

kiview left a comment

Choose a reason for hiding this comment

Waize commented May 2, 2023 • edited

ismailsimsek commented May 3, 2023

kiview left a comment

Choose a reason for hiding this comment

kiview May 26, 2023

Choose a reason for hiding this comment

pan3793 commented Jul 6, 2023

PandarinDev commented Jul 6, 2023

Waize commented Jul 24, 2023

eddumelendez commented Jul 24, 2022 •

edited

eddumelendez commented Jul 24, 2022 •

edited

Waize commented May 2, 2023 •

edited