Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid connection leaks in LogUtils #2834

Merged
merged 1 commit into from
Jun 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,34 +1,53 @@
package org.testcontainers.containers.wait.strategy;

import com.github.dockerjava.api.command.LogContainerCmd;
import lombok.SneakyThrows;
import org.testcontainers.DockerClientFactory;
import org.testcontainers.containers.ContainerLaunchException;
import org.testcontainers.containers.output.FrameConsumerResultCallback;
import org.testcontainers.containers.output.OutputFrame;
import org.testcontainers.containers.output.WaitingConsumer;
import org.testcontainers.utility.LogUtils;

import java.io.IOException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.function.Predicate;

import static org.testcontainers.containers.output.OutputFrame.OutputType.STDERR;
import static org.testcontainers.containers.output.OutputFrame.OutputType.STDOUT;

public class LogMessageWaitStrategy extends AbstractWaitStrategy {

private String regEx;

private int times = 1;

@Override
@SneakyThrows(IOException.class)
protected void waitUntilReady() {
WaitingConsumer waitingConsumer = new WaitingConsumer();
LogUtils.followOutput(DockerClientFactory.instance().client(), waitStrategyTarget.getContainerId(), waitingConsumer);

Predicate<OutputFrame> waitPredicate = outputFrame ->
// (?s) enables line terminator matching (equivalent to Pattern.DOTALL)
outputFrame.getUtf8String().matches("(?s)" + regEx);
LogContainerCmd cmd = DockerClientFactory.instance().client().logContainerCmd(waitStrategyTarget.getContainerId())
.withFollowStream(true)
.withSince(0)
.withStdOut(true)
.withStdErr(true);

try (FrameConsumerResultCallback callback = new FrameConsumerResultCallback()) {
callback.addConsumer(STDOUT, waitingConsumer);
callback.addConsumer(STDERR, waitingConsumer);

cmd.exec(callback);

Predicate<OutputFrame> waitPredicate = outputFrame ->
// (?s) enables line terminator matching (equivalent to Pattern.DOTALL)
outputFrame.getUtf8String().matches("(?s)" + regEx);

try {
waitingConsumer.waitUntil(waitPredicate, startupTimeout.getSeconds(), TimeUnit.SECONDS, times);
} catch (TimeoutException e) {
throw new ContainerLaunchException("Timed out waiting for log output matching '" + regEx + "'");
try {
waitingConsumer.waitUntil(waitPredicate, startupTimeout.getSeconds(), TimeUnit.SECONDS, times);
} catch (TimeoutException e) {
throw new ContainerLaunchException("Timed out waiting for log output matching '" + regEx + "'");
}
}
}

Expand Down
26 changes: 16 additions & 10 deletions core/src/main/java/org/testcontainers/utility/LogUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

import com.github.dockerjava.api.DockerClient;
import com.github.dockerjava.api.command.LogContainerCmd;
import lombok.SneakyThrows;
import lombok.experimental.UtilityClass;
import org.testcontainers.containers.output.FrameConsumerResultCallback;
import org.testcontainers.containers.output.OutputFrame;
import org.testcontainers.containers.output.ToStringConsumer;
import org.testcontainers.containers.output.WaitingConsumer;

import java.io.Closeable;
import java.io.IOException;
import java.util.function.Consumer;

import static org.testcontainers.containers.output.OutputFrame.OutputType.STDERR;
Expand Down Expand Up @@ -59,6 +62,7 @@ public void followOutput(DockerClient dockerClient,
* @param types types of {@link OutputFrame} to receive
* @return all previous output frames (stdout/stderr being separated by newline characters)
*/
@SneakyThrows(IOException.class)
public String getOutput(DockerClient dockerClient,
String containerId,
OutputFrame.OutputType... types) {
Expand All @@ -73,17 +77,19 @@ public String getOutput(DockerClient dockerClient,

final ToStringConsumer consumer = new ToStringConsumer();
final WaitingConsumer wait = new WaitingConsumer();
attachConsumer(dockerClient, containerId, consumer.andThen(wait), false, types);

wait.waitUntilEnd();
return consumer.toUtf8String();
try (Closeable closeable = attachConsumer(dockerClient, containerId, consumer.andThen(wait), false, types)) {
wait.waitUntilEnd();
return consumer.toUtf8String();
}
}

private static void attachConsumer(DockerClient dockerClient,
String containerId,
Consumer<OutputFrame> consumer,
boolean followStream,
OutputFrame.OutputType... types) {
private static Closeable attachConsumer(
DockerClient dockerClient,
String containerId,
Consumer<OutputFrame> consumer,
boolean followStream,
OutputFrame.OutputType... types
) {

final LogContainerCmd cmd = dockerClient.logContainerCmd(containerId)
.withFollowStream(followStream)
Expand All @@ -96,6 +102,6 @@ private static void attachConsumer(DockerClient dockerClient,
if (type == STDERR) cmd.withStdErr(true);
}

cmd.exec(callback);
return cmd.exec(callback);
}
}