Skip to content

Use Sisu/Guice instead of plexus container for component lookup #1951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Use Sisu/Guice instead of plexus container for component lookup #1951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3647eb9
[TP] Update to Archetype 3.3.1 and unify archetypes OSGi metadata
HannesWell Feb 23, 2025
fb76184
[FIXUP] Migrate to Guice directly
HannesWell Mar 1, 2025
defc2e2
Use Sisu/Guice instead of plexus container for component lookup
laeubi Mar 2, 2025
eb20e7e
Try using "deprecated" constructor
laeubi Mar 2, 2025
c49b0b5
Setup the logger
laeubi Mar 2, 2025
6ea2f52
let injector create remote catlog
laeubi Mar 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion m2e-core-tests
Open in desktop
Submodule m2e-core-tests updated 1 files
+1 −0 org.eclipse.m2e.tests/META-INF/MANIFEST.MF
13 changes: 6 additions & 7 deletions org.eclipse.m2e.core.ui/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,16 @@ Require-Bundle: org.eclipse.m2e.core;bundle-version="[2.0.0,3.0.0)",
org.eclipse.ui.navigator,
org.eclipse.debug.ui
Import-Package: org.apache.maven.archetype.catalog;provider=m2e;version="[3.2.1,4.0.0)",
org.apache.maven.archetype.catalog.io.xpp3;provider=m2e;version="[3.2.1,4.0.0)",
org.apache.maven.archetype.common;provider=m2e;version="[3.2.1,4.0.0)",
org.apache.maven.archetype.exception;provider=m2e;version="[3.2.1,4.0.0)",
org.apache.maven.archetype.metadata;provider=m2e;version="[3.2.1,4.0.0)",
org.apache.maven.archetype.source;provider=m2e;version="[3.2.1,4.0.0)",
org.apache.maven.shared.transfer.artifact;provider=m2e;version="[0.13.1,1.0.0)",
org.apache.maven.archetype.catalog.io.xpp3;provider=m2e;version="[3.3.0,4.0.0)",
org.apache.maven.archetype.common;provider=m2e;version="[3.3.0,4.0.0)",
org.apache.maven.archetype.downloader;provider=m2e;version="[3.3.0,4.0.0)",
org.apache.maven.archetype.exception;provider=m2e;version="[3.3.0,4.0.0)",
org.apache.maven.archetype.metadata;provider=m2e;version="[3.3.0,4.0.0)",
org.apache.maven.archetype.source;provider=m2e;version="[3.3.0,4.0.0)",
org.eclipse.compare.rangedifferencer,
org.eclipse.ltk.core.refactoring,
org.slf4j;version="[1.7.0,3.0.0)"
Service-Component: OSGI-INF/component.xml,
OSGI-INF/org.eclipse.m2e.core.ui.internal.archetype.ArchetypeGenerator.xml,
OSGI-INF/org.eclipse.m2e.core.ui.internal.archetype.ArchetypePlugin.xml
Automatic-Module-Name: org.eclipse.m2e.core.ui

35 changes: 14 additions & 21 deletions ...e.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/archetype/ArchetypeCatalogFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

package org.eclipse.m2e.core.ui.internal.archetype;

import java.io.File;
import java.io.InputStream;
import java.net.URI;
import java.net.URL;
Expand All @@ -24,6 +25,7 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.Status;
import org.eclipse.osgi.util.NLS;
Expand All @@ -34,9 +36,6 @@
import org.apache.maven.archetype.source.ArchetypeDataSource;
import org.apache.maven.archetype.source.ArchetypeDataSourceException;
import org.apache.maven.archetype.source.RemoteCatalogArchetypeDataSource;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.repository.MavenArtifactRepository;
import org.apache.maven.project.ProjectBuildingRequest;

