refactor: rename zone util functions to be more accurate

Author: comtalyst

pkg/cloudprovider/cloudprovider.go

@@ -481,7 +481,7 @@ func (c *CloudProvider) vmInstanceToNodeClaim(ctx context.Context, vm *armcomput
 		nodeClaim.Status.Allocatable = lo.PickBy(instanceType.Allocatable(), func(_ corev1.ResourceName, v resource.Quantity) bool { return !resources.IsZero(v) })
 	}
 
-	if zone, err := utils.GetZone(vm); err != nil {
+	if zone, err := utils.GetAKSLabelZoneFromVM(vm); err != nil {
 		log.FromContext(ctx).Info("failed to get zone for VM, zone label will be empty", "vmName", *vm.Name, "error", err)
 	} else {
 		labels[corev1.LabelTopologyZone] = zone

pkg/providers/instance/vminstance.go

@@ -185,7 +185,7 @@ func (p *DefaultVMProvider) BeginCreate(
 		return nil, err
 	}
 	vm := vmPromise.VM
-	zone, err := utils.GetZone(vm)
+	zone, err := utils.GetAKSLabelZoneFromVM(vm)
 	if err != nil {
 		log.FromContext(ctx).V(1).Info("failed to get zone for VM", "vmName", *vm.Name, "error", err)
 	}
@@ -539,7 +539,7 @@ func newVMObject(opts *createVMOptions) *armcompute.VirtualMachine {
 				CapacityTypeToVMPriority[opts.CapacityType]),
 			),
 		},
-		Zones: utils.MakeVMZone(opts.Zone),
+		Zones: utils.GetARMZonesFromAKSLabelZone(opts.Zone),
 		Tags:  opts.LaunchTemplate.Tags,
 	}
 	setVMPropertiesOSDiskType(vm.Properties, opts.LaunchTemplate)

pkg/providers/instancetype/instancetypes.go

