Add a bom packaging, trim down consumer pom, add build pom

gnodet · gnodet · commit dba2f61a13eb · 2023-06-20T22:04:09.000+02:00
The purpose of the BOM packaging is to more cleanly identity POM that will be consumed as BOM from POM that will be used as parents.  The BOMs can be turned into a consumer POM, whereas parents can not loose any information.
The consumer pom is flattened and trimmed down much more (parent, build, modules, properties, distributionManagement, repositories, pluginRepositories, reports, reporting and dependencies (for boms) or dependencyManagement (for other artifacts)).
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/BomArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/BomArtifactHandlerProvider.java
@@ -0,0 +1,46 @@
+/*
+ * 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.
+ */
+package org.apache.maven.artifact.handler.providers;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+import javax.inject.Singleton;
+
+import org.apache.maven.artifact.handler.ArtifactHandler;
+import org.apache.maven.artifact.handler.DefaultArtifactHandler;
+
+/**
+ * {@code pom} artifact handler provider.
+ */
+@Named("bom")
+@Singleton
+public class BomArtifactHandlerProvider implements Provider<ArtifactHandler> {
+    private final ArtifactHandler artifactHandler;
+
+    @Inject
+    public BomArtifactHandlerProvider() {
+        this.artifactHandler = new DefaultArtifactHandler("pom", null, null, null, null, false, "none", false);
+    }
+
+    @Override
+    public ArtifactHandler get() {
+        return artifactHandler;
+    }
+}
diff --git a/maven-core/src/main/java/org/apache/maven/internal/transformation/ConsumerPomArtifactTransformer.java b/maven-core/src/main/java/org/apache/maven/internal/transformation/ConsumerPomArtifactTransformer.java
@@ -24,6 +24,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.Writer;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -32,13 +33,17 @@
 import java.util.Collection;
 import java.util.Set;
 import java.util.concurrent.CopyOnWriteArraySet;
-import java.util.function.BiConsumer;
+import java.util.stream.Collectors;
 
+import org.apache.maven.api.model.Model;
+import org.apache.maven.api.model.ModelBase;
+import org.apache.maven.api.model.Profile;
 import org.apache.maven.feature.Features;
 import org.apache.maven.model.building.DefaultBuildPomXMLFilterFactory;
 import org.apache.maven.model.building.TransformerContext;
 import org.apache.maven.model.transform.RawToConsumerPomXMLFilterFactory;
 import org.apache.maven.model.transform.pull.XmlUtils;
+import org.apache.maven.model.v4.MavenXpp3Writer;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.project.artifact.ProjectArtifact;
 import org.codehaus.plexus.util.ReaderFactory;
