Let maven do the hard work of archetype generation

Prerequisite for eclipse-m2e#249
laeubi · Jun 11, 2022 · 747bbda · 747bbda
1 parent fb4d7a1
commit 747bbda
Show file tree

Hide file tree

Showing 16 changed files with 397 additions and 134 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,4 +1,4 @@
 [submodule "m2e-core-tests"]
 	path = m2e-core-tests
-	url = https://github.com/tesla/m2e-core-tests.git
-	branch = master
+	url = https://github.com/laeubi/m2e-core-tests.git
+	branch = adjust_repo
diff --git a/...clipse.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/archetype/ArchetypeGenerator.java b/...clipse.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/archetype/ArchetypeGenerator.java
@@ -10,178 +10,120 @@
  * Contributors:
  *      Sonatype, Inc. - initial API and implementation
  *******************************************************************************/
+
 package org.eclipse.m2e.core.ui.internal.archetype;
 
-import java.util.ArrayList;
-import java.util.Collections;
+import java.io.File;
+import java.util.Collection;
 import java.util.List;
 import java.util.Properties;
-import java.util.Set;
+import java.util.concurrent.CancellationException;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
 
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
-import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IWorkspaceRoot;
 import org.eclipse.core.resources.ResourcesPlugin;
-import org.eclipse.core.runtime.Adapters;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.osgi.util.NLS;
+import org.eclipse.swt.widgets.Display;
 
-import org.codehaus.plexus.util.StringUtils;
-
-import org.apache.maven.archetype.ArchetypeGenerationRequest;
-import org.apache.maven.archetype.ArchetypeGenerationResult;
-import org.apache.maven.artifact.Artifact;
-import org.apache.maven.artifact.repository.ArtifactRepository;
-
-import org.eclipse.m2e.core.embedder.IMaven;
-import org.eclipse.m2e.core.embedder.IMavenExecutionContext;
 import org.eclipse.m2e.core.embedder.MavenModelManager;
 import org.eclipse.m2e.core.internal.Messages;
-import org.eclipse.m2e.core.internal.embedder.MavenImpl;
+import org.eclipse.m2e.core.internal.launch.IMavenLauncher;
 import org.eclipse.m2e.core.project.IArchetype;
-import org.eclipse.m2e.core.project.IMavenProjectImportResult;
 import org.eclipse.m2e.core.project.IProjectConfigurationManager;
-import org.eclipse.m2e.core.project.IProjectCreationListener;
 import org.eclipse.m2e.core.project.LocalProjectScanner;
 import org.eclipse.m2e.core.project.MavenProjectInfo;
-import org.eclipse.m2e.core.project.ProjectImportConfiguration;
 
 
 @Component(service = {ArchetypeGenerator.class})
