KaneAI - World’s First E2E Software Testing Agent.Signup for Private Beta 
How to use withOptions method of org.testcontainers.containers.DockerComposeContainer class
Best Testcontainers-java code snippet using org.testcontainers.containers.DockerComposeContainer.withOptions
Source:KafkaComposeTestContainersLiveTest.java 
...43 private static String KAFKA_SERVICE = "kafka";44 @Container45 private static final DockerComposeContainer kafka =46 new DockerComposeContainer(new File("src/test/resources/compose-test.yml"))47 .withOptions("--compatibility")48 .withExposedService(KAFKA_SERVICE , KAFKA_PORT, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(360)))49 .withLocalCompose(true);50 51 @Autowired52 public KafkaTemplate<String, String> template;53 @Autowired54 private KafkaConsumer consumer;55 @Autowired56 private KafkaProducer producer;57 @Value("${test.topic}")58 private String topic;59 @Test60 public void givenKafkaDockerContainer_whenSendingtoDefaultTemplate_thenMessageReceived() throws Exception {61 template.send(topic, "Sending with default template");...
Source:BaseTest.java
...25 Arrays.stream(COMPOSE_FILES_PATHS)26 .map(path -> Paths.get(path).toAbsolutePath().normalize().toFile())27 .collect(Collectors.toList())28 )29 .withOptions("--env-file " + ENV_FILE_PATH);30 @DynamicPropertySource31 static void mongoProperties(DynamicPropertyRegistry registry) {32 composeContainer33 .withEnv(MONGO.getHostPortEnvVariable(), MONGO.getHostPort())34 .withEnv(MOCKSERVER.getHostPortEnvVariable(), MOCKSERVER.getHostPort())35 .withEnv("COMPOSE_PROFILES", "mockserver")36 .withExposedService(MONGO.getName(), MONGO.getPort(), Wait.forListeningPort())37 .withExposedService(MOCKSERVER.getName(), MOCKSERVER.getPort(), Wait.forHttp("/health").forStatusCode(200))38 .start();39 registry.add("spring.data.mongodb.host", () -> composeContainer.getServiceHost(MONGO.getName(), MONGO.getPort()));40 registry.add("spring.data.mongodb.port", () -> composeContainer.getServicePort(MONGO.getName(), MONGO.getPort()));41 registry.add("MOCK_SERVER_PORT", () -> composeContainer.getServicePort(MOCKSERVER.getName(), MOCKSERVER.getPort()));42 }43}...
Source:MariaDBTestResourceLifecycleManager.java
...12 public Map<String, String> start() {13 dockerCompose = new DockerComposeContainer<>(new File("../docker-compose.yml"), new File("../docker-compose.test.yml"))14 .withExposedService(MARIADB, MARIADB_PORT)15 .withLocalCompose(true)16 .withOptions("--compatibility")17 .withServices(MARIADB)18 .withRemoveImages(RemoveImages.LOCAL);19 dockerCompose.start();20 String url = String.format("jdbc:mariadb://%s:%d/cmc_learning_tree",21 dockerCompose.getServiceHost(MARIADB, MARIADB_PORT), dockerCompose.getServicePort(MARIADB, MARIADB_PORT));22 return Map.of(23 "quarkus.datasource.username", "dba",24 "quarkus.datasource.password", "GorH4l%^ztKi",25 "quarkus.datasource.jdbc.url", url,26 "quarkus.oidc.token.audience", "http://localhost:8080/api",27 "app.auth0.username", "username",28 "app.auth0.password", "password");29 }30 @Override...
withOptions
Using AI Code Generation
1import org.testcontainers.containers.DockerComposeContainer;2import org.testcontainers.containers.wait.strategy.Wait;3import org.testcontainers.containers.wait.strategy.WaitAllStrategy;4import org.testcontainers.containers.wait.strategy.WaitStrategy;5import org.testcontainers.utility.MountableFile;6import java.io.File;7import java.time.Duration;8import java.util.ArrayList;9import java.util.List;10import java.util.concurrent.TimeUnit;11public class TestcontainersTest {12 public static void main(String[] args) {13 List<String> composeFiles = new ArrayList<>();14 composeFiles.add("/Users/abc/Downloads/docker-compose.yml");15 DockerComposeContainer container = new DockerComposeContainer(new File("/Users/abc/Downloads/docker-compose.yml"))16 .withLocalCompose(true)17 .withExposedService("app_1", 8080, Wait.forHttp("/").forStatusCode(200).forResponsePredicate(response -> response.contains("Welcome to nginx!")))18 .withExposedService("db_1", 3306, Wait.forListeningPort())19 .withExposedService("redis_1", 6379, Wait.forListeningPort())20 .withExposedService("app_1", 8080, Wait.forHttp("/").forStatusCode(200).forResponsePredicate(response -> response.contains("Welcome to nginx!")))21 .withExposedService("db_1", 3306, Wait.forListeningPort())22 .withExposedService("redis_1", 6379, Wait.forListeningPort())23 .withExposedService("app_1", 8080, Wait.forHttp("/").forStatusCode(200).forResponsePredicate(response -> response.contains("Welcome to nginx!")))24 .withExposedService("db_1", 3306, Wait.forListeningPort())25 .withExposedService("redis_1", 6379, Wait.forListeningPort())26 .withExposedService("app_1", 8080, Wait.forHttp("/").forStatusCode(200).forResponsePredicate(response -> response.contains("Welcome to nginx!")))27 .withExposedService("db_1", 3306, Wait.forListeningPort())28 .withExposedService("redis_1", 6379, Wait.forListeningPort())29 .withExposedService("app_1", 8080, Wait.forHttp("/").forStatusCode(200).forResponsePredicate(response -> response.contains("Welcome to nginx!")))30 .withExposedService("db_1", 330
withOptions
Using AI Code Generation
1import org.testcontainers.containers.DockerComposeContainer;2import org.testcontainers.containers.wait.strategy.Wait;3import org.testcontainers.containers.wait.strategy.WaitAllStrategy;4import org.testcontainers.containers.wait.strategy.WaitStrategy;5import org.testcontainers.images.builder.ImageFromDockerfile;6import java.io.File;7import java.time.Duration;8public class DockerComposeContainerTest {9 public static void main(String[] args) {10 WaitStrategy waitStrategy = new WaitAllStrategy()11 .withStrategy(Wait.forLogMessage(".*Started Application.*", 1))12 .withStrategy(Wait.forHttp("/actuator/health").forStatusCode(200))13 .withStartupTimeout(Duration.ofSeconds(60));14 DockerComposeContainer container = new DockerComposeContainer(new File("docker-compose.yml"))15 .withExposedService("app_1", 8080, waitStrategy);16 container.start();17 }18}19The withExposedService() method accepts three parameters:
withOptions
Using AI Code Generation
1import org.testcontainers.containers.DockerComposeContainer;2import org.testcontainers.containers.output.Slf4jLogConsumer;3import org.testcontainers.containers.wait.strategy.Wait;4import org.testcontainers.containers.wait.strategy.WaitAllStrategy;5import org.testcontainers.lifecycle.Startables;6import org.testcontainers.utility.MountableFile;7import java.io.File;8import java.nio.file.Paths;9import java.time.Duration;10import java.util.concurrent.TimeUnit;11import java.util.stream.Stream;12import static org.testcontainers.containers.DockerComposeContainer.LOCAL_ENVIRONMENT;13public class DockerComposeContainerTest {14 public static void main(String[] args) {15 DockerComposeContainer container = new DockerComposeContainer(new File("docker-compose.yml"))16 .withLocalCompose(true)17 .withExposedService("app_1", 8080, Wait.forHttp("/").forStatusCode(200).withStartupTimeout(Duration.ofSeconds(30)))18 .withExposedService("db_1", 5432, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))19 .withExposedService("redis_1", 6379, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))20 .withExposedService("rabbit_1", 5672, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))21 .withExposedService("rabbit_1", 15672, Wait.forHttp("/api/healthchecks/node").forStatusCode(200).withStartupTimeout(Duration.ofSeconds(30)))22 .withExposedService("selenium_1", 4444, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))23 .withExposedService("selenium_1", 5900, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))24 .withExposedService("selenium_1", 5555, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))25 .withExposedService("selenium_1", 5556, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))26 .withExposedService("selenium_1", 4445, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))27 .withExposedService("selenium_1", 4446, Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(30)))
withOptions
Using AI Code Generation
1import com.github.dockerjava.api.model.ExposedPort;2import com.github.dockerjava.api.model.Ports;3import org.testcontainers.containers.DockerComposeContainer;4import org.testcontainers.containers.output.OutputFrame;5import org.testcontainers.containers.output.ToStringConsumer;6import org.testcontainers.utility.DockerImageName;7import java.io.File;8import java.nio.file.Paths;9public class DockerComposeContainerWithOptions {10 public static void main(String[] args) {11 DockerComposeContainer dockerComposeContainer = new DockerComposeContainer(Paths.get("docker-compose.yml").toFile())12 .withExposedService("redis_1", 6379, ExposedPort.tcp(6379), new ToStringConsumer<OutputFrame>() {13 public void accept(OutputFrame outputFrame) {14 System.out.println(outputFrame.getUtf8String());15 }16 })17 .withExposedService("redis_2", 6379, ExposedPort.tcp(6379), new ToStringConsumer<OutputFrame>() {18 public void accept(OutputFrame outputFrame) {19 System.out.println(outputFrame.getUtf8String());20 }21 })22 .withExposedService("redis_3", 6379, ExposedPort.tcp(6379), new ToStringConsumer<OutputFrame>() {23 public void accept(OutputFrame outputFrame) {24 System.out.println(outputFrame.getUtf8String());25 }26 })27 .withExposedService("redis_4", 6379, ExposedPort.tcp(6379), new ToStringConsumer<OutputFrame>() {28 public void accept(OutputFrame outputFrame) {29 System.out.println(outputFrame.getUtf8String());30 }31 })32 .withExposedService("redis_5", 6379, ExposedPort.tcp(6379), new ToStringConsumer<OutputFrame>() {33 public void accept(OutputFrame outputFrame) {34 System.out.println(outputFrame.getUtf8String());35 }36 })37 .withExposedService("redis_6", 6379, ExposedPort.tcp(6379), new ToStringConsumer<OutputFrame>() {38 public void accept(OutputFrame outputFrame) {39 System.out.println(outputFrame.getUtf8String());40 }41 })42 .withExposedService("redis_7", 6379, ExposedPort.tcp(6379), new ToStringConsumer<OutputFrame>() {
withOptions
Using AI Code Generation
1package org.testcontainers.containers;2import org.testcontainers.containers.output.OutputFrame;3import org.testcontainers.containers.output.ToStringConsumer;4import org.testcontainers.containers.output.WaitingConsumer;5import org.testcontainers.utility.MountableFile;6import java.io.File;7import java.io.IOException;8import java.util.concurrent.TimeUnit;9public class DockerComposeContainerTest {10 public static void main(String[] args) throws IOException, InterruptedException {11 DockerComposeContainer container = new DockerComposeContainer(new File("compose.yml"))12 .withExposedService("db_1", 5432)13 .withExposedService("web_1", 5000)14 .withLocalCompose(true)15 .withPull(false)16 .withTailChildContainers(true)17 .withCommand("up -d")18 .withScaledService("web_1", 3)19 .withScaledService("db_1", 2)20 .withEnv("TEST_VAR", "test")21 .withEnv("TEST_VAR2", "test2")22 .withEnv("TEST_VAR3", "test3")23 .withEnv("TEST_VAR4", "test4")24 .withEnv("TEST_VAR5", "test5")25 .withEnv("TEST_VAR6", "test6")26 .withEnv("TEST_VAR7", "test7")27 .withEnv("TEST_VAR8", "test8")28 .withEnv("TEST_VAR9", "test9")29 .withEnv("TEST_VAR10", "test10")30 .withEnv("TEST_VAR11", "test11")31 .withEnv("TEST_VAR12", "test12")32 .withEnv("TEST_VAR13", "test13")33 .withEnv("TEST_VAR14", "test14")34 .withEnv("TEST_VAR15", "test15")35 .withEnv("TEST_VAR16", "test16")36 .withEnv("TEST_VAR17", "test17")37 .withEnv("TEST_VAR18", "test18")38 .withEnv("TEST_VAR19", "test19")39 .withEnv("TEST_VAR20", "test20")40 .withEnv("TEST_VAR21", "test21")41 .withEnv("TEST_VAR22", "test22")42 .withEnv("TEST_VAR23", "test23")43 .withEnv("TEST_VAR24", "test24")
withOptions
Using AI Code Generation
1package com.testcontainers;2import org.junit.Test;3import org.slf4j.Logger;4import org.slf4j.LoggerFactory;5import org.testcontainers.containers.DockerComposeContainer;6import org.testcontainers.containers.output.Slf4jLogConsumer;7import org.testcontainers.containers.wait.strategy.Wait;8import java.io.File;9import java.util.concurrent.TimeUnit;10public class DockerComposeContainerTest {11 private static final Logger LOGGER = LoggerFactory.getLogger(DockerComposeContainerTest.class);12 public void test() {13 DockerComposeContainer container = new DockerComposeContainer(new File("src/test/resources/docker-compose.yml"))14 .withExposedService("redis_1", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))15 .withExposedService("redis_2", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))16 .withExposedService("redis_3", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))17 .withExposedService("redis_4", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))18 .withExposedService("redis_5", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))19 .withExposedService("redis_6", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))20 .withExposedService("redis_7", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))21 .withExposedService("redis_8", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))22 .withExposedService("redis_9", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))23 .withExposedService("redis_10", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))24 .withExposedService("redis_11", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))25 .withExposedService("redis_12", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))26 .withExposedService("redis_13", 6379, Wait.forListeningPort().withStartupTimeout(30, TimeUnit.SECONDS))27 .withExposedService("redis_14", 637
withOptions
Using AI Code Generation
1import org.testcontainers.containers.DockerComposeContainer;2import java.io.File;3public class DockerComposeContainerTest {4 public static void main(String[] args) {5 DockerComposeContainer container = new DockerComposeContainer(new File("docker-compose.yml"))6 .withLocalCompose(true)7 .withExposedService("db_1", 3306)8 .withExposedService("db_2", 3306);9 container.start();10 }11}
withOptions
Using AI Code Generation
1package com.mycompany.app;2import org.testcontainers.containers.DockerComposeContainer;3import java.io.File;4public class App {5 public static void main(String[] args) {6 File composeFile = new File("docker-compose.yml");7 DockerComposeContainer container = new DockerComposeContainer(composeFile).withExposedService("my_service_1", 8080);8 container.start();9 System.out.println("Docker Compose container started");10 }11}
withOptions
Using AI Code Generation
1import org.testcontainers.containers.DockerComposeContainer;2import org.testcontainers.containers.wait.strategy.Wait;3import org.testcontainers.utility.DockerImageName;4import java.io.File;5import java.util.concurrent.TimeUnit;6public class DockerComposeContainerTest {7 public static void main(String[] args) {8 DockerComposeContainer container = new DockerComposeContainer(new File("docker-compose.yml"))9 .withExposedService("db_1", 3306, Wait.forListeningPort()10 .withStartupTimeout(Duration.of(60, TimeUnit.SECONDS)))11 .withExposedService("db_2", 3306, Wait.forListeningPort()12 .withStartupTimeout(Duration.of(60, TimeUnit.SECONDS)));13 container.start();14 }15}
withOptions
Using AI Code Generation
1package com.mycompany.app;2import org.testcontainers.containers.DockerComposeContainer;3import java.io.File;4import java.io.IOException;5public class App {6 public static void main(String[] args) throws IOException, InterruptedException {7 File composeFile = new File("docker-compose.yml");8 DockerComposeContainer container = new DockerComposeContainer(composeFile)9 .withExposedService("service_1", 8080)10 .withExposedService("service_2", 8080)11 .withLocalCompose(true);12 container.start();13 System.out.println("Container started");14 Thread.sleep(60000);15 container.stop();16 System.out.println("Container stopped");17 }18}19package com.mycompany.app;20import org.testcontainers.containers.DockerComposeContainer;21import java.io.File;22import java.io.IOException;23public class App {24 public static void main(String[] args) throws IOException, InterruptedException {25 File composeFile = new File("docker-compose.yml");26 DockerComposeContainer container = new DockerComposeContainer(composeFile)27 .withExposedService("service_1", 8080)
Automation Testing Tutorials
Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run Testcontainers-java automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Most used method in DockerComposeContainer
- AtomicInteger
- SocatContainer
- Object
- DockerComposeContainer
- apply
- starting
- succeeded
- failed
- finished
- start
- pullImages
- withServices
- createServices
- optionsAsString
- waitUntilServiceStarted
- createServiceInstance
- getServiceNameFromContainer
- runWithCompose
- registerContainersForShutdown
- startAmbassadorContainers
- stop
- withExposedService
- getServiceInstanceName
- addWaitStrategy
- waitingFor
- getServiceHost
- getServicePort
- withScaledService
- withEnv
- withLocalCompose
- withPull
- withTailChildContainers
- withLogConsumer
- withBuild
- withOptions
- withRemoveImages
- withStartupTimeout
- getContainerByServiceName
- followLogs
- self
- randomProjectId
- dockerRemoveImagesType
- ContainerisedDockerCompose
- invoke
- convertToUnixFilesystemPath
- LocalDockerCompose
- withCommand
- logger
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
