com.spotify.docker

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.spotify.docker.AbstractDockerMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

BuildMojo, PushMojo, RemoveImageMojo, TagMojo

abstract class AbstractDockerMojo
extends org.apache.maven.plugin.AbstractMojo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractDockerMojo.SupplierToClassNameFunction

Field Summary

Fields

Modifier and Type	Field and Description
private String	dockerCertPath
private String	dockerHost URL of the docker host as specified in pom.xml.
protected org.apache.maven.plugin.MojoExecution	execution
private String	registryUrl
private int	retryPushCount Number of retries for failing pushes, defaults to 5.
private int	retryPushTimeout Retry timeout for failing pushes, defaults to 10 seconds.
private org.sonatype.plexus.components.sec.dispatcher.SecDispatcher	secDispatcher https://issues.apache.org/jira/browse/MNG-4384
private String	serverId
protected org.apache.maven.execution.MavenSession	session
private org.apache.maven.settings.Settings	settings The system settings for Maven.
private boolean	skipDocker Flag to skip docker goal, making goal a no-op.
private boolean	skipDockerPush Flag to skip docker push, making push goal a no-op.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDockerMojo()

Method Summary

Modifier and Type	Method and Description
private com.spotify.docker.client.auth.RegistryAuthSupplier	authSupplier()
protected com.spotify.docker.client.DockerClient	buildDockerClient()
protected com.spotify.docker.client.shaded.com.google.common.base.Optional<com.spotify.docker.client.DockerCertificatesStore>	dockerCertificates()
void	execute()
protected abstract void	execute(com.spotify.docker.client.DockerClient dockerClient)
protected com.spotify.docker.client.DefaultDockerClient.Builder	getBuilder()
private String	getEmail(org.apache.maven.settings.Server server) Get the email from the server configuration in ~/.m2/settings.xml.
int	getRetryPushCount()
int	getRetryPushTimeout()
private com.spotify.docker.client.auth.RegistryAuthSupplier	googleContainerRegistryAuthSupplier() Attempt to load a GCR compatible RegistryAuthSupplier based on a few conditions: First check to see if the environemnt variable DOCKER_GOOGLE_CREDENTIALS is set and points to a readable file Otherwise check if the Google Application Default Credentials can be loaded Note that we use a special environment variable of our own in addition to any environment variable that the ADC loading uses (GOOGLE_APPLICATION_CREDENTIALS) in case there is a need for the user to use the latter env var for some other purpose in their build.
boolean	isSkipDocker()
boolean	isSkipDockerPush()
protected String	rawDockerHost()
protected com.spotify.docker.client.messages.RegistryAuth	registryAuth() Builds the registryAuth object from server details.
private String	serverIdFor(com.spotify.docker.client.messages.RegistryAuth registryAuth)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

session

@Component(role=org.apache.maven.execution.MavenSession.class)
protected org.apache.maven.execution.MavenSession session

execution

@Component(role=org.apache.maven.plugin.MojoExecution.class)
protected org.apache.maven.plugin.MojoExecution execution

settings

@Component
private org.apache.maven.settings.Settings settings

The system settings for Maven. This is the instance resulting from merging global and user-level settings files.

secDispatcher

@Component(role=org.sonatype.plexus.components.sec.dispatcher.SecDispatcher.class,
           hint="mng-4384")
private org.sonatype.plexus.components.sec.dispatcher.SecDispatcher secDispatcher

https://issues.apache.org/jira/browse/MNG-4384

dockerHost

@Parameter(property="dockerHost")
private String dockerHost

URL of the docker host as specified in pom.xml.

dockerCertPath

@Parameter(property="dockerCertPath")
private String dockerCertPath

serverId

@Parameter(property="serverId")
private String serverId

registryUrl

@Parameter(property="registryUrl")
private String registryUrl

retryPushCount

@Parameter(property="retryPushCount",
           defaultValue="5")
private int retryPushCount

Number of retries for failing pushes, defaults to 5.

retryPushTimeout

@Parameter(property="retryPushTimeout",
           defaultValue="10000")
private int retryPushTimeout

Retry timeout for failing pushes, defaults to 10 seconds.

skipDocker

@Parameter(property="skipDocker",
           defaultValue="false")
private boolean skipDocker

Flag to skip docker goal, making goal a no-op. This can be useful when docker goal is bound to Maven phase, and you want to skip Docker command. Defaults to false.

skipDockerPush

@Parameter(property="skipDockerPush",
           defaultValue="false")
private boolean skipDockerPush

Flag to skip docker push, making push goal a no-op. This can be useful when docker:push is bound to deploy goal, and you want to deploy a jar but not a container. Defaults to false.

Constructor Detail

AbstractDockerMojo

AbstractDockerMojo()

Method Detail

getRetryPushTimeout

public int getRetryPushTimeout()

getRetryPushCount

public int getRetryPushCount()

isSkipDocker

public boolean isSkipDocker()

isSkipDockerPush

public boolean isSkipDockerPush()

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getBuilder

protected com.spotify.docker.client.DefaultDockerClient.Builder getBuilder()
                                                                    throws com.spotify.docker.client.exceptions.DockerCertificateException

Throws:

com.spotify.docker.client.exceptions.DockerCertificateException

buildDockerClient

protected com.spotify.docker.client.DockerClient buildDockerClient()
                                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

protected abstract void execute(com.spotify.docker.client.DockerClient dockerClient)
                         throws Exception

Throws:

Exception

rawDockerHost

protected String rawDockerHost()

dockerCertificates

protected com.spotify.docker.client.shaded.com.google.common.base.Optional<com.spotify.docker.client.DockerCertificatesStore> dockerCertificates()
                                                                                                                                          throws com.spotify.docker.client.exceptions.DockerCertificateException

Throws:

com.spotify.docker.client.exceptions.DockerCertificateException

getEmail

private String getEmail(org.apache.maven.settings.Server server)

Get the email from the server configuration in ~/.m2/settings.xml.

 <servers>
   <server>
     <id>my-private-docker-registry</id>
     [...]
     <configuration>
       <email>foo@bar.com</email>
     </configuration>
   </server>
 </servers>
 

The above settings.xml would return "foo@bar.com".

Parameters:

server - Server

Returns:

email, or null if not set

registryAuth

protected com.spotify.docker.client.messages.RegistryAuth registryAuth()
                                                                throws org.apache.maven.plugin.MojoExecutionException

Builds the registryAuth object from server details.

Returns:

RegistryAuth

Throws:

org.apache.maven.plugin.MojoExecutionException

authSupplier

private com.spotify.docker.client.auth.RegistryAuthSupplier authSupplier()
                                                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

serverIdFor

private String serverIdFor(com.spotify.docker.client.messages.RegistryAuth registryAuth)

googleContainerRegistryAuthSupplier

private com.spotify.docker.client.auth.RegistryAuthSupplier googleContainerRegistryAuthSupplier()
                                                                                         throws org.apache.maven.plugin.MojoExecutionException

Attempt to load a GCR compatible RegistryAuthSupplier based on a few conditions:

1. First check to see if the environemnt variable DOCKER_GOOGLE_CREDENTIALS is set and points to a readable file
2. Otherwise check if the Google Application Default Credentials can be loaded

Note that we use a special environment variable of our own in addition to any environment variable that the ADC loading uses (GOOGLE_APPLICATION_CREDENTIALS) in case there is a need for the user to use the latter env var for some other purpose in their build.

Returns:

a GCR RegistryAuthSupplier, or null

Throws:

org.apache.maven.plugin.MojoExecutionException - if an IOException occurs while loading the explicitly-requested credentials