org.openrewrite.jenkins.AddPluginsBom Maven / Gradle / Ivy
Show all versions of rewrite-jenkins Show documentation
/*
* Copyright 2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.jenkins;
import lombok.EqualsAndHashCode;
import lombok.Value;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.marker.Markers;
import org.openrewrite.maven.AddManagedDependency;
import org.openrewrite.maven.ChangeManagedDependencyGroupIdAndArtifactId;
import org.openrewrite.maven.MavenIsoVisitor;
import org.openrewrite.maven.RemoveRedundantDependencyVersions;
import org.openrewrite.maven.tree.*;
import org.openrewrite.xml.RemoveContentVisitor;
import org.openrewrite.xml.tree.Xml;
import java.util.LinkedList;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import static java.util.Collections.emptyList;
@Value
@EqualsAndHashCode(callSuper = false)
public class AddPluginsBom extends Recipe {
private static final BomLookup LOOKUP = new BomLookup();
private static final String PLUGINS_BOM_GROUP_ID = "io.jenkins.tools.bom";
private static final String LATEST_RELEASE = "latest.release";
private static final String VERSION_METADATA_PATTERN = "\\.v[a-f0-9_]+";
private static final String PLUGIN_BOMS_KEY = "pluginBoms";
private static final String PLUGIN_BOM_NAME_KEY = "pluginBomName";
@Override
public String getDisplayName() {
return "Add or correct Jenkins plugins BOM";
}
@Override
public String getDescription() {
return "Adds [Jenkins plugins BOM](https://www.jenkins.io/doc/developer/plugin-development/dependency-management/#jenkins-plugin-bom) " +
"at the latest release if the project depends on any managed versions or an outdated BOM is present. " +
"BOMs are expected to be synchronized to Jenkins LTS versions, so this will also remove any mismatched BOMs (Such as using Jenkins 2.387.3, but importing bom-2.319.x). " +
"If the expected BOM is already added, the version will not be upgraded.";
}
@Override
public TreeVisitor getVisitor() {
return new MavenIsoVisitor() {
@Override
public Xml.Document visitDocument(Xml.Document document, ExecutionContext ctx) {
Markers m = document.getMarkers();
Optional maybeMavenResult = m.findFirst(MavenResolutionResult.class);
if (!maybeMavenResult.isPresent()) {
return document;
}
if (Jenkins.isJenkinsPluginPom(document) == null) {
return document;
}
MavenResolutionResult result = maybeMavenResult.get();
ResolvedPom resolvedPom = result.getPom();
Pom pom = resolvedPom.getRequested();
List dependencyManagement = pom.getDependencyManagement();
boolean bomFound = false;
for (ManagedDependency md : dependencyManagement) {
if (PLUGINS_BOM_GROUP_ID.equals(md.getGroupId())) {
bomFound = true;
break;
}
}
boolean hasDependencyInBom = false;
List dependencies = pom.getDependencies();
for (Dependency dependency : dependencies) {
String groupId = dependency.getGroupId();
String version = dependency.getVersion();
if (groupId == null || version == null) {
continue;
}
if (LOOKUP.inBom(groupId, dependency.getArtifactId())) {
hasDependencyInBom = true;
doAfterVisit(new RemoveRedundantDependencyVersions(
groupId,
dependency.getArtifactId(),
false,
null
).getVisitor());
}
}
Xml.Document d = super.visitDocument(document, ctx);
String bomName = getCursor().getMessage(PLUGIN_BOM_NAME_KEY);
if (bomName == null) {
throw new IllegalStateException("Could not find jenkins.version property");
}
if (!bomFound && hasDependencyInBom) {
return (Xml.Document) new AddManagedDependency(
PLUGINS_BOM_GROUP_ID,
bomName,
LATEST_RELEASE,
"import",
"pom",
null,
VERSION_METADATA_PATTERN,
true,
null,
null
).getVisitor().visitNonNull(d, ctx, getCursor().getParentOrThrow());
} else if (bomFound) {
Xml.Tag exact = null;
Xml.Tag change = null;
List pluginBoms = getCursor().getMessage(PLUGIN_BOMS_KEY, emptyList());
for (Xml.Tag bom : pluginBoms) {
String artifactId = bom.getChildValue("artifactId")
.orElseThrow(() -> new IllegalStateException("No artifactId found on bom"));
if (artifactId.equals(bomName) && exact == null) {
exact = bom;
} else if (change == null) {
change = bom;
} else {
doAfterVisit(new RemoveContentVisitor<>(bom, true));
}
}
if (exact != null && change != null) {
doAfterVisit(new RemoveContentVisitor<>(change, true));
} else if (change != null) {
String artifactId = change.getChildValue("artifactId")
.orElseThrow(() -> new IllegalStateException("No artifactId found on bom"));
doAfterVisit(new ChangeManagedDependencyGroupIdAndArtifactId(
PLUGINS_BOM_GROUP_ID,
artifactId,
PLUGINS_BOM_GROUP_ID,
bomName,
LATEST_RELEASE,
VERSION_METADATA_PATTERN
).getVisitor());
}
}
return d;
}
@Override
public Xml.Tag visitTag(Xml.Tag tag, ExecutionContext ctx) {
Xml.Tag t = super.visitTag(tag, ctx);
if (isManagedDependencyTag()) {
String groupId = tag.getChildValue("groupId").orElse("");
String artifactId = tag.getChildValue("artifactId").orElse("");
if (PLUGINS_BOM_GROUP_ID.equals(groupId) && !artifactId.isEmpty()) {
List pluginBoms = getCursor().getNearestMessage(PLUGIN_BOMS_KEY, new LinkedList<>());
pluginBoms.add(t);
getCursor().putMessageOnFirstEnclosing(Xml.Document.class, PLUGIN_BOMS_KEY, pluginBoms);
}
} else if (isPropertyTag() && Objects.equals("jenkins.version", t.getName())) {
String jenkinsVersion = t.getValue().orElseThrow(() ->
new IllegalStateException("No value found for jenkins.version property tag"));
String bomName = Jenkins.bomNameForJenkinsVersion(jenkinsVersion);
getCursor().putMessageOnFirstEnclosing(Xml.Document.class, PLUGIN_BOM_NAME_KEY, bomName);
}
return t;
}
};
}
}