Skip to content
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

Jump to bottom

[MRELEASE-1154] Never fail for unresolvable version expressions #230

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[MRELEASE-1154] Never fail for unresolvable version expressions #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4aedda
[MRELEASE-1154] Improve exception message for unresolvable version
kwin Aug 27, 2024
9de05da
Never fail for locally unresolvable version expressions
kwin Aug 28, 2024
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
263 changes: 156 additions & 107 deletions ...manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,128 +517,177 @@ private void rewriteArtifactVersions(
if (elements == null) {
return;
}
String projectId = ArtifactUtils.versionlessKey(projectModel.getGroupId(), projectModel.getArtifactId());
for (MavenCoordinate coordinate : elements) {
String rawVersion = coordinate.getVersion();
if (rawVersion == null) {
// managed dependency or unversioned plugin
continue;
}
rewriteArtifactVersion(coordinate, projectModel, properties, result, releaseDescriptor, simulate);
}
}

String rawGroupId = coordinate.getGroupId();
if (rawGroupId == null) {
if ("plugin".equals(coordinate.getName())) {
rawGroupId = "org.apache.maven.plugins";
} else {
// incomplete dependency
continue;
}
}
String groupId = ReleaseUtil.interpolate(rawGroupId, projectModel);
private void rewriteArtifactVersion(
MavenCoordinate artifact,
Model projectModel,
Properties properties,
ReleaseResult result,
ReleaseDescriptor releaseDescriptor,
boolean simulate)
throws ReleaseExecutionException, ReleaseFailureException {
String projectId = ArtifactUtils.versionlessKey(projectModel.getGroupId(), projectModel.getArtifactId());
String rawVersion = artifact.getVersion();
if (rawVersion == null) {
// managed dependency or unversioned plugin
return;
}

String rawArtifactId = coordinate.getArtifactId();
if (rawArtifactId == null) {
// incomplete element
continue;
}
String artifactId = ReleaseUtil.interpolate(rawArtifactId, projectModel);

String key = ArtifactUtils.versionlessKey(groupId, artifactId);
String resolvedSnapshotVersion = getResolvedSnapshotVersion(key, releaseDescriptor);
String mappedVersion = getNextVersion(releaseDescriptor, key);
String originalVersion = getOriginalVersion(releaseDescriptor, key, simulate);
if (originalVersion == null) {
originalVersion = getOriginalResolvedSnapshotVersion(key, releaseDescriptor);
String rawGroupId = artifact.getGroupId();
if (rawGroupId == null) {
if ("plugin".equals(artifact.getName())) {
rawGroupId = "org.apache.maven.plugins";
} else {
// incomplete dependency
return;
}
}
String groupId = ReleaseUtil.interpolate(rawGroupId, projectModel);

// MRELEASE-220
if (mappedVersion != null
&& mappedVersion.endsWith(Artifact.SNAPSHOT_VERSION)
&& !rawVersion.endsWith(Artifact.SNAPSHOT_VERSION)
&& !releaseDescriptor.isUpdateDependencies()) {
continue;
}
String rawArtifactId = artifact.getArtifactId();
if (rawArtifactId == null) {
// incomplete element
return;
}
String artifactId = ReleaseUtil.interpolate(rawArtifactId, projectModel);

String key = ArtifactUtils.versionlessKey(groupId, artifactId);
String resolvedSnapshotVersion = getResolvedSnapshotVersion(key, releaseDescriptor);
String mappedVersion = getNextVersion(releaseDescriptor, key);
String originalVersion = getOriginalVersion(releaseDescriptor, key, simulate);
if (originalVersion == null) {
originalVersion = getOriginalResolvedSnapshotVersion(key, releaseDescriptor);
}

if (mappedVersion != null) {
if (rawVersion.equals(originalVersion)) {
logInfo(result, " Updating " + artifactId + " to " + mappedVersion);
coordinate.setVersion(mappedVersion);
} else {
String property = extractPropertyFromExpression(rawVersion);
if (property != null) {
if (property.startsWith("project.")
|| property.startsWith("pom.")
|| "version".equals(property)) {
if (!mappedVersion.equals(getNextVersion(releaseDescriptor, projectId))) {
logInfo(result, " Updating " + artifactId + " to " + mappedVersion);
coordinate.setVersion(mappedVersion);
} else {
logInfo(result, " Ignoring artifact version update for expression " + rawVersion);
}
} else if (properties != null) {
// version is an expression, check for properties to update instead
String propertyValue = properties.getProperty(property);
if (propertyValue != null) {
if (propertyValue.equals(originalVersion)) {
logInfo(result, " Updating " + rawVersion + " to " + mappedVersion);
// change the property only if the property is the same as what's in the reactor
properties.setProperty(property, mappedVersion);
} else if (mappedVersion.equals(propertyValue)) {
// this property may have been updated during processing a sibling.
logInfo(
result,
" Ignoring artifact version update for expression " + rawVersion
+ " because it is already updated");
} else if (!mappedVersion.equals(rawVersion)) {
// WARNING: ${pom.*} prefix support and ${version} is about to be dropped in mvn4!
// https://issues.apache.org/jira/browse/MNG-7404
// https://issues.apache.org/jira/browse/MNG-7244
if (mappedVersion.matches("\\$\\{project.+\\}")
|| mappedVersion.matches("\\$\\{pom.+\\}")
|| "${version}".equals(mappedVersion)) {
logInfo(
result,
" Ignoring artifact version update for expression " + mappedVersion);
// ignore... we cannot update this expression
} else {
// the value of the expression conflicts with what the user wanted to release
throw new ReleaseFailureException("The artifact (" + key + ") requires a "
+ "different version (" + mappedVersion + ") than what is found ("
+ propertyValue + ") for the expression (" + rawVersion + ") in the "
+ "project (" + projectId + ").");
}
}
} else {
if (CI_FRIENDLY_PROPERTIES.contains(property)) {
logInfo(
result,
" Ignoring artifact version update for CI friendly expression "
+ rawVersion);
} else {
// the expression used to define the version of this artifact may be inherited
// TODO needs a better error message, what pom? what dependency?
throw new ReleaseFailureException(
"Could not find property resolving version expression: " + rawVersion);
}
}
// MRELEASE-220
if (mappedVersion != null
&& mappedVersion.endsWith(Artifact.SNAPSHOT_VERSION)
&& !rawVersion.endsWith(Artifact.SNAPSHOT_VERSION)
&& !releaseDescriptor.isUpdateDependencies()) {
return;
}

if (mappedVersion != null) {
if (rawVersion.equals(originalVersion)) {
logInfo(result, " Updating " + key + " to " + mappedVersion);
artifact.setVersion(mappedVersion);
} else {
String property = extractPropertyFromExpression(rawVersion);
if (property != null) {
if (property.startsWith("project.") || property.startsWith("pom.") || "version".equals(property)) {
// those properties are read-only, replace with literal version in case it is supposed to be
// different from the project's version
if (!mappedVersion.equals(getNextVersion(releaseDescriptor, projectId))) {
logInfo(result, " Updating " + key + " to " + mappedVersion);
artifact.setVersion(mappedVersion);
} else {
// the expression used to define the version of this artifact may be inherited
// TODO needs a better error message, what pom? what dependency?
throw new ReleaseFailureException(
"Could not find properties resolving version expression : " + rawVersion);
logInfo(result, " Ignoring artifact version update for expression " + rawVersion);
}
} else {
// different/previous version not related to current release
rewritePropertyUsedInVersionExpression(
projectId,
key,
rawVersion,
mappedVersion,
originalVersion,
property,
properties,
result,
releaseDescriptor);
}
}
} else if (resolvedSnapshotVersion != null) {
logInfo(result, " Updating " + artifactId + " to " + resolvedSnapshotVersion);
}
} else if (resolvedSnapshotVersion != null) {
logInfo(result, " Updating " + key + " to " + resolvedSnapshotVersion);

coordinate.setVersion(resolvedSnapshotVersion);
artifact.setVersion(resolvedSnapshotVersion);
} else {
// artifact not related to current release
}
}

/**
* This is a best-effort implementation for adjusting property values used in versions to be adjusted.
* It only ever rewrites properties in the non-effective local POM.
* If the property used in the version expression cannot be rewritten this is just logged for informational purposes.
*
* @param projectKey the key of the project where to rewrite
* @param artifactKey the key of the artifact whose version is changed
* @param rawVersion the non interpolated version of the artifact
* @param mappedVersion the new version of the artifact
* @param originalVersion the original version (prior modification) of the artifact in the reactor
* @param property the property referenced in the version expression
* @param properties the local properties of the project (may be {@code null})
* @param result
* @param releaseDescriptor
* @return {@code true} if the property was rewritten, otherwise {@code false}
*/
boolean rewritePropertyUsedInVersionExpression(
String projectKey,
String artifactKey,
String rawVersion,
String mappedVersion,
String originalVersion,
String property,
Properties properties,
ReleaseResult result,
ReleaseDescriptor releaseDescriptor)
throws ReleaseFailureException {
if (properties == null) {
logInfo(
result,
" Ignoring artifact version update for " + artifactKey + " as expression " + rawVersion
+ " cannot be locally resolved");
return false;
}
// check for value of property
boolean isUpdated = false;
String propertyValue = properties.getProperty(property);
if (propertyValue != null) {
if (propertyValue.equals(originalVersion)) {
logInfo(result, " Updating " + rawVersion + " to " + mappedVersion);
// change the property only if the property is the same as what's in the reactor
properties.setProperty(property, mappedVersion);
isUpdated = true;
} else if (mappedVersion.equals(propertyValue)) {
// this property may have been updated during processing a sibling.
logInfo(
result,
" Ignoring artifact version update for expression " + rawVersion
+ " because it is already updated");
} else if (!mappedVersion.equals(rawVersion)) {
// WARNING: ${pom.*} prefix support and ${version} is about to be dropped in mvn4!
// https://issues.apache.org/jira/browse/MNG-7404
// https://issues.apache.org/jira/browse/MNG-7244
if (mappedVersion.matches("\\$\\{project.+\\}")
|| mappedVersion.matches("\\$\\{pom.+\\}")
|| "${version}".equals(mappedVersion)) {
logInfo(result, " Ignoring artifact version update for expression " + mappedVersion);
// ignore... we cannot update this expression
} else {
// the value of the expression conflicts with what the user wanted to release
throw new ReleaseFailureException("The artifact (" + artifactKey + ") requires a "
+ "different version (" + mappedVersion + ") than what is found ("
+ propertyValue + ") for the expression (" + rawVersion + ") in the "
+ "project (" + projectKey + ").");
}
}
} else {
if (CI_FRIENDLY_PROPERTIES.contains(property)) {
logInfo(result, " Ignoring artifact version update for CI friendly expression " + rawVersion);
} else {
// artifact not related to current release
// the expression used to define the version of this artifact may be inherited
logInfo(
Copy link
Member Author

Choose a reason for hiding this comment

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

maybe logWarn is actually better here.

result,
" Ignoring artifact version update for " + artifactKey + " as expression " + rawVersion
+ " cannot be locally resolved");
}
}
return isUpdated;
}

private void prepareScm(
Expand Down
Loading