org.openrewrite.kubernetes.search.FindImage Maven / Gradle / Ivy
Show all versions of rewrite-kubernetes Show documentation
/*
* Copyright 2021 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.kubernetes.search;
import lombok.EqualsAndHashCode;
import lombok.Value;
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;
import org.openrewrite.kubernetes.ContainerImage;
import org.openrewrite.marker.SearchResult;
import org.openrewrite.yaml.YamlIsoVisitor;
import org.openrewrite.yaml.tree.Yaml;
import static org.openrewrite.kubernetes.tree.K8S.Containers.inContainerSpec;
import static org.openrewrite.kubernetes.tree.K8S.Containers.isImageName;
import static org.openrewrite.kubernetes.tree.K8S.InitContainers.inInitContainerSpec;
@Value
@EqualsAndHashCode(callSuper = false)
public class FindImage extends Recipe {
@Option(displayName = "Repository",
description = "The repository part of the image name to search for in containers and initContainers.",
example = "gcr.io",
required = false)
@Nullable
String repository;
@Option(displayName = "Image name",
description = "The image name to search for in containers and initContainers.",
example = "nginx")
String imageName;
@Option(displayName = "Image tag",
description = "The tag part of the image name to search for in containers and initContainers.",
example = "v1.2.3",
required = false)
@Nullable
String imageTag;
@Option(displayName = "Include initContainers",
description = "Boolean to indicate whether or not to treat initContainers/image identically to " +
"containers/image.",
example = "false",
required = false)
boolean includeInitContainers;
@Option(displayName = "Optional file matcher",
description = "Matching files will be modified. This is a glob expression.",
required = false,
example = "**/pod-*.yml")
@Nullable
String fileMatcher;
@Override
public String getDisplayName() {
return "Find image by name";
}
@Override
public String getDescription() {
return "The image name to search for in containers and initContainers.";
}
@Override
public TreeVisitor getVisitor() {
ContainerImage.ImageName imageToSearch = new ContainerImage.ImageName(repository, imageName, imageTag, "*");
String result = imageToSearch.toString();
YamlIsoVisitor visitor = new YamlIsoVisitor() {
@Override
public Yaml.Scalar visitScalar(Yaml.Scalar scalar, ExecutionContext ctx) {
Cursor c = getCursor();
if ((inContainerSpec(c) || (includeInitContainers && inInitContainerSpec(c))) && isImageName(c)) {
ContainerImage image = new ContainerImage(scalar.getValue());
if (image.getImageName().matches(imageToSearch)) {
return SearchResult.found(scalar, result);
}
}
return super.visitScalar(scalar, ctx);
}
};
return fileMatcher != null ? Preconditions.check(new FindSourceFiles(fileMatcher), visitor) : visitor;
}
}