Skip to content

Remove invalid combine.self and combine.children attributes in mvnup #12160

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
+452 −24
Open

Remove invalid combine.self and combine.children attributes in mvnup #12160

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
66 changes: 42 additions & 24 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 @@ -77,6 +77,10 @@ public class CompatibilityFixStrategy extends AbstractUpgradeStrategy {

private static final Pattern EXPRESSION_PATTERN = Pattern.compile("\\$\\{([^}]+)}");

private static final Set<String> VALID_COMBINE_SELF_VALUES = Set.of(COMBINE_OVERRIDE, COMBINE_MERGE, "remove");

private static final Set<String> VALID_COMBINE_CHILDREN_VALUES = Set.of(COMBINE_APPEND, COMBINE_MERGE);

@Override
public boolean isApplicable(UpgradeContext context) {
UpgradeOptions options = getOptions(context);
Expand Down Expand Up @@ -164,44 +168,44 @@ public UpgradeResult doApply(UpgradeContext context, Map<Path, Document> pomMap)

/**
* Fixes unsupported combine.children attribute values.
* Maven 4 only supports 'append' and 'merge', not 'override'.
* Maven 4 only supports 'append' and 'merge' (default is merge).
* Invalid values are removed entirely since Maven 3 silently ignored them.
*/
private boolean fixUnsupportedCombineChildrenAttributes(Document pomDocument, UpgradeContext context) {
boolean fixed = false;
Element root = pomDocument.root();

// Find all elements with combine.children="override" and change to "merge"
long fixedCombineChildrenCount = findElementsWithAttribute(root, COMBINE_CHILDREN, COMBINE_OVERRIDE)
.peek(element -> {
element.attributeObject(COMBINE_CHILDREN).value(COMBINE_MERGE);
context.detail("Fixed: " + COMBINE_CHILDREN + "='" + COMBINE_OVERRIDE + "' → '" + COMBINE_MERGE
+ "' in " + element.name());
})
.count();
fixed |= fixedCombineChildrenCount > 0;
List<Element> invalidElements = findElementsWithInvalidAttribute(
root, COMBINE_CHILDREN, VALID_COMBINE_CHILDREN_VALUES)
.toList();

return fixed;
for (Element element : invalidElements) {
Copy link
Copy Markdown
Contributor

@rmannibucau rmannibucau Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to fail and only run on a valid pom? (to encourage people to review instead of doing a blind silent migration which can just not be desired)?

String invalidValue = element.attribute(COMBINE_CHILDREN);
element.removeAttribute(COMBINE_CHILDREN);
context.detail(
"Fixed: removed invalid " + COMBINE_CHILDREN + "='" + invalidValue + "' from " + element.name());
}

return !invalidElements.isEmpty();
}

/**
* Fixes unsupported combine.self attribute values.
* Maven 4 only supports 'override', 'merge', and 'remove' (default is merge), not 'append'.
* Maven 4 only supports 'override', 'merge', and 'remove' (default is merge).
* Invalid values are removed entirely since Maven 3 silently ignored them.
*/
private boolean fixUnsupportedCombineSelfAttributes(Document pomDocument, UpgradeContext context) {
boolean fixed = false;
Element root = pomDocument.root();

// Find all elements with combine.self="append" and change to "merge"
long fixedCombineSelfCount = findElementsWithAttribute(root, COMBINE_SELF, COMBINE_APPEND)
.peek(element -> {
element.attributeObject(COMBINE_SELF).value(COMBINE_MERGE);
context.detail("Fixed: " + COMBINE_SELF + "='" + COMBINE_APPEND + "' → '" + COMBINE_MERGE + "' in "
+ element.name());
})
.count();
fixed |= fixedCombineSelfCount > 0;
List<Element> invalidElements = findElementsWithInvalidAttribute(root, COMBINE_SELF, VALID_COMBINE_SELF_VALUES)
.toList();

return fixed;
for (Element element : invalidElements) {
String invalidValue = element.attribute(COMBINE_SELF);
element.removeAttribute(COMBINE_SELF);
context.detail("Fixed: removed invalid " + COMBINE_SELF + "='" + invalidValue + "' from " + element.name());
}

return !invalidElements.isEmpty();
}

/**
Expand Down Expand Up @@ -514,6 +518,20 @@ private Stream<Element> findElementsWithAttribute(Element element, String attrib
.flatMap(child -> findElementsWithAttribute(child, attributeName, attributeValue)));
}

/**
* Recursively finds all elements with an attribute whose value is not in the set of valid values.
*/
private Stream<Element> findElementsWithInvalidAttribute(
Element element, String attributeName, Set<String> validValues) {
return Stream.concat(
Stream.of(element).filter(e -> {
String attr = e.attribute(attributeName);
return attr != null && !validValues.contains(attr);
}),
element.childElements()
.flatMap(child -> findElementsWithInvalidAttribute(child, attributeName, validValues)));
}

/**
* Helper methods extracted from BaseUpgradeGoal for compatibility fixes.
*/
Expand Down
Loading
Loading