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

How to use DockerMachineClientProviderStrategy class of org.testcontainers.dockerclient package

Best Testcontainers-java code snippet using org.testcontainers.dockerclient.DockerMachineClientProviderStrategy

Source:DockerClientFactory.java

...13import org.hamcrest.BaseMatcher;14import org.hamcrest.Description;15import org.rnorth.visibleassertions.VisibleAssertions;16import org.testcontainers.dockerclient.DockerClientProviderStrategy;17import org.testcontainers.dockerclient.DockerMachineClientProviderStrategy;18import org.testcontainers.utility.ComparableVersion;19import org.testcontainers.utility.ResourceReaper;20import org.testcontainers.utility.TestcontainersConfiguration;21import java.io.ByteArrayOutputStream;22import java.io.InputStream;23import java.util.ArrayList;24import java.util.List;25import java.util.Map;26import java.util.Optional;27import java.util.ServiceLoader;28import java.util.UUID;29import java.util.function.BiFunction;30import java.util.function.Consumer;31/**32 * Singleton class that provides initialized Docker clients.33 * <p>34 * The correct client configuration to use will be determined on first use, and cached thereafter.35 */36@Slf4j37public class DockerClientFactory {38    public static final ThreadGroup TESTCONTAINERS_THREAD_GROUP = new ThreadGroup("testcontainers");39    public static final String TESTCONTAINERS_LABEL = DockerClientFactory.class.getPackage().getName();40    public static final String TESTCONTAINERS_SESSION_ID_LABEL = TESTCONTAINERS_LABEL + ".sessionId";41    public static final String SESSION_ID = UUID.randomUUID().toString();42    public static final Map<String, String> DEFAULT_LABELS = ImmutableMap.of(43            TESTCONTAINERS_LABEL, "true",44            TESTCONTAINERS_SESSION_ID_LABEL, SESSION_ID45    );46    private static final String TINY_IMAGE = TestcontainersConfiguration.getInstance().getTinyImage();47    private static DockerClientFactory instance;48    // Cached client configuration49    private DockerClientProviderStrategy strategy;50    private boolean initialized = false;51    private String activeApiVersion;52    private String activeExecutionDriver;53    static {54        System.setProperty("org.testcontainers.shaded.io.netty.packagePrefix", "org.testcontainers.shaded.");55    }56    /**57     * Private constructor58     */59    private DockerClientFactory() {60    }61    /**62     * Obtain an instance of the DockerClientFactory.63     *64     * @return the singleton instance of DockerClientFactory65     */66    public synchronized static DockerClientFactory instance() {67        if (instance == null) {68            instance = new DockerClientFactory();69        }70        return instance;71    }72    /**73     *74     * @return a new initialized Docker client75     */76    @Synchronized77    public DockerClient client() {78        if (strategy != null) {79            return strategy.getClient();80        }81        List<DockerClientProviderStrategy> configurationStrategies = new ArrayList<DockerClientProviderStrategy>();82        ServiceLoader.load(DockerClientProviderStrategy.class).forEach( cs -> configurationStrategies.add( cs ) );83        strategy = DockerClientProviderStrategy.getFirstValidStrategy(configurationStrategies);84        String hostIpAddress = strategy.getDockerHostIpAddress();85        log.info("Docker host IP address is {}", hostIpAddress);86        DockerClient client = strategy.getClient();87        if (!initialized) {88            Info dockerInfo = client.infoCmd().exec();89            Version version = client.versionCmd().exec();90            activeApiVersion = version.getApiVersion();91            activeExecutionDriver = dockerInfo.getExecutionDriver();92            log.info("Connected to docker: \n" +93                    "  Server Version: " + dockerInfo.getServerVersion() + "\n" +94                    "  API Version: " + activeApiVersion + "\n" +95                    "  Operating System: " + dockerInfo.getOperatingSystem() + "\n" +96                    "  Total Memory: " + dockerInfo.getMemTotal() / (1024 * 1024) + " MB");97            boolean checksEnabled = !TestcontainersConfiguration.getInstance().isDisableChecks();98            String ryukContainerId = ResourceReaper.start(hostIpAddress, client, checksEnabled);99            log.info("Ryuk started - will monitor and terminate Testcontainers containers on JVM exit");100            VisibleAssertions.info("Checking the system...");101            checkDockerVersion(version.getVersion());102            if (checksEnabled) {103                checkDiskSpace(client, ryukContainerId);104                checkMountableFile(client, ryukContainerId);105            }106            initialized = true;107        }108        return client;109    }110    private void checkDockerVersion(String dockerVersion) {111        VisibleAssertions.assertThat("Docker version", dockerVersion, new BaseMatcher<String>() {112            @Override113            public boolean matches(Object o) {114                return new ComparableVersion(o.toString()).compareTo(new ComparableVersion("1.6.0")) >= 0;115            }116            @Override117            public void describeTo(Description description) {118                description.appendText("should be at least 1.6.0");119            }120        });121    }122    private void checkDiskSpace(DockerClient dockerClient, String id) {123        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();124        try {125            dockerClient126                    .execStartCmd(dockerClient.execCreateCmd(id).withAttachStdout(true).withCmd("df", "-P").exec().getId())127                    .exec(new ExecStartResultCallback(outputStream, null))128                    .awaitCompletion();129        } catch (Exception e) {130            log.debug("Can't exec disk checking command", e);131        }132        DiskSpaceUsage df = parseAvailableDiskSpace(outputStream.toString());133        VisibleAssertions.assertTrue(134                "Docker environment should have more than 2GB free disk space",135                df.availableMB.map(it -> it >= 2048).orElse(true)136        );137    }138    private void checkMountableFile(DockerClient dockerClient, String id) {139        try (InputStream stream = dockerClient.copyArchiveFromContainerCmd(id, "/dummy").exec()) {140            stream.read();141            VisibleAssertions.pass("File should be mountable");142        } catch (Exception e) {143            VisibleAssertions.fail("File should be mountable but fails with " + e.getMessage());144        }145    }146    /**147   * Check whether the image is available locally and pull it otherwise148   */149    public void checkAndPullImage(DockerClient client, String image) {150        List<Image> images = client.listImagesCmd().withImageNameFilter(image).exec();151        if (images.isEmpty()) {152            client.pullImageCmd(image).exec(new PullImageResultCallback()).awaitSuccess();153        }154    }155    /**156     * @return the IP address of the host running Docker157     */158    public String dockerHostIpAddress() {159        return strategy.getDockerHostIpAddress();160    }161    public <T> T runInsideDocker(Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {162        if (strategy == null) {163            client();164        }165        // We can't use client() here because it might create an infinite loop166        return runInsideDocker(strategy.getClient(), createContainerCmdConsumer, block);167    }168    private <T> T runInsideDocker(DockerClient client, Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {169        checkAndPullImage(client, TINY_IMAGE);170        CreateContainerCmd createContainerCmd = client.createContainerCmd(TINY_IMAGE)171                .withLabels(DEFAULT_LABELS);172        createContainerCmdConsumer.accept(createContainerCmd);173        String id = createContainerCmd.exec().getId();174        try {175            client.startContainerCmd(id).exec();176            return block.apply(client, id);177        } finally {178            try {179                client.removeContainerCmd(id).withRemoveVolumes(true).withForce(true).exec();180            } catch (NotFoundException | InternalServerErrorException ignored) {181                log.debug("", ignored);182            }183        }184    }185    @VisibleForTesting186    static class DiskSpaceUsage {187        Optional<Long> availableMB = Optional.empty();188        Optional<Integer> usedPercent = Optional.empty();189    }190    @VisibleForTesting191    DiskSpaceUsage parseAvailableDiskSpace(String dfOutput) {192        DiskSpaceUsage df = new DiskSpaceUsage();193        String[] lines = dfOutput.split("\n");194        for (String line : lines) {195            String[] fields = line.split("\\s+");196            if (fields.length > 5 && fields[5].equals("/")) {197                long availableKB = Long.valueOf(fields[3]);198                df.availableMB = Optional.of(availableKB / 1024L);199                df.usedPercent = Optional.of(Integer.valueOf(fields[4].replace("%", "")));200                break;201            }202        }203        return df;204    }205    /**206     * @return the docker API version of the daemon that we have connected to207     */208    public String getActiveApiVersion() {209        if (!initialized) {210            client();211        }212        return activeApiVersion;213    }214    /**215     * @return the docker execution driver of the daemon that we have connected to216     */217    public String getActiveExecutionDriver() {218        if (!initialized) {219            client();220        }221        return activeExecutionDriver;222    }223    /**224     * @param providerStrategyClass a class that extends {@link DockerMachineClientProviderStrategy}225     * @return whether or not the currently active strategy is of the provided type226     */227    public boolean isUsing(Class<? extends DockerClientProviderStrategy> providerStrategyClass) {228        return providerStrategyClass.isAssignableFrom(this.strategy.getClass());229    }230    private static class NotEnoughDiskSpaceException extends RuntimeException {231        NotEnoughDiskSpaceException(String message) {232            super(message);233        }234    }235}...