Skip to content

Commit 6e6db1b

Browse files
AshleyDumaineAshleyDumaine
authored
clean up some strings (#823)
1 parent 68e578f commit 6e6db1b

10 files changed

+25
-41
lines changed

‎internal/controller/linodecluster_controller.go

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ import (
5151

5252
const (
5353
lbTypeDNS string = "dns"
54-
pauseAnnotationValue string = "true"
54+
lbTypeExternal string = "external"
55+
lbTypeNB string = "NodeBalancer"
5556
ConditionPreflightLinodeVPCReady string = "PreflightLinodeVPCReady"
5657
ConditionPreflightLinodeNBFirewallReady string = "PreflightLinodeNBFirewallReady"
5758
)
@@ -453,15 +454,15 @@ func (r *LinodeClusterReconciler) reconcileCreate(ctx context.Context, logger lo
453454
func (r *LinodeClusterReconciler) reconcileDelete(ctx context.Context, logger logr.Logger, clusterScope *scope.ClusterScope) error {
454455
logger.Info("deleting cluster")
455456
switch {
456-
case clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == "external":
457+
case clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == lbTypeExternal:
457458
logger.Info("LoadBalacing managed externally, nothing to do.")
458459
conditions.Set(clusterScope.LinodeCluster, metav1.Condition{
459460
Type: string(clusterv1.ReadyCondition),
460461
Status: metav1.ConditionFalse,
461462
Reason: string(clusterv1.DeletedReason),
462463
Message: "Deletion in progress",
463464
})
464-
r.Recorder.Event(clusterScope.LinodeCluster, corev1.EventTypeWarning, "LoadBalacing managed externally", "LoadBalacing managed externally, nothing to do.")
465+
r.Recorder.Event(clusterScope.LinodeCluster, corev1.EventTypeWarning, "LoadBalancing managed externally", "LoadBalancing managed externally, nothing to do.")
465466

466467
case clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == lbTypeDNS:
467468
if err := removeMachineFromDNS(ctx, logger, clusterScope); err != nil {
@@ -475,11 +476,11 @@ func (r *LinodeClusterReconciler) reconcileDelete(ctx context.Context, logger lo
475476
})
476477
r.Recorder.Event(clusterScope.LinodeCluster, corev1.EventTypeNormal, clusterv1.DeletedReason, "Load balancing for Type DNS deleted")
477478

478-
case clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == "NodeBalancer" && clusterScope.LinodeCluster.Spec.Network.NodeBalancerID == nil:
479+
case clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == lbTypeNB && clusterScope.LinodeCluster.Spec.Network.NodeBalancerID == nil:
479480
logger.Info("NodeBalancer ID is missing for Type NodeBalancer, nothing to do")
480481
r.Recorder.Event(clusterScope.LinodeCluster, corev1.EventTypeWarning, "NodeBalancerIDMissing", "NodeBalancer already removed, nothing to do")
481482

482-
case clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == "NodeBalancer" && clusterScope.LinodeCluster.Spec.Network.NodeBalancerID != nil:
483+
case clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == lbTypeNB && clusterScope.LinodeCluster.Spec.Network.NodeBalancerID != nil:
483484
if err := removeMachineFromNB(ctx, logger, clusterScope); err != nil {
484485
return fmt.Errorf("remove machine from loadbalancer: %w", err)
485486
}

‎internal/controller/linodecluster_controller_helpers.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ import (
2323

2424
func addMachineToLB(ctx context.Context, clusterScope *scope.ClusterScope) error {
2525
logger := logr.FromContextOrDiscard(ctx)
26-
if clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == "external" {
26+
if clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == lbTypeExternal {
2727
logger.Info("LoadBalancing is handled externally")
2828
return nil
2929
}
30-
if clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == "dns" {
30+
if clusterScope.LinodeCluster.Spec.Network.LoadBalancerType == lbTypeDNS {
3131
if err := services.EnsureDNSEntries(ctx, clusterScope, "create"); err != nil {
3232
logger.Error(err, "Failed to ensure DNS entries")
3333
return err
@@ -37,7 +37,7 @@ func addMachineToLB(ctx context.Context, clusterScope *scope.ClusterScope) error
3737
// Reconcile clusters with Spec.Network = {} and ControlPlaneEndpoint.Host externally managed
3838
if clusterScope.LinodeCluster.Spec.Network.NodeBalancerID == nil || clusterScope.LinodeCluster.Spec.Network.ApiserverNodeBalancerConfigID == nil {
3939
logger.Info("NodeBalancerID or ApiserverNodeBalancerConfigID not set for Type NodeBalancer, this cluster is managed externally")
40-
clusterScope.LinodeCluster.Spec.Network.LoadBalancerType = "external"
40+
clusterScope.LinodeCluster.Spec.Network.LoadBalancerType = lbTypeExternal
4141
return nil
4242
}
4343
nodeBalancerNodes, err := clusterScope.LinodeClient.ListNodeBalancerNodes(

‎internal/controller/linodecluster_controller_helpers_test.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ func TestAddMachineToLB(t *testing.T) {
338338
LinodeCluster: &infrav1alpha2.LinodeCluster{
339339
Spec: infrav1alpha2.LinodeClusterSpec{
340340
Network: infrav1alpha2.NetworkSpec{
341-
LoadBalancerType: "external",
341+
LoadBalancerType: lbTypeExternal,
342342
},
343343
},
344344
},
@@ -352,7 +352,7 @@ func TestAddMachineToLB(t *testing.T) {
352352
LinodeCluster: &infrav1alpha2.LinodeCluster{
353353
Spec: infrav1alpha2.LinodeClusterSpec{
354354
Network: infrav1alpha2.NetworkSpec{
355-
LoadBalancerType: "nodebalancer",
355+
LoadBalancerType: lbTypeNB,
356356
// NodeBalancerID and ApiserverNodeBalancerConfigID are nil
357357
},
358358
},
@@ -367,7 +367,7 @@ func TestAddMachineToLB(t *testing.T) {
367367
LinodeCluster: &infrav1alpha2.LinodeCluster{
368368
Spec: infrav1alpha2.LinodeClusterSpec{
369369
Network: infrav1alpha2.NetworkSpec{
370-
LoadBalancerType: "nodebalancer",
370+
LoadBalancerType: lbTypeNB,
371371
NodeBalancerID: util.Pointer(12345),
372372
ApiserverNodeBalancerConfigID: util.Pointer(67890),
373373
},
@@ -395,7 +395,7 @@ func TestAddMachineToLB(t *testing.T) {
395395
LinodeCluster: &infrav1alpha2.LinodeCluster{
396396
Spec: infrav1alpha2.LinodeClusterSpec{
397397
Network: infrav1alpha2.NetworkSpec{
398-
LoadBalancerType: "nodebalancer",
398+
LoadBalancerType: lbTypeNB,
399399
NodeBalancerID: util.Pointer(12345),
400400
ApiserverNodeBalancerConfigID: util.Pointer(67890),
401401
},
@@ -449,9 +449,9 @@ func TestAddMachineToLB(t *testing.T) {
449449
}
450450
} else {
451451
require.NoError(t, err)
452-
// For the NodeBalancer without IDs case, verify that LoadBalancerType was changed to "external"
453-
if testcase.name == "NodeBalancer without IDs should set type to external" {
454-
assert.Equal(t, "external", testcase.clusterScope.LinodeCluster.Spec.Network.LoadBalancerType)
452+
// For the NodeBalancer without IDs case, verify that LoadBalancerType was changed to lbTypeExternal
453+
if testcase.name == "NodeBalancer without IDs should set type to lbTypeExternal" {
454+
assert.Equal(t, lbTypeExternal, testcase.clusterScope.LinodeCluster.Spec.Network.LoadBalancerType)
455455
}
456456
}
457457
})

‎internal/webhook/v1alpha2/linodeobjectstoragebucket_webhook.go

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,6 @@ import (
3434
"github.com/linode/cluster-api-provider-linode/clients"
3535
)
3636

37-
var (
38-
// The capability string indicating a region supports Object Storage: [Object Storage Availability]
39-
//
40-
// [Object Storage Availability]: https://www.linode.com/docs/products/storage/object-storage/#availability
41-
LinodeObjectStorageCapability = "Object Storage"
42-
)
43-
4437
// log is for logging in this package.
4538
var linodeobjectstoragebucketlog = logf.Log.WithName("linodeobjectstoragebucket-resource")
4639

‎internal/webhook/v1alpha2/linodeobjectstoragebucket_webhook_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func TestValidateLinodeObjectStorageBucket(t *testing.T) {
4848
},
4949
}
5050
region = linodego.Region{ID: "mock-region"}
51-
capabilities = []string{LinodeObjectStorageCapability}
51+
capabilities = []string{linodego.CapabilityObjectStorage}
5252
capabilities_zero = []string{}
5353
)
5454

‎internal/webhook/v1alpha2/linodeplacementgroup_webhook.go

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import (
2323
"regexp"
2424
"slices"
2525

26+
"github.com/linode/linodego"
2627
apierrors "k8s.io/apimachinery/pkg/api/errors"
2728
"k8s.io/apimachinery/pkg/runtime"
2829
"k8s.io/apimachinery/pkg/runtime/schema"
@@ -37,13 +38,6 @@ import (
3738
"github.com/linode/cluster-api-provider-linode/clients"
3839
)
3940

40-
var (
41-
// The capability string indicating a region supports PlacementGroups: [PlacementGroups Availability]
42-
//
43-
// [PlacementGroups Availability]:https://www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/#availability
44-
LinodePlacementGroupCapability = "Placement Group"
45-
)
46-
4741
// log is for logging in this package.
4842
var linodeplacementgrouplog = logf.Log.WithName("linodeplacementgroup-resource")
4943

@@ -127,7 +121,7 @@ func (v *LinodePlacementGroupCustomValidator) validateLinodePlacementGroupSpec(c
127121
var errs field.ErrorList
128122

129123
if !skipAPIValidation {
130-
if err := validateRegion(ctx, linodeclient, spec.Region, field.NewPath("spec").Child("region"), LinodePlacementGroupCapability); err != nil {
124+
if err := validateRegion(ctx, linodeclient, spec.Region, field.NewPath("spec").Child("region"), linodego.CapabilityPlacementGroup); err != nil {
131125
errs = append(errs, err)
132126
}
133127
}

‎internal/webhook/v1alpha2/linodeplacementgroup_webhook_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func TestValidateLinodePlacementGroup(t *testing.T) {
5151
},
5252
}
5353
region = linodego.Region{ID: "test"}
54-
capabilities = []string{LinodePlacementGroupCapability}
54+
capabilities = []string{linodego.CapabilityPlacementGroup}
5555
capabilities_zero = []string{}
5656
invalidRegionError = "spec.region: Not found: \"example\""
5757
invalidRegionNoPGCapability = "spec.region: Invalid value: \"example\": no capability: Placement Group"

‎internal/webhook/v1alpha2/linodevpc_webhook.go

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import (
2727
"strconv"
2828
"strings"
2929

30+
"github.com/linode/linodego"
3031
"go4.org/netipx"
3132
apierrors "k8s.io/apimachinery/pkg/api/errors"
3233
"k8s.io/apimachinery/pkg/runtime"
@@ -42,11 +43,6 @@ import (
4243
)
4344

4445
var (
45-
// The capability string indicating a region supports VPCs: [VPC Availability]
46-
//
47-
// [VPC Availability]: https://www.linode.com/docs/products/networking/vpc/#availability
48-
LinodeVPCCapability = "VPCs"
49-
5046
// The IPv4 ranges that are excluded from VPC Subnets: [Valid IPv4 Ranges for a Subnet]
5147
//
5248
// [Valid IPv4 Ranges for a Subnet]: https://www.linode.com/docs/products/networking/vpc/guides/subnets/#valid-ipv4-ranges
@@ -151,7 +147,7 @@ func (r *linodeVPCValidator) validateLinodeVPCSpec(ctx context.Context, linodecl
151147
var errs field.ErrorList
152148

153149
if !skipAPIValidation {
154-
if err := validateRegion(ctx, linodeclient, spec.Region, field.NewPath("spec").Child("region"), LinodeVPCCapability); err != nil {
150+
if err := validateRegion(ctx, linodeclient, spec.Region, field.NewPath("spec").Child("region"), linodego.CapabilityVPCs); err != nil {
155151
errs = append(errs, err)
156152
}
157153
}

‎internal/webhook/v1alpha2/linodevpc_webhook_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func TestValidateLinodeVPC(t *testing.T) {
5252
},
5353
}
5454
region = linodego.Region{ID: "test"}
55-
capabilities = []string{LinodeVPCCapability}
55+
capabilities = []string{linodego.CapabilityVPCs}
5656
capabilities_zero = []string{}
5757
regionNotFoundError = "spec.region: Not found: \"example\""
5858
vpcCapabilityError = "spec.region: Invalid value: \"example\": no capability: VPCs"
@@ -303,7 +303,7 @@ func TestValidateVPCIPv6Ranges(t *testing.T) {
303303
},
304304
}
305305
region = linodego.Region{ID: "test"}
306-
capabilities = []string{LinodeVPCCapability}
306+
capabilities = []string{linodego.CapabilityVPCs}
307307
ErrorIPv6RangeInvalid = "spec.IPv6Range[0].Range: Invalid value: \"48\": IPv6 range must be either 'auto', valid IPv6 prefix or start with /. Example: auto, /52, 2001:db8::/52"
308308
ErrorIPv6RangeInvalidChars = "spec.IPv6Range[0].Range: Invalid value: \"/a48\": IPv6 range doesn't contain a valid number after /"
309309
ErrorIPv6RangeOutOfRange = "spec.IPv6Range[0].Range: Invalid value: \"/130\": IPv6 range must be between /0 and /128"

‎internal/webhook/v1alpha2/webhook_helpers.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ func validateObjectStorageRegion(ctx context.Context, linodegoclient clients.Lin
9999
} else {
100100
region = cexp1.FindStringSubmatch(id)[1]
101101
}
102-
return validateRegion(ctx, linodegoclient, region, path, LinodeObjectStorageCapability)
102+
return validateRegion(ctx, linodegoclient, region, path, linodego.CapabilityObjectStorage)
103103
}
104104

105105
func getCredentialDataFromRef(ctx context.Context, crClient clients.K8sClient, credentialsRef corev1.SecretReference, defaultNamespace string) ([]byte, error) {

0 commit comments

Comments
 (0)