This is an automated email from the ASF dual-hosted git repository.

slawekjaranowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-enforcer.git


The following commit(s) were added to refs/heads/master by this push:
     new 8a6f5d3d Add ignoreOptionals option to bannedDependencies and 
requireReleaseDeps (#1078)
8a6f5d3d is described below

commit 8a6f5d3dd136419f83ff6da56739930015dc5ac0
Author: Slawomir Jaranowski <[email protected]>
AuthorDate: Mon Nov 16 17:18:12 2026 +0100

    Add ignoreOptionals option to bannedDependencies and requireReleaseDeps 
(#1078)
    
    * Add ignoreOptionals option to bannedDependencies and requireReleaseDeps
    
    Closes #1077
    
    Co-Authored-By: Claude Opus 5.5 <[email protected]>
    
    * Address review: assert IT outcome, clarify ignoreOptionals docs
    
    Co-Authored-By: Claude Opus 5.5 <[email protected]>
    
    ---------
    
    Co-authored-by: Claude Opus 5.5 <[email protected]>
---
 .../rules/dependency/BannedDependencies.java       |  4 +-
 .../rules/dependency/BannedDependenciesBase.java   | 19 +++++-
 .../rules/dependency/RequireReleaseDeps.java       |  3 +-
 .../src/site/markdown/bannedDependencies.md.vm     |  1 +
 .../src/site/markdown/requireReleaseDeps.md.vm     |  1 +
 .../rules/dependency/BannedDependenciesTest.java   | 79 ++++++++++++++++++++++
 .../it/projects/banned-dependencies-fail/pom.xml   |  8 +++
 .../banned-dependencies-fail/verify.groovy         |  1 +
 .../pom.xml                                        | 15 ++--
 .../verify.groovy                                  |  3 +-
 10 files changed, 123 insertions(+), 11 deletions(-)

diff --git 
a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependencies.java
 
b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependencies.java
index 0ded3f8d..f830e6fb 100644
--- 
a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependencies.java
+++ 
b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependencies.java
@@ -64,7 +64,7 @@ public final class BannedDependencies extends 
BannedDependenciesBase {
     @Override
     public String toString() {
         return String.format(
-                "BannedDependencies[message=%s, excludes=%s, includes=%s, 
searchTransitive=%b]",
-                getMessage(), getExcludes(), getIncludes(), 
isSearchTransitive());
+                "BannedDependencies[message=%s, excludes=%s, includes=%s, 
searchTransitive=%b, ignoreOptionals=%b]",
+                getMessage(), getExcludes(), getIncludes(), 
isSearchTransitive(), isIgnoreOptionals());
     }
 }
diff --git 
a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java
 
