KaneAI - World’s First E2E Software Testing Agent.Signup for Private Beta Join TestMu Conference

How to use DockerClientFactory class of org.testcontainers package

Best Testcontainers-java code snippet using org.testcontainers.DockerClientFactory

Source:DockerClientUtils.java

1package org.example.environment.framework.utils;2import com.github.dockerjava.api.DockerClient;3import com.github.dockerjava.api.model.Container;4import org.slf4j.LoggerFactory;5import org.testcontainers.DockerClientFactory;6import org.testcontainers.containers.output.Slf4jLogConsumer;7import org.testcontainers.utility.LogUtils;8import java.util.Collections;9import java.util.Objects;10import java.util.stream.Stream;11import static org.example.environment.framework.utils.ContainerPredicates.*;12public class DockerClientUtils {13    private static final String RYUK_NAME = "testcontainers-ryuk-" + DockerClientFactory.SESSION_ID;14    public static String getLogs(String containerId){15        return LogUtils.getOutput(getClient(), containerId);16    }17    public static void followOutput(Stream<Container> containers) {18        containers.forEach(container ->19                        LogUtils.followOutput(getClient(), container.getId(), new Slf4jLogConsumer(LoggerFactory.getLogger(DockerClientUtils.class))));20    }21    public static String getNetworkIdOfContainerWithOpenPublicPort(int port) {22        return findContainersWithOpenPublicPort(port)23                .flatMap(container -> Objects.requireNonNull(container.getNetworkSettings())24                        .getNetworks()25                        .keySet()26                        .stream())27                .distinct()28                .findFirst()29                .orElse(null);30    }31    /**32     * TC starts Ryuk at first call to DockerClientFactory which instantiates docker client.33     * This is this call DockerClientFactory.instance().client().34     * It forces TC to start Ryuk.35     * Client instance will be returned only upon successful Ryuk startup.36     * Thus we are going to instantiate docker client and kill Ryuk when it was successfully started.37     */38    public static void killRyukContainer() {39        killContainers(findRyuk());40    }41    public static void killContainers(Stream<Container> containers) {42        containers.parallel()43                .map(Container::getId)44                .forEach(id ->45                        DockerClientFactory.instance().client()46                                .removeContainerCmd(id)47                                .withForce(true)48                                .exec()49                );50    }51    private static Stream<Container> findContainersWithOpenPublicPort(int port) {52        return findRunningContainers()53                .filter(hasAnyNetwork())54                .filter(hasOpenPort(port));55    }56    public static Stream<Container> findContainersBelongingToNetwork(String network) {57        return findRunningContainers()58                .filter(hasAnyNetwork())59                .filter(hasValidNetworkSettings(network));60    }61    public static Stream<Container> findRunningContainers() {62        return getClient().listContainersCmd()63                .withStatusFilter(Collections.singletonList("running"))64                .exec()65                .stream();66    }67    private static Stream<Container> findRyuk() {68        return findRunningContainers()69                .filter(hasName(RYUK_NAME));70    }71    private static DockerClient getClient() {72        return DockerClientFactory.instance().client();73    }74}...

Source:DockerClientFactoryTest.java

1package org.testcontainers;2import com.github.dockerjava.api.exception.NotFoundException;3import org.junit.Test;4import org.rnorth.visibleassertions.VisibleAssertions;5import org.testcontainers.DockerClientFactory.DiskSpaceUsage;6import org.testcontainers.dockerclient.LogToStringContainerCallback;7import org.testcontainers.utility.TestcontainersConfiguration;8/**9 * Test for {@link DockerClientFactory}.10 */11public class DockerClientFactoryTest {12    @Test13    public void runCommandInsideDockerShouldNotFailIfImageDoesNotExistsLocally() {14        final DockerClientFactory dockFactory = DockerClientFactory.instance();15        try {16            // remove tiny image, so it will be pulled during next command run17            dockFactory.client().removeImageCmd(TestcontainersConfiguration.getInstance().getTinyImage()).withForce(true).exec();18        } catch (NotFoundException ignored) {19            // Do not fail if it's not pulled yet20        }21        dockFactory.runInsideDocker(( cmd) -> cmd.withCmd("sh", "-c", "echo 'SUCCESS'"), ( client, id) -> client.logContainerCmd(id).withStdOut(true).exec(new LogToStringContainerCallback()).toString());22    }23    @Test24    public void shouldHandleBigDiskSize() throws Exception {25        String dfOutput = "/dev/disk1     2982480572 1491240286 2982480572    31%    /";26        DiskSpaceUsage usage = DockerClientFactory.instance().parseAvailableDiskSpace(dfOutput);27        VisibleAssertions.assertEquals("Available MB is correct", (2982480572L / 1024L), usage.availableMB.orElse(0L));28        VisibleAssertions.assertEquals("Available percentage is correct", 31, usage.usedPercent.orElse(0));29    }30}...

Source:ContainerShould.java

2import org.junit.BeforeClass;3import org.junit.Test;4import org.slf4j.Logger;5import org.slf4j.LoggerFactory;6import org.testcontainers.DockerClientFactory;7import org.testcontainers.containers.output.Slf4jLogConsumer;8import org.testcontainers.utility.LogUtils;9import helpers.DockerImageTagResolver;10import io.homecentr.testcontainers.containers.GenericContainerEx;11import io.homecentr.testcontainers.containers.wait.strategy.WaitEx;12public abstract class ContainerShould {13    private static final Logger logger = LoggerFactory.getLogger(ContainerShould.class);14    private static GenericContainerEx _container;15    @BeforeClass16    public static void setUp() {17        _container = new GenericContainerEx<>(new DockerImageTagResolver())18                .waitingFor(WaitEx.forS6OverlayStart());19        _container.start();20        LogUtils.followOutput(DockerClientFactory.instance().client(), _container.getContainerId(), new Slf4jLogConsumer(logger));21    }22    @AfterClass23    public static void cleanUp() {24        _container.close();25    }26    @Test27    public void doSomething() throws Exception {28        throw new Exception("Implement the test");29    }30}...

DockerClientFactory

Using AI Code Generation

1import org.testcontainers.DockerClientFactory;2import com.github.dockerjava.api.DockerClient;3import com.github.dockerjava.api.command.CreateContainerResponse;4import com.github.dockerjava.api.model.Container;5import com.github.dockerjava.api.model.ExposedPort;6import com.github.dockerjava.api.model.Ports;7import com.github.dockerjava.api.model.Ports.Binding;8import com.github.dockerjava.api.model.Ports.Binding;9import com.github.dockerjava.core.DockerClientBuilder;10import com.github.dockerjava.core.command.PullImageResultCallback;11import com.github.dockerjava.core.command.PushImageResultCallback;12import com.github.dockerjava.api.model.Image;13import com.github.dockerjava.api.command.InspectImageResponse;14import com.github.dockerjava.api.model.Container;15import com.github.dockerjava.api.command.InspectContainerResponse;16import java.util.List;17import java.util.ListIterator;18import java.util.Iterator;19import java.util.Map;20import java.util.Map.Entry;21import java.util.Set;22import java.util.HashMap;23import java.util.ArrayList;24import java.util.Arrays;25import java.util.Collection;26import java.util.Collections;27import java.util.HashSet;28import java.util.Date;29import java.util.concurrent.TimeUnit;30import java.util.concurrent.TimeoutException;31import java.util.concurrent.Executors;32import java.util.concurrent.ExecutorService;33import java.util.concurrent.CompletableFuture;34import java.util.concurrent.CompletionException;35import java.util.concurrent.CompletionStage;36import java.util.concurrent.ExecutionException;37import java.util.concurrent.atomic.AtomicInteger;38import java.util.stream.Collectors;39import java.util.stream.Stream;40import java.util.function.Function;41import java.util.function.Predicate;42import java.util.function.Supplier;43import java.util.function.Consumer;44import java.util.stream.Stream;45import java.util.stream.StreamSupport;46import java.util.stream.IntStream;47import java.util.stream.LongStream;48import java.util.concurrent.Future;49import java.util.concurrent.Callable;50import java.util.concurrent.Executor;51import java.util.concurrent.ExecutorService;52import java.util.concurrent.Executors;53import java.util.concurrent.ScheduledExecutorService;54import java.util.concurrent.TimeUnit;55import java.util.concurrent.TimeoutException;56import java.util.concurrent.atomic.AtomicInteger;57import java.util.concurrent.atomic.AtomicLong;58import java.util.concurrent.atomic.AtomicReference;59import java.util.concurrent.locks.Lock;60import java.util.concurrent.locks.ReentrantLock;61import java.util.concurrent.locks.Condition;62import java.util.concurrent.locks.ReentrantReadWriteLock;63import java.util.concurrent.locks.ReadWriteLock;64import java.util.concurrent.CompletableFuture;65import java.util.concurrent.CompletionStage;

DockerClientFactory

Using AI Code Generation

1import org.testcontainers.DockerClientFactory;2import org.testcontainers.containers.GenericContainer;3import org.testcontainers.containers.output.Slf4jLogConsumer;4import org.testcontainers.containers.output.ToStringConsumer;5import org.testcontainers.containers.wait.strategy.Wait;6import org.testcontainers.utility.DockerImageName;7import org.slf4j.Logger;8import org.slf4j.LoggerFactory;9import java.util.concurrent.TimeUnit;10public class ContainerTest {11    public static void main(String[] args) throws Exception {12        Logger logger = LoggerFactory.getLogger(ContainerTest.class);13        DockerClientFactory.instance().client();14        GenericContainer container = new GenericContainer(DockerImageName.parse("alpine:3.13.5"))15                .withCommand("tail", "-f", "/dev/null")16                .withExposedPorts(80)17                .waitingFor(Wait.forHttp("/").forPort(80).forStatusCode(200).withStartupTimeout(Duration.of(60, SECONDS)))18                .withLogConsumer(new Slf4jLogConsumer(logger));

DockerClientFactory

Using AI Code Generation

1import org.testcontainers.DockerClientFactory;2import org.testcontainers.containers.GenericContainer;3import org.testcontainers.containers.wait.strategy.Wait;4import org.testcontainers.images.builder.ImageFromDockerfile;5import java.io.File;6import java.io.IOException;7import java.util.concurrent.TimeUnit;8public class TestContainerDemo {9    public static void main(String[] args) throws IOException, InterruptedException {10        DockerClientFactory.instance().client();11        ImageFromDockerfile image = new ImageFromDockerfile()12                .withFileFromFile("Dockerfile", new File("Dockerfile"));13        GenericContainer container = new GenericContainer(image)14                .withExposedPorts(8080)15                .withEnv("JAVA_OPTS", "-Djava.security.egd=file:/dev/./urandom")16                .withCommand("/bin/sh", "-c", "java $JAVA_OPTS -jar /app.jar")17                .waitingFor(Wait.forHttp("/").forPort(8080).forStatusCode(200));18        container.start();19        System.out.println("Container Status: "+container.isRunning());20        System.out.println("Container IP Address: "+container.getContainerIpAddress());21        System.out.println("Container Port: "+container.getMappedPort(8080));22        TimeUnit.SECONDS.sleep(5);23        container.stop();24    }25}

DockerClientFactory

Using AI Code Generation

1package org.testcontainers;2import org.testcontainers.containers.GenericContainer;3import org.testcontainers.containers.output.Slf4jLogConsumer;4import org.testcontainers.containers.wait.strategy.Wait;5import org.testcontainers.containers.wait.strategy.WaitAllStrategy;6import org.testcontainers.containers.wait.strategy.WaitStrategy;7import org.testcontainers.utility.DockerImageName;8import org.testcontainers.utility.TestcontainersConfiguration;9import java.util.concurrent.TimeUnit;10public class DockerClientFactoryTest {11    public static void main(String[] args) {12        System.out.println("Testcontainers version: " + TestcontainersConfiguration.getInstance().getTestcontainersVersion());13        DockerImageName imageName = DockerImageName.parse("alpine:latest");14        GenericContainer container = new GenericContainer(imageName)15                .withExposedPorts(80)16                .waitingFor(Wait.forHttp("/").forPort(80).withStartupTimeout(Duration.ofSeconds(10)))17                .waitingFor(Wait.forListeningPort().withStartupTimeout(Duration.ofSeconds(10)))18                .withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger("docker-java")))19                .withCommand("sh", "-c", "while true; do echo hello world; sleep 1; done");20        container.start();21        System.out.println("Container started: " + container.getContainerId());22        container.stop();23    }24}

DockerClientFactory

Using AI Code Generation

1import org.testcontainers.DockerClientFactory;2import com.github.dockerjava.api.DockerClient;3import com.github.dockerjava.core.DockerClientBuilder;4import com.github.dockerjava.core.DefaultDockerClientConfig;5public class DockerClientFactoryDemo {6	public static void main(String[] args) {7		DockerClientFactory factory = DockerClientFactory.instance();8		DefaultDockerClientConfig config = DefaultDockerClientConfig.createDefaultConfigBuilder().build();9		DockerClient client = DockerClientBuilder.getInstance(config).build();10		String dockerHostIpAddress = factory.getDockerHostIpAddress();11		System.out.println("Docker host IP address: " + dockerHostIpAddress);12	}13}

DockerClientFactory

Using AI Code Generation

1import org.testcontainers.DockerClientFactory;2import org.testcontainers.dockerclient.DockerClientConfigUtils;3import org.testcontainers.utility.TestcontainersConfiguration;4public class DockerClientFactoryTest {5    public static void main(String[] args) {6        String dockerHost = System.getenv("DOCKER_HOST");7        String dockerCertPath = System.getenv("DOCKER_CERT_PATH");8        String dockerConfig = System.getenv("DOCKER_CONFIG");9        System.out.println("DOCKER_HOST: " + dockerHost);10        System.out.println("DOCKER_CERT_PATH: " + dockerCertPath);11        System.out.println("DOCKER_CONFIG: " + dockerConfig);12        TestcontainersConfiguration config = TestcontainersConfiguration.getInstance();13        System.out.println("TestcontainersConfiguration.DOCKER_HOST: " + config.getDockerHost());14        System.out.println("TestcontainersConfiguration.DOCKER_CERT_PATH: " + config.getDockerCertPath());15        System.out.println("TestcontainersConfiguration.DOCKER_CONFIG: " + config.getDockerConfig());16        DockerClientFactory.instance().client();17    }18}19import org.testcontainers.dockerclient.DockerClientConfigUtils;20public class DockerClientConfigUtilsTest {21    public static void main(String[] args) {22        String dockerHost = System.getenv("DOCKER_HOST");23        String dockerCertPath = System.getenv("DOCKER_CERT_PATH");24        String dockerConfig = System.getenv("DOCKER_CONFIG");25        System.out.println("DOCKER_HOST: " + dockerHost);26        System.out.println("DOCKER_CERT_PATH: " + dockerCertPath);27        System.out.println("DOCKER_CONFIG: " + dockerConfig);28        System.out.println("DockerClientConfigUtils.getDockerHostIpAddress(): " + DockerClientConfigUtils.getDockerHostIpAddress());29        System.out.println("DockerClientConfigUtils.getDockerHostIpAddress(): " + DockerClientConfigUtils.getDockerHostIpAddress());30    }31}32import org.testcontainers.dockerclient.DockerClientConfigUtils;33import org.testcontainers.utility.TestcontainersConfiguration;34public class DockerClientConfigUtilsTest {35    public static void main(String[] args) {36        String dockerHost = System.getenv("DOCKER_HOST");37        String dockerCertPath = System.getenv("DOCKER_CERT_PATH");38        String dockerConfig = System.getenv("DOCKER_CONFIG");39        System.out.println("DOCKER_HOST:

DockerClientFactory

Using AI Code Generation

1import org.testcontainers.DockerClientFactory;2public class 1 {3    public static void main(String[] args) {4        DockerClient dockerClient = DockerClientFactory.instance().client();5    }6}7import org.testcontainers.DockerClientFactory;8public class 2 {9    public static void main(String[] args) {10        DockerClient dockerClient = DockerClientFactory.instance().client();11    }12}13import org.testcontainers.DockerClientFactory;14public class 3 {15    public static void main(String[] args) {16        DockerClient dockerClient = DockerClientFactory.instance().client();17    }18}19import org.testcontainers.DockerClientFactory;20public class 4 {21    public static void main(String[] args) {22        DockerClient dockerClient = DockerClientFactory.instance().client();23    }24}25import org.testcontainers.DockerClientFactory;26public class 5 {27    public static void main(String[] args) {28        DockerClient dockerClient = DockerClientFactory.instance().client();29    }30}31import org.testcontainers.DockerClientFactory;32public class 6 {33    public static void main(String[] args) {34        DockerClient dockerClient = DockerClientFactory.instance().client();35    }36}37import org.testcontainers.DockerClientFactory;38public class 7 {39    public static void main(String[] args) {40        DockerClient dockerClient = DockerClientFactory.instance().client();41    }42}43import org.testcontainers.DockerClient

DockerClientFactory

Using AI Code Generation

1package com.testcontainers;2import com.github.dockerjava.api.DockerClient;3import org.testcontainers.DockerClientFactory;4public class DockerClientFactoryExample {5    public static void main(String[] args) {6        DockerClient dockerClient = DockerClientFactory.instance().client();7        System.out.println("DockerClientFactoryExample: " + dockerClient);8    }9}

DockerClientFactory

Using AI Code Generation

1import org.testcontainers.DockerClientFactory;2public class 1 {3    public static void main(String[] args) {4        DockerClient client = DockerClientFactory.instance().client();5    }6}7Java | Testcontainers - DockerClientFactory.instance()8Java | Testcontainers - DockerClientFactory.instance().client()

DockerClientFactory

Using AI Code Generation

1import org.testcontainers.DockerClientFactory;2import org.testcontainers.containers.GenericContainer;3import org.testcontainers.images.builder.ImageFromDockerfile;4import org.testcontainers.utility.MountableFile;5import java.io.File;6import java.io.IOException;7import java.nio.file.Files;8import java.nio.file.Path;9import java.nio.file.Paths;10public class Test {11    public static void main(String[] args) throws IOException {12        DockerClientFactory.instance().client();13        ImageFromDockerfile image = new ImageFromDockerfile()14                .withDockerfile(Paths.get("Dockerfile"));15        GenericContainer container = new GenericContainer(image)16                .withExposedPorts(8080)17                .withCopyFileToContainer(MountableFile.forHostPath("Dockerfile"), "/")18                .withCommand("bash", "-c", "sleep 1000");19        container.start();20        container.stop();21        container.remove();22        image.remove();23    }24}25import org.testcontainers.DockerClientFactory;26import org.testcontainers.containers.GenericContainer;27import org.testcontainers.images.builder.ImageFromDockerfile;28import org.testcontainers.utility.MountableFile;29import java.io.File;30import java.io.IOException;31import java.nio.file.Files;32import java.nio.file.Path;33import java.nio.file.Paths;34public class Test {35    public static void main(String[] args) throws IOException {36        DockerClientFactory.instance().client();37        ImageFromDockerfile image = new ImageFromDockerfile()38                .withDockerfile(Paths.get("Dockerfile"));39        GenericContainer container = new GenericContainer(image)40                .withExposedPorts(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.