Polish

Author: eddumelendez

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

@@ -16,6 +16,7 @@
 import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -59,7 +60,7 @@ public class ComposeContainer implements Startable {
 
     public static final String COMPOSE_EXECUTABLE = SystemUtils.IS_OS_WINDOWS ? "docker.exe" : "docker";
 
-    private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("docker:24.0.2");
+    private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("docker");
 
     private final ComposeDelegate composeDelegate;
 
@@ -68,7 +69,7 @@ public class ComposeContainer implements Startable {
     private List<String> filesInDirectory = new ArrayList<>();
 
     /**
-     * Creates a new ComposeContainer with a random identifier using the specified Docker image and compose files.
+     * Creates a new ComposeContainer using the specified Docker image and compose files.
      *
      * @param image        The Docker image to use for the container
      * @param composeFiles One or more Docker Compose configuration files
@@ -78,7 +79,7 @@ public ComposeContainer(DockerImageName image, File... composeFiles) {
     }
 
     /**
-     * Creates a new ComposeContainer with a random identifier using the specified Docker image and compose files.
+     * Creates a new ComposeContainer using the specified Docker image and compose files.
      *
      * @param image        The Docker image to use for the container
      * @param composeFiles A list of Docker Compose configuration files
@@ -98,54 +99,61 @@ public ComposeContainer(DockerImageName image, String identifier, File... compos
         this(image, identifier, Arrays.asList(composeFiles));
     }
 
+    /**
+     * Creates a new ComposeContainer with the specified Docker image, identifier, and a single compose file.
+     *
+     * @param image       The Docker image to use for the container
+     * @param identifier  A unique identifier for this compose environment
+     * @param composeFile A Docker Compose configuration file
+     */
+    public ComposeContainer(DockerImageName image, String identifier, File composeFile) {
+        this(image, identifier, Collections.singletonList(composeFile));
+    }
+
     /**
      * Creates a new ComposeContainer with the specified Docker image, identifier, and compose files.
-     * This is the primary constructor that all other constructors delegate to.
      *
      * @param image        The Docker image to use for the container
      * @param identifier   A unique identifier for this compose environment
      * @param composeFiles A list of Docker Compose configuration files
      */
     public ComposeContainer(DockerImageName image, String identifier, List<File> composeFiles) {
+        image.assertCompatibleWith(DEFAULT_IMAGE_NAME);
         this.composeDelegate =
             new ComposeDelegate(ComposeDelegate.ComposeVersion.V2, composeFiles, identifier, COMPOSE_EXECUTABLE, image);
         this.project = this.composeDelegate.getProject();
     }
 
     /**
-     * @deprecated
-     *  Use the new constructor ComposeContainer(DockerImageName image, File... composeFiles)
+     * Use the new constructor {@link #ComposeContainer(DockerImageName image, File... composeFiles)}
      */
-    @Deprecated
     public ComposeContainer(File... composeFiles) {
         this(DEFAULT_IMAGE_NAME, Arrays.asList(composeFiles));
+        this.localCompose = true;
     }
 
     /**
-     * @deprecated
-     *  Use the new constructor ComposeContainer(DockerImageName image,List composeFiles)
+     * Use the new constructor {@link #ComposeContainer(DockerImageName image, List composeFiles)}
      */
-    @Deprecated
     public ComposeContainer(List<File> composeFiles) {
         this(DEFAULT_IMAGE_NAME, composeFiles);
+        this.localCompose = true;
     }
 
     /**
-     * @deprecated
-     *  Use the new constructor ComposeContainer(DockerImageName image, String identifier, File... composeFile)
+     * Use the new constructor {@link #ComposeContainer(DockerImageName image, String identifier, File... composeFile)}
      */
-    @Deprecated
     public ComposeContainer(String identifier, File... composeFiles) {
         this(DEFAULT_IMAGE_NAME, identifier, Arrays.asList(composeFiles));
+        this.localCompose = true;
     }
 
     /**
-     * @deprecated
-     * Use the new constructor ComposeContainer(DockerImageName image,String identifier, List composeFiles)
+     * Use the new constructor {@link #ComposeContainer(DockerImageName image, String identifier, List composeFiles)}
      */
-    @Deprecated
     public ComposeContainer(String identifier, List<File> composeFiles) {
         this(DEFAULT_IMAGE_NAME, identifier, composeFiles);
+        this.localCompose = true;
     }
 
     @Override
@@ -291,16 +299,6 @@ public ComposeContainer withEnv(Map<String, String> env) {
         return this;
     }
 
-    /**
-     * Use a local Docker Compose binary instead of a container.
-     *
-     * @return this instance, for chaining
-     */
-    public ComposeContainer withLocalCompose(boolean localCompose) {
-        this.localCompose = localCompose;
-        return this;
-    }
-
     /**
      * Whether to pull images first.
      *

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

@@ -66,18 +66,17 @@ public class DockerComposeContainer<SELF extends DockerComposeContainer<SELF>> i
     private List<String> filesInDirectory = new ArrayList<>();
 
     /**
-     * Creates a new DockerComposeContainer with the specified Docker image, identifier, and a single compose file.
+     * Creates a new DockerComposeContainer using the specified Docker image and compose files.
      *
      * @param image        The Docker image to use for the container
-     * @param identifier   A unique identifier for this compose environment
-     * @param composeFile  A Docker Compose configuration file
+     * @param composeFiles One or more Docker Compose configuration files
      */
-    public DockerComposeContainer(DockerImageName image, String identifier, File composeFile) {
-        this(image, identifier, Collections.singletonList(composeFile));
+    public DockerComposeContainer(DockerImageName image, File... composeFiles) {
+        this(image, Arrays.asList(composeFiles));
     }
 
     /**
-     * Creates a new DockerComposeContainer with a random identifier using the specified Docker image and compose files.
+     * Creates a new DockerComposeContainer using the specified Docker image and compose files.
      *
      * @param image        The Docker image to use for the container
      * @param composeFiles A list of Docker Compose configuration files
@@ -97,9 +96,19 @@ public DockerComposeContainer(DockerImageName image, String identifier, File...
         this(image, identifier, Arrays.asList(composeFiles));
     }
 
+    /**
+     * Creates a new DockerComposeContainer with the specified Docker image, identifier, and a single compose file.
+     *
+     * @param image        The Docker image to use for the container
+     * @param identifier   A unique identifier for this compose environment
+     * @param composeFile  A Docker Compose configuration file
+     */
+    public DockerComposeContainer(DockerImageName image, String identifier, File composeFile) {
+        this(image, identifier, Collections.singletonList(composeFile));
+    }
+
     /**
      * Creates a new DockerComposeContainer with the specified Docker image, identifier, and compose files.
-     * This is the primary constructor that all other constructors delegate to.
      *
      * @param image        The Docker image to use for the container
      * @param identifier   A unique identifier for this compose environment
@@ -112,46 +121,41 @@ public DockerComposeContainer(DockerImageName image, String identifier, List<Fil
     }
 
     /**
-     * @deprecated
-     *  Use the new constructor DockerComposeContainer(File composeFile, String identifier)
+     * Use the new constructor {@link #DockerComposeContainer(DockerImageName image, String identifier, File composeFile)}
      */
-    @Deprecated
     public DockerComposeContainer(File composeFile, String identifier) {
         this(identifier, composeFile);
+        this.localCompose = true;
     }
 
     /**
-     * @deprecated
-     *  Use the new constructor DockerComposeContainer(File... composeFiles)
+     * Use the new constructor {@link #DockerComposeContainer(DockerImageName image, List composeFiles)}
      */
-    @Deprecated
     public DockerComposeContainer(File... composeFiles) {
         this(Arrays.asList(composeFiles));
+        this.localCompose = true;
     }
 
     /**
-     * @deprecated
-     *  Use the new constructor DockerComposeContainer(List composeFiles)
+     * Use the new constructor {@link #DockerComposeContainer(DockerImageName image, List composeFiles)}
      */
     @Deprecated
     public DockerComposeContainer(List<File> composeFiles) {
         this(Base58.randomString(6).toLowerCase(), composeFiles);
+        this.localCompose = true;
     }
 
     /**
-     * @deprecated
-     *  Use the new constructor DockerComposeContainer(String identifier,File... composeFiles)
+     * Use the new constructor {@link #DockerComposeContainer(DockerImageName image, String identifier, File... composeFiles)}
      */
-    @Deprecated
     public DockerComposeContainer(String identifier, File... composeFiles) {
         this(identifier, Arrays.asList(composeFiles));
+        this.localCompose = true;
     }
 
     /**
-     * @deprecated
-     *  Use the new constructor DockerComposeContainer(String identifier,List composeFiles)
+     * Use the new constructor {@link #DockerComposeContainer(DockerImageName image, String identifier, List composeFiles)}
      */
-    @Deprecated
     public DockerComposeContainer(String identifier, List<File> composeFiles) {
         this.composeDelegate =
             new ComposeDelegate(
@@ -162,6 +166,7 @@ public DockerComposeContainer(String identifier, List<File> composeFiles) {
                 DockerImageName.parse("docker/compose:1.29.2")
             );
         this.project = this.composeDelegate.getProject();
+        this.localCompose = true;
     }
 
     @Override
@@ -303,16 +308,6 @@ public SELF withEnv(Map<String, String> env) {
         return self();
     }
 
-    /**
-     * Use a local Docker Compose binary instead of a container.
-     *
-     * @return this instance, for chaining
-     */
-    public SELF withLocalCompose(boolean localCompose) {
-        this.localCompose = localCompose;
-        return self();
-    }
-
     /**
      * Whether to pull images first.
      *

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

@@ -244,7 +244,7 @@ private String getConfigurable(
         }
 
         for (final Properties properties : propertiesSources) {
-            if (properties.get(propertyName) != null && !properties.get(propertyName).toString().trim().isEmpty()) {
+            if (properties.get(propertyName) != null) {
                 return (String) properties.get(propertyName);
             }
         }

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

@@ -1,82 +1,49 @@
 package org.testcontainers.containers;
 
-import ch.qos.logback.classic.Logger;
-import ch.qos.logback.classic.spi.ILoggingEvent;
-import ch.qos.logback.core.AppenderBase;
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
-import org.slf4j.LoggerFactory;
+import org.junit.jupiter.api.Test;
 import org.testcontainers.utility.DockerImageName;
-import org.testcontainers.utility.TestcontainersConfiguration;
 
 import java.io.File;
-import java.util.ArrayList;
-import java.util.List;
+import java.util.Optional;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-public class ComposeContainerTest {
+class ComposeContainerTest {
 
     public static final String DOCKER_IMAGE = "docker:25.0.2";
 
-    private static final String COMPOSE_FILE_PATH = "src/test/resources/docker-compose-imagename-parsing-v2.yml";
-
-    private ComposeContainer composeContainer;
-
-    private TestLogAppender testLogAppender;
-
-    private Logger rootLogger;
-
-    @Before
-    public void setup() {
-        testLogAppender = new TestLogAppender();
-        testLogAppender.start();
-        rootLogger = (Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
-        rootLogger.addAppender(testLogAppender);
-        TestcontainersConfiguration.getInstance().updateUserConfig("compose.container.image", DOCKER_IMAGE);
-    }
-
-    @After
-    public void tearDown() {
-        composeContainer.stop();
-        rootLogger.detachAppender(testLogAppender);
-        TestcontainersConfiguration.getInstance().updateUserConfig("compose.container.image", "");
-        System.clearProperty("compose.container.image");
-    }
+    private static final String COMPOSE_FILE_PATH = "src/test/resources/v2-compose-test.yml";
 
     @Test
-    public void testWithCustomDockerImage() {
-        composeContainer = new ComposeContainer(DockerImageName.parse(DOCKER_IMAGE), new File(COMPOSE_FILE_PATH));
+    void testWithCustomDockerImage() {
+        ComposeContainer composeContainer = new ComposeContainer(
+            DockerImageName.parse(DOCKER_IMAGE),
+            new File(COMPOSE_FILE_PATH)
+        );
         composeContainer.start();
-        verifyContainerCreation();
+        verifyContainerCreation(composeContainer);
+        composeContainer.stop();
     }
 
     @Test
-    public void testWithCustomDockerImageAndIdentifier() {
-        composeContainer =
-            new ComposeContainer(DockerImageName.parse(DOCKER_IMAGE), "myidentifier", new File(COMPOSE_FILE_PATH));
+    void testWithCustomDockerImageAndIdentifier() {
+        ComposeContainer composeContainer = new ComposeContainer(
+            DockerImageName.parse(DOCKER_IMAGE),
+            "myidentifier",
+            new File(COMPOSE_FILE_PATH)
+        );
         composeContainer.start();
-        verifyContainerCreation();
-    }
-
-    private void verifyContainerCreation() {
-        List<String> logs = testLogAppender.getLogs();
-
-        assertThat(logs).isNotNull().anyMatch(line -> line.contains("Creating container for image: " + DOCKER_IMAGE));
+        verifyContainerCreation(composeContainer);
+        composeContainer.stop();
     }
 
-    private static class TestLogAppender extends AppenderBase<ILoggingEvent> {
-
-        private final List<String> logs = new ArrayList<>();
-
-        @Override
-        protected void append(ILoggingEvent eventObject) {
-            logs.add(eventObject.getFormattedMessage());
-        }
-
-        public List<String> getLogs() {
-            return logs;
-        }
+    private void verifyContainerCreation(ComposeContainer composeContainer) {
+        Optional<ContainerState> redis = composeContainer.getContainerByServiceName("redis");
+        assertThat(redis)
+            .hasValueSatisfying(container -> {
+                assertThat(container.isRunning()).isTrue();
+                assertThat(container.getContainerInfo().getConfig().getLabels())
+                    .containsEntry("com.docker.compose.version", "2.24.5");
+            });
     }
 }