-
Notifications
You must be signed in to change notification settings - Fork 117
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
introduce MojoUtils to encapsulate Mojo parameter retrieval
- Loading branch information
Showing
5 changed files
with
196 additions
and
135 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
185 changes: 185 additions & 0 deletions
185
org.eclipse.m2e.core/src/org/eclipse/m2e/core/internal/embedder/MojoUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| /******************************************************************************* | ||
| * 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: | ||
| * Konrad Windszus - initial implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.m2e.core.internal.embedder; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.eclipse.core.runtime.CoreException; | ||
| import org.eclipse.core.runtime.IProgressMonitor; | ||
| import org.eclipse.core.runtime.Status; | ||
| import org.eclipse.osgi.util.NLS; | ||
|
|
||
| import org.codehaus.plexus.classworlds.realm.ClassRealm; | ||
| import org.codehaus.plexus.component.configurator.ComponentConfigurationException; | ||
| import org.codehaus.plexus.component.configurator.converters.ConfigurationConverter; | ||
| import org.codehaus.plexus.component.configurator.converters.lookup.ConverterLookup; | ||
| import org.codehaus.plexus.component.configurator.converters.lookup.DefaultConverterLookup; | ||
| import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator; | ||
| import org.codehaus.plexus.configuration.PlexusConfiguration; | ||
| import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration; | ||
| import org.codehaus.plexus.util.xml.Xpp3Dom; | ||
|
|
||
| import org.apache.maven.execution.MavenSession; | ||
| import org.apache.maven.model.ConfigurationContainer; | ||
| import org.apache.maven.model.Plugin; | ||
| import org.apache.maven.plugin.BuildPluginManager; | ||
| import org.apache.maven.plugin.InvalidPluginDescriptorException; | ||
| import org.apache.maven.plugin.MojoExecution; | ||
| import org.apache.maven.plugin.MojoNotFoundException; | ||
| import org.apache.maven.plugin.PluginDescriptorParsingException; | ||
| import org.apache.maven.plugin.PluginNotFoundException; | ||
| import org.apache.maven.plugin.PluginParameterExpressionEvaluator; | ||
| import org.apache.maven.plugin.PluginResolutionException; | ||
| import org.apache.maven.plugin.descriptor.MojoDescriptor; | ||
| import org.apache.maven.project.MavenProject; | ||
|
|
||
| import org.eclipse.m2e.core.embedder.IComponentLookup; | ||
| import org.eclipse.m2e.core.embedder.IMaven; | ||
| import org.eclipse.m2e.core.embedder.IMavenExecutionContext; | ||
| import org.eclipse.m2e.core.internal.Messages; | ||
|
|
||
|
|
||
| /** | ||
| * Utility methods to resolve Mojo parameters Still restricted to internal use only until a proper API has been | ||
| * established. | ||
| */ | ||
| public final class MojoUtils { | ||
|
|
||
| private final ConverterLookup converterLookup; | ||
| private final IComponentLookup componentManager; | ||
| private final ClassLoader classLoader; | ||
| private final IMavenExecutionContext executionContext; | ||
|
|
||
| public MojoUtils(IComponentLookup componentManager, ClassLoader classLoader, | ||
| IMavenExecutionContext executionContext) { | ||
| super(); | ||
| this.converterLookup = new DefaultConverterLookup(); | ||
| this.componentManager = componentManager; | ||
| this.classLoader = classLoader; | ||
| this.executionContext = executionContext; | ||
| } | ||
|
|
||
| public <T> T getParameterValue(MavenProject project, String parameter, Class<T> type, Plugin plugin, | ||
| ConfigurationContainer configuration, String goal, IProgressMonitor monitor) throws CoreException { | ||
| return executionContext.execute(project, | ||
| (context, pm) -> getParameterValue(parameter, type, context.getSession(), plugin, configuration, goal), | ||
| monitor); | ||
| } | ||
|
|
||
| public <T> T getParameterValue(MavenProject project, MojoExecution mojoExecution, String parameter, | ||
| Class<T> asType, IProgressMonitor monitor) throws CoreException { | ||
| return executionContext.execute(project, | ||
| (context, pm) -> getParameterValue(context.getSession(), mojoExecution, List.of(parameter), asType), | ||
| monitor); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves a nested configuration parameter from the given {@code mojoExecution}. It coerces from String to the given | ||
| * type and considers expressions and default values. | ||
| * | ||
| * @param <T> | ||
| * @param project the Maven project | ||
| * @param mojoExecution the mojo execution from which to retrieve the configuration value | ||
| * @param parameterPath the path of the parameter to look up, the first item is the name of the element directly below | ||
| * {@code <configuration>} and the last one is the element containing the actual value | ||
| * @param asType the type to coerce to | ||
| * @param monitor the progress monitor | ||
| * @return the parameter value or {@code null} if the parameter with the given name was not found | ||
| * @throws CoreException | ||
| * @see IMaven#getMojoParameterValue(MavenProject, MojoExecution, String, Class, IProgressMonitor) | ||
| */ | ||
| public <T> T getParameterValue(MavenProject project, MojoExecution mojoExecution, List<String> parameterPath, | ||
| Class<T> asType, IProgressMonitor monitor) throws CoreException { | ||
| return executionContext.execute(project, | ||
| (context, pm) -> getParameterValue(context.getSession(), mojoExecution, parameterPath, asType), monitor); | ||
| } | ||
|
|
||
| private <T> T getParameterValue(MavenSession session, MojoExecution mojoExecution, List<String> parameterPath, | ||
| Class<T> asType) throws CoreException { | ||
| Xpp3Dom dom = mojoExecution.getConfiguration(); | ||
| if(dom == null) { | ||
| return null; | ||
| } | ||
| PlexusConfiguration configuration = new XmlPlexusConfiguration(dom); | ||
| for(String parameter : parameterPath) { | ||
| configuration = configuration.getChild(parameter); | ||
| if(configuration == null) { | ||
| return null; | ||
| } | ||
| } | ||
| return getParameterValue(session, mojoExecution, configuration, asType, String.join("/", parameterPath)); | ||
| } | ||
|
|
||
| private <T> T getParameterValue(MavenSession session, MojoExecution mojoExecution, | ||
| PlexusConfiguration configuration, Class<T> asType, String parameterLabel) throws CoreException { | ||
| try { | ||
| MojoDescriptor mojoDescriptor = mojoExecution.getMojoDescriptor(); | ||
|
|
||
| ClassRealm pluginRealm = componentManager.lookup(BuildPluginManager.class).getPluginRealm(session, | ||
| mojoDescriptor.getPluginDescriptor()); | ||
|
|
||
| ExpressionEvaluator expressionEvaluator = new PluginParameterExpressionEvaluator(session, mojoExecution); | ||
| ConfigurationConverter typeConverter = converterLookup.lookupConverterForType(asType); | ||
|
|
||
| Object value = typeConverter.fromConfiguration(converterLookup, configuration, asType, | ||
| mojoDescriptor.getImplementationClass(), pluginRealm, expressionEvaluator, null); | ||
| return asType.cast(value); | ||
| } catch(Exception e) { | ||
| throw new CoreException(Status.error( | ||
| NLS.bind(Messages.MavenImpl_error_param_for_execution, parameterLabel, mojoExecution.getExecutionId()), e)); | ||
| } | ||
| } | ||
|
|
||
| private <T> T getParameterValue(String parameter, Class<T> type, MavenSession session, Plugin plugin, | ||
| ConfigurationContainer configuration, String goal) throws CoreException { | ||
| Xpp3Dom config = (Xpp3Dom) configuration.getConfiguration(); | ||
| config = (config != null) ? config.getChild(parameter) : null; | ||
|
|
||
| PlexusConfiguration paramConfig = null; | ||
|
|
||
| if(config == null) { | ||
| MojoDescriptor mojoDescriptor; | ||
|
|
||
| try { | ||
| mojoDescriptor = componentManager.lookup(BuildPluginManager.class).getMojoDescriptor(plugin, goal, | ||
| session.getCurrentProject().getRemotePluginRepositories(), session.getRepositorySession()); | ||
| } catch(PluginNotFoundException | PluginResolutionException | PluginDescriptorParsingException | ||
| | MojoNotFoundException | InvalidPluginDescriptorException ex) { | ||
| throw new CoreException(Status.error(Messages.MavenImpl_error_param, ex)); | ||
| } | ||
|
|
||
| PlexusConfiguration defaultConfig = mojoDescriptor.getMojoConfiguration(); | ||
| if(defaultConfig != null) { | ||
| paramConfig = defaultConfig.getChild(parameter, false); | ||
| } | ||
| } else { | ||
| paramConfig = new XmlPlexusConfiguration(config); | ||
| } | ||
|
|
||
| if(paramConfig == null) { | ||
| return null; | ||
| } | ||
|
|
||
| try { | ||
| MojoExecution mojoExecution = new MojoExecution(plugin, goal, "default"); //$NON-NLS-1$ | ||
|
|
||
| ExpressionEvaluator expressionEvaluator = new PluginParameterExpressionEvaluator(session, mojoExecution); | ||
|
|
||
| ConfigurationConverter typeConverter = converterLookup.lookupConverterForType(type); | ||
|
|
||
| Object value = typeConverter.fromConfiguration(converterLookup, paramConfig, type, Object.class, | ||
| classLoader, expressionEvaluator, null); | ||
| return type.cast(value); | ||
| } catch(ComponentConfigurationException | ClassCastException ex) { | ||
| throw new CoreException(Status.error(Messages.MavenImpl_error_param, ex)); | ||
| } | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.