Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,9 @@ public MavenExecutionPlan calculateExecutionPlan(
throws PluginNotFoundException, PluginResolutionException, LifecyclePhaseNotFoundException,
PluginDescriptorParsingException, MojoNotFoundException, InvalidPluginDescriptorException,
NoPluginFoundForPrefixException, LifecycleNotFoundException, PluginVersionResolutionException {
lifecyclePluginResolver.resolveMissingPluginVersions(project, session);
if (tasks.stream().anyMatch(LifecycleTask.class::isInstance)) {
lifecyclePluginResolver.resolveMissingPluginVersions(project, session);
}

final List<MojoExecution> executions = calculateMojoExecutions(session, project, tasks);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,9 @@ public class DefaultLifecycleTaskSegmentCalculator implements LifecycleTaskSegme

private final MojoDescriptorCreator mojoDescriptorCreator;

private final LifecyclePluginResolver lifecyclePluginResolver;

@Inject
public DefaultLifecycleTaskSegmentCalculator(
MojoDescriptorCreator mojoDescriptorCreator, LifecyclePluginResolver lifecyclePluginResolver) {
public DefaultLifecycleTaskSegmentCalculator(MojoDescriptorCreator mojoDescriptorCreator) {
this.mojoDescriptorCreator = mojoDescriptorCreator;
this.lifecyclePluginResolver = lifecyclePluginResolver;
}

@Override
Expand Down Expand Up @@ -108,8 +104,6 @@ public List<TaskSegment> calculateTaskSegments(MavenSession session, List<String
if (isGoalSpecification(task)) {
// "pluginPrefix[:version]:goal" or "groupId:artifactId[:version]:goal"

lifecyclePluginResolver.resolveMissingPluginVersions(session.getTopLevelProject(), session);

MojoDescriptor mojoDescriptor =
mojoDescriptorCreator.getMojoDescriptor(task, session, session.getTopLevelProject());

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,18 +67,15 @@ public class MojoDescriptorCreator {
private final PluginVersionResolver pluginVersionResolver;
private final BuildPluginManager pluginManager;
private final PluginPrefixResolver pluginPrefixResolver;
private final LifecyclePluginResolver lifecyclePluginResolver;

@Inject
public MojoDescriptorCreator(
PluginVersionResolver pluginVersionResolver,
BuildPluginManager pluginManager,
PluginPrefixResolver pluginPrefixResolver,
LifecyclePluginResolver lifecyclePluginResolver) {
PluginPrefixResolver pluginPrefixResolver) {
this.pluginVersionResolver = pluginVersionResolver;
this.pluginManager = pluginManager;
this.pluginPrefixResolver = pluginPrefixResolver;
this.lifecyclePluginResolver = lifecyclePluginResolver;
}

private Plugin findPlugin(String groupId, String artifactId, Collection<Plugin> plugins) {
Expand Down Expand Up @@ -237,15 +234,6 @@ public MojoDescriptor getMojoDescriptor(String task, MavenSession session, Maven
public Plugin findPluginForPrefix(String prefix, MavenSession session) throws NoPluginFoundForPrefixException {
// [prefix]:[goal]

if (session.getCurrentProject() != null) {
try {
lifecyclePluginResolver.resolveMissingPluginVersions(session.getCurrentProject(), session);
} catch (PluginVersionResolutionException e) {
// not critical here
logger.debug(e.getMessage(), e);
}
}

PluginPrefixRequest prefixRequest = new DefaultPluginPrefixRequest(prefix, session);
PluginPrefixResult prefixResult = pluginPrefixResolver.resolve(prefixRequest);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
import org.apache.maven.lifecycle.NoGoalSpecifiedException;
import org.apache.maven.lifecycle.internal.ExecutionEventCatapult;
import org.apache.maven.lifecycle.internal.GoalTask;
import org.apache.maven.lifecycle.internal.LifecyclePluginResolver;
import org.apache.maven.lifecycle.internal.LifecycleStarter;
import org.apache.maven.lifecycle.internal.LifecycleTask;
import org.apache.maven.lifecycle.internal.MojoDescriptorCreator;
Expand All @@ -61,20 +60,17 @@ public class ConcurrentLifecycleStarter implements LifecycleStarter {
private final ExecutionEventCatapult eventCatapult;
private final DefaultLifecycles defaultLifeCycles;
private final BuildPlanExecutor executor;
private final LifecyclePluginResolver lifecyclePluginResolver;
private final MojoDescriptorCreator mojoDescriptorCreator;

@Inject
public ConcurrentLifecycleStarter(
ExecutionEventCatapult eventCatapult,
DefaultLifecycles defaultLifeCycles,
BuildPlanExecutor executor,
LifecyclePluginResolver lifecyclePluginResolver,
MojoDescriptorCreator mojoDescriptorCreator) {
this.eventCatapult = eventCatapult;
this.defaultLifeCycles = defaultLifeCycles;
this.executor = executor;
this.lifecyclePluginResolver = lifecyclePluginResolver;
this.mojoDescriptorCreator = mojoDescriptorCreator;
}

Expand Down Expand Up @@ -149,8 +145,6 @@ public List<TaskSegment> calculateTaskSegments(MavenSession session, List<String
if (isGoalSpecification(task)) {
// "pluginPrefix[:version]:goal" or "groupId:artifactId[:version]:goal"

lifecyclePluginResolver.resolveMissingPluginVersions(session.getTopLevelProject(), session);

MojoDescriptor mojoDescriptor =
mojoDescriptorCreator.getMojoDescriptor(task, session, session.getTopLevelProject());

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@
import org.apache.maven.plugin.prefix.PluginPrefixRequest;
import org.apache.maven.plugin.prefix.PluginPrefixResolver;
import org.apache.maven.plugin.prefix.PluginPrefixResult;
import org.apache.maven.plugin.version.DefaultPluginVersionRequest;
import org.apache.maven.plugin.version.PluginVersionResolver;
import org.eclipse.aether.DefaultRepositorySystemSession;
import org.eclipse.aether.RepositoryEvent;
import org.eclipse.aether.RepositoryEvent.EventType;
Expand Down Expand Up @@ -77,13 +79,18 @@ public class DefaultPluginPrefixResolver implements PluginPrefixResolver {
private final BuildPluginManager pluginManager;
private final RepositorySystem repositorySystem;
private final MetadataReader metadataReader;
private final PluginVersionResolver pluginVersionResolver;

@Inject
public DefaultPluginPrefixResolver(
BuildPluginManager pluginManager, RepositorySystem repositorySystem, MetadataReader metadataReader) {
BuildPluginManager pluginManager,
RepositorySystem repositorySystem,
MetadataReader metadataReader,
PluginVersionResolver pluginVersionResolver) {
this.pluginManager = pluginManager;
this.repositorySystem = repositorySystem;
this.metadataReader = metadataReader;
this.pluginVersionResolver = pluginVersionResolver;
}

@Override
Expand Down Expand Up @@ -167,6 +174,13 @@ private PluginPrefixResult resolveFromProject(
private PluginPrefixResult doResolveFromProject(PluginPrefixRequest request, Collection<Plugin> plugins) {
for (Plugin plugin : plugins) {
try {
if (plugin.getVersion() == null) {
DefaultPluginVersionRequest versionRequest = new DefaultPluginVersionRequest(
plugin, request.getRepositorySession(), request.getRepositories())
.setPom(request.getPom());
plugin.setVersion(
pluginVersionResolver.resolve(versionRequest).getVersion());
}
PluginDescriptor pluginDescriptor =
pluginManager.loadPlugin(plugin, request.getRepositories(), request.getRepositorySession());

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/*
* 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.apache.maven.lifecycle.internal;

import java.util.List;
import java.util.Map;

import org.apache.maven.execution.MavenSession;
import org.apache.maven.lifecycle.DefaultLifecycles;
import org.apache.maven.lifecycle.Lifecycle;
import org.apache.maven.lifecycle.LifecycleMappingDelegate;
import org.apache.maven.plugin.BuildPluginManager;
import org.apache.maven.plugin.descriptor.MojoDescriptor;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.project.MavenProject;
import org.junit.jupiter.api.Test;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class DefaultLifecycleExecutionPlanCalculatorTest {
@Test
void doesNotResolveProjectPluginsForDirectGoal() throws Exception {
MojoDescriptorCreator mojoDescriptorCreator = mock(MojoDescriptorCreator.class);
LifecyclePluginResolver lifecyclePluginResolver = mock(LifecyclePluginResolver.class);
MavenSession session = mock(MavenSession.class);
MavenProject project = new MavenProject();

PluginDescriptor pluginDescriptor = new PluginDescriptor();
pluginDescriptor.setGroupId("org.apache.maven.plugins");
pluginDescriptor.setArtifactId("maven-help-plugin");
pluginDescriptor.setVersion("1.0");
MojoDescriptor mojoDescriptor = new MojoDescriptor();
mojoDescriptor.setPluginDescriptor(pluginDescriptor);
mojoDescriptor.setGoal("help");
when(mojoDescriptorCreator.getMojoDescriptor("help:help", session, project))
.thenReturn(mojoDescriptor);

DefaultLifecycleExecutionPlanCalculator calculator = new DefaultLifecycleExecutionPlanCalculator(
mock(BuildPluginManager.class),
mock(DefaultLifecycles.class),
mojoDescriptorCreator,
lifecyclePluginResolver);

calculator.calculateExecutionPlan(session, project, List.of(new GoalTask("help:help")), false);

verify(lifecyclePluginResolver, never()).resolveMissingPluginVersions(project, session);
}

@Test
void resolvesProjectPluginsForLifecycleTask() throws Exception {
LifecyclePluginResolver lifecyclePluginResolver = mock(LifecyclePluginResolver.class);
MavenSession session = mock(MavenSession.class);
MavenProject project = new MavenProject();
DefaultLifecycles defaultLifecycles = mock(DefaultLifecycles.class);
Lifecycle lifecycle = new Lifecycle("default", List.of("validate"), Map.of());
LifecycleMappingDelegate lifecycleMappingDelegate = mock(LifecycleMappingDelegate.class);

when(defaultLifecycles.get("validate")).thenReturn(lifecycle);
when(lifecycleMappingDelegate.calculateLifecycleMappings(session, project, lifecycle, "validate"))
.thenReturn(Map.of());

DefaultLifecycleExecutionPlanCalculator calculator = new DefaultLifecycleExecutionPlanCalculator(
mock(BuildPluginManager.class),
defaultLifecycles,
mock(MojoDescriptorCreator.class),
lifecyclePluginResolver,
lifecycleMappingDelegate,
Map.of(),
Map.of());

calculator.calculateExecutionPlan(session, project, List.of(new LifecycleTask("validate")), false);

verify(lifecyclePluginResolver).resolveMissingPluginVersions(project, session);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,7 @@ public static LifecycleExecutionPlanCalculator createExecutionPlaceCalculator(

public static MojoDescriptorCreator createMojoDescriptorCreator() {
return new MojoDescriptorCreator(
new PluginVersionResolverStub(),
new BuildPluginManagerStub(),
new PluginPrefixResolverStub(),
new LifecyclePluginResolver(new PluginVersionResolverStub()));
new PluginVersionResolverStub(), new BuildPluginManagerStub(), new PluginPrefixResolverStub());
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public class LifecycleTaskSegmentCalculatorStub extends DefaultLifecycleTaskSegm
public static final String INSTALL = "install";

public LifecycleTaskSegmentCalculatorStub() {
super(null, null);
super(null);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/*
* 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.apache.maven.plugin.prefix.internal;

import java.util.List;

import org.apache.maven.artifact.repository.metadata.io.MetadataReader;
import org.apache.maven.model.Build;
import org.apache.maven.model.Model;
import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.BuildPluginManager;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugin.prefix.DefaultPluginPrefixRequest;
import org.apache.maven.plugin.prefix.PluginPrefixResult;
import org.apache.maven.plugin.version.PluginVersionResolver;
import org.apache.maven.plugin.version.PluginVersionResult;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.RepositorySystemSession;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.when;

@ExtendWith(MockitoExtension.class)
class DefaultPluginPrefixResolverTest {
@Mock
private BuildPluginManager pluginManager;

@Mock
private RepositorySystem repositorySystem;

@Mock
private MetadataReader metadataReader;

@Mock
private PluginVersionResolver pluginVersionResolver;

@Mock
private RepositorySystemSession repositorySession;

@Mock
private PluginVersionResult pluginVersionResult;

@Test
void resolvesVersionOnlyForMatchingProjectPlugin() throws Exception {
Plugin matchingPlugin = plugin("com.example", "custom-maven-plugin");
Plugin unrelatedPlugin = plugin("org.apache.maven.plugins", "maven-release-plugin");

Build build = new Build();
build.setPlugins(List.of(unrelatedPlugin, matchingPlugin));
Model model = new Model();
model.setBuild(build);

when(pluginVersionResult.getVersion()).thenReturn("1.0");
when(pluginVersionResolver.resolve(any())).thenReturn(pluginVersionResult);

PluginDescriptor descriptor = new PluginDescriptor();
descriptor.setGroupId(matchingPlugin.getGroupId());
descriptor.setArtifactId(matchingPlugin.getArtifactId());
descriptor.setVersion("1.0");
descriptor.setGoalPrefix("custom");
when(pluginManager.loadPlugin(
argThat(plugin -> matchingPlugin.getArtifactId().equals(plugin.getArtifactId())
&& "1.0".equals(plugin.getVersion())),
eq(List.of()),
eq(repositorySession)))
.thenReturn(descriptor);

DefaultPluginPrefixResolver resolver =
new DefaultPluginPrefixResolver(pluginManager, repositorySystem, metadataReader, pluginVersionResolver);
PluginPrefixResult result = resolver.resolve(new DefaultPluginPrefixRequest()
.setPrefix("custom")
.setPom(model)
.setRepositorySession(repositorySession));

assertEquals(matchingPlugin.getGroupId(), result.getGroupId());
assertEquals(matchingPlugin.getArtifactId(), result.getArtifactId());

verify(pluginVersionResolver)
.resolve(argThat(request ->
matchingPlugin.getArtifactId().equals(request.getArtifactId()) && request.getPom() == model));
verify(pluginVersionResolver, never())
.resolve(argThat(request -> unrelatedPlugin.getArtifactId().equals(request.getArtifactId())));
verify(pluginManager, never())
.loadPlugin(
argThat(plugin -> unrelatedPlugin.getArtifactId().equals(plugin.getArtifactId())),
any(),
eq(repositorySession));
verifyNoInteractions(repositorySystem);
}

private Plugin plugin(String groupId, String artifactId) {
Plugin plugin = new Plugin();
plugin.setGroupId(groupId);
plugin.setArtifactId(artifactId);
return plugin;
}
}