annotate.go

package annotate

import (
	"fmt"
	"sort"
	"strings"

	"github.com/jenkins-x-plugins/jx-gitops/pkg/rootcmd"
	"github.com/jenkins-x/jx-helpers/v3/pkg/cobras/helper"
	"github.com/jenkins-x/jx-helpers/v3/pkg/cobras/templates"
	"github.com/jenkins-x/jx-helpers/v3/pkg/kyamls"
	"github.com/pkg/errors"
	"github.com/spf13/cobra"
	"sigs.k8s.io/kustomize/kyaml/yaml"
)

var (
	annotateLong = templates.LongDesc(`
		Annotates all kubernetes resources in the given directory tree
`)

	annotateExample = templates.Examples(`
		# updates recursively annotates all resources in the current directory 
		%s annotate myannotate=cheese another=thing
		# updates recursively all resources
		%s annotate --dir myresource-dir foo=bar
	`)
)

// AnnotateOptions the options for the command
type Options struct {
	kyamls.Filter
	Dir      string
	Annotate string
	PodSpec  bool
}

// NewCmdUpdate creates a command object for the command
func NewCmdUpdateAnnotate() (*cobra.Command, *Options) {
	o := &Options{}

	cmd := &cobra.Command{
		Use:     "annotate",
		Short:   "Annotates all kubernetes resources in the given directory tree",
		Long:    annotateLong,
		Example: fmt.Sprintf(annotateExample, rootcmd.BinaryName, rootcmd.BinaryName),
		Run: func(cmd *cobra.Command, args []string) {
			err := UpdateAnnotateInYamlFiles(o.Dir, args, o.Filter, o.PodSpec)
			helper.CheckErr(err)
		},
	}
	cmd.Flags().StringVarP(&o.Dir, "dir", "", ".", "the directory to recursively look for the *.yaml or *.yml files")
	cmd.Flags().BoolVarP(&o.PodSpec, "pod-spec", "p", false, "annotate the PodSpec in spec.templates.metadata.annotations rather than the top level annotations")
	o.Filter.AddFlags(cmd)
	return cmd, o
}

// UpdateAnnotateInYamlFiles updates the annotations in yaml files
func UpdateAnnotateInYamlFiles(dir string, annotations []string, filter kyamls.Filter, podSpec bool) error { //nolint:gocritic
	modifyFn := func(node *yaml.RNode, path string) (bool, error) {
		sort.Strings(annotations)

		for _, a := range annotations {
			paths := strings.SplitN(a, "=", 2)
			k := paths[0]
			v := ""
			if len(paths) > 1 {
				v = paths[1]
			}

			if podSpec {
				vn := yaml.NewScalarRNode(v)
				vn.YNode().Tag = yaml.NodeTagString
				vn.YNode().Style = yaml.SingleQuotedStyle

				_, err := node.Pipe(
					yaml.PathGetter{Path: []string{"spec", "template", "metadata", "annotations"}, Create: yaml.MappingNode},
					yaml.FieldSetter{Name: k, Value: vn})
				if err != nil {
					return false, errors.Wrapf(err, "failed to set annotation %s=%s", k, v)
				}
			} else {
				err := node.PipeE(yaml.SetAnnotation(k, v))
				if err != nil {
					return false, errors.Wrapf(err, "failed to set annotation %s=%s", k, v)
				}
			}
		}
		return true, nil
	}

	return kyamls.ModifyFiles(dir, modifyFn, filter)
}