Allow exludes to apply when includes are not specified

apache · Nov 3, 2022 · e322900 · e322900
1 parent b5fdb11
commit e322900
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 14 deletions.
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
@@ -31,6 +31,7 @@
 import org.apache.maven.shared.dependency.graph.DependencyNode;
 import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
 
+
 /**
  * @author Brian Fox
  *
@@ -132,7 +133,7 @@ public List<List<DependencyNode>> getConflictedVersionNumbers( List<String> incl
         for ( List<DependencyNode> nodes : idsToNode.values() )
         {
             List<DependencyNode> filteredNodes = nodes;
-            if ( formattedIncludes != null && !formattedIncludes.isEmpty() )
+            if ( formattedIncludes != null || formattedExcludes != null )
             {
                 filteredNodes = new ArrayList<>();
                 for ( DependencyNode node : nodes )
@@ -154,8 +155,8 @@ public List<List<DependencyNode>> getConflictedVersionNumbers( List<String> incl
     private static boolean includeArtifact( Artifact artifact, List<String> includes, List<String> excludes )
         throws EnforcerRuleException
     {
-        boolean included = false;
-        if ( includes != null )
+        boolean included = includes == null || includes.isEmpty();
+        if ( !included )
         {
             for ( String pattern : includes )
             {

diff --git a/enforcer-rules/src/site/apt/dependencyConvergence.apt.vm b/enforcer-rules/src/site/apt/dependencyConvergence.apt.vm
@@ -133,13 +133,11 @@ and
   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.
+    * includes - A list of artifacts for which dependency convergence should be enforced. Not specifying any includes
+      is interpreted the same as including 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.
+      to the includes.
 
     []
 
@@ -158,4 +156,4 @@ and
           <exclude>org.apache.commons:*:[3.4]</exclude>
         </excludes>
       </dependencyConvergence>
-+---------------------------------------------
++---------------------------------------------
diff --git a/...nforcer-plugin/src/it/projects/dependency-convergence_include-all-exclude_success/pom.xml b/...nforcer-plugin/src/it/projects/dependency-convergence_include-all-exclude_success/pom.xml
@@ -61,8 +61,7 @@
                                         <include>*</include>
                                     </includes>
                                     <excludes>
-                                        <excludes>org.slf4j:slf4j-api:[1.6.1]</excludes>
-                                        <excludes>org.slf4j:slf4j-api:[1.6.2]</excludes>
+                                        <excludes>org.slf4j:slf4j-api:[1.6.1,1.6.2]</excludes>
                                     </excludes>
                                 </dependencyConvergence>
                             </rules>

diff --git a/...rgence_exclude_failure/invoker.properties → ..._include-empty_failure/invoker.properties b/...rgence_exclude_failure/invoker.properties → ..._include-empty_failure/invoker.properties
diff --git a/...dency-convergence_exclude_failure/pom.xml → ...convergence_include-empty_failure/pom.xml b/...dency-convergence_exclude_failure/pom.xml → ...convergence_include-empty_failure/pom.xml
@@ -27,6 +27,11 @@
     <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>
@@ -50,11 +55,10 @@
                         <id>enforce</id>
                         <configuration>
                             <rules>
-                                <!-- if there are no includes, return all errors -->
+                                <!-- if there are no includes, assume everything is included and apply excludes -->
                                 <dependencyConvergence>
-                                    <includes/>
                                     <excludes>
-                                        <exclude>org.slf4j</exclude>
+                                        <exclude>org.slf4j:slf4j-api:[1.6.2]</exclude>
                                     </excludes>
                                 </dependencyConvergence>
                             </rules>