Compatibility Adjustments

Author: laeubi

MAVEN4_UPGRADE_NOTES.md

@@ -0,0 +1,178 @@
+# Maven 4 Upgrade Notes for m2e
+
+This document describes the changes made to upgrade m2e's embedded Maven runtime from Maven 3.9.11 to Maven 4.0.0-rc-4.
+
+## Compatibility Issues
+
+- MavenCLI --> Constants
+- LifecycleExecutionPlanCalculator -> changed signatures
+- org.apache.maven.shared.utils.StringUtils -> replace
+- ReadonlyMavenExecutionRequest implements MavenExecutionReques --> needs to be part of runtime!
+- ExtensionResolutionException --> convert to plexus one helper method in runtime
+- ProjectSorter --> catch generic exception
+
+
+
+## Changes Made
+
+### 1. Maven Runtime Bundle (org.eclipse.m2e.maven.runtime)
+
+#### Version Update
+- Updated `maven-core.version` from `3.9.11` to `4.0.0-rc-4`
+- Updated bundle version from `3.9.1100-SNAPSHOT` to `4.0.004-SNAPSHOT`
+
+#### Dependency Changes
+
+**Removed Dependencies:**
+- `org.fusesource.jansi:jansi` - Replaced with `org.jline:jansi-core` (Maven 4 uses JLine's jansi)
+- `org.apache.maven:maven-slf4j-provider` - Replaced with `org.apache.maven:maven-logging`
+- `org.apache.maven.resolver:maven-resolver-transport-http` - Replaced with `maven-resolver-transport-jdk`
+
+**Added/Updated Dependencies:**
+- `org.apache.maven:maven-logging:4.0.0-rc-4` - New Maven 4 logging module
+- `org.apache.maven:maven-compat:4.0.0-rc-4` - Backward compatibility layer for Maven 3 APIs
+- `org.jline:jansi-core:3.30.4` - JLine's jansi implementation
+- `org.apache.maven.resolver:maven-resolver-transport-jdk:2.0.9` - Java 11+ HTTP client-based transport
+- Updated all resolver dependencies to version `2.0.9`
+- Updated `com.google.guava:failureaccess` to version `1.0.1`
+
+#### Removed Source Files
+- `org.eclipse.m2e.slf4j2.provider.MavenSLF4JProvider` - No longer needed as Maven 4 provides its own SLF4J provider
+- `META-INF/services/org.slf4j.spi.SLF4JServiceProvider` - Service registration for the removed provider
+
+#### BND Configuration Updates
+- Updated SLF4J binding jar name from `maven-slf4j-provider-${maven-core.version}.jar` to `maven-logging-${maven-core.version}.jar`
+
+### 2. Runtime Target Platform (target-platform/m2e-runtimes.target)
+
+- Updated to reference Maven runtime `3.9.1100.20241011-1318` from m2e release 2.2.1 for backward compatibility
+- This allows running tests with both Maven 3.9.11 and Maven 4.0.0-rc-4
+
+### 3. Root POM (pom.xml)
+
+- Updated maven.runtime dependency version from `3.9.1100-SNAPSHOT` to `4.0.004-SNAPSHOT`
+
+## Maven 4 Architecture Changes
+
+### New Modules in Maven 4
+Maven 4 introduces several new API modules:
+- `maven-api-core` - Core Maven 4 API
+- `maven-api-model` - Model API
+- `maven-api-plugin` - Plugin API
+- `maven-api-settings` - Settings API
+- `maven-api-toolchain` - Toolchain API
+- `maven-api-xml` - XML processing API
+- `maven-di` - Dependency injection module
+- `maven-impl` - Implementation module
+- `maven-jline` - JLine integration
+- `maven-logging` - Logging module (replaces maven-slf4j-provider)
+
+### Backward Compatibility
+
+Maven 4 provides the `maven-compat` module that maintains compatibility with Maven 3 APIs. This includes:
+- Support for Plexus Container API
+- Legacy Maven APIs from Maven 3.x
+- Compatibility layer for plugins built against Maven 3
+
+## Code Compatibility Assessment
+
+### PlexusContainer Usage
+
+The following areas of m2e use PlexusContainer and related Plexus APIs:
+
+1. **org.eclipse.m2e.core.internal.embedder.PlexusContainerManager**
+   - Creates and manages PlexusContainer instances
+   - Uses DefaultPlexusContainer, ContainerConfiguration
+   - **Status**: Should work with maven-compat module
+
+2. **org.eclipse.m2e.core.internal.embedder.IMavenPlexusContainer**
+   - Interface for wrapping PlexusContainer
+   - **Status**: Should work with maven-compat module
+
+3. **Plexus Utility Classes**
+   - `org.codehaus.plexus.util.xml.Xpp3Dom` - Used extensively for plugin configuration
+   - `org.codehaus.plexus.util.dag.*` - DAG utilities for dependency ordering
+   - `org.codehaus.plexus.util.Scanner` - Build context scanning
+   - `org.codehaus.plexus.classworlds.ClassRealm` - ClassLoader management
+   - **Status**: These are still available in Maven 4 (plexus-utils, plexus-classworlds)
+
+4. **org.eclipse.m2e.tests.common.AbstractMavenProjectTestCase**
+   - Test utilities that lookup PlexusContainer
+   - **Status**: Should work with maven-compat module
+
+5. **org.eclipse.m2e.core.ui.internal.archetype.ArchetypePlugin**
+   - Uses DefaultPlexusContainer for archetype operations
+   - **Status**: Should work with maven-compat module
+
+## Testing Requirements
+
+The following areas should be tested to ensure Maven 4 compatibility:
+
+### Core Functionality
+1. [ ] Project import from existing Maven projects
+2. [ ] POM editing and validation
+3. [ ] Dependency resolution
+4. [ ] Plugin execution during builds
+5. [ ] Workspace resolution
+6. [ ] Maven lifecycle execution
+7. [ ] External Maven launches
+
+### PlexusContainer Compatibility
+1. [ ] Container creation and disposal
+2. [ ] Component lookup
+3. [ ] Extension loading from .mvn/extensions.xml
+4. [ ] ClassRealm management
+5. [ ] Plugin realm creation
+
+### Build and Test Infrastructure
+1. [ ] Maven runtime bundle builds successfully
+2. [ ] All m2e modules compile against Maven 4 APIs
+3. [ ] Unit tests pass
+4. [ ] Integration tests pass
+5. [ ] UI tests pass
+
+### Maven 4 Specific Features
+1. [ ] New Maven 4 API usage (if any)
+2. [ ] Maven 4 resolver transport (JDK HTTP client)
+3. [ ] Maven 4 logging integration with Eclipse
+4. [ ] Maven 4 dependency injection (Guice/Sisu)
+
+## Known Issues and Limitations
+
+### Build Environment
+- The current build requires access to repo.eclipse.org which may not be available in all environments
+- Tycho 4.0.13 may have issues with JavaSE-21 execution environment
+
+### Potential API Changes
+The following Maven APIs may have changed between Maven 3 and Maven 4:
+1. **Resolver APIs** - Updated from 1.x to 2.x
+   - New transport mechanism (JDK HTTP client vs Apache HttpClient)
+   - May affect custom repository configurations
+
+2. **Logging** - New maven-logging module
+   - Uses SLF4J 2.x
+   - May affect log filtering and configuration
+
+3. **Plugin API** - New maven-api-plugin module
+   - May affect plugin descriptor reading
+   - May affect mojo parameter injection
+
+## Recommendations
+
+### Short Term
+1. Complete full build and test cycle to identify any runtime issues
+2. Test with real-world projects to validate Maven 4 compatibility
+3. Document any API incompatibilities found during testing
+4. Consider keeping Maven 3.9.11 runtime as an alternative for users
+
+### Long Term
+1. Consider migrating to Maven 4 APIs where beneficial
+2. Deprecate Maven 3-specific workarounds that are no longer needed
+3. Take advantage of Maven 4's improved dependency injection
+4. Explore Maven 4's new features (e.g., build cache, consumer POM)
+
+## References
+
+- Maven 4.0.0-rc-4 Release: https://repo.maven.apache.org/maven2/org/apache/maven/maven/4.0.0-rc-4/
+- Maven Resolver 2.0.9: https://maven.apache.org/resolver/
+- Maven 4 Migration Guide: https://maven.apache.org/docs/4.0.0/

org.eclipse.m2e.apt.core/META-INF/MANIFEST.MF

@@ -10,7 +10,7 @@ Require-Bundle: org.eclipse.core.runtime;bundle-version="[3.27.0,4.0.0)",
  org.eclipse.jdt.apt.core;bundle-version="3.7.50",
  org.eclipse.m2e.core;bundle-version="[2.0.0,3.0.0)",
  org.eclipse.m2e.jdt;bundle-version="[2.0.0,3.0.0)",
- org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,4.0.0)"
+ org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,5.0.0)"
 Eclipse-LazyStart: true
 Bundle-RequiredExecutionEnvironment: JavaSE-21
 Bundle-Vendor: %Bundle-Vendor

