Merge pull request #3304 from PiotrLewandowski323/issue-3291

Add unit tests for azure/pointers.go

Author: k8s-ci-robot

azure/converters/tags.go

@@ -19,6 +19,7 @@ package converters
 import (
 	"k8s.io/utils/pointer"
 	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1beta1"
+	"sigs.k8s.io/cluster-api-provider-azure/azure"
 )
 
 // MapToTags converts a map[string]*string into a infrav1.Tags.
@@ -38,15 +39,5 @@ func MapToTags(src map[string]*string) infrav1.Tags {
 
 // TagsToMap converts infrav1.Tags into a map[string]*string.
 func TagsToMap(src infrav1.Tags) map[string]*string {
-	if src == nil {
-		return nil
-	}
-
-	tags := make(map[string]*string, len(src))
-
-	for k, v := range src {
-		tags[k] = pointer.String(v)
-	}
-
-	return tags
+	return azure.StringMapPtr(src)
 }

azure/pointers.go

@@ -27,11 +27,14 @@ func StringSlice(s *[]string) []string {
 	return nil
 }
 
-// StringMapPtr returns a pointer to a given string map, or nil if the map is nil.
-func StringMapPtr(m map[string]string) *map[string]*string { //nolint:gocritic
+// StringMapPtr converts a map[string]string into a map[string]*string. It returns nil if the map is nil.
+func StringMapPtr(m map[string]string) map[string]*string {
+	if m == nil {
+		return nil
+	}
 	msp := make(map[string]*string, len(m))
 	for k, v := range m {
 		msp[k] = pointer.String(v)
 	}
-	return &msp
+	return msp
 }

azure/pointers_test.go

@@ -0,0 +1,78 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package azure
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	. "github.com/onsi/gomega"
+	"k8s.io/utils/pointer"
+)
+
+func TestStringSlice(t *testing.T) {
+	cases := []struct {
+		Name     string
+		Arg      *[]string
+		Expected []string
+	}{
+		{
+			Name:     "Should return nil if the pointer is nil",
+			Arg:      nil,
+			Expected: nil,
+		},
+		{
+			Name:     "Should return string slice value for the passed string slice pointer",
+			Arg:      &[]string{"foo", "bar"},
+			Expected: []string{"foo", "bar"},
+		},
+	}
+	for _, tc := range cases {
+		t.Run(tc.Name, func(t *testing.T) {
+			g := NewWithT(t)
+			actual := StringSlice(tc.Arg)
+			g.Expect(tc.Expected).To(Equal(actual))
+		})
+	}
+}
+
+func TestStringMapPtr(t *testing.T) {
+	cases := []struct {
+		Name     string
+		Arg      map[string]string
+		Expected map[string]*string
+	}{
+		{
+			Name:     "Should return nil if the map is nil",
+			Arg:      nil,
+			Expected: nil,
+		},
+		{
+			Name:     "Should convert to a map[string]*string",
+			Arg:      map[string]string{"foo": "baz", "bar": "qux"},
+			Expected: map[string]*string{"foo": pointer.String("baz"), "bar": pointer.String("qux")},
+		},
+	}
+	for _, tc := range cases {
+		t.Run(tc.Name, func(t *testing.T) {
+			actual := StringMapPtr(tc.Arg)
+			if !cmp.Equal(tc.Expected, actual) {
+				t.Errorf("Got difference between expected result and result %v", cmp.Diff(tc.Expected, actual))
+			}
+		})
+	}
+}

azure/services/agentpools/spec.go

@@ -265,6 +265,11 @@ func (s *AgentPoolSpec) Parameters(ctx context.Context, existing interface{}) (p
 	if s.SKU != "" {
 		sku = &s.SKU
 	}
+	tags := converters.TagsToMap(s.AdditionalTags)
+	if tags == nil {
+		// Make sure we send a non-nil, empty map if AdditionalTags are nil as this tells AKS to delete any existing tags.
+		tags = make(map[string]*string, 0)
+	}
 	var vnetSubnetID *string
 	if s.VnetSubnetID != "" {
 		vnetSubnetID = &s.VnetSubnetID
@@ -352,7 +357,7 @@ func (s *AgentPoolSpec) Parameters(ctx context.Context, existing interface{}) (p
 			VnetSubnetID:         vnetSubnetID,
 			EnableNodePublicIP:   s.EnableNodePublicIP,
 			NodePublicIPPrefixID: s.NodePublicIPPrefixID,
-			Tags:                 *azure.StringMapPtr(s.AdditionalTags),
+			Tags:                 tags,
 			LinuxOSConfig:        linuxOSConfig,
 		},
 	}

azure/services/managedclusters/spec.go

@@ -347,7 +347,7 @@ func (s *ManagedClusterSpec) Parameters(ctx context.Context, existing interface{
 			Enabled: &item.Enabled,
 		}
 		if item.Config != nil {
-			addonProfile.Config = *azure.StringMapPtr(item.Config)
+			addonProfile.Config = azure.StringMapPtr(item.Config)
 		}
 		managedCluster.AddonProfiles[item.Name] = addonProfile
 	}