Skip to content

Fix mvnup: use effective model to resolve properties from remote parents #12158

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
gnodet wants to merge 1 commit into
base: master
Choose a base branch
from
+140 −0
Open

Fix mvnup: use effective model to resolve properties from remote parents #12158

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
14 changes: 14 additions & 0 deletions ...li/src/main/java/org/apache/maven/cling/invoker/mvnup/goals/CompatibilityFixStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ public UpgradeResult doApply(UpgradeContext context, Map<Path, Document> pomMap)
Set<Path> errorPoms = new HashSet<>();

Set<String> allDefinedProperties = collectAllDefinedProperties(pomMap);
allDefinedProperties.addAll(collectEffectiveProperties(context, pomMap));

for (Map.Entry<Path, Document> entry : pomMap.entrySet()) {
Path pomPath = entry.getKey();
Expand Down Expand Up @@ -375,6 +376,19 @@ private void collectPropertiesFromDom(Document document, Set<String> properties)
propsElement.childElements().forEach(child -> properties.add(child.name())))));
}

private Set<String> collectEffectiveProperties(UpgradeContext context, Map<Path, Document> pomMap) {
Set<String> properties = new HashSet<>();
for (Path pomPath : pomMap.keySet()) {
try {
org.apache.maven.api.model.Model effectiveModel = buildEffectiveModel(pomPath);
properties.addAll(effectiveModel.getProperties().keySet());
} catch (Exception e) {
context.debug("Failed to build effective model for " + pomPath + ": " + e.getMessage());
}
}
return properties;
}

/**
* Fixes dependencies with undefined property expressions by commenting them out.
*/
Expand Down
126 changes: 126 additions & 0 deletions ...rc/test/java/org/apache/maven/cling/invoker/mvnup/goals/CompatibilityFixStrategyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -919,6 +919,132 @@ void shouldRecognizePropertyFromGrandparent() throws Exception {
deps.childElements("dependency").count(),
"Dependency should not be commented out when property is inherited from grandparent");
}

@Test
@DisplayName("should not comment out when property is defined in external parent not in reactor")
void shouldNotCommentOutWhenPropertyFromExternalParentNotInReactor() throws Exception {
String externalParentPom = """
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>external-parent</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>
<properties>
<oak.version>1.62.0</oak.version>
</properties>
</project>
""";

String childPom = """
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.example</groupId>
<artifactId>external-parent</artifactId>
<version>1.0.0</version>
<relativePath>../external/pom.xml</relativePath>
</parent>
<artifactId>child</artifactId>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.apache.jackrabbit</groupId>
<artifactId>oak-core</artifactId>
<version>${oak.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
""";

Path externalDir = Files.createDirectories(tempDir.resolve("external"));
Path externalParentPath = externalDir.resolve("pom.xml");
Path childDir = Files.createDirectories(tempDir.resolve("child"));
Path childPomPath = childDir.resolve("pom.xml");

Files.writeString(externalParentPath, externalParentPom);
Files.writeString(childPomPath, childPom);

Document childDoc = Document.of(childPom);
Map<Path, Document> pomMap = Map.of(childPomPath, childDoc);

UpgradeContext context = createMockContext(childDir);
strategy.doApply(context, pomMap);

Element root = childDoc.root();
Element depMgmt = DomUtils.findChildElement(root, "dependencyManagement");
Element deps = DomUtils.findChildElement(depMgmt, "dependencies");
assertEquals(
1,
deps.childElements("dependency").count(),
"Managed dependency should not be commented out when property is inherited from external parent");
}

@Test
@DisplayName("should comment out when property is truly undefined even in effective model")
void shouldCommentOutWhenPropertyTrulyUndefinedInEffectiveModel() throws Exception {
String parentPom = """
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>parent</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>
</project>
""";

String childPom = """
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.example</groupId>
<artifactId>parent</artifactId>
<version>1.0.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>child</artifactId>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>${truly.undefined.prop}</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
""";

Path parentPath = tempDir.resolve("pom.xml");
Path childDir = Files.createDirectories(tempDir.resolve("child"));
Path childPomPath = childDir.resolve("pom.xml");

Files.writeString(parentPath, parentPom);
Files.writeString(childPomPath, childPom);

Document childDoc = Document.of(childPom);
Map<Path, Document> pomMap = Map.of(childPomPath, childDoc);

UpgradeContext context = createMockContext(childDir);
strategy.doApply(context, pomMap);

String xml = DomUtils.toXml(childDoc);
assertTrue(xml.contains("mvnup: commented out"), "Should contain comment-out marker");
assertTrue(xml.contains("truly.undefined.prop"), "Should mention the undefined property");
}
}

@Nested
Expand Down
Loading