Skip to content
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.

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

[MNG-6326] Make the build fail if core extensions can not be loaded #648

Merged
merged 4 commits into from Jan 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
86 changes: 37 additions & 49 deletions maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
Expand Up @@ -705,6 +705,7 @@ protected void configure()

private List<CoreExtensionEntry> loadCoreExtensions( CliRequest cliRequest, ClassRealm containerRealm,
Set<String> providedArtifacts )
throws Exception
{
if ( cliRequest.multiModuleProjectDirectory == null )
{
Expand All @@ -717,75 +718,62 @@ private List<CoreExtensionEntry> loadCoreExtensions( CliRequest cliRequest, Clas
return Collections.emptyList();
}

try
List<CoreExtension> extensions = readCoreExtensionsDescriptor( extensionsFile );
if ( extensions.isEmpty() )
{
List<CoreExtension> extensions = readCoreExtensionsDescriptor( extensionsFile );
if ( extensions.isEmpty() )
{
return Collections.emptyList();
}
return Collections.emptyList();
}

ContainerConfiguration cc = new DefaultContainerConfiguration() //
.setClassWorld( cliRequest.classWorld ) //
.setRealm( containerRealm ) //
.setClassPathScanning( PlexusConstants.SCANNING_INDEX ) //
.setAutoWiring( true ) //
.setJSR250Lifecycle( true ) //
.setName( "maven" );
ContainerConfiguration cc = new DefaultContainerConfiguration() //
.setClassWorld( cliRequest.classWorld ) //
.setRealm( containerRealm ) //
.setClassPathScanning( PlexusConstants.SCANNING_INDEX ) //
.setAutoWiring( true ) //
.setJSR250Lifecycle( true ) //
.setName( "maven" );

DefaultPlexusContainer container = new DefaultPlexusContainer( cc, new AbstractModule()
DefaultPlexusContainer container = new DefaultPlexusContainer( cc, new AbstractModule()
{
@Override
protected void configure()
{
@Override
protected void configure()
{
bind( ILoggerFactory.class ).toInstance( slf4jLoggerFactory );
}
} );
bind( ILoggerFactory.class ).toInstance( slf4jLoggerFactory );
}
} );

try
{
container.setLookupRealm( null );
try
{
container.setLookupRealm( null );

container.setLoggerManager( plexusLoggerManager );
container.setLoggerManager( plexusLoggerManager );

container.getLoggerManager().setThresholds( cliRequest.request.getLoggingLevel() );
container.getLoggerManager().setThresholds( cliRequest.request.getLoggingLevel() );

Thread.currentThread().setContextClassLoader( container.getContainerRealm() );
Thread.currentThread().setContextClassLoader( container.getContainerRealm() );

executionRequestPopulator = container.lookup( MavenExecutionRequestPopulator.class );
executionRequestPopulator = container.lookup( MavenExecutionRequestPopulator.class );

configurationProcessors = container.lookupMap( ConfigurationProcessor.class );
configurationProcessors = container.lookupMap( ConfigurationProcessor.class );

configure( cliRequest );
configure( cliRequest );

MavenExecutionRequest request = DefaultMavenExecutionRequest.copy( cliRequest.request );
MavenExecutionRequest request = DefaultMavenExecutionRequest.copy( cliRequest.request );

request = populateRequest( cliRequest, request );
request = populateRequest( cliRequest, request );

request = executionRequestPopulator.populateDefaults( request );
request = executionRequestPopulator.populateDefaults( request );

BootstrapCoreExtensionManager resolver = container.lookup( BootstrapCoreExtensionManager.class );
BootstrapCoreExtensionManager resolver = container.lookup( BootstrapCoreExtensionManager.class );

return Collections.unmodifiableList( resolver.loadCoreExtensions( request, providedArtifacts,
extensions ) );
return Collections.unmodifiableList( resolver.loadCoreExtensions( request, providedArtifacts,
extensions ) );

}
finally
{
executionRequestPopulator = null;
container.dispose();
}
}
catch ( RuntimeException e )
{
// runtime exceptions are most likely bugs in maven, let them bubble up to the user
throw e;
}
catch ( Exception e )
finally
{
slf4jLogger.warn( "Failed to read extensions descriptor {}: {}", extensionsFile, e.getMessage() );
gnodet marked this conversation as resolved.
Show resolved Hide resolved
executionRequestPopulator = null;
container.dispose();
}
return Collections.emptyList();
}

