com.github.danielflower.mavenplugins.release.PomUpdater Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of multi-module-maven-release-plugin Show documentation
A maven release plugin built for multi-maven-module git repositories allowing continuous deployment
The newest version!
package com.github.danielflower.mavenplugins.release;

import java.io.File;
import java.io.Writer;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

import org.apache.maven.model.Dependency;
import org.apache.maven.model.Model;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.io.xpp3.MavenXpp3Writer;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.WriterFactory;

public class PomUpdater {

    private final Log log;
    private final Reactor reactor;

    public PomUpdater(Log log, Reactor reactor) {
        this.log = log;
        this.reactor = reactor;
    }

    public UpdateResult updateVersion() {
        List changedPoms = new ArrayList();
        List errors = new ArrayList();
        for (ReleasableModule module : reactor.getModulesInBuildOrder()) {
            try {
                MavenProject project = module.getProject();
                if (module.willBeReleased()) {
                    log.info("Going to release " + module.getArtifactId() + " " + module.getNewVersion());
                }

                List errorsForCurrentPom = alterModel(project, module.getNewVersion());
                errors.addAll(errorsForCurrentPom);

                File pom = project.getFile().getCanonicalFile();
                changedPoms.add(pom);
                Writer fileWriter = WriterFactory.newXmlWriter(pom);

                Model originalModel = project.getOriginalModel();
                try {
                    MavenXpp3Writer pomWriter = new MavenXpp3Writer();
                    pomWriter.write(fileWriter, originalModel);
                } finally {
                    fileWriter.close();
                }
            } catch (Exception e) {
                return new UpdateResult(changedPoms, errors, e);
            }
        }
        return new UpdateResult(changedPoms, errors, null);
    }

    public static class UpdateResult {
        public final List alteredPoms;
        public final List dependencyErrors;
        public final Exception unexpectedException;

        public UpdateResult(List alteredPoms, List dependencyErrors, Exception unexpectedException) {
            this.alteredPoms = alteredPoms;
            this.dependencyErrors = dependencyErrors;
            this.unexpectedException = unexpectedException;
        }
        public boolean success() {
            return (dependencyErrors.size() == 0) && (unexpectedException == null);
        }
    }

    private List alterModel(MavenProject project, String newVersion) {
        Model originalModel = project.getOriginalModel();
        originalModel.setVersion(newVersion);

        List errors = new ArrayList();

        String searchingFrom = project.getArtifactId();
        MavenProject parent = project.getParent();
        if (parent != null && MavenVersionResolver.isSnapshot(parent.getVersion())) {
            try {
                ReleasableModule parentBeingReleased = reactor.find(parent.getGroupId(), parent.getArtifactId(), parent.getVersion());
                originalModel.getParent().setVersion(parentBeingReleased.getVersionToDependOn());
                log.debug(" Parent " + parentBeingReleased.getArtifactId() + " rewritten to version " + parentBeingReleased.getVersionToDependOn());
            } catch (UnresolvedSnapshotDependencyException e) {
                errors.add("The parent of " + searchingFrom + " is " + e.artifactId + " " + e.version);
            }
        }

        Properties projectProperties = project.getProperties();
        for (Dependency dependency : originalModel.getDependencies()) {
            alterSingleDependency(errors, searchingFrom, projectProperties, dependency);
        }

        //Support for dependency management
        if (originalModel.getDependencyManagement() != null) {
            for (Dependency dependency : originalModel.getDependencyManagement().getDependencies()) {
                alterSingleDependency(errors, searchingFrom, projectProperties, dependency);
            }
        }

        //Support for plugin
        if (originalModel.getBuild() != null && originalModel.getBuild().getPlugins() != null) {
            for (Plugin plugin : originalModel.getBuild().getPlugins()) {
                alterSinglePlugin(errors, searchingFrom, projectProperties, plugin);
            }
        }

        //Support for pluginManagement
        if (originalModel.getBuild() != null && originalModel.getBuild().getPluginManagement() != null
        && originalModel.getBuild().getPluginManagement().getPlugins() != null) {
            for (Plugin plugin : originalModel.getBuild().getPluginManagement().getPlugins()) {
                alterSinglePlugin(errors, searchingFrom, projectProperties, plugin);
            }
        }

        for (Plugin plugin : project.getModel().getBuild().getPlugins()) {
            String version = plugin.getVersion();
            if (MavenVersionResolver.isSnapshot(MavenVersionResolver.resolveVersion(version, projectProperties))) {
                if (!isMultiModuleReleasePlugin(plugin) && !isReleasablePlugin(plugin)) {
                    errors.add(searchingFrom + " references plugin " + plugin.getArtifactId() + " " + version);
                }
            }
        }
        return errors;
    }
    
    private boolean isReleasablePlugin(Plugin plugin) {
        try {
            reactor.find(plugin.getGroupId(), plugin.getArtifactId(), plugin.getVersion());
            return true;
        } catch (UnresolvedSnapshotDependencyException ignore) {}
        return false;
    }

    private void alterSinglePlugin(List errors, String searchingFrom, Properties projectProperties, Plugin plugin) {
        String version = plugin.getVersion();
        if (!isMultiModuleReleasePlugin(plugin) &&
            MavenVersionResolver.isSnapshot(MavenVersionResolver.resolveVersion(version, projectProperties))) {
            try {
                ReleasableModule pluginBeingReleased = reactor.find(plugin.getGroupId(), plugin.getArtifactId(), version);
                plugin.setVersion(pluginBeingReleased.getVersionToDependOn());
                log.info("Plugin dependency on " + pluginBeingReleased.getArtifactId() + " rewritten to version " + pluginBeingReleased.getVersionToDependOn());
            } catch (UnresolvedSnapshotDependencyException e) {
                errors.add(searchingFrom + " references plugin dependency " + e.artifactId + " " + e.version);
            }
        }
        else {
            log.debug("Plugin dependency on " + plugin.getArtifactId() + " kept at version " + plugin.getVersion());
        }
    }

    private void alterSingleDependency(List errors, String searchingFrom, Properties projectProperties, Dependency dependency) {
        String version = dependency.getVersion();
        if (MavenVersionResolver.isSnapshot(MavenVersionResolver.resolveVersion(version, projectProperties))) {
            try {
                ReleasableModule dependencyBeingReleased = reactor.find(dependency.getGroupId(), dependency.getArtifactId(), version);
                dependency.setVersion(dependencyBeingReleased.getVersionToDependOn());
                log.debug(" Dependency on " + dependencyBeingReleased.getArtifactId() + " rewritten to version " + dependencyBeingReleased.getVersionToDependOn());
            } catch (UnresolvedSnapshotDependencyException e) {
                errors.add(searchingFrom + " references dependency " + e.artifactId + " " + e.version);
            }
        }
        else {
            log.debug(" Dependency on " + dependency.getArtifactId() + " kept at version " + dependency.getVersion());
        }
    }

    private static boolean isMultiModuleReleasePlugin(Plugin plugin) {
        return plugin.getGroupId().equals("com.github.danielflower.mavenplugins") && plugin.getArtifactId().equals("multi-module-maven-release-plugin");
    }


}