com.ejwa.mavengitdepplugin.DownloaderMojo.java Source code

Introduction

Here is the source code for com.ejwa.mavengitdepplugin.DownloaderMojo.java

Source

/*
 * Copyright  2011 Ejwa Software. All rights reserved.
 *
 * This file is part of maven-gitdep-plugin. maven-gitdep-plugin
 * enables the use of git dependencies in Maven 3.
 *
 * maven-gitdep-plugin is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * maven-gitdep-plugin is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with maven-gitdep-plugin. If not, see
 * <http://www.gnu.org/licenses/>.
 */
package com.ejwa.mavengitdepplugin;

import com.ejwa.mavengitdepplugin.model.Directory;
import com.ejwa.mavengitdepplugin.model.POM;
import com.ejwa.mavengitdepplugin.util.GitDependencyHandler;
import com.ejwa.mavengitdepplugin.util.Resolver;
import java.io.File;
import java.util.List;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.resolver.ArtifactResolver;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.eclipse.jgit.api.CheckoutCommand;
import org.eclipse.jgit.api.CheckoutResult.Status;
import org.eclipse.jgit.api.CloneCommand;
import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.TextProgressMonitor;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevWalk;

/**
 * Goal which downloads needed dependencies and puts them in
 * BUILD_DIR/.maven-gitdep-NAME-VERSION-tmp/.
 *
 * @goal download
 * @execute goal=cleanup
 */
public class DownloaderMojo extends AbstractMojo {

    /**
     * @parameter expression="${localRepository}"
     * @required
     * @readonly
     */
    private ArtifactRepository localRepository;

    /**
     * @component
     */
    private ArtifactResolver artifactResolver;

    /**
     * @component
     */
    private ArtifactFactory artifactFactory;

    /**
     * A list of git dependencies... These controll how to fetch git
     * dependencies from an external source.
     *
     * @parameter
     */
    private List<GitDependency> gitDependencies;

    private Git clone(POM pom, GitDependency dependency) {
        final CloneCommand c = new CloneCommand();

        c.setURI(dependency.getLocation());
        c.setCloneAllBranches(true);
        c.setProgressMonitor(new TextProgressMonitor());

        final GitDependencyHandler dependencyHandler = new GitDependencyHandler(dependency);
        final String version = dependencyHandler.getDependencyVersion(pom);
        final String tempDirectory = Directory.getTempDirectoryString(dependency.getLocation(), version);
        c.setDirectory(new File(tempDirectory));

        return c.call();
    }

    /*
     * Checks out a given version. The version can be one of the following:
     *
     * SHA-1: a complete or abbreviated SHA-1
     * short-name: a short reference name under refs/heads, refs/tags, or
     *             refs/remotes namespace
     *
     * The resolve() command of JGit can support other formats, but
     * because we want everything to work smoothly with Maven, this
     * plugin does not support the other formats.
     */
    private void checkout(Git git, POM pom, GitDependency dependency) {
        final GitDependencyHandler dependencyHandler = new GitDependencyHandler(dependency);
        final String version = dependencyHandler.getDependencyVersion(pom);

        try {
            final ObjectId rev = git.getRepository().resolve(version);
            final RevCommit rc = new RevWalk(git.getRepository()).parseCommit(rev);
            final CheckoutCommand checkout = git.checkout();

            checkout.setName("maven-gitdep-branch-" + rc.getCommitTime());
            checkout.setStartPoint(rc);
            checkout.setCreateBranch(true);
            checkout.call();

            final Status status = checkout.getResult().getStatus();

            if (!status.equals(Status.OK)) {
                getLog().error("Status of checkout: " + status);
                throw new IllegalStateException("Invalid checkout state of dependency.");
            }
        } catch (Exception ex) {
            getLog().error(ex);
            throw new IllegalStateException("Failed to check out dependency.");
        }
    }

    @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
    public void execute() throws MojoExecutionException {
        for (GitDependency d : gitDependencies) {
            final POM pom = POM.getProjectPOM(getLog());
            final Resolver resolver = new Resolver(localRepository, artifactResolver, artifactFactory);

            if (!resolver.isInstalled(getLog(), d, pom)) {
                final Git git = clone(pom, d);
                checkout(git, pom, d);
            }
        }
    }
}