From a83f102cc948b8e3567c2d961cdbdc1b612dfb5b Mon Sep 17 00:00:00 2001 From: "jan.kozlowski" Date: Fri, 26 Apr 2024 23:21:51 +0200 Subject: [PATCH 1/2] fix: include label in templates when adding by cli --- kustomize/commands/edit/add/addmetadata.go | 10 +++++++++- kustomize/commands/edit/add/addmetadata_test.go | 10 ++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/kustomize/commands/edit/add/addmetadata.go b/kustomize/commands/edit/add/addmetadata.go index eda017b76..bc4ca28f4 100644 --- a/kustomize/commands/edit/add/addmetadata.go +++ b/kustomize/commands/edit/add/addmetadata.go @@ -39,6 +39,7 @@ type addMetadataOptions struct { mapValidator func(map[string]string) error kind kindOfAdd labelsWithoutSelector bool + includeTemplates bool } // newCmdAddAnnotation adds one or more commonAnnotations to the kustomization file. @@ -83,6 +84,9 @@ func newCmdAddLabel(fSys filesys.FileSystem, v func(map[string]string) error) *c cmd.Flags().BoolVar(&o.labelsWithoutSelector, "without-selector", false, "using add labels without selector option", ) + cmd.Flags().BoolVar(&o.includeTemplates, "include-templates", false, + "include labels in templates (requires --without-selector)", + ) return cmd } @@ -132,7 +136,11 @@ func (o *addMetadataOptions) addAnnotations(m *types.Kustomization) error { func (o *addMetadataOptions) addLabels(m *types.Kustomization) error { if o.labelsWithoutSelector { - m.Labels = append(m.Labels, types.Label{Pairs: make(map[string]string), IncludeSelectors: false}) + m.Labels = append(m.Labels, types.Label{ + Pairs: make(map[string]string), + IncludeSelectors: false, + IncludeTemplates: o.includeTemplates, + }) return o.writeToMap(m.Labels[len(m.Labels)-1].Pairs, label) } if m.CommonLabels == nil { diff --git a/kustomize/commands/edit/add/addmetadata_test.go b/kustomize/commands/edit/add/addmetadata_test.go index 329a48df0..bcc1e186d 100644 --- a/kustomize/commands/edit/add/addmetadata_test.go +++ b/kustomize/commands/edit/add/addmetadata_test.go @@ -284,6 +284,16 @@ func TestAddLabelWithoutSelector(t *testing.T) { assert.Equal(t, m.Labels[0], types.Label{Pairs: map[string]string{"new": "label"}}) } +func TestAddLabelWithoutSelectorIncludeTemplates(t *testing.T) { + var o addMetadataOptions + o.labelsWithoutSelector = true + m := makeKustomization(t) + o.metadata = map[string]string{"new": "label"} + o.includeTemplates = true + require.NoError(t, o.addLabels(m)) + assert.Equal(t, m.Labels[0], types.Label{Pairs: map[string]string{"new": "label"}, IncludeTemplates: true}) +} + func TestAddLabelWithoutSelectorAddLabel(t *testing.T) { var o addMetadataOptions o.metadata = map[string]string{"owls": "cute", "otters": "adorable"} From cba368896021d0bb9515e605d7bd2bec2effd1b2 Mon Sep 17 00:00:00 2001 From: "jan.kozlowski" Date: Mon, 29 Apr 2024 02:05:01 +0200 Subject: [PATCH 2/2] add validation and test case --- kustomize/commands/edit/add/addmetadata.go | 3 +++ kustomize/commands/edit/add/addmetadata_test.go | 13 +++++++++++++ 2 files changed, 16 insertions(+) diff --git a/kustomize/commands/edit/add/addmetadata.go b/kustomize/commands/edit/add/addmetadata.go index bc4ca28f4..93cf91a00 100644 --- a/kustomize/commands/edit/add/addmetadata.go +++ b/kustomize/commands/edit/add/addmetadata.go @@ -116,6 +116,9 @@ func (o *addMetadataOptions) validateAndParse(args []string) error { if len(args) < 1 { return fmt.Errorf("must specify %s", o.kind) } + if !o.labelsWithoutSelector && o.includeTemplates { + return fmt.Errorf("--without-selector flag must be specified for --include-templates to work") + } m, err := util.ConvertSliceToMap(args, o.kind.String()) if err != nil { return err diff --git a/kustomize/commands/edit/add/addmetadata_test.go b/kustomize/commands/edit/add/addmetadata_test.go index bcc1e186d..ec840ffb3 100644 --- a/kustomize/commands/edit/add/addmetadata_test.go +++ b/kustomize/commands/edit/add/addmetadata_test.go @@ -294,6 +294,19 @@ func TestAddLabelWithoutSelectorIncludeTemplates(t *testing.T) { assert.Equal(t, m.Labels[0], types.Label{Pairs: map[string]string{"new": "label"}, IncludeTemplates: true}) } +func TestAddLabelIncludeTemplatesWithoutRequiredFlag(t *testing.T) { + fSys := filesys.MakeFsInMemory() + v := valtest_test.MakeHappyMapValidator(t) + cmd := newCmdAddLabel(fSys, v.Validator) + args := []string{"new:label"} + _ = cmd.Flag("include-templates").Value.Set("true") + _ = cmd.Flag("without-selector").Value.Set("false") + err := cmd.RunE(cmd, args) + v.VerifyNoCall() + require.Error(t, err) + require.Containsf(t, err.Error(), "--without-selector flag must be specified for --include-templates to work", "incorrect error: %s", err.Error()) +} + func TestAddLabelWithoutSelectorAddLabel(t *testing.T) { var o addMetadataOptions o.metadata = map[string]string{"owls": "cute", "otters": "adorable"}