Maven4 "legacy" mode and more (#2380)

Simple ability to make Maven 4 "work like Maven 3" would. Changes: * Resolver session (scope manager, transitive dep mgr) - DONE * model validation (in "Maven3" mode model 4.1.0 should be rejected) - DONE * scope validation (obey what scopeMgr holds) - DONE * inline POM transformation in Maven3 mode (instead of consumer POM transformation) - DONE * added IT that confirms: maven4 in maven3 mode does not need flatten plugin Issues: https://issues.apache.org/jira/browse/MNG-8742 https://issues.apache.org/jira/browse/MNG-8743 https://issues.apache.org/jira/browse/MNG-8744

Author: cstamas

api/maven-api-core/src/main/java/org/apache/maven/api/Constants.java

@@ -462,6 +462,15 @@ public final class Constants {
  @Config(type = "java.lang.Boolean", defaultValue = "true")
  public static final String MAVEN_CONSUMER_POM = "maven.consumer.pom";
 
+ /**
+ * User property for controlling "maven personality". If activated Maven will behave
+ * as previous major version, Maven 3.
+ *
+ * @since 4.0.0
+ */
+ @Config(type = "java.lang.Boolean", defaultValue = "false")
+ public static final String MAVEN_MAVEN3_PERSONALITY = "maven.maven3Personality";
+
  /**
  * User property for disabling version resolver cache.
  *

api/maven-api-core/src/main/java/org/apache/maven/api/feature/Features.java

@@ -35,17 +35,17 @@ public final class Features {
  private Features() {}
 
  /**
- * Check if the consumer POM feature is active.
+ * Check if the personality is "maven3".
  */
- public static boolean consumerPom(@Nullable Properties userProperties) {
- return doGet(userProperties, Constants.MAVEN_CONSUMER_POM, true);
+ public static boolean mavenMaven3Personality(@Nullable Map<String, ?> userProperties) {
+ return doGet(userProperties, Constants.MAVEN_MAVEN3_PERSONALITY, false);
  }
 
  /**
  * Check if the consumer POM feature is active.
  */
- public static boolean consumerPom(@Nullable Map<String, String> userProperties, boolean def) {
- return doGet(userProperties, Constants.MAVEN_CONSUMER_POM, def);
+ public static boolean consumerPom(@Nullable Map<String, ?> userProperties) {
+ return doGet(userProperties, Constants.MAVEN_CONSUMER_POM, !mavenMaven3Personality(userProperties));
  }
 
  private static boolean doGet(Properties userProperties, String key, boolean def) {

api/maven-api-core/src/main/java/org/apache/maven/api/services/ModelBuilder.java

@@ -29,7 +29,7 @@ public interface ModelBuilder extends Service {
 
  String MODEL_VERSION_4_1_0 = "4.1.0";
 
- List<String> VALID_MODEL_VERSIONS = List.of(MODEL_VERSION_4_0_0, MODEL_VERSION_4_1_0);
+ List<String> KNOWN_MODEL_VERSIONS = List.of(MODEL_VERSION_4_0_0, MODEL_VERSION_4_1_0);
 
  ModelBuilderSession newSession();
 

compat/maven-compat/src/test/java/org/apache/maven/project/AbstractMavenProjectTestCase.java

@@ -34,6 +34,7 @@
 import org.apache.maven.execution.DefaultMavenExecutionResult;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.impl.InternalSession;
+import org.apache.maven.impl.resolver.scopes.Maven4ScopeManagerConfiguration;
 import org.apache.maven.internal.impl.DefaultLookup;
 import org.apache.maven.internal.impl.DefaultSession;
 import org.apache.maven.internal.impl.InternalMavenSession;
@@ -45,6 +46,7 @@
 import org.codehaus.plexus.PlexusContainer;
 import org.codehaus.plexus.testing.PlexusTest;
 import org.eclipse.aether.DefaultRepositorySystemSession;
+import org.eclipse.aether.internal.impl.scope.ScopeManagerImpl;
 import org.junit.jupiter.api.BeforeEach;
 
 import static org.junit.jupiter.api.Assertions.fail;
@@ -158,6 +160,7 @@ protected MavenProject getProject(File pom) throws Exception {
  protected void initRepoSession(ProjectBuildingRequest request) throws Exception {
  File localRepo = new File(request.getLocalRepository().getBasedir());
  DefaultRepositorySystemSession session = MavenRepositorySystemUtils.newSession();
+ session.setScopeManager(new ScopeManagerImpl(Maven4ScopeManagerConfiguration.INSTANCE));
  session.setLocalRepositoryManager(new LegacyLocalRepositoryManager(localRepo));
  request.setRepositorySession(session);
 

impl/maven-core/src/main/java/org/apache/maven/internal/aether/DefaultRepositorySystemSessionFactory.java

@@ -34,6 +34,7 @@
 import org.apache.maven.api.di.Inject;
 import org.apache.maven.api.di.Named;
 import org.apache.maven.api.di.Singleton;
+import org.apache.maven.api.feature.Features;
 import org.apache.maven.api.services.TypeRegistry;
 import org.apache.maven.api.xml.XmlNode;
 import org.apache.maven.eventspy.internal.EventSpyDispatcher;
@@ -155,14 +156,15 @@ public RepositorySystemSession newRepositorySession(MavenExecutionRequest reques
  public SessionBuilder newRepositorySessionBuilder(MavenExecutionRequest request) {
  requireNonNull(request, "request");
 
- MavenSessionBuilderSupplier supplier = new MavenSessionBuilderSupplier(repoSystem);
+ // this map is read ONLY to get config from (profiles + env + system + user)
+ Map<String, String> mergedProps = createMergedProperties(request);
+
+ boolean mavenMaven3Personality = Features.mavenMaven3Personality(mergedProps);
+ MavenSessionBuilderSupplier supplier = new MavenSessionBuilderSupplier(repoSystem, mavenMaven3Personality);
  SessionBuilder sessionBuilder = supplier.get();
  sessionBuilder.setArtifactTypeRegistry(new TypeRegistryAdapter(typeRegistry)); // dynamic
  sessionBuilder.setCache(request.getRepositoryCache());
 
- // this map is read ONLY to get config from (profiles + env + system + user)
- Map<String, String> mergedProps = createMergedProperties(request);
-
  // configProps map is kept "pristine", is written ONLY, the mandatory resolver config
  Map<String, Object> configProps = new LinkedHashMap<>();
  configProps.put(ConfigurationProperties.USER_AGENT, getUserAgent());
@@ -356,7 +358,7 @@ public SessionBuilder newRepositorySessionBuilder(MavenExecutionRequest request)
 
  // may be overridden
  String resolverDependencyManagerTransitivity = mergedProps.getOrDefault(
- Constants.MAVEN_RESOLVER_DEPENDENCY_MANAGER_TRANSITIVITY, Boolean.TRUE.toString());
+ Constants.MAVEN_RESOLVER_DEPENDENCY_MANAGER_TRANSITIVITY, Boolean.toString(!mavenMaven3Personality));
  sessionBuilder.setDependencyManager(
  supplier.getDependencyManager(Boolean.parseBoolean(resolverDependencyManagerTransitivity)));
 

impl/maven-core/src/main/java/org/apache/maven/internal/aether/MavenTransformer.java

@@ -22,7 +22,7 @@
 import javax.inject.Named;
 import javax.inject.Singleton;
 
-import org.apache.maven.internal.transformation.ConsumerPomArtifactTransformer;
+import org.apache.maven.internal.transformation.TransformerManager;
 import org.eclipse.aether.RepositorySystemSession;
 import org.eclipse.aether.deployment.DeployRequest;
 import org.eclipse.aether.installation.InstallRequest;
@@ -36,20 +36,20 @@
 @Singleton
 @Named
 final class MavenTransformer implements ArtifactTransformer {
- private final ConsumerPomArtifactTransformer consumerPomArtifactTransformer;
+ private final TransformerManager transformerManager;
 
  @Inject
- MavenTransformer(ConsumerPomArtifactTransformer consumerPomArtifactTransformer) {
- this.consumerPomArtifactTransformer = requireNonNull(consumerPomArtifactTransformer);
+ MavenTransformer(TransformerManager transformerManager) {
+ this.transformerManager = requireNonNull(transformerManager);
  }
 
  @Override
  public InstallRequest transformInstallArtifacts(RepositorySystemSession session, InstallRequest request) {
- return consumerPomArtifactTransformer.remapInstallArtifacts(session, request);
+ return transformerManager.remapInstallArtifacts(session, request);
  }
 
  @Override
  public DeployRequest transformDeployArtifacts(RepositorySystemSession session, DeployRequest request) {
- return consumerPomArtifactTransformer.remapDeployArtifacts(session, request);
+ return transformerManager.remapDeployArtifacts(session, request);
  }
 }

impl/maven-core/src/main/java/org/apache/maven/internal/transformation/PomArtifactTransformer.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.internal.transformation;
+
+import javax.xml.stream.XMLStreamException;
+
+import java.io.IOException;
+import java.nio.file.Path;
+
+import org.apache.maven.api.services.ModelBuilderException;
+import org.apache.maven.project.MavenProject;
+import org.eclipse.aether.RepositorySystemSession;
+import org.eclipse.aether.deployment.DeployRequest;
+import org.eclipse.aether.installation.InstallRequest;
+
+/**
+ * Maven POM transformer.
+ * TODO: rename this interface to "Transformer" as it can do much more than just transform POM.
+ * @since TBD
+ */
+public interface PomArtifactTransformer {
+ InstallRequest remapInstallArtifacts(RepositorySystemSession session, InstallRequest request);
+
+ DeployRequest remapDeployArtifacts(RepositorySystemSession session, DeployRequest request);
+
+ void injectTransformedArtifacts(RepositorySystemSession session, MavenProject currentProject) throws IOException;
+
+ void transform(MavenProject project, RepositorySystemSession session, Path src, Path tgt)
+ throws ModelBuilderException, XMLStreamException, IOException;
+}

impl/maven-core/src/main/java/org/apache/maven/internal/transformation/ConsumerPomArtifactTransformer.java renamed to impl/maven-core/src/main/java/org/apache/maven/internal/transformation/TransformerManager.java

@@ -26,16 +26,11 @@
 import org.eclipse.aether.installation.InstallRequest;
 
 /**
- * Consumer POM transformer.
+ * Maven transformer manager.
  *
- * @since TBD
+ * @since 4.0.0
  */
-public interface ConsumerPomArtifactTransformer {
-
- String CONSUMER_POM_CLASSIFIER = "consumer";
-
- String BUILD_POM_CLASSIFIER = "build";
-
+public interface TransformerManager {
  InstallRequest remapInstallArtifacts(RepositorySystemSession session, InstallRequest request);
 
  DeployRequest remapDeployArtifacts(RepositorySystemSession session, DeployRequest request);

impl/maven-core/src/main/java/org/apache/maven/internal/transformation/impl/DefaultConsumerPomArtifactTransformer.java renamed to impl/maven-core/src/main/java/org/apache/maven/internal/transformation/impl/ConsumerPomArtifactTransformer.java

@@ -24,7 +24,6 @@
 import javax.xml.stream.XMLStreamException;
 
 import java.io.IOException;
-import java.io.Writer;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -37,8 +36,6 @@
 import org.apache.maven.api.feature.Features;
 import org.apache.maven.api.model.Model;
 import org.apache.maven.api.services.ModelBuilderException;
-import org.apache.maven.internal.transformation.ConsumerPomArtifactTransformer;
-import org.apache.maven.model.v4.MavenStaxWriter;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.project.artifact.ProjectArtifact;
 import org.eclipse.aether.RepositorySystemSession;
@@ -54,30 +51,29 @@
  * @since TBD
  */
 @Singleton
-@Named("consumer-pom")
-class DefaultConsumerPomArtifactTransformer implements ConsumerPomArtifactTransformer {
+@Named
+class ConsumerPomArtifactTransformer extends TransformerSupport {
+ private static final String CONSUMER_POM_CLASSIFIER = "consumer";
 
- private static final String NAMESPACE_FORMAT = "http://maven.apache.org/POM/%s";
-
- private static final String SCHEMA_LOCATION_FORMAT = "https://maven.apache.org/xsd/maven-%s.xsd";
+ private static final String BUILD_POM_CLASSIFIER = "build";
 
  private final Set<Path> toDelete = new CopyOnWriteArraySet<>();
 
- private final ConsumerPomBuilder builder;
+ private final PomBuilder builder;
 
  @Inject
- DefaultConsumerPomArtifactTransformer(ConsumerPomBuilder builder) {
+ ConsumerPomArtifactTransformer(PomBuilder builder) {
  this.builder = builder;
  }
 
- @Override
  @SuppressWarnings("deprecation")
+ @Override
  public void injectTransformedArtifacts(RepositorySystemSession session, MavenProject project) throws IOException {
  if (project.getFile() == null) {
  // If there is no build POM there is no reason to inject artifacts for the consumer POM.
  return;
  }
- if (Features.consumerPom(session.getUserProperties(), true)) {
+ if (Features.consumerPom(session.getConfigProperties())) {
  Path buildDir =
  project.getBuild() != null ? Paths.get(project.getBuild().getDirectory()) : null;
  if (buildDir != null) {
@@ -108,7 +104,8 @@ TransformedArtifact createConsumerPomArtifact(
  "pom");
  }
 
- void transform(MavenProject project, RepositorySystemSession session, Path src, Path tgt)
+ @Override
+ public void transform(MavenProject project, RepositorySystemSession session, Path src, Path tgt)
  throws ModelBuilderException, XMLStreamException, IOException {
  Model model = builder.build(session, project, src);
  write(model, tgt);
@@ -173,7 +170,7 @@ private Collection<Artifact> replacePom(Collection<Artifact> artifacts) {
  main.getExtension(),
  main.getVersion(),
  main.getProperties(),
- main.getFile()));
+ main.getPath()));
  }
  for (Artifact consumer : consumers) {
  result.remove(consumer);
@@ -184,22 +181,10 @@ private Collection<Artifact> replacePom(Collection<Artifact> artifacts) {
  consumer.getExtension(),
  consumer.getVersion(),
  consumer.getProperties(),
- consumer.getFile()));
+ consumer.getPath()));
  }
  artifacts = result;
  }
  return artifacts;
  }
-
- void write(Model model, Path dest) throws IOException, XMLStreamException {
- String version = model.getModelVersion();
- Files.createDirectories(dest.getParent());
- try (Writer w = Files.newBufferedWriter(dest)) {
- MavenStaxWriter writer = new MavenStaxWriter();
- writer.setNamespace(String.format(NAMESPACE_FORMAT, version));
- writer.setSchemaLocation(String.format(SCHEMA_LOCATION_FORMAT, version));
- writer.setAddLocationInformation(false);
- writer.write(w, model);
- }
- }
 }

impl/maven-core/src/main/java/org/apache/maven/internal/transformation/impl/DefaultConsumerPomBuilder.java

@@ -53,7 +53,7 @@
 import org.slf4j.LoggerFactory;
 
 @Named
-class DefaultConsumerPomBuilder implements ConsumerPomBuilder {
+class DefaultConsumerPomBuilder implements PomBuilder {
  private static final String BOM_PACKAGING = "bom";
 
  public static final String POM_PACKAGING = "pom";
@@ -198,8 +198,7 @@ private ModelBuilderResult buildModel(RepositorySystemSession session, Path src)
  request.lifecycleBindingsInjector(lifecycleBindingsInjector::injectLifecycleBindings);
  ModelBuilder.ModelBuilderSession mbSession =
  iSession.getData().get(SessionData.key(ModelBuilder.ModelBuilderSession.class));
- ModelBuilderResult result = mbSession.build(request.build());
- return result;
+ return mbSession.build(request.build());
  }
 
  static Model transformNonPom(Model model, MavenProject project) {