@@ -64,6 +69,8 @@ public final class ConsumerPomArtifactTransformer {
 
     private static final String CONSUMER_POM_CLASSIFIER = "consumer";
 
+    private static final String BUILD_POM_CLASSIFIER = "build";
+
     private final Set<Path> toDelete = new CopyOnWriteArraySet<>();
 
     public void injectTransformedArtifacts(MavenProject project, RepositorySystemSession session) throws IOException {
@@ -72,18 +79,23 @@ public void injectTransformedArtifacts(MavenProject project, RepositorySystemSes
             return;
         }
         if (isActive(session)) {
-            Path generatedFile;
-            String buildDirectory =
-                    project.getBuild() != null ? project.getBuild().getDirectory() : null;
-            if (buildDirectory == null) {
-                generatedFile = Files.createTempFile(CONSUMER_POM_CLASSIFIER, "pom");
-            } else {
-                Path buildDir = Paths.get(buildDirectory);
+            Path buildDir =
+                    project.getBuild() != null ? Paths.get(project.getBuild().getDirectory()) : null;
+            if (buildDir != null) {
                 Files.createDirectories(buildDir);
-                generatedFile = Files.createTempFile(buildDir, CONSUMER_POM_CLASSIFIER, "pom");
             }
-            deferDeleteFile(generatedFile);
-            project.addAttachedArtifact(new ConsumerPomArtifact(project, generatedFile, session));
+            Path build = buildDir != null
+                    ? Files.createTempFile(buildDir, BUILD_POM_CLASSIFIER + "-", ".pom")
+                    : Files.createTempFile(BUILD_POM_CLASSIFIER + "-", ".pom");
+            deferDeleteFile(build);
+            project.addAttachedArtifact(new BuildPomArtifact(project, build, session));
+            if (!"pom".equals(project.getPackaging())) {
+                Path consumer = buildDir != null
+                        ? Files.createTempFile(buildDir, CONSUMER_POM_CLASSIFIER + "-", ".pom")
+                        : Files.createTempFile(CONSUMER_POM_CLASSIFIER + "-", ".pom");
+                deferDeleteFile(consumer);
+                project.addAttachedArtifact(new ConsumerPomArtifact(project, consumer));
+            }
         } else if (project.getModel().isRoot()) {
             throw new IllegalStateException(
                     "The use of the root attribute on the model requires the buildconsumer feature to be active");
@@ -124,61 +136,130 @@ private boolean isActive(RepositorySystemSession session) {
     }
 
     private boolean consumerPomPresent(Collection<Artifact> artifacts) {
-        return artifacts.stream().anyMatch(a -> CONSUMER_POM_CLASSIFIER.equals(a.getClassifier()));
+        return artifacts.stream()
+                .anyMatch(a -> "pom".equals(a.getExtension()) && BUILD_POM_CLASSIFIER.equals(a.getClassifier()));
     }
 
     private Collection<Artifact> replacePom(Collection<Artifact> artifacts) {
-        ArrayList<Artifact> result = new ArrayList<>(artifacts.size());
+        Artifact consumer = null;
+        Artifact build = null;
+        Artifact main = null;
         for (Artifact artifact : artifacts) {
-            if (CONSUMER_POM_CLASSIFIER.equals(artifact.getClassifier())) {
-                // if under CONSUMER_POM_CLASSIFIER, move it to "" classifier
-                DefaultArtifact remapped = new DefaultArtifact(
-                        artifact.getGroupId(),
-                        artifact.getArtifactId(),
+            if ("pom".equals(artifact.getExtension())) {
+                if (CONSUMER_POM_CLASSIFIER.equals(artifact.getClassifier())) {
+                    consumer = artifact;
+                } else if (BUILD_POM_CLASSIFIER.equals(artifact.getClassifier())) {
+                    build = artifact;
+                } else if ("".equals(artifact.getClassifier())) {
+                    main = artifact;
+                }
+            }
+        }
+        if (main != null) {
+            if (consumer != null) {
+                ArrayList<Artifact> result = new ArrayList<>(artifacts);
+                result.remove(main);
+                result.remove(consumer);
+                result.add(new DefaultArtifact(
+                        consumer.getGroupId(),
+                        consumer.getArtifactId(),
                         "",
-                        artifact.getExtension(),
-                        artifact.getVersion(),
-                        artifact.getProperties(),
-                        artifact.getFile());
-                result.add(remapped);
-            } else if ("".equals(artifact.getClassifier())
-                            && (artifact.getExtension().equals("pom"))
-                    || artifact.getExtension().startsWith("pom.")) {
-                // skip POM and POM subordinates
-                continue;
-            } else {
-                // everything else: add as is
-                result.add(artifact);
+                        consumer.getExtension(),
+                        consumer.getVersion(),
+                        consumer.getProperties(),
+                        consumer.getFile()));
+                artifacts = result;
+            } else if (build != null) {
+                ArrayList<Artifact> result = new ArrayList<>(artifacts);
+                result.remove(main);
+                result.remove(build);
+                result.add(new DefaultArtifact(
+                        build.getGroupId(),
+                        build.getArtifactId(),
+                        "",
+                        build.getExtension(),
+                        build.getVersion(),
+                        build.getProperties(),
+                        build.getFile()));
+                artifacts = result;
             }
         }
-        return result;
+        return artifacts;
     }
 
     /**
      * Consumer POM is transformed from original POM.
      */
     private static class ConsumerPomArtifact extends TransformedArtifact {
 
-        private ConsumerPomArtifact(MavenProject mavenProject, Path target, RepositorySystemSession session) {
+        private MavenProject project;
+
+        private ConsumerPomArtifact(MavenProject mavenProject, Path target) {
             super(
                     new ProjectArtifact(mavenProject),
                     () -> mavenProject.getFile().toPath(),
                     CONSUMER_POM_CLASSIFIER,
                     "pom",
-                    target,
-                    transformer(session));
+                    target);
+            this.project = mavenProject;
         }
 
-        private static BiConsumer<Path, Path> transformer(RepositorySystemSession session) {
+        @Override
+        public void transform(Path src, Path dest) {
+            Model model = project.getModel().getDelegate();
+            boolean isBom = "bom".equals(model.getPackaging());
+            Model.Builder builder =
+                    prune(Model.newBuilder(model, true).root(false).parent(null), isBom);
+            builder.profiles(model.getProfiles().stream()
+                    .map(p -> prune(Profile.newBuilder(p, true), isBom).build())
+                    .collect(Collectors.toList()));
+
+            Model consumer = builder.build();
+
+            try (Writer w = Files.newBufferedWriter(dest)) {
+                new MavenXpp3Writer().write(w, consumer);
+            } catch (IOException e) {
+                throw new RuntimeException(e);
+            }
+        }
+
+        private <T extends ModelBase.Builder> T prune(T builder, boolean isBom) {
+            builder.properties(null).reporting(null).pluginRepositories(null).distributionManagement(null);
+            if (isBom) {
+                builder.dependencies(null);
+            } else {
+                builder.dependencyManagement(null);
+            }
+            return builder;
+        }
+    }
+
+    /**
+     * Consumer POM is transformed from original POM.
+     */
+    private static class BuildPomArtifact extends TransformedArtifact {
+
+        private RepositorySystemSession session;
+
+        private BuildPomArtifact(MavenProject mavenProject, Path target, RepositorySystemSession session) {
+            super(
+                    new ProjectArtifact(mavenProject),
+                    () -> mavenProject.getFile().toPath(),
+                    BUILD_POM_CLASSIFIER,
+                    "pom",
+                    target);
+            this.session = session;
+        }
+
+        @Override
+        public void transform(Path src, Path dest) {
             TransformerContext context = (TransformerContext) session.getData().get(TransformerContext.KEY);
-            return (src, dest) -> {
-                try (InputStream inputStream = transform(src, context)) {
-                    Files.createDirectories(dest.getParent());
-                    Files.copy(inputStream, dest, StandardCopyOption.REPLACE_EXISTING);
-                } catch (XmlPullParserException | IOException e) {
-                    throw new RuntimeException(e);
-                }
-            };
+            try (InputStream inputStream = ConsumerPomArtifactTransformer.transform(src, context)) {
+                Files.createDirectories(dest.getParent());
+                Files.copy(inputStream, dest, StandardCopyOption.REPLACE_EXISTING);
+            } catch (XmlPullParserException | IOException e) {
+                throw new RuntimeException(e);
+            }
         }
     }
 
diff --git a/maven-core/src/main/java/org/apache/maven/internal/transformation/TransformedArtifact.java b/maven-core/src/main/java/org/apache/maven/internal/transformation/TransformedArtifact.java
@@ -23,7 +23,6 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.security.MessageDigest;
-import java.util.function.BiConsumer;
 import java.util.function.Supplier;
 
 import org.apache.maven.artifact.Artifact;
@@ -42,12 +41,7 @@ abstract class TransformedArtifact extends DefaultArtifact {
     private final OnChangeTransformer onChangeTransformer;
 
     TransformedArtifact(
-            Artifact source,
-            Supplier<Path> sourcePathProvider,
-            String classifier,
-            String extension,
-            Path targetPath,
-            BiConsumer<Path, Path> transformerConsumer) {
+            Artifact source, Supplier<Path> sourcePathProvider, String classifier, String extension, Path targetPath) {
         super(
                 source.getGroupId(),
                 source.getArtifactId(),
@@ -58,7 +52,7 @@ abstract class TransformedArtifact extends DefaultArtifact {
                 new TransformedArtifactHandler(
                         classifier, extension, source.getArtifactHandler().getPackaging()));
         this.onChangeTransformer =
-                new OnChangeTransformer(sourcePathProvider, targetPath, TransformedArtifact::sha1, transformerConsumer);
+                new OnChangeTransformer(sourcePathProvider, targetPath, TransformedArtifact::sha1, this::transform);
     }
 
     @Override
@@ -102,6 +96,8 @@ private static String sha1(Path path) {
         }
     }
 
+    protected abstract void transform(Path src, Path dst);
+
     private static class TransformedArtifactHandler implements ArtifactHandler {
         private final String classifier;
 
diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/BomLifecycleMappingProvider.java b/maven-core/src/main/java/org/apache/maven/lifecycle/providers/packaging/BomLifecycleMappingProvider.java
@@ -0,0 +1,43 @@
+/*
+ * 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.
+ */
+package org.apache.maven.lifecycle.providers.packaging;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+/**
+ * {@code bom} packaging plugins bindings provider for {@code default} lifecycle.
+ */
+@Named("bom")
+@Singleton
+public final class BomLifecycleMappingProvider extends AbstractLifecycleMappingProvider {
+    // START SNIPPET: bom
+    @SuppressWarnings("checkstyle:linelength")
+    private static final String[] BINDINGS = {
+        "install", "org.apache.maven.plugins:maven-install-plugin:" + INSTALL_PLUGIN_VERSION + ":install",
+        "deploy", "org.apache.maven.plugins:maven-deploy-plugin:" + DEPLOY_PLUGIN_VERSION + ":deploy"
+    };
+    // END SNIPPET: bom
+
+    @Inject
+    public BomLifecycleMappingProvider() {
+        super(BINDINGS);
+    }
+}
diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java
@@ -1602,7 +1602,8 @@ private void importDependencyManagement(
         for (Iterator<Dependency> it = depMgmt.getDependencies().iterator(); it.hasNext(); ) {
             Dependency dependency = it.next();
 
-            if (!"pom".equals(dependency.getType()) || !"import".equals(dependency.getScope())) {
+            if (!("pom".equals(dependency.getType()) && "import".equals(dependency.getScope()))
+                    || "bom".equals(dependency.getType())) {
                 continue;
             }
 

Original file line number	Diff line number	Diff line change
`@@ -1602,7 +1602,8 @@ private void importDependencyManagement(`
`1602`	`1602`	`for (Iterator<Dependency> it = depMgmt.getDependencies().iterator(); it.hasNext(); ) {`
`1603`	`1603`	`Dependency dependency = it.next();`
`1604`	`1604`
`1605`		`- if (!"pom".equals(dependency.getType()) \|\| !"import".equals(dependency.getScope())) {`
	`1605`	`+ if (!("pom".equals(dependency.getType()) && "import".equals(dependency.getScope()))`
	`1606`	`+ \|\| "bom".equals(dependency.getType())) {`
`1606`	`1607`	`continue;`
`1607`	`1608`	`}`
`1608`	`1609`