Merge pull request mojohaus#69 from sebthom/issue-52-ignore-optional-…

…deps Add option ignoreOptionals to EnforceByteCodeVersion. Fixes mojohaus#52
Vlatombe · Jan 17, 2019 · a48e0cf · a48e0cf
2 parents 61ec7cd + 852d6a1
commit a48e0cf
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 1 deletion.
diff --git a/src/it/enforce-bytecode-version-ignore-optional-dependencies/invoker.properties b/src/it/enforce-bytecode-version-ignore-optional-dependencies/invoker.properties
@@ -0,0 +1,2 @@
+invoker.goals = enforcer:enforce install
+invoker.buildResult = success
diff --git a/src/it/enforce-bytecode-version-ignore-optional-dependencies/pom.xml b/src/it/enforce-bytecode-version-ignore-optional-dependencies/pom.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>test</groupId>
+    <artifactId>enforce-bytecode-version-ignore-optional-dependencies</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <description>GitHub Issue #52 - ignoring optional dependencies </description>
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <version>@enforcerPluginVersion@</version>
+                <dependencies>
+                    <dependency>
+                        <groupId>@project.groupId@</groupId>
+                        <artifactId>@project.artifactId@</artifactId>
+                        <version>@project.version@</version>
+                    </dependency>
+                </dependencies>
+                <configuration>
+                    <rules>
+                        <enforceBytecodeVersion>
+                            <maxJdkVersion>1.2</maxJdkVersion>
+                            <ignoredScopes>
+                                <!-- exclude junit/hamcrest -->
+                                <ignoredScope>test</ignoredScope>
+                            </ignoredScopes>
+                            <ignoreOptionals>true</ignoreOptionals>
+                        </enforceBytecodeVersion>
+                    </rules>
+                </configuration>
+                <executions>
+                    <execution>
+                        <phase>compile</phase>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.11</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <!-- this artifact contains classes targeting JDK 1.3 or newer -->
+            <groupId>javax.transaction</groupId>
+            <artifactId>jta</artifactId>
+            <version>1.1</version>
+            <optional>true</optional>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/src/main/java/org/apache/maven/plugins/enforcer/EnforceBytecodeVersion.java b/src/main/java/org/apache/maven/plugins/enforcer/EnforceBytecodeVersion.java
@@ -150,6 +150,12 @@ static String renderVersion( int major, int minor )
      */
     private String[] ignoredScopes;
 
+    /**
+     * Ignore all dependencies which have {@code &lt;optional&gt;true&lt;/optional&gt;}.
+     * @since 1.2
+     */
+    private boolean ignoreOptionals = false;
+
     private List<IgnorableDependency> ignorableDependencies = new ArrayList<IgnorableDependency>();
 
     @Override
@@ -399,7 +405,7 @@ public void setSearchTransitive( boolean theSearchTransitive )
      */
     private Set<Artifact> filterArtifacts( Set<Artifact> dependencies )
     {
-        if ( includes == null && excludes == null && ignoredScopes == null )
+        if ( includes == null && excludes == null && ignoredScopes == null && ignoreOptionals == false )
         {
             return dependencies;
         }
@@ -421,6 +427,10 @@ private Set<Artifact> filterArtifacts( Set<Artifact> dependencies )
             {
                 continue;
             }
+            if ( ignoreOptionals && artifact.isOptional() )
+            {
+                continue;
+            }
             if ( filter.include( artifact ) )
             {
                 result.add( artifact );

diff --git a/src/site/apt/enforceBytecodeVersion.apt.vm b/src/site/apt/enforceBytecodeVersion.apt.vm
@@ -41,6 +41,8 @@ Enforce Bytecode Version
 
    * ignoredScopes - a list of scopes (e.g. test, provided) to ignore when scanning artifacts
 
+   * ignoreOptionals - a boolean, if <<<true>>> all dependencies which have <<<<optional>true</optional>>>> are ignored.
+
    []
 
 Note
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		invoker.goals = enforcer:enforce install
		invoker.buildResult = success
-Original file line number
+Diff line change
@@ Expand Up / @@ -41,6 +41,8 @@ Enforce Bytecode Version @@
        * ignoredScopes - a list of scopes (e.g. test, provided) to ignore when scanning artifacts
+       * ignoreOptionals - a boolean, if <<<true>>> all dependencies which have <<<<optional>true</optional>>>> are ignored.
        []
     Note
@@ Expand Down @@