com.spotify.plugin.dockerfile.PushMojo.java Source code

Introduction

Here is the source code for com.spotify.plugin.dockerfile.PushMojo.java

Source

/*-
 * -\-\-
 * Dockerfile Maven Plugin
 * --
 * Copyright (C) 2016 Spotify AB
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -/-/-
 */

package com.spotify.plugin.dockerfile;

import com.spotify.docker.client.DockerClient;
import com.spotify.docker.client.exceptions.DockerException;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

@Mojo(name = "push", defaultPhase = LifecyclePhase.DEPLOY, requiresProject = true, threadSafe = true)
public class PushMojo extends AbstractDockerMojo {

    /**
     * The repository to put the built image into, for example <tt>spotify/foo</tt>.  You should also
     * set the <tt>tag</tt> parameter, otherwise the tag <tt>latest</tt> is used by default.
     */
    @Parameter(property = "dockerfile.repository")
    private String repository;

    /**
     * The tag to apply to the built image.
     */
    @Parameter(property = "dockerfile.tag")
    private String tag;

    /**
     * Disables the push goal; it becomes a no-op.
     */
    @Parameter(property = "dockerfile.push.skip", defaultValue = "false")
    private boolean skipPush;

    @Override
    protected void execute(DockerClient dockerClient) throws MojoExecutionException, MojoFailureException {
        final Log log = getLog();

        if (skipPush) {
            log.info("Skipping execution because 'dockerfile.push.skip' is set");
            return;
        }

        if (repository == null) {
            repository = readMetadata(Metadata.REPOSITORY);
        }

        // Do this hoop jumping so that the override order is correct
        if (tag == null) {
            tag = readMetadata(Metadata.TAG);
        }
        if (tag == null) {
            tag = "latest";
        }

        if (repository == null) {
            throw new MojoExecutionException("Can't push image; image repository not known "
                    + "(specify dockerfile.repository parameter, or run the tag goal before)");
        }

        try {
            dockerClient.push(formatImageName(repository, tag), LoggingProgressHandler.forLog(log, verbose));
        } catch (DockerException | InterruptedException e) {
            throw new MojoExecutionException("Could not push image", e);
        }
    }
}