enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireSameVersions.java

package org.apache.maven.plugins.enforcer;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;

/**
 * @author Robert Scholte
 * @since 1.3
 */
public class RequireSameVersions
    extends AbstractNonCacheableEnforcerRule
{
    private boolean uniqueVersions;

    private Set<String> dependencies = new HashSet<String>();

    private Set<String> plugins = new HashSet<String>();

    private Set<String> buildPlugins = new HashSet<String>();

    private Set<String> reportPlugins = new HashSet<String>();

    @Override
    public void execute( EnforcerRuleHelper helper )
        throws EnforcerRuleException
    {
        // get the project
        MavenProject project = null;
        try
        {
            project = (MavenProject) helper.evaluate( "${project}" );
        }
        catch ( ExpressionEvaluationException eee )
        {
            throw new EnforcerRuleException( "Unable to retrieve the MavenProject: ", eee );
        }

        // consider including profile based artifacts
        Map<String, List<String>> versionMembers = new LinkedHashMap<String, List<String>>();

        Set<String> buildPluginSet = new HashSet<String>( buildPlugins );
        buildPluginSet.addAll( plugins );
        Set<String> reportPluginSet = new HashSet<String>( reportPlugins );
        reportPluginSet.addAll( plugins );

        // CHECKSTYLE_OFF: LineLength
        versionMembers.putAll( collectVersionMembers( project.getArtifacts(), dependencies, " (dependency)" ) );
        versionMembers.putAll( collectVersionMembers( project.getPluginArtifacts(), buildPlugins, " (buildPlugin)" ) );
        versionMembers.putAll( collectVersionMembers( project.getReportArtifacts(), reportPlugins, " (reportPlugin)" ) );
        // CHECKSTYLE_ON: LineLength

        if ( versionMembers.size() > 1 )
        {
            StringBuilder builder = new StringBuilder( "Found entries with different versions"
                + System.lineSeparator() );
            for ( Map.Entry<String, List<String>> entry : versionMembers.entrySet() )
            {
                builder.append( "Entries with version " ).append( entry.getKey() ).append( System.lineSeparator() );
                for ( String conflictId : entry.getValue() )
                {
                    builder.append( "- " ).append( conflictId ).append( System.lineSeparator() );
                }
            }
            throw new EnforcerRuleException( builder.toString() );
        }
    }

    private Map<String, List<String>> collectVersionMembers( Set<Artifact> artifacts, Collection<String> patterns,
                                                             String source )
    {
        Map<String, List<String>> versionMembers = new LinkedHashMap<String, List<String>>();

        List<Pattern> regExs = new ArrayList<Pattern>();
        for ( String pattern : patterns )
        {
            String regex = pattern.replace( ".", "\\." ).replace( "*", ".*" ).replace( ":", "\\:" ).replace( '?', '.' );

            // pattern is groupId[:artifactId[:type[:classifier]]]
            regExs.add( Pattern.compile( regex + "(\\:.+)?" ) );
        }

        for ( Artifact artifact : artifacts )
        {
            for ( Pattern regEx : regExs )
            {
                if ( regEx.matcher( artifact.getDependencyConflictId() ).matches() )
                {
                    String version = uniqueVersions ? artifact.getVersion() : artifact.getBaseVersion();
                    if ( !versionMembers.containsKey( version ) )
                    {
                        versionMembers.put( version, new ArrayList<String>() );
                    }
                    versionMembers.get( version ).add( artifact.getDependencyConflictId() + source );
                }
            }
        }
        return versionMembers;
    }

}