Move to new Enforcer API - require m-enforcer-p 3.2.0

fix #256
mojohaus · May 30, 2023 · b23d7db · b23d7db
1 parent b7ba48d
commit b23d7db
Show file tree

Hide file tree

Showing 41 changed files with 380 additions and 499 deletions.
diff --git a/pom.xml b/pom.xml
@@ -153,6 +153,10 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.eclipse.sisu</groupId>
+        <artifactId>sisu-maven-plugin</artifactId>
+      </plugin>
     </plugins>
   </build>
 

diff --git a/src/it/circular-simple/verify.groovy b/src/it/circular-simple/verify.groovy
@@ -0,0 +1,10 @@
+File file = new File(basedir, "build.log");
+assert file.exists();
+
+String text = file.getText("utf-8");
+
+
+assert text.contains('ERROR] Rule 0: org.codehaus.mojo.extraenforcer.dependencies.BanCircularDependencies failed with message:')
+assert text.contains('[ERROR] Circular Dependency found. Your project\'s groupId:artifactId combination must not exist in the list of direct or transitive dependencies.')
+
+return true;
diff --git a/src/it/mojo-1744/verify.groovy b/src/it/mojo-1744/verify.groovy
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import org.codehaus.mojo.extraenforcerrules.it.BanDuplicateClassesLogParser;
+import org.codehaus.mojo.extraenforcer.it.BanDuplicateClassesLogParser;
 
 File log = new File( basedir, 'build.log' )
 assert log.exists()

diff --git a/src/it/mojo-1853/verify.groovy b/src/it/mojo-1853/verify.groovy
@@ -1,7 +1,7 @@
 final File file = new File( basedir, "build.log" );
 final String buf = file.getText("utf-8");
 
-assert buf.contains(/org.apache.maven.plugins.enforcer.RequirePropertyDiverges failed with message/);
+assert buf.contains(/org.codehaus.mojo.extraenforcer.model.RequirePropertyDiverges failed with message/);
 
 assert buf.contains('Property \'project.url\' evaluates to \'http://company/company-parent-pom/child-fail');
 

diff --git a/src/it/mojo-1929/verify.groovy b/src/it/mojo-1929/verify.groovy
@@ -1,7 +1,7 @@
 final File file = new File( basedir, "build.log" );
 final String buf = file.getText("utf-8");
 
-assert buf.contains(/org.apache.maven.plugins.enforcer.RequirePropertyDiverges failed with message/);
+assert buf.contains(/org.codehaus.mojo.extraenforcer.model.RequirePropertyDiverges failed with message/);
 
 assert buf.contains('Property \'project.url\' evaluates to \'http://company/company-parent-pom/child-fail');
 

diff --git a/src/it/require-project-url-missing/verify.groovy b/src/it/require-project-url-missing/verify.groovy
@@ -2,6 +2,6 @@ File file = new File( basedir, "build.log" );
 assert file.exists();
 
 String text = file.getText("utf-8");
-assert text.contains('org.apache.maven.plugins.enforcer.RequireProjectUrl failed with message');
+assert text.contains('org.codehaus.mojo.extraenforcer.model.RequireProjectUrl failed with message');
 
 return true;
diff --git a/src/it/require-project-url-present/verify.groovy b/src/it/require-project-url-present/verify.groovy
@@ -2,6 +2,6 @@ File file = new File( basedir, "build.log" );
 assert file.exists();
 
 String text = file.getText("utf-8");
-assert !text.contains('org.apache.maven.plugins.enforcer.RequireProjectUrl failed with message');
+assert !text.contains('org.codehaus.mojo.extraenforcer.model.RequireProjectUrl failed with message');
 
 return true;
diff --git a/src/it/require-project-url-regex/verify.groovy b/src/it/require-project-url-regex/verify.groovy
@@ -2,6 +2,6 @@ File file = new File( basedir, "build.log" );
 assert file.exists();
 
 String text = file.getText("utf-8");
-assert text.contains('org.apache.maven.plugins.enforcer.RequireProjectUrl failed with message');
+assert text.contains('org.codehaus.mojo.extraenforcer.model.RequireProjectUrl failed with message');
 
 return true;
diff --git a/src/it/require-property-diverges/verify.groovy b/src/it/require-property-diverges/verify.groovy
@@ -1,7 +1,7 @@
 final File file = new File( basedir, "build.log" );
 final String buf = file.getText( "utf-8" );
 
-assert buf.contains(/org.apache.maven.plugins.enforcer.RequirePropertyDiverges failed with message/);
+assert buf.contains(/org.codehaus.mojo.extraenforcer.model.RequirePropertyDiverges failed with message/);
 
 assert buf.contains('Property \'project.issueManagement\' is required for this build and not defined in hierarchy at all.');
 

diff --git a/src/it/require-roles-missing-contributor/verify.groovy b/src/it/require-roles-missing-contributor/verify.groovy
@@ -2,6 +2,6 @@ File file = new File( basedir, "build.log" );
 assert file.exists();
 
 String text = file.getText("utf-8");
