Skip to content

Commit

Permalink
[MASSEMBLY-1008] Fix transitive dependencies resolving with required …
Browse files Browse the repository at this point in the history 
…scope
  • Loading branch information
@slawekjaranowski
slawekjaranowski committed Dec 27, 2023
1 parent 16def83 commit 34e9938
Show file tree
Hide file tree
Showing 3 changed files with 185 additions and 32 deletions.
3 changes: 3 additions & 0 deletions src/it/projects/dependency-sets/massembly-1008/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ under the License.
<groupId>test</groupId>
<artifactId>massembly-1008</artifactId>
<version>1</version>

<url>https://issues.apache.org/jira/browse/MASSEMBLY-1008</url>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
Expand Down
125 changes: 116 additions & 9 deletions src/main/java/org/apache/maven/plugins/assembly/artifact/DefaultDependencyResolver.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,24 @@
import javax.inject.Named;
import javax.inject.Singleton;

import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Deque;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;

import org.apache.maven.RepositoryUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.DefaultArtifact;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.model.DependencyManagement;
import org.apache.maven.plugins.assembly.AssemblerConfigurationSource;
import org.apache.maven.plugins.assembly.archive.ArchiveCreationException;
import org.apache.maven.plugins.assembly.archive.phase.ModuleSetAssemblyPhase;
Expand All @@ -40,14 +49,24 @@
import org.apache.maven.plugins.assembly.model.ModuleSet;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.StringUtils;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.collection.CollectRequest;
import org.eclipse.aether.graph.DefaultDependencyNode;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.graph.DependencyFilter;
import org.eclipse.aether.graph.DependencyNode;
import org.eclipse.aether.graph.DependencyVisitor;
import org.eclipse.aether.resolution.DependencyRequest;
import org.eclipse.aether.resolution.DependencyResult;
import org.eclipse.aether.util.filter.DependencyFilterUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static java.util.Objects.requireNonNull;

/**
* @author jdcasey
*
*/
@Singleton
@Named
Expand All @@ -56,9 +75,12 @@ public class DefaultDependencyResolver implements DependencyResolver {

private final ArtifactHandlerManager artifactHandlerManager;

private final RepositorySystem repositorySystem;

@Inject
public DefaultDependencyResolver(ArtifactHandlerManager artifactHandlerManager) {
public DefaultDependencyResolver(ArtifactHandlerManager artifactHandlerManager, RepositorySystem repositorySystem) {
this.artifactHandlerManager = requireNonNull(artifactHandlerManager);
this.repositorySystem = requireNonNull(repositorySystem);
}

@Override
Expand All @@ -75,7 +97,8 @@ public Map<DependencySet, Set<Artifact>> resolveDependencySets(
final MavenProject currentProject = configSource.getProject();

final ResolutionManagementInfo info = new ResolutionManagementInfo();
updateDependencySetResolutionRequirements(dependencySet, info, currentProject);
updateDependencySetResolutionRequirements(
configSource.getMavenSession().getRepositorySession(), dependencySet, info, currentProject);
updateModuleSetResolutionRequirements(moduleSet, dependencySet, info, configSource);

result.put(dependencySet, info.getArtifacts());
Expand All @@ -96,7 +119,8 @@ public Map<DependencySet, Set<Artifact>> resolveDependencySets(
final MavenProject currentProject = configSource.getProject();

final ResolutionManagementInfo info = new ResolutionManagementInfo();
updateDependencySetResolutionRequirements(dependencySet, info, currentProject);
updateDependencySetResolutionRequirements(
configSource.getMavenSession().getRepositorySession(), dependencySet, info, currentProject);

result.put(dependencySet, info.getArtifacts());
}
Expand Down Expand Up @@ -127,7 +151,10 @@ void updateModuleSetResolutionRequirements(

if (binaries.isIncludeDependencies()) {
updateDependencySetResolutionRequirements(
dependencySet, requirements, projects.toArray(new MavenProject[0]));
configSource.getMavenSession().getRepositorySession(),
dependencySet,
requirements,
projects.toArray(new MavenProject[0]));
}
}
}
Expand All @@ -149,7 +176,10 @@ private Artifact createArtifact(String groupId, String artifactId, String versio
}

void updateDependencySetResolutionRequirements(
final DependencySet set, final ResolutionManagementInfo requirements, final MavenProject... projects)
RepositorySystemSession systemSession,
final DependencySet set,
final ResolutionManagementInfo requirements,
final MavenProject... projects)
throws DependencyResolutionException {
for (final MavenProject project : projects) {
if (project == null) {
Expand All @@ -158,14 +188,91 @@ void updateDependencySetResolutionRequirements(

Set<Artifact> dependencyArtifacts = null;
if (set.isUseTransitiveDependencies()) {
dependencyArtifacts = project.getArtifacts();
try {
// we need resolve project again according to requested scope
dependencyArtifacts = resolveTransitive(systemSession, set.getScope(), project);
} catch (org.eclipse.aether.resolution.DependencyResolutionException e) {
throw new DependencyResolutionException(e.getMessage(), e);
}
} else {
// FIXME remove using deprecated method
dependencyArtifacts = project.getDependencyArtifacts();
}

requirements.addArtifacts(dependencyArtifacts);
LOGGER.debug("Dependencies for project: " + project.getId() + " are:\n"
+ StringUtils.join(dependencyArtifacts.iterator(), "\n"));
if (LOGGER.isDebugEnabled()) {
LOGGER.debug(
"Dependencies for project: {} are:\n{}",
project.getId(),
StringUtils.join(dependencyArtifacts.iterator(), "\n"));
}
}
}

private Set<Artifact> resolveTransitive(
RepositorySystemSession repositorySession, String scope, MavenProject project)
throws org.eclipse.aether.resolution.DependencyResolutionException {

// scope dependency filter
DependencyFilter scoopeDependencyFilter = DependencyFilterUtils.classpathFilter(scope);

// get project dependencies filtered by requested scope
List<Dependency> dependencies = project.getDependencies().stream()
.map(d -> RepositoryUtils.toDependency(d, repositorySession.getArtifactTypeRegistry()))
.filter(d -> scoopeDependencyFilter.accept(new DefaultDependencyNode(d), null))
.collect(Collectors.toList());

List<Dependency> managedDependencies = Optional.ofNullable(project.getDependencyManagement())
.map(DependencyManagement::getDependencies)
.map(list -> list.stream()
.map(d -> RepositoryUtils.toDependency(d, repositorySession.getArtifactTypeRegistry()))
.collect(Collectors.toList()))
.orElse(null);

CollectRequest collectRequest = new CollectRequest();
collectRequest.setManagedDependencies(managedDependencies);
collectRequest.setRepositories(project.getRemoteProjectRepositories());
collectRequest.setDependencies(dependencies);
collectRequest.setRootArtifact(RepositoryUtils.toArtifact(project.getArtifact()));

DependencyRequest request = new DependencyRequest(collectRequest, scoopeDependencyFilter);

DependencyResult dependencyResult = repositorySystem.resolveDependencies(repositorySession, request);

// cache for artifact mapping
Map<org.eclipse.aether.artifact.Artifact, Artifact> etherToMavenArtifacts = new HashMap<>();
Deque<String> stack = new ArrayDeque<>();
stack.push(project.getArtifact().getId());

Set<Artifact> artifacts = new HashSet<>();

// we need rebuild artifact dependencyTrail - it is used by useTransitiveFiltering
dependencyResult.getRoot().accept(new DependencyVisitor() {
@Override
public boolean visitEnter(DependencyNode node) {
if (node.getDependency() != null) {
stack.push(etherToMavenArtifacts
.computeIfAbsent(node.getDependency().getArtifact(), RepositoryUtils::toArtifact)
.getId());
}
return true;
}

@Override
public boolean visitLeave(DependencyNode node) {
if (node.getDependency() != null) {
Artifact artifact =
etherToMavenArtifacts.computeIfAbsent(node.getDependency().getArtifact(), RepositoryUtils::toArtifact);
List<String> depTrail = new ArrayList<>();
stack.descendingIterator().forEachRemaining(depTrail::add);
stack.pop();
artifact.setDependencyTrail(depTrail);
artifacts.add(artifact);
}
return true;
}
});

return artifacts;
}
}
89 changes: 66 additions & 23 deletions src/test/java/org/apache/maven/plugins/assembly/artifact/DefaultDependencyResolverTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,55 +27,84 @@
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.DefaultArtifact;
import org.apache.maven.artifact.handler.DefaultArtifactHandler;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Model;
import org.apache.maven.plugins.assembly.AssemblerConfigurationSource;
import org.apache.maven.plugins.assembly.model.DependencySet;
import org.apache.maven.plugins.assembly.model.ModuleBinaries;
import org.apache.maven.plugins.assembly.model.ModuleSet;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.ContainerConfiguration;
import org.codehaus.plexus.PlexusConstants;
import org.codehaus.plexus.PlexusTestCase;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.graph.DefaultDependencyNode;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.resolution.DependencyRequest;
import org.eclipse.aether.resolution.DependencyResult;
import org.junit.Test;

import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class DefaultDependencyResolverTest extends PlexusTestCase {
@RunWith(MockitoJUnitRunner.class)
public class DefaultDependencyResolverTest {

private DefaultDependencyResolver resolver;
@Mock
private ArtifactHandlerManager artifactHandlerManager;

protected void customizeContainerConfiguration(ContainerConfiguration configuration) {
configuration.setClassPathScanning(PlexusConstants.SCANNING_CACHE).setAutoWiring(true);
}
@Mock
private RepositorySystem repositorySystem;

@Override
public void setUp() throws Exception {
super.setUp();
@Mock
private RepositorySystemSession systemSession;

resolver = (DefaultDependencyResolver) lookup(DependencyResolver.class);
}
@InjectMocks
private DefaultDependencyResolver resolver;

@Test
public void test_getDependencySetResolutionRequirements_transitive() throws DependencyResolutionException {
public void test_getDependencySetResolutionRequirements_transitive() throws Exception {
final DependencySet ds = new DependencySet();
ds.setScope(Artifact.SCOPE_SYSTEM);
ds.setUseTransitiveDependencies(true);

final MavenProject project = createMavenProject("main-group", "main-artifact", "1", null);

Set<Artifact> dependencyArtifacts = new HashSet<>();
dependencyArtifacts.add(newArtifact("g.id", "a-id", "1"));
Set<Artifact> artifacts = new HashSet<>(dependencyArtifacts);
Set<Artifact> artifacts = new HashSet<>();
artifacts.add(newArtifact("g.id", "a-id", "1"));
artifacts.add(newArtifact("g.id", "a-id-2", "2"));
project.setArtifacts(artifacts);
project.setDependencyArtifacts(dependencyArtifacts);

DefaultDependencyNode node1 = new DefaultDependencyNode(
new Dependency(new org.eclipse.aether.artifact.DefaultArtifact("g.id:a-id:1"), "runtime"));
DefaultDependencyNode node2 = new DefaultDependencyNode(
new Dependency(new org.eclipse.aether.artifact.DefaultArtifact("g.id:a-id-2:2"), "runtime"));

DependencyResult dependencyResult = new DependencyResult(new DependencyRequest());
DefaultDependencyNode rootDependencyNode = new DefaultDependencyNode((Dependency) null);
rootDependencyNode.setChildren(Arrays.asList(node1, node2));
dependencyResult.setRoot(rootDependencyNode);

when(repositorySystem.resolveDependencies(eq(systemSession), any())).thenReturn(dependencyResult);

final ResolutionManagementInfo info = new ResolutionManagementInfo();
resolver.updateDependencySetResolutionRequirements(ds, info, project);
resolver.updateDependencySetResolutionRequirements(systemSession, ds, info, project);
assertEquals(artifacts, info.getArtifacts());
// dependencyTrail is set
info.getArtifacts().forEach(artifact -> {
assertEquals(2, artifact.getDependencyTrail().size());
assertEquals(
project.getArtifact().getId(), artifact.getDependencyTrail().get(0));
assertEquals(artifact.getId(), artifact.getDependencyTrail().get(1));
});
}

@Test
Expand All @@ -94,7 +123,7 @@ public void test_getDependencySetResolutionRequirements_nonTransitive() throws D
project.setDependencyArtifacts(dependencyArtifacts);

final ResolutionManagementInfo info = new ResolutionManagementInfo();
resolver.updateDependencySetResolutionRequirements(ds, info, project);
resolver.updateDependencySetResolutionRequirements(systemSession, ds, info, project);
assertEquals(dependencyArtifacts, info.getArtifacts());
}

Expand All @@ -118,7 +147,7 @@ public void test_getModuleSetResolutionRequirements_withoutBinaries() throws Dep
}

@Test
public void test_getModuleSetResolutionRequirements_includeDeps() throws DependencyResolutionException {
public void test_getModuleSetResolutionRequirements_includeDeps() throws Exception {
final File rootDir = new File("root");
final MavenProject project = createMavenProject("main-group", "main-artifact", "1", rootDir);
final MavenProject module1 = createMavenProject("main-group", "module-1", "1", new File(rootDir, "module-1"));
Expand All @@ -135,15 +164,29 @@ public void test_getModuleSetResolutionRequirements_includeDeps() throws Depende
final AssemblerConfigurationSource cs = mock(AssemblerConfigurationSource.class);
when(cs.getReactorProjects()).thenReturn(Arrays.asList(project, module1, module2));
when(cs.getProject()).thenReturn(project);
MavenSession mavenSession = mock(MavenSession.class);
when(cs.getMavenSession()).thenReturn(mavenSession);
when(mavenSession.getRepositorySession()).thenReturn(systemSession);

final ResolutionManagementInfo info = new ResolutionManagementInfo();

final ModuleSet ms = new ModuleSet();
final ModuleBinaries mb = new ModuleBinaries();
mb.setIncludeDependencies(true);
ms.setBinaries(mb);
// FIXME - this is not checked - because ms.UseAllReactorProjects is false
ms.addInclude("*:module-1");

DefaultDependencyNode node1 = new DefaultDependencyNode(
new Dependency(new org.eclipse.aether.artifact.DefaultArtifact("group.id:module-1-dep:1"), "runtime"));

DependencyResult dependencyResult = new DependencyResult(new DependencyRequest());
DefaultDependencyNode rootDependencyNode = new DefaultDependencyNode((Dependency) null);
rootDependencyNode.setChildren(Collections.singletonList(node1));
dependencyResult.setRoot(rootDependencyNode);

when(repositorySystem.resolveDependencies(eq(systemSession), any())).thenReturn(dependencyResult);

resolver.updateModuleSetResolutionRequirements(ms, new DependencySet(), info, cs);
assertEquals(module1Artifacts, info.getArtifacts());

Expand Down

0 comments on commit 34e9938

Please sign in to comment.