[MENFORCER-411] DependencyConvergence takes include/exclude parameter…

…s to filter errors
apache · Jan 12, 2022 · cf23701 · cf23701
1 parent 1a274f4
commit cf23701
Show file tree

Hide file tree

Showing 14 changed files with 647 additions and 5 deletions.
diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DependencyConvergence.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/DependencyConvergence.java
@@ -51,6 +51,10 @@ public class DependencyConvergence
 
     private boolean uniqueVersions;
 
+    private List<String> includes;
+
+    private List<String> excludes;
+
     public void setUniqueVersions( boolean uniqueVersions )
     {
         this.uniqueVersions = uniqueVersions;
@@ -113,8 +117,8 @@ public void execute( EnforcerRuleHelper helper )
             DependencyVersionMap visitor = new DependencyVersionMap( log );
             visitor.setUniqueVersions( uniqueVersions );
             node.accept( visitor );
-            List<CharSequence> errorMsgs = new ArrayList<>();
-            errorMsgs.addAll( getConvergenceErrorMsgs( visitor.getConflictedVersionNumbers() ) );
+            List<List<DependencyNode>> errors = visitor.getConflictedVersionNumbers( includes, excludes );
+            List<CharSequence> errorMsgs = new ArrayList<>( getConvergenceErrorMsgs( errors ) );
             for ( CharSequence errorMsg : errorMsgs )
             {
                 log.warn( errorMsg );

diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/ArtifactUtils.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/ArtifactUtils.java
@@ -108,7 +108,7 @@ public static Set<Artifact> checkDependencies( Set<Artifact> dependencies, List<
      * @return <code>true</code> if the artifact matches one of the patterns
      * @throws EnforcerRuleException the enforcer rule exception
      */
-    private static boolean compareDependency( String pattern, Artifact artifact )
+    static boolean compareDependency( String pattern, Artifact artifact )
         throws EnforcerRuleException
     {
 

diff --git a/...cer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/DependencyVersionMap.java b/...cer-rules/src/main/java/org/apache/maven/plugins/enforcer/utils/DependencyVersionMap.java
@@ -24,7 +24,9 @@
 import java.util.List;
 import java.util.Map;
 
+import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.artifact.Artifact;
+import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.shared.dependency.graph.DependencyNode;
 import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
@@ -120,16 +122,93 @@ private boolean containsConflicts( List<DependencyNode> nodes )
         return false;
     }
 
-    public List<List<DependencyNode>> getConflictedVersionNumbers()
+    public List<List<DependencyNode>> getConflictedVersionNumbers( List<String> includes, List<String> excludes )
+        throws EnforcerRuleException
     {
+        List<String> formattedIncludes = formatPatterns( includes );
+        List<String> formattedExcludes = formatPatterns( excludes );
+
         List<List<DependencyNode>> output = new ArrayList<>();
         for ( List<DependencyNode> nodes : idsToNode.values() )
         {
+            // if no artifact patterns are specified to include, don't do any filtering
+            if ( includes != null && !includes.isEmpty() )
+            {
+                // filter the nodes, can't put this in containsConflicts() because of the checked exception
+                // this should be done before checking if there are conflicts because filtering could
+                // eliminate conflicts and we don't want to have to check for conflicts twice
+                List<DependencyNode> filteredNodes = new ArrayList<>();
+                for ( DependencyNode node : nodes )
+                {
+                    if ( includeArtifact( node.getArtifact(), formattedIncludes, formattedExcludes ) )
+                    {
+                        filteredNodes.add( node );
+                    }
+                }
+                nodes = filteredNodes;
+            }
             if ( containsConflicts( nodes ) )
             {
                 output.add( nodes );
             }
         }
         return output;
     }
+
+    private static boolean includeArtifact( Artifact artifact, List<String> includes, List<String> excludes )
+        throws EnforcerRuleException
+    {
+        boolean included = false;
+        if ( includes != null )
+        {
+            for ( String pattern : includes )
+            {
+                if ( ArtifactUtils.compareDependency( pattern, artifact ) )
+                {
+                    included = true;
+                    break;
+                }
+            }
+        }
+
+        if ( !included )
+        {
+            return false;
+        }
+
+        boolean excluded = false;
+        if ( excludes != null )
+        {
+            for ( String pattern : excludes )
+            {
+                if ( ArtifactUtils.compareDependency( pattern, artifact ) )
+                {
+                    excluded = true;
+                    break;
+                }
+            }
+        }
+
+        return !excluded;
+    }
+
+    private static List<String> formatPatterns( List<String> patterns )
+    {
+        if ( patterns == null )
+        {
+            return null;
+        }
+
+        List<String> formattedPatterns = new ArrayList<>();
+        for ( String pattern : patterns )
+        {
+            String[] subStrings = pattern.split( ":" );
+            subStrings = StringUtils.stripAll( subStrings );
+            String formattedPattern = StringUtils.join( subStrings, ":" );
+
+            formattedPatterns.add( formattedPattern );
+        }
+
+        return formattedPatterns;
+    }
 }
diff --git a/enforcer-rules/src/site/apt/dependencyConvergence.apt.vm b/enforcer-rules/src/site/apt/dependencyConvergence.apt.vm
@@ -117,7 +117,7 @@ and
 </project>
 +-----------------------------------------------------------------------------------
 
-* Timestamped version
+* Timestamped Version
 
 	By default the non-unique versions are matched, which means the <<<X.Y-SNAPSHOT>>> instead of the timestamped versions.
 	If you want to use the unique versions of the dependencies, you can set its property to <<<true>>>.
@@ -128,3 +128,34 @@ and
       </dependencyConvergence>
 +---------------------------------------------
 
+* Filtering Dependency Errors
+
+  By default, all dependency convergence errors are reported, and any single error will fail the build. If you want
+  to tune which dependency errors are reported and fail the build, you can add the following optional parameters:
+
+    * includes - A list of artifacts for which dependency convergence should be enforced. If empty, dependency
+      convergence will be enforced for all artifacts.
+
+    * excludes - A list of artifacts for which dependency convergence should not be enforced. These are exceptions
+      to the includes. In other words, excludes only subtract from artifacts that matched an included artifact.
+      If you want to enforce dependency convergence for all except a few artifacts, set the includes to <<<*>>> and
+      exclude the artifacts you want.
+
+    []
+
+  The format for artifacts is groupId[:artifactId][:version][:type][:scope][:classifier] where artifactId, version,
+  type, scope and classifier are optional. Wildcards may be used to replace an entire section or just parts of a
+  section. This rule uses the {{{./versionRanges.html}Enforcer version range syntax}} to define allowed versions.
+
++---------------------------------------------
+      <dependencyConvergence>
+        <includes>
+          <include>org.slf4j</include>
+          <include>org.apache.commons</include>
+        </includes>
+        <excludes>
+          <exclude>org.slf4j:slf4j-jdk14</exclude>
+          <exclude>org.apache.commons:*:[3.4]</exclude>
+        </excludes>
+      </dependencyConvergence>
++---------------------------------------------
diff --git a/...enforcer-plugin/src/it/projects/dependency-convergence_exclude_failure/invoker.properties b/...enforcer-plugin/src/it/projects/dependency-convergence_exclude_failure/invoker.properties
@@ -0,0 +1,18 @@
+# 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.
+
+invoker.buildResult=failure
diff --git a/maven-enforcer-plugin/src/it/projects/dependency-convergence_exclude_failure/pom.xml b/maven-enforcer-plugin/src/it/projects/dependency-convergence_exclude_failure/pom.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  * 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.
+  *
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.apache.maven.enforcer.its</groupId>
+    <artifactId>dependency-convergence</artifactId>
+    <version>1.0.0</version>
+    <packaging>jar</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-jdk14</artifactId>
+            <version>1.6.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-nop</artifactId>
+            <version>1.6.0</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <version>@project.version@</version>
+                <executions>
+                    <execution>
+                        <id>enforce</id>
+                        <configuration>
+                            <rules>
+                                <!-- if there are no includes, return all errors -->
+                                <dependencyConvergence>
+                                    <includes/>
+                                    <excludes>
+                                        <exclude>org.slf4j</exclude>
+                                    </excludes>
+                                </dependencyConvergence>
+                            </rules>
+                        </configuration>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
diff --git a/...gin/src/it/projects/dependency-convergence_include-all-exclude_failure/invoker.properties b/...gin/src/it/projects/dependency-convergence_include-all-exclude_failure/invoker.properties
@@ -0,0 +1,18 @@
+# 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.
+
+invoker.buildResult=failure
diff --git a/...nforcer-plugin/src/it/projects/dependency-convergence_include-all-exclude_failure/pom.xml b/...nforcer-plugin/src/it/projects/dependency-convergence_include-all-exclude_failure/pom.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  * 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.
+  *
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.apache.maven.enforcer.its</groupId>
+    <artifactId>dependency-convergence</artifactId>
+    <version>1.0.0</version>
+    <packaging>jar</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+            <version>1.6.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-jdk14</artifactId>
+            <version>1.6.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-nop</artifactId>
+            <version>1.6.0</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <version>@project.version@</version>
+                <executions>
+                    <execution>
+                        <id>enforce</id>
+                        <configuration>
+                            <rules>
+                                <!-- if everything is included, return any errors that are not excluded -->
+                                <dependencyConvergence>
+                                    <includes>
+                                        <include>*</include>
+                                    </includes>
+                                    <excludes>
+                                        <exclude>org.apache.commons</exclude>
+                                        <exclude>org.slf4j:slf4j-api:[1.6.2]</exclude>
+                                    </excludes>
+                                </dependencyConvergence>
+                            </rules>
+                        </configuration>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>