feat: support edit set label for labels and not only commonLabels

Author: gaeljw

kustomize/commands/edit/set/setlabel.go

@@ -4,6 +4,7 @@
 package set
 
 import (
+	"errors"
 	"fmt"
 
 	"github.com/spf13/cobra"
@@ -17,6 +18,7 @@ import (
 type setLabelOptions struct {
 	metadata     map[string]string
 	mapValidator func(map[string]string) error
+	fields       string // TODO does enum type exists in Go?
 }
 
 // newCmdSetLabel sets one or more commonLabels to the kustomization file.
@@ -25,14 +27,23 @@ func newCmdSetLabel(fSys filesys.FileSystem, v func(map[string]string) error) *c
 	o.mapValidator = v
 	cmd := &cobra.Command{
 		Use: "label",
-		Short: "Sets one or more commonLabels in " +
+		Short: "Sets one or more labels/commonLabels in " +
 			konfig.DefaultKustomizationFileName(),
 		Example: `
-		set label {labelKey1:labelValue1} {labelKey2:labelValue2}`,
+		# Set commonLabels (default)
+		set label {labelKey1:labelValue1} {labelKey2:labelValue2}
+
+		# Set commonLabels
+		set label --fields=commonLabels {labelKey1:labelValue1} {labelKey2:labelValue2}
+
+		# Set labels
+		set label --fields=labels {labelKey1:labelValue1} {labelKey2:labelValue2}
+		`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return o.runE(args, fSys, o.setLabels)
 		},
 	}
+	cmd.Flags().StringVar(&o.fields, "fields", "commonLabels", "Name of the fields to set (commonLabels or labels)")
 	return cmd
 }
 
@@ -62,6 +73,9 @@ func (o *setLabelOptions) validateAndParse(args []string) error {
 	if len(args) < 1 {
 		return fmt.Errorf("must specify label")
 	}
+	if o.fields != "labels" && o.fields != "commonLabels" {
+		return errors.New("fields must be \"labels\" or \"commonLabels\"")
+	}
 	m, err := util.ConvertSliceToMap(args, "label")
 	if err != nil {
 		return err
@@ -74,10 +88,20 @@ func (o *setLabelOptions) validateAndParse(args []string) error {
 }
 
 func (o *setLabelOptions) setLabels(m *types.Kustomization) error {
-	if m.CommonLabels == nil {
-		m.CommonLabels = make(map[string]string)
+	if o.fields == "commonLabels" {
+		if m.CommonLabels == nil {
+			m.CommonLabels = make(map[string]string)
+		}
+		return o.writeToMap(m.CommonLabels)
+	} else if o.fields == "labels" {
+		if m.Labels == nil {
+			m.Labels = make([]types.Label, len(o.metadata))
+		}
+		m.Labels = o.addLabels(m.Labels)
+		return nil
+	} else {
+		return nil
 	}
-	return o.writeToMap(m.CommonLabels)
 }
 
 func (o *setLabelOptions) writeToMap(m map[string]string) error {
@@ -86,3 +110,8 @@ func (o *setLabelOptions) writeToMap(m map[string]string) error {
 	}
 	return nil
 }
+
+func (o *setLabelOptions) addLabels(m []types.Label) []types.Label {
+	newLabel := types.Label{Pairs: o.metadata, IncludeSelectors: false}
+	return append(m, newLabel)
+}

kustomize/commands/edit/set/setlabel_test.go

@@ -4,6 +4,7 @@
 package set
 
 import (
+	"reflect"
 	"testing"
 
 	valtest_test "sigs.k8s.io/kustomize/api/testutils/valtest"
@@ -27,15 +28,57 @@ func makeKustomization(t *testing.T) *types.Kustomization {
 	return m
 }
 
-func TestRunSetLabel(t *testing.T) {
+func TestRunSetCommonLabels(t *testing.T) {
 	var o setLabelOptions
+	o.fields = "commonLabels"
 	o.metadata = map[string]string{"owls": "cute", "otters": "adorable"}
 
 	m := makeKustomization(t)
 	err := o.setLabels(m)
 	if err != nil {
 		t.Errorf("unexpected error: could not write to kustomization file")
 	}
+
+	// assert content
+	expectedContent := map[string]string{"app": "helloworld", "owls": "cute", "otters": "adorable"}
+	if !reflect.DeepEqual(m.CommonLabels, expectedContent) {
+		t.Log("m.CommonLabels", m.CommonLabels)
+		t.Log("expectedContent", expectedContent)
+		t.Errorf("commonLabels does not contain expected content")
+	}
+
+	// adding the same test input should work
+	err = o.setLabels(m)
+	if err != nil {
+		t.Errorf("unexpected error: could not write to kustomization file")
+	}
+	// adding new labels should work
+	o.metadata = map[string]string{"new": "label", "owls": "not cute"}
+	err = o.setLabels(m)
+	if err != nil {
+		t.Errorf("unexpected error: could not write to kustomization file")
+	}
+}
+
+func TestRunSetLabels(t *testing.T) {
+	var o setLabelOptions
+	o.fields = "labels"
+	o.metadata = map[string]string{"owls": "cute", "otters": "adorable"}
+
+	m := makeKustomization(t)
+	err := o.setLabels(m)
+	if err != nil {
+		t.Errorf("unexpected error: could not write to kustomization file")
+	}
+
+	// assert content
+	expectedContent := types.Label{Pairs: map[string]string{"owls": "cute", "otters": "adorable"}, IncludeSelectors: false}
+	if !reflect.DeepEqual(m.Labels[2], expectedContent) {
+		t.Log("m.Labels[2]", m.Labels[2])
+		t.Log("expectedContent", expectedContent)
+		t.Errorf("labels does not contain expected content")
+	}
+
 	// adding the same test input should work
 	err = o.setLabels(m)
 	if err != nil {