001package org.apache.maven.plugins.enforcer; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import java.util.ArrayList; 023import java.util.Collection; 024import java.util.HashSet; 025import java.util.LinkedHashMap; 026import java.util.List; 027import java.util.Map; 028import java.util.Set; 029import java.util.regex.Pattern; 030 031import org.apache.maven.artifact.Artifact; 032import org.apache.maven.enforcer.rule.api.EnforcerRuleException; 033import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper; 034import org.apache.maven.project.MavenProject; 035import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException; 036 037/** 038 * @author Robert Scholte 039 * @since 1.3 040 */ 041public class RequireSameVersions 042 extends AbstractNonCacheableEnforcerRule 043{ 044 private boolean uniqueVersions; 045 046 private Set<String> dependencies = new HashSet<>(); 047 048 private Set<String> plugins = new HashSet<>(); 049 050 private Set<String> buildPlugins = new HashSet<>(); 051 052 private Set<String> reportPlugins = new HashSet<>(); 053 054 @Override 055 public void execute( EnforcerRuleHelper helper ) 056 throws EnforcerRuleException 057 { 058 // get the project 059 MavenProject project; 060 try 061 { 062 project = (MavenProject) helper.evaluate( "${project}" ); 063 } 064 catch ( ExpressionEvaluationException eee ) 065 { 066 throw new EnforcerRuleException( "Unable to retrieve the MavenProject: ", eee ); 067 } 068 069 // consider including profile based artifacts 070 Map<String, List<String>> versionMembers = new LinkedHashMap<>(); 071 072 Set<String> buildPluginSet = new HashSet<>( buildPlugins ); 073 buildPluginSet.addAll( plugins ); 074 Set<String> reportPluginSet = new HashSet<>( reportPlugins ); 075 reportPluginSet.addAll( plugins ); 076 077 // CHECKSTYLE_OFF: LineLength 078 versionMembers.putAll( collectVersionMembers( project.getArtifacts(), dependencies, " (dependency)" ) ); 079 versionMembers.putAll( collectVersionMembers( project.getPluginArtifacts(), buildPlugins, " (buildPlugin)" ) ); 080 versionMembers.putAll( collectVersionMembers( project.getReportArtifacts(), reportPlugins, " (reportPlugin)" ) ); 081 // CHECKSTYLE_ON: LineLength 082 083 if ( versionMembers.size() > 1 ) 084 { 085 StringBuilder builder = new StringBuilder( "Found entries with different versions" 086 + System.lineSeparator() ); 087 for ( Map.Entry<String, List<String>> entry : versionMembers.entrySet() ) 088 { 089 builder.append( "Entries with version " ).append( entry.getKey() ).append( System.lineSeparator() ); 090 for ( String conflictId : entry.getValue() ) 091 { 092 builder.append( "- " ).append( conflictId ).append( System.lineSeparator() ); 093 } 094 } 095 throw new EnforcerRuleException( builder.toString() ); 096 } 097 } 098 099 private Map<String, List<String>> collectVersionMembers( Set<Artifact> artifacts, Collection<String> patterns, 100 String source ) 101 { 102 Map<String, List<String>> versionMembers = new LinkedHashMap<>(); 103 104 List<Pattern> regExs = new ArrayList<>(); 105 for ( String pattern : patterns ) 106 { 107 String regex = pattern.replace( ".", "\\." ).replace( "*", ".*" ).replace( ":", "\\:" ).replace( '?', '.' ); 108 109 // pattern is groupId[:artifactId[:type[:classifier]]] 110 regExs.add( Pattern.compile( regex + "(\\:.+)?" ) ); 111 } 112 113 for ( Artifact artifact : artifacts ) 114 { 115 for ( Pattern regEx : regExs ) 116 { 117 if ( regEx.matcher( artifact.getDependencyConflictId() ).matches() ) 118 { 119 String version = uniqueVersions ? artifact.getVersion() : artifact.getBaseVersion(); 120 if ( !versionMembers.containsKey( version ) ) 121 { 122 versionMembers.put( version, new ArrayList<String>() ); 123 } 124 versionMembers.get( version ).add( artifact.getDependencyConflictId() + source ); 125 } 126 } 127 } 128 return versionMembers; 129 } 130 131}