import org.eclipse.m2e.core.embedder.IMaven;
import org.eclipse.m2e.core.embedder.IMavenExecutionContext;
Expand Down Expand Up @@ -111,7 +110,7 @@ public static class InternalCatalogFactory extends ArchetypeCatalogFactory {
@Override
public ArchetypeCatalog getArchetypeCatalog() {
try {
return source.getArchetypeCatalog(null);
return source.getArchetypeCatalog(null, null);
} catch(ArchetypeDataSourceException e) {
return new ArchetypeCatalog();
}
Expand All @@ -137,9 +136,8 @@ public static class DefaultLocalCatalogFactory extends ArchetypeCatalogFactory {
@Override
public ArchetypeCatalog getArchetypeCatalog() throws CoreException {
return maven.createExecutionContext().execute((ctx, m) -> {
ProjectBuildingRequest buildingRequest = ctx.newProjectBuildingRequest();
try {
return source.getArchetypeCatalog(buildingRequest);
return source.getArchetypeCatalog(ctx.getRepositorySession(), ArchetypePlugin.getRemoteRepositories(ctx));
} catch(ArchetypeDataSourceException e) {
return new ArchetypeCatalog();
}
Expand Down Expand Up @@ -173,14 +171,10 @@ public ArchetypeCatalog getArchetypeCatalog() throws CoreException {
if(catalog == null) {
//local but not embedded catalog
IMavenExecutionContext context = maven.createExecutionContext();
ArtifactRepository localRepository = new MavenArtifactRepository();
localRepository.setUrl(getLocalRepositoryURL());
context.getExecutionRequest().setLocalRepository(localRepository);
context.getExecutionRequest().setLocalRepositoryPath(getLocalRepositoryPath());
return context.execute((ctx, m) -> {
ProjectBuildingRequest buildingRequest = ctx.newProjectBuildingRequest();
buildingRequest.setLocalRepository(localRepository);
try {
return source.getArchetypeCatalog(buildingRequest);
return source.getArchetypeCatalog(ctx.getRepositorySession(), ArchetypePlugin.getRemoteRepositories(ctx));
} catch(ArchetypeDataSourceException e) {
return new ArchetypeCatalog();
}
Expand All @@ -189,22 +183,22 @@ public ArchetypeCatalog getArchetypeCatalog() throws CoreException {
return catalog;
}

private String getLocalRepositoryURL() {
private File getLocalRepositoryPath() {
Path path;
try { // First try to use the id as a path, then as a URI else as it is
path = Path.of(getId());
} catch(Exception e1) {
try {
path = Path.of(new URI(getId()));
} catch(Exception e2) {
return getId();
throw new IllegalStateException("Illegal repository path: " + getId());
}
}
path = path.toAbsolutePath();
if(Files.isRegularFile(path)) {
path = path.getParent();
}
return path.toUri().toString();
return path.toFile();
}

private ArchetypeCatalog getEmbeddedCatalog() throws CoreException {
Expand Down Expand Up @@ -281,13 +275,12 @@ public ArchetypeCatalog getArchetypeCatalog() throws CoreException {
final String remoteUrl = url;

ArchetypeCatalog catalog = maven.createExecutionContext().execute((ctx, m) -> {
ProjectBuildingRequest buildingRequest = ctx.newProjectBuildingRequest();
try {
ArtifactRepository archeTypeRepo = new MavenArtifactRepository();
archeTypeRepo.setUrl(remoteUrl);
archeTypeRepo.setId(RemoteCatalogArchetypeDataSource.ARCHETYPE_REPOSITORY_ID);
buildingRequest.getRemoteRepositories().add(archeTypeRepo);
return source.getArchetypeCatalog(buildingRequest);
RemoteRepository archeTypeRepo = new RemoteRepository.Builder(
RemoteCatalogArchetypeDataSource.ARCHETYPE_REPOSITORY_ID, "", remoteUrl).build();
List<RemoteRepository> remoteRepositories = new ArrayList<>(ArchetypePlugin.getRemoteRepositories(ctx));
remoteRepositories.add(archeTypeRepo);
return source.getArchetypeCatalog(ctx.getRepositorySession(), remoteRepositories);
} catch(ArchetypeDataSourceException e) {
return new ArchetypeCatalog();
}
Expand Down
110 changes: 64 additions & 46 deletions org.eclipse.m2e.core.ui/src/org/eclipse/m2e/core/ui/internal/archetype/ArchetypePlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.Map;
import java.util.stream.Collectors;

import org.osgi.framework.FrameworkUtil;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
Expand All @@ -34,33 +35,39 @@
import org.slf4j.LoggerFactory;

import com.google.inject.AbstractModule;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.Module;

import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Status;
import org.eclipse.sisu.space.BeanScanning;
import org.eclipse.sisu.space.BundleClassSpace;
import org.eclipse.sisu.space.ClassSpace;
import org.eclipse.sisu.space.SpaceModule;
import org.eclipse.sisu.wire.WireModule;

import org.codehaus.plexus.ContainerConfiguration;
import org.codehaus.plexus.DefaultContainerConfiguration;
import org.codehaus.plexus.DefaultPlexusContainer;
import org.codehaus.plexus.PlexusConstants;
import org.codehaus.plexus.PlexusContainerException;
import org.codehaus.plexus.classworlds.ClassWorld;
import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
import org.codehaus.plexus.logging.LogEnabled;

import org.apache.maven.RepositoryUtils;
import org.apache.maven.archetype.catalog.Archetype;
import org.apache.maven.archetype.common.ArchetypeArtifactManager;
import org.apache.maven.archetype.exception.UnknownArchetype;
import org.apache.maven.archetype.metadata.ArchetypeDescriptor;
import org.apache.maven.archetype.metadata.RequiredProperty;
import org.apache.maven.archetype.source.ArchetypeDataSource;
import org.apache.maven.archetype.source.ArchetypeDataSourceException;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.project.ProjectBuildingRequest;
import org.apache.maven.archetype.source.InternalCatalogArchetypeDataSource;
import org.apache.maven.archetype.source.LocalCatalogArchetypeDataSource;
import org.apache.maven.archetype.source.RemoteCatalogArchetypeDataSource;
import org.apache.maven.cli.logging.Slf4jLogger;

import org.eclipse.m2e.core.embedder.IMaven;
import org.eclipse.m2e.core.embedder.IMavenExecutionContext;
import org.eclipse.m2e.core.internal.MavenPluginActivator;
import org.eclipse.m2e.core.project.IArchetype;
import org.eclipse.m2e.core.ui.internal.M2EUIPluginActivator;
Expand All @@ -76,6 +83,10 @@
@Component(service = ArchetypePlugin.class)
public class ArchetypePlugin {

private static final InternalCatalogArchetypeDataSource INTERNAL_CATALOG = new InternalCatalogArchetypeDataSource();

private static final LocalCatalogArchetypeDataSource LOCAL_CATALOG = new LocalCatalogArchetypeDataSource();

public static final String ARCHETYPE_PREFIX = "archetype";

private final Map<String, ArchetypeCatalogFactory> catalogs = new LinkedHashMap<>();
Expand All @@ -92,9 +103,7 @@ public class ArchetypePlugin {

private ArchetypeArtifactManager archetypeArtifactManager;

private Map<String, ArchetypeDataSource> archetypeDataSourceMap;

private DefaultPlexusContainer container;
private RemoteCatalogArchetypeDataSource remoteCatalog;

public ArchetypePlugin() {
this.configFile = new File(MavenPluginActivator.getDefault().getStateLocation().toFile(),
Expand All @@ -103,25 +112,40 @@ public ArchetypePlugin() {
}

@Activate
void activate() throws PlexusContainerException, ComponentLookupException {
void activate() {
final Module logginModule = new AbstractModule() {
@Override
protected void configure() {
bind(ILoggerFactory.class).toInstance(LoggerFactory.getILoggerFactory());
}
};
final ContainerConfiguration cc = new DefaultContainerConfiguration() //
.setClassWorld(new ClassWorld("plexus.core", ArchetypeArtifactManager.class.getClassLoader())) //$NON-NLS-1$
.setClassPathScanning(PlexusConstants.SCANNING_INDEX) //
.setAutoWiring(true) //
.setName("plexus"); //$NON-NLS-1$
container = new DefaultPlexusContainer(cc, logginModule);
archetypeArtifactManager = container.lookup(ArchetypeArtifactManager.class);
archetypeDataSourceMap = container.lookupMap(ArchetypeDataSource.class);
addArchetypeCatalogFactory(
new ArchetypeCatalogFactory.InternalCatalogFactory(archetypeDataSourceMap.get("internal-catalog")));
Slf4jLogger logger = new Slf4jLogger(LoggerFactory.getILoggerFactory().getLogger("catalog"));
INTERNAL_CATALOG.enableLogging(logger);
LOCAL_CATALOG.enableLogging(logger);
ClassSpace space = new BundleClassSpace(FrameworkUtil.getBundle(ArchetypeArtifactManager.class));
final Module repositorySystemModule = new AbstractModule() {
@Override
protected void configure() {
try {
bind(RepositorySystem.class).toInstance(MavenPluginActivator.getDefault().getRepositorySystem());
} catch(CoreException ex) {
ex.printStackTrace();
}
}
};
Injector injector = Guice.createInjector(
new WireModule(logginModule, repositorySystemModule, new SpaceModule(space, BeanScanning.INDEX)));
archetypeArtifactManager = injector.getInstance(ArchetypeArtifactManager.class);
if(archetypeArtifactManager instanceof LogEnabled le) {
le.enableLogging(logger);
}
this.remoteCatalog = injector.getInstance(RemoteCatalogArchetypeDataSource.class);
if(remoteCatalog instanceof LogEnabled le) {
le.enableLogging(logger);
}
addArchetypeCatalogFactory(
new ArchetypeCatalogFactory.DefaultLocalCatalogFactory(maven, archetypeDataSourceMap.get("catalog")));
new ArchetypeCatalogFactory.InternalCatalogFactory(INTERNAL_CATALOG));
addArchetypeCatalogFactory(new ArchetypeCatalogFactory.DefaultLocalCatalogFactory(maven, LOCAL_CATALOG));
for(ArchetypeCatalogFactory archetypeCatalogFactory : ExtensionReader.readArchetypeExtensions(this)) {
addArchetypeCatalogFactory(archetypeCatalogFactory);
}
Expand All @@ -135,18 +159,16 @@ protected void configure() {
@Deactivate
void shutdown() throws IOException {
saveCatalogs();
container.dispose();
}

public LocalCatalogFactory newLocalCatalogFactory(String path, String description, boolean editable,
boolean enabled) {
return new LocalCatalogFactory(path, description, editable, enabled, maven, archetypeDataSourceMap.get("catalog"));
return new LocalCatalogFactory(path, description, editable, enabled, maven, LOCAL_CATALOG);
}

public RemoteCatalogFactory newRemoteCatalogFactory(String url, String description, boolean editable,
boolean enabled) {
return new RemoteCatalogFactory(url, description, editable, enabled, maven,
archetypeDataSourceMap.get("remote-catalog"));
return new RemoteCatalogFactory(url, description, editable, enabled, maven, remoteCatalog);
}

public ArchetypeGenerator getGenerator() {
Expand Down Expand Up @@ -219,36 +241,32 @@ public List<RequiredProperty> getRequiredProperties(IArchetype archetype, IProgr
final String artifactId = archetype.getArtifactId();
final String version = archetype.getVersion();

final List<ArtifactRepository> repositories = new ArrayList<>(maven.getArtifactRepositories());

return maven.createExecutionContext().execute((context, monitor1) -> {
ArtifactRepository localRepository = context.getLocalRepository();
if(archetypeArtifactManager.isFileSetArchetype(groupId, artifactId, version, null, localRepository, repositories,
context.newProjectBuildingRequest())) {
ArchetypeDescriptor descriptor;
try {
descriptor = archetypeArtifactManager.getFileSetArchetypeDescriptor(groupId, artifactId, version, null,
localRepository, repositories, context.newProjectBuildingRequest());
} catch(UnknownArchetype ex) {
throw new CoreException(Status.error("UnknownArchetype", ex));
try {
File archetypeFile = archetypeArtifactManager.getArchetypeFile(groupId, artifactId, version,
getRemoteRepositories(context), context.getRepositorySession());
if(archetypeArtifactManager.isFileSetArchetype(archetypeFile)) {
ArchetypeDescriptor descriptor = archetypeArtifactManager.getFileSetArchetypeDescriptor(archetypeFile);
return descriptor.getRequiredProperties();
}
return descriptor.getRequiredProperties();
return null;
} catch(UnknownArchetype ex) {
throw new CoreException(Status.error("UnknownArchetype", ex));
}
return null;
}, monitor);
}

public void updateLocalCatalog(Archetype archetype) throws CoreException {
maven.createExecutionContext().execute((ctx, m) -> {
ProjectBuildingRequest request = ctx.newProjectBuildingRequest();
try {
ArchetypeDataSource source = archetypeDataSourceMap.get("catalog");

source.updateCatalog(request, archetype);
LOCAL_CATALOG.updateCatalog(ctx.getRepositorySession(), archetype);
} catch(ArchetypeDataSourceException e) {
}
return null;
}, null);
}

static List<RemoteRepository> getRemoteRepositories(IMavenExecutionContext ctx) throws CoreException {
return RepositoryUtils.toRepos(ctx.getExecutionRequest().getRemoteRepositories());
}
}
4 changes: 0 additions & 4 deletions org.eclipse.m2e.feature/feature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,6 @@
id="org.eclipse.m2e.archetype.descriptor"
version="0.0.0"/>

<plugin
id="org.eclipse.m2e.archetype.maven-artifact-transfer"
version="0.0.0"/>

<plugin
id="org.eclipse.m2e.model.edit"
version="0.0.0"/>
Expand Down
8 changes: 5 additions & 3 deletions org.eclipse.m2e.maven.runtime/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
</parent>

<artifactId>org.eclipse.m2e.maven.runtime</artifactId>
<version>3.9.900-SNAPSHOT</version>
<version>3.9.901-SNAPSHOT</version>
<packaging>jar</packaging>

<name>M2E Embedded Maven Runtime (includes Incubating components)</name>
Expand Down Expand Up @@ -202,8 +202,10 @@
org.slf4j.*;version="[1.7.31,3.0.0)",\
javax.inject;version="[1.0.0,2.0.0)",\
javax.annotation;version="[1.2.0,2.0.0)", \
org.apache.commons.cli;version="[1.4.0,2.0.0)", \
org.apache.commons.codec*
org.apache.commons.cli;version="[1.4.0,2.0.0)",\
org.apache.commons.codec*,\
org.osgi.*,\

Require-Bundle: \
com.google.guava;bundle-version="32.2.1"

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
<dependency>
<groupId>org.eclipse.m2e</groupId>
<artifactId>org.eclipse.m2e.maven.runtime</artifactId>
<version>3.9.900-SNAPSHOT</version>
<version>3.9.901-SNAPSHOT</version>
</dependency>
</dependencies>

Expand Down
Loading
Loading