private List<CoreExtension> readCoreExtensionsDescriptor( File extensionsFile )
Expand Down
Expand Up @@ -128,19 +128,30 @@ private CoreExtensionEntry createExtension( CoreExtension extension, List<Artifa

private List<Artifact> resolveExtension( CoreExtension extension, RepositorySystemSession repoSession,
List<RemoteRepository> repositories, DependencyFilter dependencyFilter )
throws PluginResolutionException
throws ExtensionResolutionException
{
Plugin plugin = new Plugin();
plugin.setGroupId( extension.getGroupId() );
plugin.setArtifactId( extension.getArtifactId() );
plugin.setVersion( extension.getVersion() );

DependencyNode root =
pluginDependenciesResolver.resolveCoreExtension( plugin, dependencyFilter, repositories, repoSession );
PreorderNodeListGenerator nlg = new PreorderNodeListGenerator();
root.accept( nlg );
List<Artifact> artifacts = nlg.getArtifacts( false );

return artifacts;
try
{
// TODO: enhance the PluginDependenciesResolver to provide a
// TODO: resolveCoreExtension method which uses a CoreExtension
// TODO: object instead of a Plugin as this makes no sense
Plugin plugin = new Plugin();
plugin.setGroupId( extension.getGroupId() );
plugin.setArtifactId( extension.getArtifactId() );
plugin.setVersion( extension.getVersion() );

DependencyNode root = pluginDependenciesResolver
michael-o marked this conversation as resolved.
Show resolved Hide resolved
.resolveCoreExtension( plugin, dependencyFilter, repositories, repoSession );
PreorderNodeListGenerator nlg = new PreorderNodeListGenerator();
root.accept( nlg );
List<Artifact> artifacts = nlg.getArtifacts( false );

return artifacts;
}
catch ( PluginResolutionException e )
{
throw new ExtensionResolutionException( extension, e.getCause() );
}
}

}
@@ -0,0 +1,47 @@
package org.apache.maven.cli.internal;

/*
* 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.
*/

import org.apache.maven.cli.internal.extension.model.CoreExtension;

/**
* Exception occurring trying to resolve a plugin.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
public class ExtensionResolutionException
extends Exception
{

private final CoreExtension extension;

public ExtensionResolutionException( CoreExtension extension, Throwable cause )
{
super( "Extension " + extension.getId() + " or one of its dependencies could not be resolved: "
+ cause.getMessage(), cause );
michael-o marked this conversation as resolved.
Show resolved Hide resolved
this.extension = extension;
}

public CoreExtension getExtension()
{
return extension;
}

}
26 changes: 26 additions & 0 deletions maven-embedder/src/main/mdo/core-extensions.mdo
Expand Up @@ -83,6 +83,32 @@
<type>String</type>
</field>
</fields>
<codeSegments>
<codeSegment>
<version>1.0.0+</version>
<code>
<![CDATA[
/**
* Gets the identifier of the extension.
*
* @return The extension id in the form {@code <groupId>:<artifactId>:<version>}, never {@code null}.
*/
public String getId()
{
StringBuilder id = new StringBuilder( 128 );

id.append( ( getGroupId() == null ) ? "[unknown-group-id]" : getGroupId() );
id.append( ":" );
id.append( ( getArtifactId() == null ) ? "[unknown-artifact-id]" : getArtifactId() );
id.append( ":" );
id.append( ( getVersion() == null ) ? "[unknown-version]" : getVersion() );

return id.toString();
}
]]>
</code>
</codeSegment>
</codeSegments>
</class>
</classes>
</model>