b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java
index 10394c02..39fab474 100644
--- 
a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java
+++ 
b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.java
@@ -69,6 +69,9 @@ abstract class BannedDependenciesBase extends 
AbstractStandardEnforcerRule {
     /** Specify if transitive dependencies should be searched (default) or 
only look at direct dependencies. */
     private boolean searchTransitive = true;
 
+    /** Specify if direct optional dependencies of the project, and their 
transitive dependencies, should be ignored. */
+    private boolean ignoreOptionals = false;
+
     private final MavenSession session;
 
     private final ResolverUtil resolverUtil;
@@ -87,6 +90,7 @@ abstract class BannedDependenciesBase extends 
AbstractStandardEnforcerRule {
 
         if (!searchTransitive) {
             String result = 
session.getCurrentProject().getDependencyArtifacts().stream()
+                    .filter(a -> !(ignoreOptionals && a.isOptional()))
                     .filter(a -> !validate(a))
                     .collect(
                             StringBuilder::new,
@@ -107,7 +111,7 @@ abstract class BannedDependenciesBase extends 
AbstractStandardEnforcerRule {
         } else {
             StringBuilder messageBuilder = new StringBuilder();
             DependencyNode rootNode =
-                    resolverUtil.resolveTransitiveDependencies(true, false, 
false, Collections.emptyList());
+                    resolverUtil.resolveTransitiveDependencies(true, false, 
ignoreOptionals, Collections.emptyList());
 
             Set<MatchingArtifact> visitedArtifacts = new HashSet<>();
             if (!validate(rootNode, 0, messageBuilder, visitedArtifacts)) {
@@ -216,4 +220,17 @@ abstract class BannedDependenciesBase extends 
AbstractStandardEnforcerRule {
     public boolean isSearchTransitive() {
         return searchTransitive;
     }
+
+    /**
+     * Sets the ignore optionals.
+     *
+     * @param ignoreOptionals if {@code true} direct optional dependencies of 
the project are not checked
+     */
+    public void setIgnoreOptionals(boolean ignoreOptionals) {
+        this.ignoreOptionals = ignoreOptionals;
+    }
+
+    public boolean isIgnoreOptionals() {
+        return ignoreOptionals;
+    }
 }
diff --git 
a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.java
 
b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.java
index 0b0490dd..e19f2694 100644
--- 
a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.java
+++ 
b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.java
@@ -136,11 +136,12 @@ public final class RequireReleaseDeps extends 
BannedDependenciesBase {
     @Override
     public String toString() {
         return String.format(
-                "RequireReleaseDeps[message=%s, excludes=%s, includes=%s, 
searchTransitive=%b, onlyWhenRelease=%b, failWhenParentIsSnapshot=%b]",
+                "RequireReleaseDeps[message=%s, excludes=%s, includes=%s, 
searchTransitive=%b, ignoreOptionals=%b, onlyWhenRelease=%b, 
failWhenParentIsSnapshot=%b]",
                 getMessage(),
                 getExcludes(),
                 getIncludes(),
                 isSearchTransitive(),
+                isIgnoreOptionals(),
                 onlyWhenRelease,
                 failWhenParentIsSnapshot);
     }
diff --git a/enforcer-rules/src/site/markdown/bannedDependencies.md.vm 
b/enforcer-rules/src/site/markdown/bannedDependencies.md.vm
index 82738479..98319e1b 100644
--- a/enforcer-rules/src/site/markdown/bannedDependencies.md.vm
+++ b/enforcer-rules/src/site/markdown/bannedDependencies.md.vm
@@ -31,6 +31,7 @@ This rule checks the dependencies and fails if any of the 
matching excludes are
 The following parameters are supported by this rule:
 
 - **searchTransitive** - if transitive dependencies should be checked. Default 
is true.
+- **ignoreOptionals** - if `true` direct optional dependencies of the project 
(and their transitive dependencies) won't be checked. Default is `false`.
 - **excludes** - a list of artifacts to ban. The format is 
groupId\[:artifactId\]\[:version\]\[:type\]\[:scope\]\[:classifier\] where 
artifactId, version, type, scope and classifier are optional. Wildcards may be 
used to replace an entire or just parts of a section. Examples:
     - org.apache.maven
     - org.apache.maven:badArtifact
diff --git a/enforcer-rules/src/site/markdown/requireReleaseDeps.md.vm 
b/enforcer-rules/src/site/markdown/requireReleaseDeps.md.vm
index 6bfcc55a..4d4032ba 100644
--- a/enforcer-rules/src/site/markdown/requireReleaseDeps.md.vm
+++ b/enforcer-rules/src/site/markdown/requireReleaseDeps.md.vm
@@ -31,6 +31,7 @@ This rule checks the dependencies and fails if any snapshots 
are found.
 The following parameters are supported by this rule:
 
 - **searchTransitive** - if transitive dependencies should be checked. 
Default: true
+- **ignoreOptionals** - if `true` direct optional dependencies of the project 
(and their transitive dependencies) won't be checked. Default is `false`.
 - **message** - an optional message to the user if the rule fails.
 - **onlyWhenRelease** - if this rule should only be executed when the version 
is a non-SNAPSHOT version. Default: false
 - **failWhenParentIsSnapshot** - if the parent should be checked. Default: true
diff --git 
a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesTest.java
 
b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesTest.java
index a26586b4..5ef0ec50 100644
--- 
a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesTest.java
+++ 
b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/dependency/BannedDependenciesTest.java
@@ -19,7 +19,10 @@
 package org.apache.maven.enforcer.rules.dependency;
 
 import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
 
+import org.apache.maven.artifact.Artifact;
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.apache.maven.enforcer.rules.utils.DependencyNodeBuilder;
 import org.apache.maven.enforcer.rules.utils.EnforcerArtifactStubFactory;
@@ -34,6 +37,8 @@ import org.mockito.junit.jupiter.MockitoExtension;
 import static org.assertj.core.api.Assertions.assertThatCode;
 import static org.mockito.ArgumentMatchers.anyBoolean;
 import static org.mockito.ArgumentMatchers.anyList;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
 /**
@@ -205,6 +210,80 @@ class BannedDependenciesTest {
                         "default-group:childAAA:war:classifier:1.0.0-SNAPSHOT 
<--- banned via the exclude/include list");
     }
 
+    @Test
+    void optionalDependencyIsCheckedByDefaultDoNotUseTransitiveDependencies() 
throws Exception {
+        when(session.getCurrentProject()).thenReturn(project);
+        
when(project.getDependencyArtifacts()).thenReturn(getArtifactsWithOptional());
+
+        rule.setSearchTransitive(false);
+        rule.setExcludes(Collections.singletonList("g:optional"));
+
+        assertThatCode(rule::execute)
+                .isInstanceOf(EnforcerRuleException.class)
+                .hasMessageContaining("g:optional:jar:1.0 <--- banned via the 
exclude/include list");
+    }
+
+    @Test
+    void ignoreOptionalsDoNotUseTransitiveDependencies() throws Exception {
+        when(session.getCurrentProject()).thenReturn(project);
+        
when(project.getDependencyArtifacts()).thenReturn(getArtifactsWithOptional());
+
+        rule.setSearchTransitive(false);
+        rule.setIgnoreOptionals(true);
+        rule.setExcludes(Collections.singletonList("g:optional"));
+
+        assertThatCode(rule::execute).doesNotThrowAnyException();
+    }
+
+    @Test
+    void ignoreOptionalsStillChecksNonOptionalDoNotUseTransitiveDependencies() 
throws Exception {
+        when(session.getCurrentProject()).thenReturn(project);
+        
when(project.getDependencyArtifacts()).thenReturn(getArtifactsWithOptional());
+
+        rule.setSearchTransitive(false);
+        rule.setIgnoreOptionals(true);
+        rule.setExcludes(Collections.singletonList("g"));
+
+        assertThatCode(rule::execute)
+                .isInstanceOf(EnforcerRuleException.class)
+                .hasMessageContaining("g:compile:jar:1.0 <--- banned via the 
exclude/include list")
+                .hasMessageNotContaining("g:optional");
+    }
+
+    @Test
+    void optionalDependenciesAreResolvedByDefaultUseTransitiveDependencies() 
throws Exception {
+        when(resolverUtil.resolveTransitiveDependencies(anyBoolean(), 
anyBoolean(), anyBoolean(), anyList()))
+                .thenReturn(new DependencyNodeBuilder().build());
+
+        rule.setSearchTransitive(true);
+
+        assertThatCode(rule::execute).doesNotThrowAnyException();
+
+        verify(resolverUtil).resolveTransitiveDependencies(anyBoolean(), 
anyBoolean(), eq(false), anyList());
+    }
+
+    @Test
+    void ignoreOptionalsUseTransitiveDependencies() throws Exception {
+        when(resolverUtil.resolveTransitiveDependencies(anyBoolean(), 
anyBoolean(), anyBoolean(), anyList()))
+                .thenReturn(new DependencyNodeBuilder().build());
+
+        rule.setSearchTransitive(true);
+        rule.setIgnoreOptionals(true);
+
+        assertThatCode(rule::execute).doesNotThrowAnyException();
+
+        verify(resolverUtil).resolveTransitiveDependencies(anyBoolean(), 
anyBoolean(), eq(true), anyList());
+    }
+
+    private static Set<Artifact> getArtifactsWithOptional() {
+        Artifact optional = ARTIFACT_STUB_FACTORY.createArtifact("g", 
"optional", "1.0");
+        optional.setOptional(true);
+        Set<Artifact> artifacts = new HashSet<>();
+        artifacts.add(ARTIFACT_STUB_FACTORY.createArtifact("g", "compile", 
"1.0"));
+        artifacts.add(optional);
+        return artifacts;
+    }
+
     @Test
     void invalidExcludeFormat() throws Exception {
         rule.setSearchTransitive(false);
diff --git 
a/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/pom.xml 
b/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/pom.xml
index 33d215fe..e8dab947 100644
--- a/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/pom.xml
+++ b/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/pom.xml
@@ -35,6 +35,12 @@ under the License.
       <artifactId>menforcer128_api</artifactId>
       <version>1.4.0</version>
     </dependency>
+    <dependency>
+      <groupId>org.apache.maven.plugins.enforcer.its</groupId>
+      <artifactId>menforcer138_io</artifactId>
+      <version>2.0.3</version>
+      <optional>true</optional>
+    </dependency>
   </dependencies>
 
   <build>
@@ -54,6 +60,8 @@ under the License.
                 <BannedDependencies>
                   <excludes>
                     
<exclude>org.apache.maven.plugins.enforcer.its:menforcer128_api</exclude>
+                    <!-- transitive dependency of optional menforcer138_io -->
+                    
<exclude>org.apache.maven.plugins.enforcer.its:menforcer138_utils</exclude>
                   </excludes>
                 </BannedDependencies>
               </rules>
diff --git 
a/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/verify.groovy 
b/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/verify.groovy
index 415c0e3f..d890eb10 100644
--- 
a/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/verify.groovy
+++ 
b/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/verify.groovy
@@ -18,3 +18,4 @@
  */
 def buildLog = new File( basedir, 'build.log' ).text
 assert buildLog.contains( 
'org.apache.maven.plugins.enforcer.its:menforcer128_api:jar:1.4.0 <--- banned 
via the exclude/include list' )
+assert buildLog.contains( 
'org.apache.maven.plugins.enforcer.its:menforcer138_utils:jar:3.0 <--- banned 
via the exclude/include list' )
diff --git 
a/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/pom.xml 
b/maven-enforcer-plugin/src/it/projects/banned-dependencies-ignore-optionals/pom.xml
similarity index 78%
copy from maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/pom.xml
copy to 
maven-enforcer-plugin/src/it/projects/banned-dependencies-ignore-optionals/pom.xml
index 33d215fe..e49074f2 100644
--- a/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/pom.xml
+++ 
b/maven-enforcer-plugin/src/it/projects/banned-dependencies-ignore-optionals/pom.xml
@@ -23,17 +23,19 @@ under the License.
   <modelVersion>4.0.0</modelVersion>
 
   <groupId>org.apache.maven.its.enforcer</groupId>
-  <artifactId>test</artifactId>
+  <artifactId>banned-dependencies-ignore-optionals</artifactId>
   <version>1.0</version>
 
   <description>
+    Optional dependencies and their transitive dependencies are not checked 
when ignoreOptionals is set - #1077
   </description>
 
   <dependencies>
     <dependency>
       <groupId>org.apache.maven.plugins.enforcer.its</groupId>
-      <artifactId>menforcer128_api</artifactId>
-      <version>1.4.0</version>
+      <artifactId>menforcer138_io</artifactId>
+      <version>2.0.3</version>
+      <optional>true</optional>
     </dependency>
   </dependencies>
 
@@ -51,11 +53,12 @@ under the License.
             </goals>
             <configuration>
               <rules>
-                <BannedDependencies>
+                <bannedDependencies>
+                  <ignoreOptionals>true</ignoreOptionals>
                   <excludes>
-                    
<exclude>org.apache.maven.plugins.enforcer.its:menforcer128_api</exclude>
+                    <exclude>*:*:*:jar:compile</exclude>
                   </excludes>
-                </BannedDependencies>
+                </bannedDependencies>
               </rules>
             </configuration>
           </execution>
diff --git 
a/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/verify.groovy 
b/maven-enforcer-plugin/src/it/projects/banned-dependencies-ignore-optionals/verify.groovy
similarity index 83%
copy from 
maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/verify.groovy
copy to 
maven-enforcer-plugin/src/it/projects/banned-dependencies-ignore-optionals/verify.groovy
index 415c0e3f..2587108d 100644
--- 
a/maven-enforcer-plugin/src/it/projects/banned-dependencies-fail/verify.groovy
+++ 
b/maven-enforcer-plugin/src/it/projects/banned-dependencies-ignore-optionals/verify.groovy
@@ -17,4 +17,5 @@
  * under the License.
  */
 def buildLog = new File( basedir, 'build.log' ).text
-assert buildLog.contains( 
'org.apache.maven.plugins.enforcer.its:menforcer128_api:jar:1.4.0 <--- banned 
via the exclude/include list' )
+assert buildLog.contains( 'Rule 0: 
org.apache.maven.enforcer.rules.dependency.BannedDependencies passed' )
+assert !buildLog.contains( 'banned via the exclude/include list' )

Reply via email to