+@SuppressWarnings("restriction")
 public class ArchetypeGenerator {
 
-  private static final Logger log = LoggerFactory.getLogger(ArchetypeGenerator.class);
-
-  @Reference
-  IMaven maven;
-
   @Reference
   IProjectConfigurationManager projectConfigurationManager;
 
   @Reference
   MavenModelManager mavenModelManager;
 
+  @Reference
+  IMavenLauncher mavenLauncher;
+
   /**
    * Creates project structure using Archetype and then imports created project(s)
    *
-   * @return an unmodifiable list of created projects.
+   * @return a list of created projects.
    * @since 1.8
    */
-  public List<IProject> createArchetypeProjects(IPath location, IArchetype archetype, String groupId, String artifactId,
-      String version, String javaPackage, Properties properties, ProjectImportConfiguration configuration,
-      IProjectCreationListener listener, IProgressMonitor monitor) throws CoreException {
-    return IMavenExecutionContext.getThreadContext().orElseGet(maven::createExecutionContext)
-        .execute((context, m) -> createArchetypeProjects0(location, archetype, groupId,
-        artifactId, version,
-        javaPackage, properties, configuration, listener, m), monitor);
-  }
-
-  List<IProject> createArchetypeProjects0(IPath location, IArchetype archetype, String groupId, String artifactId,
-      String version, String javaPackage, Properties properties, ProjectImportConfiguration configuration,
-      IProjectCreationListener listener, IProgressMonitor monitor) throws CoreException {
-    monitor.beginTask(NLS.bind(Messages.ProjectConfigurationManager_task_creating_project1, artifactId), 2);
-
+  public Collection<MavenProjectInfo> createArchetypeProjects(IPath location, IArchetype archetype, String groupId,
+      String artifactId,
+      String version, String javaPackage, Properties properties, IProgressMonitor monitor) throws CoreException {
+    SubMonitor subMonitor = SubMonitor.convert(monitor,
+        NLS.bind(Messages.ProjectConfigurationManager_task_creating_project1, artifactId), 3);
     IWorkspaceRoot workspaceRoot = ResourcesPlugin.getWorkspace().getRoot();
 
-    monitor.subTask(NLS.bind(Messages.ProjectConfigurationManager_task_executing_archetype, archetype.getGroupId(),
+    subMonitor.subTask(NLS.bind(Messages.ProjectConfigurationManager_task_executing_archetype, archetype.getGroupId(),
         archetype.getArtifactId()));
     if(location == null) {
       // if the project should be created in the workspace, figure out the path
       location = workspaceRoot.getLocation();
     }
-
-    List<IProject> createdProjects = new ArrayList<>();
-
+    File basedir = location.toFile();
+    if(basedir == null || (!basedir.mkdirs() && !basedir.isDirectory())) {
+      throw new CoreException(Status.error(Messages.ProjectConfigurationManager_error_failed));
+    }
+    //See https://maven.apache.org/archetype/maven-archetype-plugin/generate-mojo.html
+    Properties userProperties = new Properties(properties);
+    userProperties.setProperty("archetypeGroupId", archetype.getGroupId());
+    userProperties.setProperty("archetypeArtifactId", archetype.getArtifactId());
+    userProperties.setProperty("archetypeVersion", archetype.getVersion());
+    String repository = archetype.getRepository();
+    if(repository != null) {
+      userProperties.setProperty("archetypeRepository", repository);
+    }
+    userProperties.setProperty("groupId", groupId);
+    userProperties.setProperty("artifactId", artifactId);
+    userProperties.setProperty("version", version);
+    userProperties.setProperty("package", javaPackage);
+    String projectFolder = location.append(artifactId).toFile().getAbsolutePath();
     try {
-
-      Artifact artifact = resolveArchetype(archetype, monitor);
-
-      ArchetypeGenerationRequest request = new ArchetypeGenerationRequest() //
-          .setTransferListener(((MavenImpl) maven).createTransferListener(monitor)) //
-          .setArchetypeGroupId(artifact.getGroupId()) //
-          .setArchetypeArtifactId(artifact.getArtifactId()) //
-          .setArchetypeVersion(artifact.getVersion()) //
-          .setArchetypeRepository(archetype.getRepository()) //
-          .setGroupId(groupId) //
-          .setArtifactId(artifactId) //
-          .setVersion(version) //
-          .setPackage(javaPackage) // the model does not have a package field
-          .setLocalRepository(maven.getLocalRepository()) //
-          .setRemoteArtifactRepositories(maven.getArtifactRepositories(true)).setProperties(properties)
-          .setOutputDirectory(location.toPortableString());
-
-      ArchetypeGenerationResult result = Adapters.adapt(archetype, org.apache.maven.archetype.ArchetypeManager.class)
-          .generateProjectFromArchetype(request);
-
-      Exception cause = result.getCause();
-      if(cause != null) {
-        String msg = NLS.bind(Messages.ProjectConfigurationManager_error_unable_archetype, archetype);
-        log.error(msg, cause);
-        throw new CoreException(Status.error(msg, cause));
+      CompletableFuture<?> maven = mavenLauncher.runMaven(basedir, "archetype:generate", userProperties);
+      subMonitor.worked(1);
+      Display current = Display.getCurrent();
+      while(!maven.isDone()) {
+        if(current != null) {
+          while(!current.isDisposed() && current.readAndDispatch()) {
+            //loop to process events
+          }
+        }
+        Thread.onSpinWait();
       }
-      monitor.worked(1);
-
-      // XXX Archetyper don't allow to specify project folder
-      String projectFolder = location.append(artifactId).toFile().getAbsolutePath();
-
+      maven.get(); //wait for maven build to complete...
+      subMonitor.worked(1);
       LocalProjectScanner scanner = new LocalProjectScanner(List.of(projectFolder), true, mavenModelManager);
-      scanner.run(monitor);
-
-      Set<MavenProjectInfo> projectSet = projectConfigurationManager.collectProjects(scanner.getProjects());
-
-      List<IMavenProjectImportResult> importResults = projectConfigurationManager.importProjects(projectSet,
-          configuration, listener, monitor);
-      for(IMavenProjectImportResult r : importResults) {
-        IProject p = r.getProject();
-        if(p != null && p.exists()) {
-          createdProjects.add(p);
-        }
+      try {
+        scanner.run(subMonitor.split(1));
+      } catch(InterruptedException e) {
+        return List.of();
       }
-
-      monitor.worked(1);
-    } catch(CoreException e) {
-      throw e;
-    } catch(InterruptedException e) {
+      return projectConfigurationManager.collectProjects(scanner.getProjects());
+    } catch(InterruptedException | CancellationException ex) {
       throw new CoreException(Status.CANCEL_STATUS);
-    } catch(Exception ex) {
+    } catch(ExecutionException ex) {
+      if(ex.getCause() instanceof CoreException) {
+        CoreException coreException = (CoreException) ex.getCause();
+        throw coreException;
+      }
       throw new CoreException(Status.error(Messages.ProjectConfigurationManager_error_failed, ex)); //$NON-NLS-1$
     }
-    return Collections.unmodifiableList(createdProjects);
-  }
 
-  /**
-   * Apparently, Archetype#generateProjectFromArchetype 2.0-alpha-4 does not attempt to resolve archetype from
-   * configured remote repositories. To compensate, we populate local repo with archetype pom/jar.
-   */
-  private Artifact resolveArchetype(IArchetype a, IProgressMonitor monitor) throws CoreException {
-    List<ArtifactRepository> repos = new ArrayList<>();
-    repos.addAll(maven.getArtifactRepositories()); // see org.apache.maven.archetype.downloader.DefaultDownloader#download
-
-    //MNGECLIPSE-1399 use archetype repository too, not just the default ones
-    String artifactRemoteRepository = a.getRepository();
-
-    try {
-
-      if(StringUtils.isNotBlank(artifactRemoteRepository)) {
-        ArtifactRepository archetypeRepository = maven.createArtifactRepository(a.getArtifactId() + "-repo", //$NON-NLS-1$
-            a.getRepository().trim());
-        repos.add(0, archetypeRepository);//If the archetype doesn't exist locally, this will be the first remote repo to be searched.
-      }
-
-      maven.resolve(a.getGroupId(), a.getArtifactId(), a.getVersion(), "pom", null, repos, monitor); //$NON-NLS-1$
-      return maven.resolve(a.getGroupId(), a.getArtifactId(), a.getVersion(), "jar", null, repos, monitor); //$NON-NLS-1$
-    } catch(CoreException e) {
-      String msg = Messages.ProjectConfigurationManager_error_resolve + a.getGroupId() + ':'
-          + Messages.ProjectConfigurationManager_error_resolve2;
-      throw new CoreException(Status.error(msg, e));
-    }
   }
 
 }
diff --git a/org.eclipse.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/wizards/MavenModuleWizard.java b/org.eclipse.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/wizards/MavenModuleWizard.java
@@ -21,8 +21,10 @@
 import static org.eclipse.m2e.core.ui.internal.editing.PomEdits.textEquals;
 
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.List;
 import java.util.Properties;
+import java.util.stream.Collectors;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -53,6 +55,7 @@
 
 import org.eclipse.m2e.core.MavenPlugin;
 import org.eclipse.m2e.core.internal.project.ProjectConfigurationManager;
+import org.eclipse.m2e.core.project.MavenProjectInfo;
 import org.eclipse.m2e.core.ui.internal.M2EUIPluginActivator;
 import org.eclipse.m2e.core.ui.internal.MavenImages;
 import org.eclipse.m2e.core.ui.internal.Messages;
@@ -247,15 +250,17 @@ protected List<IProject> doCreateMavenProjects(IProgressMonitor monitor) throws
       job = new AbstractCreateMavenProjectJob(NLS.bind(Messages.wizardProjectJobCreating, archetype.getArtifactId())) {
         @Override
         protected List<IProject> doCreateMavenProjects(IProgressMonitor monitor) throws CoreException {
-          List<IProject> projects = M2EUIPluginActivator.getDefault().getArchetypeManager().getGenerator()
+          Collection<MavenProjectInfo> projects = M2EUIPluginActivator.getDefault().getArchetypeManager().getGenerator()
               .createArchetypeProjects(location,
               new MavenArchetype(archetype), //
               groupId, artifactId, version, javaPackage, //
-              properties, importConfiguration, new MavenProjectWorkspaceAssigner(workingSets), monitor);
-
+                  properties, monitor);
           setModule(moduleName);
 
-          return projects;
+          return MavenPlugin.getProjectConfigurationManager()
+              .importProjects(projects, importConfiguration, new MavenProjectWorkspaceAssigner(workingSets), monitor)
+              .stream().filter(r -> r.getProject() != null && r.getProject().exists()).map(r -> r.getProject())
+              .collect(Collectors.toList());
         }
       };
     }

diff --git a/org.eclipse.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/wizards/MavenProjectWizard.java b/org.eclipse.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/wizards/MavenProjectWizard.java
@@ -14,8 +14,10 @@
 package org.eclipse.m2e.core.ui.internal.wizards;
 
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.List;
 import java.util.Properties;
+import java.util.stream.Collectors;
 
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
@@ -47,6 +49,7 @@
 import org.eclipse.m2e.core.MavenPlugin;
 import org.eclipse.m2e.core.internal.IMavenConstants;
 import org.eclipse.m2e.core.internal.project.ProjectConfigurationManager;
+import org.eclipse.m2e.core.project.MavenProjectInfo;
 import org.eclipse.m2e.core.project.ProjectImportConfiguration;
 import org.eclipse.m2e.core.ui.internal.M2EUIPluginActivator;
 import org.eclipse.m2e.core.ui.internal.MavenImages;
@@ -238,12 +241,15 @@ protected List<IProject> doCreateMavenProjects(IProgressMonitor monitor) throws
       job = new AbstractCreateMavenProjectJob(NLS.bind(Messages.wizardProjectJobCreating, archetype.getArtifactId())) {
         @Override
         protected List<IProject> doCreateMavenProjects(IProgressMonitor monitor) throws CoreException {
-          List<IProject> projects = M2EUIPluginActivator.getDefault().getArchetypeManager().getGenerator()
+          Collection<MavenProjectInfo> projects = M2EUIPluginActivator.getDefault().getArchetypeManager().getGenerator()
               .createArchetypeProjects(location,
               new MavenArchetype(archetype), //
               groupId, artifactId, version, javaPackage, //
-              properties, importConfiguration, new MavenProjectWorkspaceAssigner(workingSets), monitor);
-          return projects;
+              properties, monitor);
+          return MavenPlugin.getProjectConfigurationManager().importProjects(projects,
+              importConfiguration, new MavenProjectWorkspaceAssigner(workingSets), monitor).stream()
+              .filter(r -> r.getProject() != null && r.getProject().exists()).map(r -> r.getProject())
+              .collect(Collectors.toList());
         }
       };
     }

diff --git a/org.eclipse.m2e.core/src/org/eclipse/m2e/core/internal/MavenPluginActivator.java b/org.eclipse.m2e.core/src/org/eclipse/m2e/core/internal/MavenPluginActivator.java
@@ -65,7 +65,7 @@ public class MavenPluginActivator extends Plugin {
 
   private BundleContext bundleContext;
 
-  private String version = "0.0.0"; //$NON-NLS-1$
+  private static String version = "0.0.0"; //$NON-NLS-1$
 
   private final BundleListener bundleListener = event -> LifecycleMappingFactory.setBundleMetadataSources(null);
 
@@ -197,7 +197,8 @@ public ProjectRegistryRefreshJob getProjectManagerRefreshJob() {
   }
 
   public static String getVersion() {
-    return plugin.version;
+
+    return version;
   }
 
   public static String getUserAgent() {

diff --git a/org.eclipse.m2e.core/src/org/eclipse/m2e/core/internal/launch/IMavenLauncher.java b/org.eclipse.m2e.core/src/org/eclipse/m2e/core/internal/launch/IMavenLauncher.java
@@ -0,0 +1,27 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Christoph Läubrich
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *      Christoph Läubrich - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.m2e.core.internal.launch;
+
+import java.io.File;
+import java.util.Properties;
+import java.util.concurrent.CompletableFuture;
+
+import org.eclipse.core.runtime.CoreException;
+
+
+/**
+ * {@link IMavenLauncher} allows to trigger a maven run
+ */
+public interface IMavenLauncher {
+
+  CompletableFuture<?> runMaven(File basedir, String goals, Properties properties) throws CoreException;
+
+}
diff --git a/org.eclipse.m2e.launching/.project b/org.eclipse.m2e.launching/.project
@@ -20,6 +20,11 @@
 			<arguments>
 			</arguments>
 		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.pde.ds.core.builder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
 	</buildSpec>
 	<natures>
 		<nature>org.eclipse.pde.PluginNature</nature>

diff --git a/org.eclipse.m2e.launching/.settings/org.eclipse.pde.ds.annotations.prefs b/org.eclipse.m2e.launching/.settings/org.eclipse.pde.ds.annotations.prefs
@@ -0,0 +1,8 @@
+classpath=true
+dsVersion=V1_3
+eclipse.preferences.version=1
+enabled=true
+generateBundleActivationPolicyLazy=true
+path=OSGI-INF
+validationErrorLevel=error
+validationErrorLevel.missingImplicitUnbindMethod=error
diff --git a/org.eclipse.m2e.launching/META-INF/MANIFEST.MF b/org.eclipse.m2e.launching/META-INF/MANIFEST.MF
@@ -30,3 +30,4 @@ Export-Package: org.eclipse.m2e.actions;x-internal:=true,
  org.eclipse.m2e.ui.internal.launch;x-internal:=true
 Import-Package: org.slf4j;version="[1.6.2,2.0.0)"
 Automatic-Module-Name: org.eclipse.m2e.launching
+Service-Component: OSGI-INF/org.eclipse.m2e.internal.launch.EclipseMavenLauncher.xml