[MARTIFACT-80] check ignore on .pom and main artifact

Author: hboutemy

src/it/buildinfo-multi/ignore-all/pom.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements. See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership. The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License. You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied. See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+<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>
+
+  <parent>
+    <groupId>org.apache.maven.plugins.it</groupId>
+    <artifactId>multi</artifactId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>ignore-all</artifactId>
+  <name>multi-module ignore all</name>
+</project>

src/it/buildinfo-multi/ignore-jar/pom.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements. See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership. The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License. You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied. See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+<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>
+
+  <parent>
+    <groupId>org.apache.maven.plugins.it</groupId>
+    <artifactId>multi</artifactId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>ignore-jar</artifactId>
+  <name>multi-module ignore jar (main artifact)</name>
+</project>

src/it/buildinfo-multi/ignore-pom/pom.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements. See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership. The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License. You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied. See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+<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>
+
+  <parent>
+    <groupId>org.apache.maven.plugins.it</groupId>
+    <artifactId>multi</artifactId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>ignore-pom</artifactId>
+  <name>multi-module ignore pom</name>
+</project>

src/it/buildinfo-multi/pom.xml

@@ -40,6 +40,9 @@
   <modules>
     <module>modB</module>
     <module>modA</module>
+    <module>ignore-all</module>
+    <module>ignore-pom</module>
+    <module>ignore-jar</module>
   </modules>
 
   <distributionManagement>
@@ -80,6 +83,9 @@
             <configuration>
               <ignore>
                 <ignore>*/*.spdx.json</ignore>
+                <ignore>*/ignore-all-*</ignore>
+                <ignore>*/ignore-pom-*.pom</ignore>
+                <ignore>*/ignore-jar-*.jar</ignore>
               </ignore>
             </configuration>
           </execution>

src/it/buildinfo-multi/verify.groovy

@@ -24,37 +24,64 @@ assert buildinfoFile.isFile()
 
 File modA = new File( basedir, "modA/target/multi-modA-1.0-SNAPSHOT.buildinfo")
 assert !modA.isFile()
-
 File modB = new File( basedir, "modB/target/multi-modB-1.0-SNAPSHOT.buildinfo")
-assert modB.isFile()
+assert !modB.isFile()
+File ignoreAll = new File( basedir, "ignore-all/target/ignore-all-1.0-SNAPSHOT.buildinfo")
+assert !ignoreAll.isFile()
+File ignorePom = new File( basedir, "ignore-pom/target/ignore-pom-1.0-SNAPSHOT.buildinfo")
+assert !ignorePom.isFile()
+
+File ignoreJar = new File( basedir, "ignore-jar/target/ignore-jar-1.0-SNAPSHOT.buildinfo")
+assert ignoreJar.isFile()
 
 // check that copy content in root is the same
-assert buildinfoFile.text.equals( modB.text )
+assert buildinfoFile.text.equals( ignoreJar.text )
 
 // check generated aggregate buildinfo content
-String buildinfo = modB.text
+String buildinfo = ignoreJar.text
 assert buildinfo.contains( "group-id=org.apache.maven.plugins.it" )
 assert buildinfo.contains( "artifact-id=multi" )
 assert buildinfo.contains( "version=1.0-SNAPSHOT" )
+
 assert buildinfo.contains( "outputs.1.coordinates=org.apache.maven.plugins.it:multi-modA" )
 assert buildinfo.contains( "outputs.1.0.filename=multi-modA-1.0-SNAPSHOT.pom" )
 assert buildinfo.contains( "outputs.1.1.filename=multi-modA-1.0-SNAPSHOT.jar" )
 assert !buildinfo.contains( "outputs.1.2.filename=" )
 assert buildinfo.contains( "# ignored multi-modA-1.0-SNAPSHOT.spdx.json" )
+
 assert buildinfo.contains( "outputs.2.coordinates=org.apache.maven.plugins.it:multi-modB" )
 assert buildinfo.contains( "outputs.2.0.filename=multi-modB-1.0-SNAPSHOT.pom" )
 assert buildinfo.contains( "outputs.2.1.filename=multi-modB-1.0-SNAPSHOT.jar" )
 assert !buildinfo.contains( "outputs.2.2.filename=" )
 assert buildinfo.contains( "# ignored multi-modB-1.0-SNAPSHOT.spdx.json" )
+
+assert buildinfo.contains( "outputs.3.coordinates=org.apache.maven.plugins.it:ignore-all" )
+assert buildinfo.contains( "# ignored ignore-all-1.0-SNAPSHOT.pom" )
+assert buildinfo.contains( "# ignored ignore-all-1.0-SNAPSHOT.jar" )
+assert !buildinfo.contains( "outputs.3.0.filename=" )
+assert buildinfo.contains( "# ignored ignore-pom-1.0-SNAPSHOT.spdx.json" )
+
+assert buildinfo.contains( "outputs.4.coordinates=org.apache.maven.plugins.it:ignore-pom" )
+assert buildinfo.contains( "# ignored ignore-pom-1.0-SNAPSHOT.pom" )
+assert buildinfo.contains( "outputs.4.0.filename=ignore-pom-1.0-SNAPSHOT.jar" )
+assert !buildinfo.contains( "outputs.4.1.filename=" )
+assert buildinfo.contains( "# ignored ignore-pom-1.0-SNAPSHOT.spdx.json" )
+
+assert buildinfo.contains( "outputs.5.coordinates=org.apache.maven.plugins.it:ignore-jar" )
+assert buildinfo.contains( "outputs.5.0.filename=ignore-jar-1.0-SNAPSHOT.pom" )
+assert buildinfo.contains( "# ignored ignore-jar-1.0-SNAPSHOT.jar" )
+assert !buildinfo.contains( "outputs.5.1.filename=" )
+assert buildinfo.contains( "# ignored ignore-jar-1.0-SNAPSHOT.spdx.json" )
+
 assert !buildinfo.contains( ".buildinfo" )