-assert text.contains('org.apache.maven.plugins.enforcer.RequireContributorRoles failed with message');
+assert text.contains('org.codehaus.mojo.extraenforcer.model.RequireContributorRoles failed with message');
 assert text.contains('Found no contributor representing role(s) \'[quality manager]\'');
 return true;
diff --git a/src/it/smokes/verify.bsh b/src/it/smokes/verify.bsh
@@ -7,7 +7,7 @@ try
     File file = new File( basedir, "build.log" );
     String buf = FileUtils.fileRead( file );
 
-    Pattern p = Pattern.compile( "\\Qorg.apache.maven.plugins.enforcer.BanDuplicateClasses failed with message\\E" );
+    Pattern p = Pattern.compile( "\\Qorg.codehaus.mojo.extraenforcer.dependencies.BanDuplicateClasses failed with message\\E" );
     Matcher m = p.matcher( buf.toString() );
     if ( !m.find() )
     {

diff --git a/src/main/java/org/apache/maven/plugins/enforcer/AbstractMojoHausEnforcerRule.java b/src/main/java/org/apache/maven/plugins/enforcer/AbstractMojoHausEnforcerRule.java
diff --git a/...enforcer/AbstractResolveDependencies.java → ...ndencies/AbstractResolveDependencies.java b/...enforcer/AbstractResolveDependencies.java → ...ndencies/AbstractResolveDependencies.java
@@ -1,4 +1,4 @@
-package org.apache.maven.plugins.enforcer;
+package org.codehaus.mojo.extraenforcer.dependencies;
 
 import java.util.ArrayList;
 import java.util.HashSet;
@@ -8,18 +8,14 @@
 
 import org.apache.maven.RepositoryUtils;
 import org.apache.maven.artifact.Artifact;
-import org.apache.maven.enforcer.rule.api.EnforcerRule;
+import org.apache.maven.enforcer.rule.api.AbstractEnforcerRule;
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
-import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
 import org.apache.maven.execution.MavenSession;
-import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.project.DefaultProjectBuildingRequest;
 import org.apache.maven.project.ProjectBuildingRequest;
 import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
 import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException;
 import org.apache.maven.shared.dependency.graph.DependencyNode;
-import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
-import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
 import org.eclipse.aether.RepositorySystem;
 import org.eclipse.aether.resolution.ArtifactRequest;
 import org.eclipse.aether.resolution.ArtifactResolutionException;
@@ -31,32 +27,22 @@
  * @author Robert Scholte
  *
  */
-public abstract class AbstractResolveDependencies extends AbstractMojoHausEnforcerRule {
+abstract class AbstractResolveDependencies extends AbstractEnforcerRule {
 
-    private DependencyGraphBuilder graphBuilder;
+    private final MavenSession session;
+    private final RepositorySystem repositorySystem;
 
-    private MavenSession session;
-    private RepositorySystem repositorySystem;
+    private final DependencyGraphBuilder graphBuilder;
 
-    private EnforcerRuleHelper helper;
-
-    public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
-        this.helper = helper;
+    protected AbstractResolveDependencies(
+            MavenSession session, RepositorySystem repositorySystem, DependencyGraphBuilder graphBuilder) {
+        this.session = session;
+        this.repositorySystem = repositorySystem;
+        this.graphBuilder = graphBuilder;
+    }
 
-        // Get components
-        try {
-            repositorySystem = helper.getComponent(RepositorySystem.class);
-            graphBuilder = helper.getComponent(DependencyGraphBuilder.class);
-        } catch (ComponentLookupException e) {
-            throw new EnforcerRuleException("Unable to lookup DependencyTreeBuilder: ", e);
-        }
-
-        // Resolve expressions
-        try {
-            session = (MavenSession) helper.evaluate("${session}");
-        } catch (ExpressionEvaluationException e) {
-            throw new EnforcerRuleException("Unable to lookup an expression " + e.getLocalizedMessage(), e);
-        }
+    @Override
+    public void execute() throws EnforcerRuleException {
 
         ProjectBuildingRequest buildingRequest = new DefaultProjectBuildingRequest(session.getProjectBuildingRequest());
         buildingRequest.setProject(session.getCurrentProject());
@@ -124,31 +110,6 @@ private void resolveArtifact(Artifact artifact) throws ArtifactResolutionExcepti
         artifact.setResolved(true);
     }
 
-    protected Log getLog() {
-        return helper.getLog();
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public boolean isCacheable() {
-        return false;
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public boolean isResultValid(EnforcerRule enforcerRule) {
-        return false;
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public String getCacheId() {
-        return "Does not matter as not cacheable";
-    }
-
     /**
      * Convert a wildcard into a regex.
      *

diff --git a/...ins/enforcer/BanCircularDependencies.java → ...dependencies/BanCircularDependencies.java b/...ins/enforcer/BanCircularDependencies.java → ...dependencies/BanCircularDependencies.java
@@ -1,4 +1,4 @@
-package org.apache.maven.plugins.enforcer;
+package org.codehaus.mojo.extraenforcer.dependencies;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
@@ -19,82 +19,76 @@
  * under the License.
  */
 
+import javax.inject.Inject;
+import javax.inject.Named;
+
 import java.util.HashSet;
 import java.util.Set;
 
 import org.apache.maven.artifact.Artifact;
-import org.apache.maven.enforcer.rule.api.EnforcerRule;
+import org.apache.maven.enforcer.rule.api.AbstractEnforcerRule;
+import org.apache.maven.enforcer.rule.api.EnforcerRuleError;
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
-import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
 import org.apache.maven.execution.MavenSession;
-import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.project.DefaultProjectBuildingRequest;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.project.ProjectBuildingRequest;
 import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
 import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException;
 import org.apache.maven.shared.dependency.graph.DependencyNode;
-import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
-import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
 
 /**
  * Bans circular dependencies on the classpath.
  *
  * @since 1.0-alpha-4
  */
-public class BanCircularDependencies extends AbstractMojoHausEnforcerRule {
+@Named("banCircularDependencies")
+public class BanCircularDependencies extends AbstractEnforcerRule {
 
-    private transient DependencyGraphBuilder graphBuilder;
+    private final DependencyGraphBuilder graphBuilder;
+    private final MavenProject project;
+    private final MavenSession session;
 
     private String message;
 
+    @Inject
+    public BanCircularDependencies(DependencyGraphBuilder graphBuilder, MavenProject project, MavenSession session) {
+        this.graphBuilder = graphBuilder;
+        this.project = project;
+        this.session = session;
+    }
+
     /**
      * {@inheritDoc}
      */
-    public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
-        Log log = helper.getLog();
-
-        try {
-            graphBuilder = helper.getComponent(DependencyGraphBuilder.class);
-        } catch (ComponentLookupException e) {
-            throw new EnforcerRuleException("Unable to lookup DependencyGraphBuilder: ", e);
-        }
-
-        try {
-            MavenProject project = (MavenProject) helper.evaluate("${project}");
-            MavenSession session = (MavenSession) helper.evaluate("${session}");
-
-            ProjectBuildingRequest buildingRequest =
-                    new DefaultProjectBuildingRequest(session.getProjectBuildingRequest());
-            buildingRequest.setProject(project);
-
-            Set<Artifact> artifacts = getDependenciesToCheck(buildingRequest);
-            if (artifacts != null) {
-                for (Artifact artifact : artifacts) {
-                    log.debug("groupId: " + artifact.getGroupId() + project.getGroupId());
-                    if (artifact.getGroupId().equals(project.getGroupId())) {
-                        log.debug("artifactId: " + artifact.getArtifactId() + " " + project.getArtifactId());
-                        if (artifact.getArtifactId().equals(project.getArtifactId())) {
-                            throw new EnforcerRuleException(getErrorMessage() + "\n  " + artifact.getGroupId() + ":"
-                                    + artifact.getArtifactId() + "\n ");
-                        }
+    public void execute() throws EnforcerRuleException {
+
+        ProjectBuildingRequest buildingRequest = new DefaultProjectBuildingRequest(session.getProjectBuildingRequest());
+        buildingRequest.setProject(project);
+
+        Set<Artifact> artifacts = getDependenciesToCheck(buildingRequest);
+        if (artifacts != null) {
+            for (Artifact artifact : artifacts) {
+                getLog().debug("groupId: " + artifact.getGroupId() + project.getGroupId());
+                if (artifact.getGroupId().equals(project.getGroupId())) {
+                    getLog().debug("artifactId: " + artifact.getArtifactId() + " " + project.getArtifactId());
+                    if (artifact.getArtifactId().equals(project.getArtifactId())) {
+                        throw new EnforcerRuleException(getErrorMessage() + "\n  " + artifact.getGroupId() + ":"
+                                + artifact.getArtifactId() + "\n ");
                     }
                 }
             }
-        } catch (ExpressionEvaluationException e) {
-            log.error("Error checking for circular dependencies", e);
-            e.printStackTrace();
         }
     }
 
-    protected Set<Artifact> getDependenciesToCheck(ProjectBuildingRequest buildingRequest) {
+    protected Set<Artifact> getDependenciesToCheck(ProjectBuildingRequest buildingRequest) throws EnforcerRuleError {
         Set<Artifact> dependencies;
         try {
             DependencyNode node = graphBuilder.buildDependencyGraph(buildingRequest, null);
             dependencies = getAllDescendants(node);
         } catch (DependencyGraphBuilderException e) {
             // otherwise we need to change the signature of this protected method
-            throw new RuntimeException(e);
+            throw new EnforcerRuleError(e);
         }
         return dependencies;
     }
@@ -121,25 +115,4 @@ private String getErrorMessage() {
         }
         return message;
     }
-
-    /**
-     * {@inheritDoc}
-     */
-    public boolean isCacheable() {
-        return false;
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public boolean isResultValid(EnforcerRule enforcerRule) {
-        return false;
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public String getCacheId() {
-        return "Does not matter as not cacheable";
-    }
 }