Never treat attached artifacts as content packages which don't have extension "zip" (#343)

This closes #342

Author: kwin

aemanalyser-maven-plugin/src/main/java/com/adobe/aem/analyser/mojos/AemAnalyseMojo.java

@@ -89,7 +89,7 @@ public class AemAnalyseMojo extends AbstractAnalyseMojo {
      * Only analyze the package attached to the project with the given classifier.
      */
     @Parameter(property = "aem.analyser.classifier")
-    private String classifier;
+    String classifier;
 
     /**
      * Analyzes the given list of content package files.
@@ -98,7 +98,7 @@ public class AemAnalyseMojo extends AbstractAnalyseMojo {
      * The files must be located inside the Maven project directory (e.g. src or target folder). 
      */
     @Parameter
-    private List<File> contentPackageFiles;
+    List<File> contentPackageFiles;
 
     /**
      * Additional content package artifacts to be considered in the analysis given as list of Maven coordinates/ids in format
@@ -185,7 +185,7 @@ void convertContentPackages(final List<String> additionalWarnings, final List<St
      * @return The list of artifacts (non empty)
      * @throws MojoExecutionException If anything goes wrong, for example no content packages are found
      */
-    private List<Artifact> getContentPackages() throws MojoExecutionException {
+    List<Artifact> getContentPackages() throws MojoExecutionException {
         final List<Artifact> result = new ArrayList<>();
         if (!Constants.PACKAGING_AEM_ANALYSE.equals(project.getPackaging())) {
             if (contentPackageFiles != null && !contentPackageFiles.isEmpty()) {
@@ -197,20 +197,21 @@ private List<Artifact> getContentPackages() throws MojoExecutionException {
             } else if (classifier != null) {
                 // look for attached artifact with given classifier
                 for (Artifact artifact : project.getAttachedArtifacts()) {
-                    if (classifier.equals(artifact.getClassifier())) {
+                    if (classifier.equals(artifact.getClassifier()) && Constants.EXTENSION_CONTENT_PACKAGE.equalsIgnoreCase(artifact.getArtifactHandler().getExtension())) {
                         getLog().info("Using attached artifact with classifier '" + classifier + "' as content package: " + project.getArtifact());
                         result.add(artifact);
+                        break; // only one attached artifact with matching classifier and extension is expected
                     }
                 }
                 if (result.isEmpty()) {
-                    throw new MojoExecutionException("No attached artifact with classifier " + classifier + " found for project.");
+                    throw new MojoExecutionException("No attached artifact with classifier \"" + classifier + "\" and extension \"" + Constants.EXTENSION_CONTENT_PACKAGE + "\" found for project.");
                 }
             } else {
                 // Use the current project artifact as the content package
                 getLog().info("Using current project as content package: " + project.getArtifact());
                 if (project.getArtifact().getFile() == null) {
                     // in case of a standalone usage of the plugin, the project artifact file might not be set
-                    final File target = new File(project.getBuild().getDirectory(), project.getBuild().getFinalName() + "." + project.getArtifact().getArtifactHandler().getExtension());
+                    final File target = new File(project.getBuild().getDirectory(), project.getBuild().getFinalName() + "." + Constants.EXTENSION_CONTENT_PACKAGE);
                     if ( !target.exists() ) {
                         throw new MojoExecutionException("Project artifact file not found. Build the project first. Looking for: " + target.getName());
                     }

aemanalyser-maven-plugin/src/main/java/com/adobe/aem/analyser/mojos/Constants.java

@@ -25,6 +25,9 @@ public abstract class Constants extends com.adobe.aem.analyser.Constants {
     /** Packaging for content packages */
     public static final String PACKAGING_CONTENT_PACKAGE = "content-package";
 
+    /** The extension for the content packages without the leading dot */
+    public static final String EXTENSION_CONTENT_PACKAGE = "zip";
+
     /** The directory for the content package converter */
     public static final String CONVERTER_DIRECTORY = "cp-conversion";
 

aemanalyser-maven-plugin/src/test/java/com/adobe/aem/analyser/mojos/AemAnalyseMojoTest.java

@@ -24,7 +24,11 @@
 import java.util.List;
 
 import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.DefaultArtifact;
+import org.apache.maven.artifact.handler.ArtifactHandler;
+import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 import org.apache.maven.model.Build;
+import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.project.MavenProject;
 import org.apache.sling.feature.ArtifactId;
 import org.apache.sling.feature.builder.ArtifactProvider;
@@ -131,6 +135,34 @@ public void testGetAnalyserTasksWithSkip() {
         assertEquals(ImmutableSet.of("utask2","utask3"), mojo.getAnalyserUserTasks());
     }
 
+    @Test
+    public void testGetContentPackagesWithClassifier() throws MojoExecutionException {
+        MavenProject prj = Mockito.mock(MavenProject.class);
+        Artifact packageArtifact = new DefaultArtifact("group", "artifact", "1.0", null, Constants.PACKAGING_CONTENT_PACKAGE, "myclassifier", new ContentPackageArtifactHandler());
+        Artifact signatureForPackageArtifact = new DefaultArtifact("group", "artifact", "1.0", null, Constants.PACKAGING_ZIP, "myclassifier", new DefaultArtifactHandler("zip.asc"));
+        Mockito.when(prj.getAttachedArtifacts()).thenReturn(
+            List.of(
+                packageArtifact,
+                signatureForPackageArtifact
+            )
+        );
+        AemAnalyseMojo mojo = new TestAnalyseMojo(prj);
+        mojo.classifier = "myclassifier";
+
+        assertEquals(List.of(packageArtifact), mojo.getContentPackages());
+    }
+
+    // copied from https://github.com/apache/jackrabbit-filevault-package-maven-plugin/blob/filevault-package-maven-plugin-1.4.0/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/extensions/ContentPackageArtifactHandler.java
+    private static final class ContentPackageArtifactHandler extends DefaultArtifactHandler {
+        public ContentPackageArtifactHandler() {
+            super(Constants.PACKAGING_CONTENT_PACKAGE);
+            setIncludesDependencies(true);
+            setExtension("zip");
+            setLanguage("java");
+            setAddedToClasspath(true);
+        }
+    }
+
     private static class TestAnalyseMojo extends AemAnalyseMojo {
         private TestAnalyseMojo(final MavenProject prj) {
             this.project = prj;