net.oneandone.maven.rules.ForbidOverridingManagedPluginsRule.java Source code

Introduction

Here is the source code for net.oneandone.maven.rules.ForbidOverridingManagedPluginsRule.java

Source

/**
 * Copyright 1&1 Internet AG, https://github.com/1and1/
 *
 * 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 net.oneandone.maven.rules;

import static net.oneandone.maven.rules.common.RuleHelper.getProject;

import java.util.List;
import java.util.Map;

import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;

import net.oneandone.maven.rules.common.AbstractFilterableRule;

public class ForbidOverridingManagedPluginsRule extends AbstractFilterableRule {

    public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
        Log log = helper.getLog();

        try {
            MavenProject project = getProject(helper);

            checkPluginManagementDiffs(project, log);

            if (failureDetected) {
                throw new EnforcerRuleException("Failing because of overridden managed plugins");
            }
        } catch (ExpressionEvaluationException e) {
            throw new EnforcerRuleException("Unable to lookup an expression " + e.getLocalizedMessage(), e);
        }
    }

    private void checkPluginManagementDiffs(MavenProject project, Log log) {
        if (project.getParent() != null) {
            List<Plugin> projectPlugins = project.getBuildPlugins();
            if (project.getPluginManagement() != null) {
                projectPlugins.addAll(project.getPluginManagement().getPlugins());
            }
            Map<String, Plugin> parentProjectPlugins = project.getParent().getPluginManagement().getPluginsAsMap();

            for (Plugin plugin : projectPlugins) {
                final Plugin parentPlugin = parentProjectPlugins.get(plugin.getKey());
                if (parentPlugin != null && !plugin.getVersion().equals(parentPlugin.getVersion())
                        && !isExcluded(plugin.getKey())) {
                    logHeader(log, "plugin management");
                    log.warn("Difference for: " + plugin.getKey());
                    log.warn("Project: " + plugin.getVersion());
                    log.warn("Parent:  " + parentPlugin.getVersion());
                    log.warn("----------------------------------------");
                    failureDetected = true;
                }
            }
        }
    }

}