org.eclipse.m2e.binaryproject.ui/META-INF/MANIFEST.MF

@@ -9,7 +9,7 @@ Require-Bundle: org.eclipse.ui,
  org.eclipse.m2e.core.ui;bundle-version="[2.0.0,3.0.0)",
  org.eclipse.m2e.binaryproject;bundle-version="[2.0.0,3.0.0)",
  org.eclipse.m2e.core;bundle-version="[2.0.0,3.0.0)",
- org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,4.0.0)"
+ org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,5.0.0)"
 Bundle-RequiredExecutionEnvironment: JavaSE-21
 Bundle-ActivationPolicy: lazy
 Automatic-Module-Name: org.eclipse.m2e.binaryproject.ui

org.eclipse.m2e.binaryproject/META-INF/MANIFEST.MF

@@ -5,7 +5,7 @@ Bundle-Version: 2.2.100.qualifier
 Bundle-Vendor: Eclipse.org - m2e
 Bundle-Name: M2E Binary Project Core
 Require-Bundle: org.eclipse.m2e.core;bundle-version="[2.0.0,3.0.0)",
- org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,4.0.0)",
+ org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,5.0.0)",
  org.eclipse.m2e.sourcelookup;bundle-version="[2.0.0,3.0.0)",
  org.eclipse.m2e.jdt;bundle-version="[2.0.0,3.0.0)",
  org.eclipse.jdt.core;bundle-version="3.7.0",

