From f23d45fcb4747bc72ed93432a4b0c1215cb5a237 Mon Sep 17 00:00:00 2001
From: Nick <10539313+ncapps@users.noreply.github.com>
Date: Thu, 30 Nov 2023 08:41:43 -0800
Subject: [PATCH] Add deprecation warning message to commonLabels (#5464)

* Add commonLabels deprecation warning message

* Add test

* Add warningToRunEditFix message
---
 api/types/kustomization.go      | 4 ++++
 api/types/kustomization_test.go | 9 +++++++++
 2 files changed, 13 insertions(+)

diff --git a/api/types/kustomization.go b/api/types/kustomization.go
index 41376bedd..f86ec0b9e 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." + " " + deprecatedWarningToRunEditFix
 )
 
 // CheckDeprecatedFields check deprecated field is used or not.
@@ -196,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)
 	}
diff --git a/api/types/kustomization_test.go b/api/types/kustomization_test.go
index 963f774f6..f39455f7e 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,