-assert buildinfo.contains( "mvn.aggregate.artifact-id=multi-modB" )
+assert buildinfo.contains( "mvn.aggregate.artifact-id=ignore-jar" )
 
 // check existence of buildinfo in local repository
-File localModB = new File( basedir, "../../local-repo/org/apache/maven/plugins/it/multi-modB/1.0-SNAPSHOT/multi-modB-1.0-SNAPSHOT.buildinfo")
-assert localModB.isFile()
+File localIgnoreJar = new File( basedir, "../../local-repo/org/apache/maven/plugins/it/ignore-jar/1.0-SNAPSHOT/ignore-jar-1.0-SNAPSHOT.buildinfo")
+assert localIgnoreJar.isFile()
 
 // check existence of buildinfo in remote repository
-File remoteDir = new File( basedir, "modB/target/remote-repo/org/apache/maven/plugins/it/multi-modB/1.0-SNAPSHOT" )
+File remoteDir = new File( basedir, "ignore-jar/target/remote-repo/org/apache/maven/plugins/it/ignore-jar/1.0-SNAPSHOT" )
 assert remoteDir.isDirectory()
 for ( File f : remoteDir.listFiles() )
 {

src/main/java/org/apache/maven/plugins/artifact/buildinfo/AbstractBuildinfoMojo.java

@@ -74,19 +74,22 @@ public abstract class AbstractBuildinfoMojo extends AbstractMojo {
 
     /**
      * Artifacts to ignore, specified as a glob matching against <code>${groupId}/${filename}</code>, for example
-     * <code>*</>/*.xml</code>.
+     * <code>*</>/*.xml</code>. If all artifacts from a module are to be ignored, prefer {@code skipModules}.
      */
     @Parameter(property = "buildinfo.ignore", defaultValue = "")
     private List<String> ignore;
 
     /**
-     * Detect projects/modules with install or deploy skipped: avoid taking fingerprints.
+     * Auto-detect projects/modules with install or deploy skipped: avoid taking fingerprints.
+     * If auto-detection gives unexpected results, prefer handwritten {@code skipModules}.
      */
     @Parameter(property = "buildinfo.detect.skip", defaultValue = "true")
     private boolean detectSkip;
 
     /**
-     * Avoid taking fingerprints for modules specified as glob matching against <code>${groupId}/${artifactId}</code>.
+     * Avoid taking fingerprints for full modules, specified as glob matching against
+     * <code>${groupId}/${artifactId}</code>.
+     * For ignoring only a few files instead of full modules, see {@code ignore}.
      * @since 3.5.0
      */
     @Parameter(property = "buildinfo.skipModules")

src/main/java/org/apache/maven/plugins/artifact/buildinfo/BuildInfoWriter.java

@@ -185,32 +185,45 @@ void printArtifacts(MavenProject project) throws MojoExecutionException {
         }
 
         artifacts.put(pomArtifact, prefix + n);
-        printFile(
-                prefix + n++,
-                pomArtifact.getGroupId(),
-                pomArtifact.getFile(),
-                project.getArtifactId() + '-' + project.getVersion() + ".pom");
+        if (isIgnore(pomArtifact)) {
+            p.println("# ignored " + getArtifactFilename(pomArtifact));
+        } else {
+            printFile(
+                    prefix + n++,
+                    pomArtifact.getGroupId(),
+                    pomArtifact.getFile(),
+                    project.getArtifactId() + '-' + project.getVersion() + ".pom");
+        }
 
         if (consumerPom != null) {
             // build pom
             Artifact buildPomArtifact = new DefaultArtifact(
                     project.getGroupId(), project.getArtifactId(), "build", "pom", project.getVersion());
             buildPomArtifact = buildPomArtifact.setFile(project.getFile());
 
-            artifacts.put(buildPomArtifact, prefix + n);
-            printFile(
-                    prefix + n++,
-                    buildPomArtifact.getGroupId(),
-                    buildPomArtifact.getFile(),
-                    project.getArtifactId() + '-' + project.getVersion() + "-build.pom");
+            if (isIgnore(buildPomArtifact)) {
+                p.println("# ignored " + getArtifactFilename(buildPomArtifact));
+            } else {
+                artifacts.put(buildPomArtifact, prefix + n);
+                printFile(
+                        prefix + n++,
+                        buildPomArtifact.getGroupId(),
+                        buildPomArtifact.getFile(),
+                        project.getArtifactId() + '-' + project.getVersion() + "-build.pom");
+            }
         }
 
         if (project.getArtifact() == null) {
             return;
         }
 
         if (project.getArtifact().getFile() != null) {
-            printArtifact(prefix, n++, RepositoryUtils.toArtifact(project.getArtifact()));
+            Artifact main = RepositoryUtils.toArtifact(project.getArtifact());
+            if (isIgnore(main)) {
+                p.println("# ignored " + getArtifactFilename(main));
+            } else {
+                printArtifact(prefix, n++, RepositoryUtils.toArtifact(project.getArtifact()));
+            }
         }
 
         for (Artifact attached : RepositoryUtils.toArtifacts(project.getAttachedArtifacts())) {