org.eclipse.m2e.core.tests/META-INF/MANIFEST.MF

@@ -6,7 +6,8 @@ Bundle-SymbolicName: org.eclipse.m2e.core.tests
 Bundle-Version: 2.0.0.qualifier
 Bundle-RequiredExecutionEnvironment: JavaSE-21
 Bundle-Vendor: Eclipse.org - m2e
-Require-Bundle: org.eclipse.m2e.tests.common,
+Require-Bundle: org.eclipse.m2e.maven.runtime;bundle-version="[4.0.0,5.0.0)",
+ org.eclipse.m2e.tests.common,
  org.eclipse.core.runtime,
  org.eclipse.m2e.launching,
  org.eclipse.jdt.launching,

org.eclipse.m2e.core.ui/META-INF/MANIFEST.MF

@@ -32,7 +32,7 @@ Require-Bundle: org.eclipse.m2e.core;bundle-version="[2.0.0,3.0.0)",
  org.eclipse.core.resources;bundle-version="3.5.2",
  org.eclipse.core.runtime;bundle-version="3.5.0",
  org.eclipse.m2e.model.edit;bundle-version="[2.0.0,3.0.0)";visibility:=reexport,
- org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,4.0.0)",
+ org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,5.0.0)",
  org.eclipse.ui.console;bundle-version="3.4.0",
  org.eclipse.ui.ide;bundle-version="3.18.0",
  org.eclipse.core.filesystem;bundle-version="1.2.1",

org.eclipse.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/preferences/MavenSettingsPreferencePage.java

@@ -59,7 +59,6 @@
 import org.eclipse.ui.ide.IDE;
 
 import org.apache.maven.building.Problem;
-import org.apache.maven.cli.MavenCli;
 import org.apache.maven.cli.configuration.SettingsXmlConfigurationProcessor;
 import org.apache.maven.repository.RepositorySystem;
 import org.apache.maven.settings.Settings;
@@ -69,6 +68,7 @@
 import org.eclipse.m2e.core.embedder.IMaven;
 import org.eclipse.m2e.core.embedder.IMavenConfiguration;
 import org.eclipse.m2e.core.internal.IMavenToolbox;
+import org.eclipse.m2e.core.internal.embedder.MavenCLICompat;
 import org.eclipse.m2e.core.project.IMavenProjectFacade;
 import org.eclipse.m2e.core.project.MavenUpdateRequest;
 import org.eclipse.m2e.core.ui.internal.Messages;
