From 21bcbc699e4dc355c2e286bf6e4b55face53ca90 Mon Sep 17 00:00:00 2001 From: Nick Capps Date: Fri, 24 Nov 2023 17:11:56 -0800 Subject: [PATCH 1/3] Add commonLabels deprecation warning message --- api/types/kustomization.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/api/types/kustomization.go b/api/types/kustomization.go index 41376bedd4..af87a5bb23 100644 --- a/api/types/kustomization.go +++ b/api/types/kustomization.go @@ -188,6 +188,7 @@ const ( deprecatedPatchesJson6902Message = "# Warning: 'patchesJson6902' is deprecated. Please use 'patches' instead." + " " + deprecatedWarningToRunEditFix deprecatedPatchesStrategicMergeMessage = "# Warning: 'patchesStrategicMerge' is deprecated. Please use 'patches' instead." + " " + deprecatedWarningToRunEditFix deprecatedVarsMessage = "# Warning: 'vars' is deprecated. Please use 'replacements' instead." + " " + deprecatedWarningToRunEditFixExperimential + deprecatedCommonLabelsWarningMessage = "# Warning: 'commonLabels' is deprecated. Please use 'labels' instead." ) // CheckDeprecatedFields check deprecated field is used or not. @@ -208,6 +209,9 @@ func (k *Kustomization) CheckDeprecatedFields() *[]string { if k.Vars != nil { warningMessages = append(warningMessages, deprecatedVarsMessage) } + if k.CommonLabels != nil { + warningMessages = append(warningMessages, deprecatedCommonLabelsWarningMessage) + } return &warningMessages } From f2dfc110016d8b6f19a05e1103202b286d364329 Mon Sep 17 00:00:00 2001 From: Nick Capps Date: Fri, 24 Nov 2023 17:28:08 -0800 Subject: [PATCH 2/3] Add test --- api/types/kustomization.go | 6 +++--- api/types/kustomization_test.go | 9 +++++++++ 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/api/types/kustomization.go b/api/types/kustomization.go index af87a5bb23..78696b312b 100644 --- a/api/types/kustomization.go +++ b/api/types/kustomization.go @@ -197,6 +197,9 @@ func (k *Kustomization) CheckDeprecatedFields() *[]string { if k.Bases != nil { warningMessages = append(warningMessages, deprecatedBaseWarningMessage) } + if k.CommonLabels != nil { + warningMessages = append(warningMessages, deprecatedCommonLabelsWarningMessage) + } if k.ImageTags != nil { warningMessages = append(warningMessages, deprecatedImageTagsWarningMessage) } @@ -209,9 +212,6 @@ func (k *Kustomization) CheckDeprecatedFields() *[]string { if k.Vars != nil { warningMessages = append(warningMessages, deprecatedVarsMessage) } - if k.CommonLabels != nil { - warningMessages = append(warningMessages, deprecatedCommonLabelsWarningMessage) - } return &warningMessages } diff --git a/api/types/kustomization_test.go b/api/types/kustomization_test.go index 963f774f66..f39455f7ec 100644 --- a/api/types/kustomization_test.go +++ b/api/types/kustomization_test.go @@ -29,6 +29,13 @@ func TestKustomization_CheckDeprecatedFields(t *testing.T) { }, want: &[]string{deprecatedBaseWarningMessage}, }, + { + name: "using_CommonLabels", + k: Kustomization{ + CommonLabels: map[string]string{}, + }, + want: &[]string{deprecatedCommonLabelsWarningMessage}, + }, { name: "using_ImageTags", k: Kustomization{ @@ -61,6 +68,7 @@ func TestKustomization_CheckDeprecatedFields(t *testing.T) { name: "usingAll", k: Kustomization{ Bases: []string{"base"}, + CommonLabels: map[string]string{}, ImageTags: []Image{}, PatchesJson6902: []Patch{}, PatchesStrategicMerge: []PatchStrategicMerge{}, @@ -68,6 +76,7 @@ func TestKustomization_CheckDeprecatedFields(t *testing.T) { }, want: &[]string{ deprecatedBaseWarningMessage, + deprecatedCommonLabelsWarningMessage, deprecatedImageTagsWarningMessage, deprecatedPatchesJson6902Message, deprecatedPatchesStrategicMergeMessage, From ddab1973ea9d011da82ded9403da2158d6ecabf3 Mon Sep 17 00:00:00 2001 From: Nick Capps Date: Mon, 27 Nov 2023 21:05:51 -0800 Subject: [PATCH 3/3] Add warningToRunEditFix message --- api/types/kustomization.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/types/kustomization.go b/api/types/kustomization.go index 78696b312b..f86ec0b9e2 100644 --- a/api/types/kustomization.go +++ b/api/types/kustomization.go @@ -188,7 +188,7 @@ const ( deprecatedPatchesJson6902Message = "# Warning: 'patchesJson6902' is deprecated. Please use 'patches' instead." + " " + deprecatedWarningToRunEditFix deprecatedPatchesStrategicMergeMessage = "# Warning: 'patchesStrategicMerge' is deprecated. Please use 'patches' instead." + " " + deprecatedWarningToRunEditFix deprecatedVarsMessage = "# Warning: 'vars' is deprecated. Please use 'replacements' instead." + " " + deprecatedWarningToRunEditFixExperimential - deprecatedCommonLabelsWarningMessage = "# Warning: 'commonLabels' is deprecated. Please use 'labels' instead." + deprecatedCommonLabelsWarningMessage = "# Warning: 'commonLabels' is deprecated. Please use 'labels' instead." + " " + deprecatedWarningToRunEditFix ) // CheckDeprecatedFields check deprecated field is used or not.