com.alexecollins.docker.mojo.AbstractDockerMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docker-maven-plugin Show documentation
Show all versions of docker-maven-plugin Show documentation
A plug-in for starting and stopping Docker containers.
package com.alexecollins.docker.mojo;
import com.alexecollins.docker.orchestration.DockerOrchestrator;
import com.alexecollins.docker.orchestration.ExcludeFilter;
import com.alexecollins.docker.orchestration.model.BuildFlag;
import com.alexecollins.docker.util.MavenLogAppender;
import com.github.dockerjava.api.DockerClient;
import com.github.dockerjava.api.DockerException;
import com.github.dockerjava.api.command.VersionCmd;
import com.github.dockerjava.api.model.Version;
import com.github.dockerjava.core.DockerClientBuilder;
import com.github.dockerjava.core.DockerClientConfig;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import java.io.File;
import java.util.HashSet;
import java.util.Properties;
import java.util.Set;
abstract class AbstractDockerMojo extends AbstractMojo {
/**
* The host, e.g. -Ddocker.host=http://127.0.0.1:2375
*/
@Parameter(property = "docker.host")
private String host;
/**
* A prefix to namespace scope machine. Important for isolating machines.
*/
@Parameter(defaultValue = "${project.artifactId}", property = "docker.prefix")
private String prefix;
/**
* Where to look for directories containing Dockerfile and conf.yml
*/
@Parameter(defaultValue = "src/main/docker", property = "docker.src")
private String src;
/**
* Installed Docker version.
*/
@Parameter(property = "docker.version")
private String version;
/**
* Docker username (for deploy).
*/
@Parameter(property = "docker.username", defaultValue = "${user.name}")
private String username;
/**
* Docker username (for deploy).
*/
@Parameter(property = "docker.password")
private String password;
/**
* Docker repository server (for deploy).
*/
@Parameter(property = "docker.serverAddress")
private String serverAddress;
/**
* Docker email (for deploy).
*/
@Parameter(property = "docker.email")
private String email;
/**
* Remove intermediate images during build.
*/
@Parameter(defaultValue = "false", property = "docker.removeIntermediateImages")
private boolean removeIntermediateImages;
/**
* Use cached images during build.
*/
@Parameter(defaultValue = "true", property = "docker.cache")
private boolean cache = true;
/**
* Don't output the docker api responses during builds.
*/
@Parameter(defaultValue = "false", property = "docker.quiet")
private boolean quiet;
/**
* Always pull FROM image when building.
*/
@Parameter(defaultValue = "false", property = "docker.pull")
private boolean pull;
/**
* Silently ignore permission errors. This is useful if your CI does not support removal of containers.
*/
@Parameter(defaultValue = "false", property = "docker.permissionErrorTolerant")
private boolean permissionErrorTolerant;
/**
* Skip execution.
*/
@Parameter(defaultValue = "false", property = "docker.skip")
private boolean skip;
/**
* Exclude certain definitions, e.g. to not start one container.
*
* Comma-separated.
*/
@Parameter(defaultValue = "", property = "docker.exclude")
private String exclude = "";
/**
* Specify docker certificate path. Defaults to not being set
*/
@Parameter(property = "docker.certPath")
private String certificatePath;
/**
* Specify the docker configuration path. Defaults to not being set
*/
@Parameter(property = "docker.cfgPath")
private String cfgPath;
/**
* Do auto detection on the docker version.
*/
@Parameter(defaultValue = "true", property = "docker.versionAutoDetect")
private boolean versionAutoDetect;
@Component
private MavenProject project;
public MavenProject getProject() {
return project;
}
@Override
public final void execute() throws MojoExecutionException, MojoFailureException {
MavenLogAppender.setLog(getLog());
if (skip) {
getLog().info("skipped");
return;
}
// not great eh
final Properties properties = properties();
getLog().debug("properties filtering supported for " + properties.keySet());
try {
final DockerClient docker = dockerClient();
getLog().info("Docker version " + docker.versionCmd().exec().getVersion());
doExecute(dockerOrchestrator(properties, docker));
} catch (Exception e) {
e.printStackTrace();
throw new MojoExecutionException(e.getMessage(), e);
}
}
private DockerOrchestrator dockerOrchestrator(Properties properties, DockerClient docker) {
return DockerOrchestrator
.builder()
.docker(docker)
.src(src())
.workDir(workDir())
.rootDir(projDir())
.user(username)
.project(prefix)
.properties(properties)
.buildFlags(buildFlags())
.definitionFilter(new ExcludeFilter(exclude.split(",")))
.permissionErrorTolerant(permissionErrorTolerant)
.build();
}
private Set buildFlags() {
final Set buildFlags = new HashSet<>();
if (removeIntermediateImages) {
buildFlags.add(BuildFlag.REMOVE_INTERMEDIATE_IMAGES);
}
if (!cache) {
buildFlags.add(BuildFlag.NO_CACHE);
}
if (quiet) {
buildFlags.add(BuildFlag.QUIET);
}
if (pull) {
buildFlags.add(BuildFlag.PULL);
}
return buildFlags;
}
private DockerClient dockerClient() throws DockerException {
DockerClientConfig.DockerClientConfigBuilder builder = DockerClientConfig.createDefaultConfigBuilder();
if (host != null) {
builder = builder.withUri(host);
}
if (version != null) {
builder = builder.withVersion(version);
}
if (username != null) {
builder = builder.withUsername(username);
}
if (password != null) {
builder = builder.withPassword(password);
}
if (email != null) {
builder = builder.withEmail(email);
}
if (serverAddress != null) {
builder = builder.withServerAddress(serverAddress);
}
if (certificatePath != null) {
builder = builder.withDockerCertPath(certificatePath);
}
if (cfgPath != null) {
builder = builder.withDockerCfgPath(cfgPath);
}
if (versionAutoDetect) {
final DockerClient initialClient = DockerClientBuilder.getInstance(builder.build()).build();
final VersionCmd versionCmd = initialClient.versionCmd();
final Version version = versionCmd.exec();
builder = builder.withVersion(version.getApiVersion());
return DockerClientBuilder.getInstance(builder.build()).build();
} else {
return DockerClientBuilder.getInstance(builder.build()).build();
}
}
private Properties properties() {
final Properties p = new Properties();
p.putAll(System.getenv());
final String[] x = new String[]{
"project.groupId", project.getGroupId(),
"project.artifactId", project.getArtifactId(),
"project.version", project.getVersion(),
"project.name", project.getName(),
"project.description", project.getDescription(),
"project.build.finalName", project.getBuild().getFinalName()
};
for (int i = 0; i < x.length; i += 2) {
if (x[i + 1] != null) {
p.setProperty(x[i], x[i + 1]);
}
}
p.putAll(project.getProperties());
p.putAll(System.getProperties());
return p;
}
private File workDir() {
return new File(project.getBuild().getDirectory(), "docker");
}
private File projDir() {
return project.getBasedir();
}
private File src() {
return new File(projDir(), src);
}
protected abstract void doExecute(DockerOrchestrator orchestrator) throws Exception;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy