Skip to content

Support Maven <exclusions> syntax within target <dependency> elements #2170

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

Open
vogella wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support Maven <exclusions> syntax within target <dependency> elements #2170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
68 changes: 68 additions & 0 deletions ...se.m2e.pde.target.tests/src/org/eclipse/m2e/pde/target/tests/DependencyExclusionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,74 @@ public void testExclusionOfDifferentVersions() throws Exception {
assertTargetBundles(target, includeSource ? withSourceBundles(expectedBundles) : expectedBundles);
}

@Test
public void testMavenExclusionSyntaxOnDependency() throws Exception {
ITargetLocation target = resolveMavenTarget(String.format(
"""
<location includeDependencyDepth="infinite" includeDependencyScopes="compile" includeSource="%s" missingManifest="error" type="Maven">
<dependencies>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-commons</artifactId>
<version>1.9.3</version>
<type>jar</type>
<exclusions>
<exclusion>
<groupId>org.apiguardian</groupId>
<artifactId>apiguardian-api</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</location>
""",
includeSource));
assertStatusOk(target.getStatus());
assertArrayEquals(EMPTY, target.getFeatures());
List<ExpectedBundle> expectedBundles = List.of(junitPlatformCommons("1.9.3"));
assertTargetBundles(target, includeSource ? withSourceBundles(expectedBundles) : expectedBundles);
}

@Test
public void testMavenExclusionSyntaxIsPerDependency() throws Exception {
ITargetLocation target = resolveMavenTarget(String.format(
"""
<location includeDependencyDepth="infinite" includeDependencyScopes="compile" includeSource="%s" missingManifest="error" type="Maven">
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>5.9.3</version>
<type>jar</type>
<exclusions>
<exclusion>
<groupId>org.apiguardian</groupId>
<artifactId>apiguardian-api</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-commons</artifactId>
<version>1.9.3</version>
<type>jar</type>
</dependency>
</dependencies>
</location>
""",
includeSource));
assertStatusOk(target.getStatus());
assertArrayEquals(EMPTY, target.getFeatures());
// apiguardian excluded from junit-jupiter-api's transitive graph,
// but junit-platform-commons (without exclusion) still pulls it in
List<ExpectedBundle> expectedBundles = List.of(//
junitJupiterAPI(), //
junitPlatformCommons("1.9.3"), //
apiGuardian("1.1.2"), //
opentest4j());
assertTargetBundles(target, includeSource ? withSourceBundles(expectedBundles) : expectedBundles);
}

private static ExpectedBundle junitPlatformCommons(String version) {
return originalOSGiBundle("junit-platform-commons", version, "org.junit.platform:junit-platform-commons");
}
Expand Down
10 changes: 9 additions & 1 deletion org.eclipse.m2e.pde.target/src/org/eclipse/m2e/pde/target/MavenTargetDependency.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@
*******************************************************************************/
package org.eclipse.m2e.pde.target;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import org.apache.maven.model.Dependency;
import org.apache.maven.model.Exclusion;
import org.eclipse.aether.graph.DependencyNode;

public final class MavenTargetDependency extends Dependency {
Expand Down Expand Up @@ -66,7 +68,13 @@ public void bind(MavenTargetLocation mavenTargetLocation) {
}

public MavenTargetDependency copy() {
return new MavenTargetDependency(getGroupId(), getArtifactId(), getVersion(), getType(), getClassifier());
MavenTargetDependency copy = new MavenTargetDependency(getGroupId(), getArtifactId(), getVersion(), getType(),
getClassifier());
List<Exclusion> exclusions = getExclusions();
if (!exclusions.isEmpty()) {
copy.setExclusions(new ArrayList<>(exclusions));
}
return copy;
}

public boolean matches(Dependency other) {
Expand Down
18 changes: 17 additions & 1 deletion org.eclipse.m2e.pde.target/src/org/eclipse/m2e/pde/target/MavenTargetLocation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.graph.DependencyNode;
import org.eclipse.aether.graph.Exclusion;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.resolution.VersionRangeRequest;
import org.eclipse.aether.resolution.VersionRangeResolutionException;
Expand Down Expand Up @@ -97,6 +98,8 @@
public static final String ELEMENT_GROUP_ID = "groupId";
public static final String ELEMENT_INSTRUCTIONS = "instructions";
public static final String ELEMENT_EXCLUDED = "exclude";
public static final String ELEMENT_EXCLUSIONS = "exclusions";
public static final String ELEMENT_EXCLUSION = "exclusion";
public static final String ELEMENT_DEPENDENCY = "dependency";
public static final String ELEMENT_DEPENDENCIES = "dependencies";
public static final String ELEMENT_REPOSITORY = "repository";
Expand Down Expand Up @@ -251,8 +254,10 @@
root.getVersion(), root.getType(), root.getClassifier(), repositories, subMonitor.split(80)));
}
if (artifact != null) {
List<Exclusion> exclusions = root.getExclusions().stream()
.map(ex -> new Exclusion(ex.getGroupId(), ex.getArtifactId(), null, null)).toList();
MavenRootDependency dependency = new MavenRootDependency(artifact.getGroupId(), artifact.getArtifactId(),
artifact.getVersion(), artifact.getClassifier(), artifact.getExtension());
artifact.getVersion(), artifact.getClassifier(), artifact.getExtension(), exclusions);
DependencyDepth depth = MavenDependencyCollector.getEffectiveDepth(dependency,
dependencyDepth);
SubMonitor split = subMonitor.split(20);
Expand Down Expand Up @@ -290,7 +295,7 @@

static ICallable<DependencyResult> create(MavenTargetDependency root, MavenRootDependency dependency,
DependencyDepth dependencyDepth, Collection<String> dependencyScopes,
@SuppressWarnings("deprecation") List<ArtifactRepository> repositories, MavenTargetLocation parent,

Check warning on line 298 in org.eclipse.m2e.pde.target/src/org/eclipse/m2e/pde/target/MavenTargetLocation.java

View check run for this annotation

Jenkins - M2E / Compiler

Unnecessary Code 

NORMAL:
Unnecessary @SuppressWarnings("deprecation")
Collection<AdditionalRepository> extra) {
return (context, monitor) -> {
try {
Expand Down Expand Up @@ -600,6 +605,17 @@
element(xml, ELEMENT_VERSION, dependency.getVersion());
element(xml, ELEMENT_TYPE, dependency.getType());
element(xml, ELEMENT_CLASSIFIER, dependency.getClassifier());
List<org.apache.maven.model.Exclusion> depExclusions = dependency.getExclusions();
if (!depExclusions.isEmpty()) {
xml.append("<" + ELEMENT_EXCLUSIONS + ">");
depExclusions.forEach(ex -> {
xml.append("<" + ELEMENT_EXCLUSION + ">");
element(xml, ELEMENT_GROUP_ID, ex.getGroupId());
element(xml, ELEMENT_ARTIFACT_ID, ex.getArtifactId());
xml.append("</" + ELEMENT_EXCLUSION + ">");
});
xml.append("</" + ELEMENT_EXCLUSIONS + ">");
}
xml.append("</" + ELEMENT_DEPENDENCY + ">");
});
xml.append("</" + ELEMENT_DEPENDENCIES + ">");
Expand Down
15 changes: 14 additions & 1 deletion org.eclipse.m2e.pde.target/src/org/eclipse/m2e/pde/target/MavenTargetLocationFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.List;
Expand Down Expand Up @@ -130,7 +131,19 @@ private static MavenTargetDependency parseDependency(Element element) {
String version = getText(MavenTargetLocation.ELEMENT_VERSION, element);
String artifactType = getText(MavenTargetLocation.ELEMENT_TYPE, element);
String classifier = getText(MavenTargetLocation.ELEMENT_CLASSIFIER, element);
return new MavenTargetDependency(groupId, artifactId, version, artifactType, classifier);
MavenTargetDependency dependency = new MavenTargetDependency(groupId, artifactId, version, artifactType,
classifier);
List<org.apache.maven.model.Exclusion> exclusions = descendants(element,
MavenTargetLocation.ELEMENT_EXCLUSION).map(exclusionElement -> {
org.apache.maven.model.Exclusion exclusion = new org.apache.maven.model.Exclusion();
exclusion.setGroupId(getText(MavenTargetLocation.ELEMENT_GROUP_ID, exclusionElement));
exclusion.setArtifactId(getText(MavenTargetLocation.ELEMENT_ARTIFACT_ID, exclusionElement));
return exclusion;
}).toList();
if (!exclusions.isEmpty()) {
dependency.setExclusions(new ArrayList<>(exclusions));
}
return dependency;
}

private static String getText(String tagName, Element location) {
Expand Down
27 changes: 25 additions & 2 deletions ...clipse.m2e.pde.target/src/org/eclipse/m2e/pde/target/shared/MavenDependencyCollector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import org.eclipse.aether.graph.DefaultDependencyNode;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.graph.DependencyNode;
import org.eclipse.aether.graph.Exclusion;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.repository.RepositoryPolicy;
import org.eclipse.aether.resolution.ArtifactDescriptorRequest;
Expand Down Expand Up @@ -91,6 +92,7 @@ public DependencyResult collect(MavenRootDependency root) throws RepositoryExcep
"Invalid root dependency: " + root + " allowed types are " + VALID_EXTENSIONS);
}
DependencyDepth depth = getEffectiveDepth(root, dependencyDepth);
List<Exclusion> exclusions = root.exclusions();
List<RepositoryArtifact> artifacts = new ArrayList<>();
List<DependencyNode> nodes = new ArrayList<>();
ArtifactDescriptor rootDescriptor = readArtifactDescriptor(new Dependency(
Expand All @@ -101,7 +103,9 @@ public DependencyResult collect(MavenRootDependency root) throws RepositoryExcep
}
if (depth == DependencyDepth.DIRECT) {
for (Dependency dependency : rootDescriptor.dependencies()) {
readArtifactDescriptor(dependency, rootDescriptor.node(), artifacts, nodes);
if (!isExcluded(dependency, exclusions)) {
readArtifactDescriptor(dependency, rootDescriptor.node(), artifacts, nodes);
}
}
return new DependencyResult(depth, artifacts, rootDescriptor.node(), nodes);
}
Expand All @@ -113,7 +117,7 @@ public DependencyResult collect(MavenRootDependency root) throws RepositoryExcep
while (!queue.isEmpty()) {
ArtifactDescriptor current = queue.poll();
for (Dependency dependency : current.dependencies()) {
if (isValidDependency(dependency) && isValidScope(dependency)) {
if (isValidDependency(dependency) && isValidScope(dependency) && !isExcluded(dependency, exclusions)) {
if (isVersionRanged(dependency)) {
ArtifactDescriptor dependencyDescriptor = resolveHighestVersion(dependency, current.node(),
artifacts, nodes);
Expand All @@ -134,6 +138,25 @@ public DependencyResult collect(MavenRootDependency root) throws RepositoryExcep
return new DependencyResult(depth, artifacts, rootDescriptor.node(), nodes);
}

private static boolean isExcluded(Dependency dependency, List<Exclusion> exclusions) {
if (exclusions.isEmpty()) {
return false;
}
String groupId = dependency.getArtifact().getGroupId();
String artifactId = dependency.getArtifact().getArtifactId();
for (Exclusion exclusion : exclusions) {
if (matchesPattern(exclusion.getGroupId(), groupId)
&& matchesPattern(exclusion.getArtifactId(), artifactId)) {
return true;
}
}
return false;
}

private static boolean matchesPattern(String pattern, String value) {
return "*".equals(pattern) || pattern.equals(value);
}

private ArtifactDescriptor resolveHighestVersion(Dependency dependency, DependencyNode parent,
Collection<RepositoryArtifact> artifacts, List<DependencyNode> nodes)
throws VersionRangeResolutionException {
Expand Down
23 changes: 16 additions & 7 deletions org.eclipse.m2e.pde.target/src/org/eclipse/m2e/pde/target/shared/MavenRootDependency.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,22 @@
*******************************************************************************/
package org.eclipse.m2e.pde.target.shared;

public record MavenRootDependency(String groupId, String artifactId, String version, String classifier, String type) {
import java.util.List;

public String getType() {
if (type == null || type.isBlank()) {
return "jar";
}
return type;
}
import org.eclipse.aether.graph.Exclusion;

public record MavenRootDependency(String groupId, String artifactId, String version, String classifier, String type,
List<Exclusion> exclusions) {

public MavenRootDependency(String groupId, String artifactId, String version, String classifier, String type) {
this(groupId, artifactId, version, classifier, type, List.of());
}

public String getType() {
if (type == null || type.isBlank()) {
return "jar";
}
return type;
}

}
Loading