org.openrewrite.kubernetes.UpdateContainerImageName Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rewrite-kubernetes Show documentation
A rewrite module automating best practices and migrations for Kubernetes
The newest version!
/*
 *  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;

import lombok.EqualsAndHashCode;
import lombok.Value;
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;
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 UpdateContainerImageName extends Recipe {

    @Option(displayName = "Repository to find",
            description = "The repository part of the image name to search for in containers and initContainers.",
            example = "gcr.io",
            required = false)
    @Nullable
    String repoToFind;

    @Option(displayName = "Image name to find",
            description = "The image name to search for in containers and initContainers.",
            example = "nginx")
    String imageToFind;

    @Option(displayName = "Image tag to find",
            description = "The tag part of the image name to search for in containers and initContainers.",
            example = "v1.2.3",
            required = false)
    @Nullable
    String tagToFind;

    @Option(displayName = "Image digest to find",
            description = "The digest part of the image name to search for in containers and initContainers.",
            example = "sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229",
            required = false)
    @Nullable
    String digestToFind;

    @Option(displayName = "Repository to update",
            description = "The repository part of the image name to update to in containers and initContainers.",
            example = "gcr.io/account/bucket",
            required = false)
    @Nullable
    String repoToUpdate;

    @Option(displayName = "Image name to update",
            description = "The image name to update to in containers and initContainers.",
            example = "nginx",
            required = false)
    @Nullable
    String imageToUpdate;

    @Option(displayName = "Image tag to update",
            description = "The tag part of the image name to update to in containers and initContainers.",
            example = "v1.2.3",
            required = false)
    @Nullable
    String tagToUpdate;

    @Option(displayName = "Image digest to update",
            description = "The digest part of the image name to update to in containers and initContainers.",
            example = "sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229",
            required = false)
    @Nullable
    String digestToUpdate;

    @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 "Update image name";
    }

    @Override
    public String getDescription() {
        return "Search for image names that match patterns and replace the components of the name with new values.";
    }

    @Override
    public TreeVisitor getVisitor() {
        ContainerImage.ImageName imageToSearch = new ContainerImage.ImageName(repoToFind,
                imageToFind,
                tagToFind,
                digestToFind);

        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)) {
                        ContainerImage.ImageName newName = image.getImageName();
                        if (null != repoToUpdate) {
                            newName = newName.withRepository(repoToUpdate);
                        }
                        if (null != imageToUpdate) {
                            newName = newName.withImage(imageToUpdate);
                        }
                        if (null != tagToUpdate) {
                            newName = newName.withTag(tagToUpdate);
                        }
                        if (null != digestToUpdate) {
                            newName = newName.withDigest(digestToUpdate);
                        }
                        return scalar.withValue(newName.toString());
                    }
                }
                return super.visitScalar(scalar, ctx);
            }
        };
        return fileMatcher != null ? Preconditions.check(new FindSourceFiles(fileMatcher), visitor) : visitor;
    }

}