@@ -192,7 +192,7 @@ func (p *DefaultProvider) instanceTypeZones(sku *skewer.SKU) sets.Set[string] {
 	skuZones := lo.Keys(sku.AvailabilityZones(p.region))
 	if len(skuZones) > 0 {
 		return sets.New(lo.Map(skuZones, func(zone string, _ int) string {
-			return utils.MakeZone(p.region, zone)
+			return utils.GetAKSLabelZoneFromARMZone(p.region, zone)
 		})...)
 	}
 	return sets.New("") // empty string means non-zonal offering

pkg/providers/instancetype/suite_test.go

@@ -89,7 +89,7 @@ var coreProvisioner, coreProvisionerNonZonal *provisioning.Provisioner
 var cluster, clusterNonZonal *state.Cluster
 var cloudProvider, cloudProviderNonZonal *cloudprovider.CloudProvider
 
-var fakeZone1 = utils.MakeZone(fake.Region, "1")
+var fakeZone1 = utils.GetAKSLabelZoneFromARMZone(fake.Region, "1")
 
 var defaultTestSKU = &skewer.SKU{Name: lo.ToPtr("Standard_D2_v3"), Family: lo.ToPtr("standardD2v3Family")}
 
@@ -400,7 +400,7 @@ var _ = Describe("InstanceType Provider", func() {
 			ExpectNotScheduled(ctx, env.Client, pod)
 
 			// ensure that initial zone was made unavailable
-			zone, err := utils.GetZone(&azureEnv.VirtualMachinesAPI.VirtualMachineCreateOrUpdateBehavior.CalledWithInput.Pop().VM)
+			zone, err := utils.GetAKSLabelZoneFromVM(&azureEnv.VirtualMachinesAPI.VirtualMachineCreateOrUpdateBehavior.CalledWithInput.Pop().VM)
 			Expect(err).ToNot(HaveOccurred())
 			ExpectUnavailable(azureEnv, defaultTestSKU, zone, karpv1.CapacityTypeSpot)
 
@@ -470,7 +470,7 @@ var _ = Describe("InstanceType Provider", func() {
 			// ensure that initial VM size was made unavailable
 			vm := azureEnv.VirtualMachinesAPI.VirtualMachineCreateOrUpdateBehavior.CalledWithInput.Pop().VM
 			initialVMSize := *vm.Properties.HardwareProfile.VMSize
-			zone, err := utils.GetZone(&vm)
+			zone, err := utils.GetAKSLabelZoneFromVM(&vm)
 			Expect(err).ToNot(HaveOccurred())
 			ExpectUnavailable(azureEnv, &skewer.SKU{Name: lo.ToPtr(string(initialVMSize))}, zone, karpv1.CapacityTypeSpot)
 
@@ -1152,7 +1152,7 @@ var _ = Describe("InstanceType Provider", func() {
 			Eventually(func() []*karpv1.NodeClaim { return ExpectNodeClaims(ctx, env.Client) }).To(HaveLen(0))
 
 			By("marking whatever zone was picked as unavailable - for both spot and on-demand")
-			zone, err := utils.GetZone(&azureEnv.VirtualMachinesAPI.VirtualMachineCreateOrUpdateBehavior.CalledWithInput.Pop().VM)
+			zone, err := utils.GetAKSLabelZoneFromVM(&azureEnv.VirtualMachinesAPI.VirtualMachineCreateOrUpdateBehavior.CalledWithInput.Pop().VM)
 			Expect(err).ToNot(HaveOccurred())
 			for _, skuToCheck := range expectedUnavailableSKUs {
 				Expect(azureEnv.UnavailableOfferingsCache.IsUnavailable(skuToCheck, zone, karpv1.CapacityTypeSpot)).To(BeTrue())
@@ -1292,7 +1292,7 @@ var _ = Describe("InstanceType Provider", func() {
 				ExpectProvisioned(ctx, env.Client, cluster, cloudProvider, coreProvisioner, pod)
 				ExpectNotScheduled(ctx, env.Client, pod)
 				for _, zoneID := range []string{"1", "2", "3"} {
-					ExpectUnavailable(azureEnv, sku, utils.MakeZone(fake.Region, zoneID), capacityType)
+					ExpectUnavailable(azureEnv, sku, utils.GetAKSLabelZoneFromARMZone(fake.Region, zoneID), capacityType)
 				}
 			}
 

pkg/utils/zone.go

@@ -23,25 +23,25 @@ import (
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
 )
 
-// MakeZone returns the zone value in format of <region>-<zone-id>.
-func MakeZone(location string, zoneID string) string {
+// GetAKSLabelZoneFromARMZone returns the zone value in format of <region>-<zone-id>.
+func GetAKSLabelZoneFromARMZone(location string, zoneID string) string {
 	if zoneID == "" {
 		return ""
 	}
 	return fmt.Sprintf("%s-%s", strings.ToLower(location), zoneID)
 }
 
-// VM Zones field expects just the zone number, without region
-func MakeVMZone(zone string) []*string {
+// GetARMZonesFromAKSLabelZone returns the zone ID from <region>-<zone-id>.
+func GetARMZonesFromAKSLabelZone(zone string) []*string {
 	if zone == "" {
 		return []*string{}
 	}
 	zoneNum := zone[len(zone)-1:]
 	return []*string{&zoneNum}
 }
 
-// GetZone returns the zone for the given virtual machine, or an empty string if there is no zone specified
-func GetZone(vm *armcompute.VirtualMachine) (string, error) {
+// GetAKSLabelZoneFromVM returns the zone for the given virtual machine, or an empty string if there is no zone specified
+func GetAKSLabelZoneFromVM(vm *armcompute.VirtualMachine) (string, error) {
 	if vm == nil {
 		return "", fmt.Errorf("cannot pass in a nil virtual machine")
 	}
@@ -52,7 +52,7 @@ func GetZone(vm *armcompute.VirtualMachine) (string, error) {
 		if vm.Location == nil {
 			return "", fmt.Errorf("virtual machine is missing location")
 		}
-		return MakeZone(*vm.Location, *(vm.Zones)[0]), nil
+		return GetAKSLabelZoneFromARMZone(*vm.Location, *(vm.Zones)[0]), nil
 	}
 	if len(vm.Zones) > 1 {
 		return "", fmt.Errorf("virtual machine has multiple zones")

pkg/utils/zone_test.go

@@ -25,7 +25,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestGetZone(t *testing.T) {
+func TestGetAKSLabelZoneFromVM(t *testing.T) {
 	tc := []struct {
 		testName      string
 		input         *armcompute.VirtualMachine
@@ -74,7 +74,7 @@ func TestGetZone(t *testing.T) {
 	}
 
 	for _, c := range tc {
-		zone, err := utils.GetZone(c.input)
+		zone, err := utils.GetAKSLabelZoneFromVM(c.input)
 		assert.Equal(t, c.expectedZone, zone, c.testName)
 		if err == nil && c.expectedError != "" {
 			assert.Fail(t, "expected error but got nil", c.testName)