@@ -210,9 +210,9 @@ protected Control createContents(Composite parent) {
 
     userToolchainsLink = createLink(composite, Messages.MavenSettingsPreferencePage_userToolchainslink2,
         Messages.MavenSettingsPreferencePage_userToolchainslink_tooltip, this::getUserToolchains,
-        MavenCli.DEFAULT_USER_TOOLCHAINS_FILE);
+        MavenCLICompat.DEFAULT_USER_TOOLCHAINS_FILE);
     userToolchainsText = createFileSelectionWidgets(composite, mavenConfiguration.getUserToolchainsFile(),
-        MavenCli.DEFAULT_USER_TOOLCHAINS_FILE);
+        MavenCLICompat.DEFAULT_USER_TOOLCHAINS_FILE);
 
     Button updateSettings = new Button(composite, SWT.NONE);
     updateSettings.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, false, false, 2, 1));
@@ -310,7 +310,7 @@ protected void checkSettings() {
         Messages.MavenSettingsPreferencePage_userSettingslink2, Messages.MavenSettingsPreferencePage_userSettingslink1);
 
     String userToolchains = getUserToolchains();
-    updateLink(userToolchainsLink, userToolchains, MavenCli.DEFAULT_USER_TOOLCHAINS_FILE,
+    updateLink(userToolchainsLink, userToolchains, MavenCLICompat.DEFAULT_USER_TOOLCHAINS_FILE,
         Messages.MavenSettingsPreferencePage_userToolchainslink2,
         Messages.MavenSettingsPreferencePage_userToolchainslink1);
 

org.eclipse.m2e.core/META-INF/MANIFEST.MF

@@ -6,7 +6,7 @@ Bundle-Version: 2.7.600.qualifier
 Bundle-Activator: org.eclipse.m2e.core.internal.MavenPluginActivator
 Bundle-Vendor: %Bundle-Vendor
 Bundle-Localization: plugin
-Require-Bundle: org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,4.0.0)",
+Require-Bundle: org.eclipse.m2e.maven.runtime;bundle-version="[3.8.6,5.0.0)",
  org.eclipse.m2e.workspace.cli;bundle-version="0.1.0",
  org.eclipse.core.runtime;bundle-version="[3.27.0,4.0.0)",
  org.eclipse.core.resources;bundle-version="3.9.0",

org.eclipse.m2e.core/src/org/eclipse/m2e/core/internal/MavenPluginActivator.java

@@ -32,8 +32,6 @@
 
 import org.codehaus.plexus.PlexusContainer;
 
-import org.apache.maven.project.DefaultProjectBuilder;
-
 import org.eclipse.m2e.core.embedder.IMaven;
 import org.eclipse.m2e.core.embedder.IMavenConfiguration;
 import org.eclipse.m2e.core.embedder.MavenModelManager;
@@ -101,7 +99,8 @@ public void start(final BundleContext context) throws Exception {
     }
 
     // Workaround MNG-6530
-    System.setProperty(DefaultProjectBuilder.DISABLE_GLOBAL_MODEL_CACHE_SYSTEM_PROPERTY, Boolean.toString(true));
+    //TODO is this still working for maven4?
+    System.setProperty("maven.defaultProjectBuilder.disableGlobalModelCache", Boolean.toString(true));
     URLConnectionCaches.disable();
     // For static access, this also enables any of the services and keep them running forever...
     this.bundleContext = context;

org.eclipse.m2e.core/src/org/eclipse/m2e/core/internal/embedder/MavenCLICompat.java

@@ -0,0 +1,41 @@
+/*
+ * 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.eclipse.m2e.core.internal.embedder;
+
+import java.io.File;
+
+
+/**
+ * Some constants copied here for backward compatibility
+ */
+public class MavenCLICompat {
+  public static final String LOCAL_REPO_PROPERTY = "maven.repo.local";
+
+  public static final String MULTIMODULE_PROJECT_DIRECTORY = "maven.multiModuleProjectDirectory";
+
+  public static final String USER_HOME = System.getProperty("user.home");
+
+  public static final File USER_MAVEN_CONFIGURATION_HOME = new File(USER_HOME, ".m2");
+
+  public static final File DEFAULT_USER_TOOLCHAINS_FILE = new File(USER_MAVEN_CONFIGURATION_HOME, "toolchains.xml");
+
+  public static final File DEFAULT_GLOBAL_TOOLCHAINS_FILE = new File(System.getProperty("maven.conf"),
+      "toolchains.xml");
+}