Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.fabric8.maven.docker.service.WaitService Maven / Gradle / Ivy
package io.fabric8.maven.docker.service;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Properties;
import org.apache.commons.text.StrSubstitutor;
import org.apache.maven.shared.utils.StringUtils;
import io.fabric8.maven.docker.access.DockerAccess;
import io.fabric8.maven.docker.access.DockerAccessException;
import io.fabric8.maven.docker.config.ImageConfiguration;
import io.fabric8.maven.docker.config.RunImageConfiguration;
import io.fabric8.maven.docker.config.WaitConfiguration;
import io.fabric8.maven.docker.log.DefaultLogCallback;
import io.fabric8.maven.docker.log.LogDispatcher;
import io.fabric8.maven.docker.log.LogOutputSpec;
import io.fabric8.maven.docker.model.Container;
import io.fabric8.maven.docker.util.Logger;
import io.fabric8.maven.docker.wait.ExitCodeChecker;
import io.fabric8.maven.docker.wait.HealthCheckChecker;
import io.fabric8.maven.docker.wait.HttpPingChecker;
import io.fabric8.maven.docker.wait.LogWaitChecker;
import io.fabric8.maven.docker.wait.PreconditionFailedException;
import io.fabric8.maven.docker.wait.TcpPortChecker;
import io.fabric8.maven.docker.wait.WaitChecker;
import io.fabric8.maven.docker.wait.WaitTimeoutException;
import io.fabric8.maven.docker.wait.WaitUtil;
/**
* @author roland
* @since 03.05.17
*/
public class WaitService {
private final QueryService queryService;
private DockerAccess dockerAccess;
private Logger log;
public WaitService(DockerAccess dockerAccess, QueryService queryService, Logger log) {
this.dockerAccess = dockerAccess;
this.log = log;
this.queryService = queryService;
}
// ========================================================================================================
public void wait(ImageConfiguration imageConfig, Properties projectProperties, String containerId) throws IOException {
List checkers = prepareWaitCheckers(imageConfig, projectProperties, containerId);
int timeout = getTimeOut(imageConfig);
if (checkers.isEmpty()) {
if (timeout > 0) {
log.info("%s: Pausing for %d ms", imageConfig.getDescription(), timeout);
WaitUtil.sleep(timeout);
}
return;
}
String logLine = extractCheckerLog(checkers);
ContainerRunningPrecondition precondition = new ContainerRunningPrecondition(dockerAccess, containerId);
try {
long waited = WaitUtil.wait(precondition, timeout, checkers);
log.info("%s: Waited %s %d ms", imageConfig.getDescription(), logLine, waited);
} catch (WaitTimeoutException exp) {
String desc = String.format("%s: Timeout after %d ms while waiting %s",
imageConfig.getDescription(), exp.getWaited(),
logLine);
log.error(desc);
throw new IOException(desc);
} catch (PreconditionFailedException exp) {
String desc = String.format("%s: Container stopped with exit code %d unexpectedly after %d ms while waiting %s",
imageConfig.getDescription(), precondition.getExitCode(), exp.getWaited(),
logLine);
log.error(desc);
throw new IOException(desc);
}
}
private int getTimeOut(ImageConfiguration imageConfig) {
WaitConfiguration wait = getWaitConfiguration(imageConfig);
return wait != null && wait.getTime() != null ? wait.getTime() : 0;
}
private String extractCheckerLog(List checkers) {
List logOut = new ArrayList<>();
for (WaitChecker checker : checkers) {
logOut.add(checker.getLogLabel());
}
return StringUtils.join(logOut.toArray(), " and ");
}
private List prepareWaitCheckers(ImageConfiguration imageConfig, Properties projectProperties, String containerId) throws IOException {
WaitConfiguration wait = getWaitConfiguration(imageConfig);
if (wait == null) {
return Collections.emptyList();
}
List checkers = new ArrayList<>();
if (wait.getUrl() != null) {
checkers.add(getUrlWaitChecker(imageConfig.getDescription(), projectProperties, wait, log));
}
if (wait.getLog() != null) {
log.debug("LogWaitChecker: Waiting on %s", wait.getLog());
checkers.add(new LogWaitChecker(wait.getLog(), dockerAccess, containerId, log));
}
if (wait.getTcp() != null) {
try {
Container container = queryService.getMandatoryContainer(containerId);
checkers.add(getTcpWaitChecker(container, imageConfig.getDescription(), projectProperties, wait.getTcp()));
} catch (DockerAccessException e) {
throw new IOException("Unable to access container " + containerId, e);
}
}
if (Boolean.TRUE.equals(wait.getHealthy())) {
checkers.add(new HealthCheckChecker(dockerAccess, containerId, imageConfig.getDescription(), log));
}
if (wait.getExit() != null) {
checkers.add(new ExitCodeChecker(wait.getExit(), queryService, containerId));
}
return checkers;
}
private WaitConfiguration getWaitConfiguration(ImageConfiguration imageConfig) {
RunImageConfiguration runConfig = imageConfig.getRunConfiguration();
return runConfig.getWaitConfiguration();
}
// =================================================================================================================
private WaitChecker getUrlWaitChecker(String imageConfigDesc,
Properties projectProperties,
WaitConfiguration wait,
Logger log) {
String waitUrl = StrSubstitutor.replace(wait.getUrl(), projectProperties);
WaitConfiguration.HttpConfiguration httpConfig = wait.getHttp();
HttpPingChecker checker;
if (httpConfig != null) {
checker = new HttpPingChecker(waitUrl, httpConfig.getMethod(), httpConfig.getStatus(), httpConfig.isAllowAllHosts(), log);
log.info("%s: Waiting on url %s with method %s for status %s.",
imageConfigDesc, waitUrl, httpConfig.getMethod(), httpConfig.getStatus());
} else {
checker = new HttpPingChecker(waitUrl, log);
log.info("%s: Waiting on url %s.", imageConfigDesc, waitUrl);
}
return checker;
}
private WaitChecker getTcpWaitChecker(Container container,
String imageConfigDesc,
Properties projectProperties,
WaitConfiguration.TcpConfiguration tcpConfig) {
List ports = new ArrayList<>();
List portsConfigured = getTcpPorts(tcpConfig);
String host = getTcpHost(tcpConfig, projectProperties);
WaitConfiguration.TcpConfigMode mode = getTcpMode(tcpConfig, host);
if (mode == WaitConfiguration.TcpConfigMode.mapped) {
for (int port : portsConfigured) {
Container.PortBinding binding = container.getPortBindings().get(port + "/tcp");
if (binding == null) {
throw new IllegalArgumentException(
String.format("Cannot watch on port %d, since there is no network binding", port));
}
ports.add(binding.getHostPort());
}
log.info("%s: Waiting for mapped ports %s on host %s", imageConfigDesc, ports, host);
} else {
final String networkMode = container.getNetworkMode();
log.info("%s: Network mode: %s", imageConfigDesc, networkMode);
if (networkMode == null || networkMode.isEmpty() || "default".equals(networkMode) || "bridge".equals(networkMode)) {
// Safe mode when network mode is not present
host = container.getIPAddress();
} else if (!"host".equals(networkMode)) {
// Custom network
host = container.getCustomNetworkIpAddresses().get(networkMode);
}
ports = portsConfigured;
log.info("%s: Waiting for ports %s directly on container with IP (%s).",
imageConfigDesc, ports, host);
}
return new TcpPortChecker(host, ports);
}
private List getTcpPorts(WaitConfiguration.TcpConfiguration tcpConfig) {
List portsConfigured = tcpConfig.getPorts();
if (portsConfigured == null || portsConfigured.isEmpty()) {
throw new IllegalArgumentException("TCP wait config given but no ports to wait on");
}
return portsConfigured;
}
private WaitConfiguration.TcpConfigMode getTcpMode(WaitConfiguration.TcpConfiguration tcpConfig, String host) {
WaitConfiguration.TcpConfigMode mode = tcpConfig.getMode();
if (mode == null) {
return "localhost".equals(host) ? WaitConfiguration.TcpConfigMode.direct : WaitConfiguration.TcpConfigMode.mapped;
} else {
return mode;
}
}
private String getTcpHost(WaitConfiguration.TcpConfiguration tcpConfig, Properties projectProperties) {
String host = tcpConfig.getHost();
if (host == null) {
// Host defaults to ${docker.host.address}.
host = projectProperties.getProperty("docker.host.address");
}
return host;
}
private class ContainerRunningPrecondition implements WaitUtil.Precondition {
private final String containerId;
private final DockerAccess dockerAccess;
private Integer exitCode;
ContainerRunningPrecondition(DockerAccess dockerAccess, String containerId) {
this.dockerAccess = dockerAccess;
this.containerId = containerId;
}
@Override
public boolean isOk() {
try {
exitCode = dockerAccess.getContainer(containerId).getExitCode();
return exitCode == null;
} catch (DockerAccessException e) {
return false;
}
}
@Override
public void cleanup() {
if (exitCode != null && log.isVerboseEnabled()) {
// if not running, probably something went wrong during startup: spit out logs
new LogDispatcher(dockerAccess).fetchContainerLog(containerId, LogOutputSpec.DEFAULT);
dockerAccess.getLogSync(containerId, new DefaultLogCallback(
new LogOutputSpec.Builder()
.color("black", true)
.prefix(containerId.substring(0, 6))
.useColor(true)
.logStdout(true)
.build()
));
}
}
Integer getExitCode() {
return exitCode;
}
}
}
