fixup! refactor: Create placementGroup struct

Author: jimmidyson

api/v1alpha1/aws_node_types.go

@@ -39,15 +39,21 @@ type AWSGenericNodeSpec struct {
 	// +kubebuilder:validation:Optional
 	AdditionalSecurityGroups AdditionalSecurityGroup `json:"additionalSecurityGroups,omitempty"`
 
-	// PlacementGroupName specifies the name of the placement group in which to launch nodes from this nodepool.
+	// PlacementGroup specifies the placement group in which to launch the instance.
 	// +kubebuilder:validation:Optional
-	// +kubebuilder:validation:MinLength=1
-	// +kubebuilder:validation:MaxLength=255
-	PlacementGroupName string `json:"placementGroupName,omitempty"`
+	PlacementGroup *PlacementGroup `json:"placementGroupName,omitempty"`
 }
 
 type AdditionalSecurityGroup []SecurityGroup
 
+type PlacementGroup struct {
+	// Name is the name of the placement group.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=255
+	Name string `json:"name"`
+}
+
 type SecurityGroup struct {
 	// ID is the id of the security group
 	// +kubebuilder:validation:Optional

api/v1alpha1/crds/caren.nutanix.com_awsclusterconfigs.yaml

@@ -388,10 +388,16 @@ spec:
                           default: m5.xlarge
                           type: string
                         placementGroupName:
-                          description: PlacementGroupName specifies the name of the placement group in which to launch nodes from this nodepool.
-                          maxLength: 255
-                          minLength: 1
-                          type: string
+                          description: PlacementGroup specifies the placement group in which to launch the instance.
+                          properties:
+                            name:
+                              description: Name is the name of the placement group.
+                              maxLength: 255
+                              minLength: 1
+                              type: string
+                          required:
+                            - name
+                          type: object
                       type: object
                     nodeRegistration:
                       default: {}

api/v1alpha1/crds/caren.nutanix.com_awsworkernodeconfigs.yaml

@@ -90,11 +90,17 @@ spec:
                     description: The AWS instance type to use for the cluster Machines.
                     type: string
                   placementGroupName:
-                    description: PlacementGroupName specifies the name of the placement
-                      group in which to launch nodes from this nodepool.
-                    maxLength: 255
-                    minLength: 1
-                    type: string
+                    description: PlacementGroup specifies the placement group in which
+                      to launch the instance.
+                    properties:
+                      name:
+                        description: Name is the name of the placement group.
+                        maxLength: 255
+                        minLength: 1
+                        type: string
+                    required:
+                    - name
+                    type: object
                 type: object
               nodeRegistration:
                 default: {}

api/v1alpha1/zz_generated.deepcopy.go

@@ -22,7 +22,7 @@ import (
 
 const (
 	// VariableName is the external patch variable name.
-	VariableName = "placementGroupName"
+	VariableName = "placementGroup"
 )
 
 type awsPlacementGroupControlPlanePatchHandler struct {
@@ -61,7 +61,7 @@ func (h *awsPlacementGroupControlPlanePatchHandler) Mutate(
 		"holderRef", holderRef,
 	)
 
-	placementGroupNameVar, err := variables.Get[string](
+	placementGroupVar, err := variables.Get[v1alpha1.PlacementGroup](
 		vars,
 		h.variableName,
 		h.variableFieldPath...,
@@ -80,7 +80,7 @@ func (h *awsPlacementGroupControlPlanePatchHandler) Mutate(
 		"variableFieldPath",
 		h.variableFieldPath,
 		"variableValue",
-		placementGroupNameVar,
+		placementGroupVar,
 	)
 
 	return patches.MutateIfApplicable(
@@ -98,7 +98,7 @@ func (h *awsPlacementGroupControlPlanePatchHandler) Mutate(
 				"patchedObjectName", client.ObjectKeyFromObject(obj),
 			).Info("setting placement group in control plane AWSMachineTemplate spec")
 
-			obj.Spec.Template.Spec.PlacementGroupName = placementGroupNameVar
+			obj.Spec.Template.Spec.PlacementGroupName = placementGroupVar.Name
 
 			return nil
 		},

pkg/handlers/aws/mutation/placementgroup/inject_control_plane.go

@@ -33,7 +33,7 @@ var _ = Describe("Generate PlacementGroup patches for ControlPlane", func() {
 			Vars: []runtimehooksv1.Variable{
 				capitest.VariableWithValue(
 					v1alpha1.ClusterConfigVariableName,
-					"pg-1234",
+					v1alpha1.PlacementGroup{Name: "pg-1234"},
 					v1alpha1.ControlPlaneConfigVariableName,
 					v1alpha1.AWSVariableName,
 					VariableName,

pkg/handlers/aws/mutation/placementgroup/inject_control_plane_test.go

@@ -55,7 +55,7 @@ func (h *awsPlacementGroupWorkerPatchHandler) Mutate(
 		"holderRef", holderRef,
 	)
 
-	placementGroupNameVar, err := variables.Get[string](
+	placementGroupVar, err := variables.Get[v1alpha1.PlacementGroup](
 		vars,
 		h.variableName,
 		h.variableFieldPath...,
@@ -74,7 +74,7 @@ func (h *awsPlacementGroupWorkerPatchHandler) Mutate(
 		"variableFieldPath",
 		h.variableFieldPath,
 		"variableValue",
-		placementGroupNameVar,
+		placementGroupVar,
 	)
 
 	return patches.MutateIfApplicable(
@@ -92,7 +92,7 @@ func (h *awsPlacementGroupWorkerPatchHandler) Mutate(
 				"patchedObjectName", client.ObjectKeyFromObject(obj),
 			).Info("setting placement group in workers AWSMachineTemplate spec")
 
-			obj.Spec.Template.Spec.PlacementGroupName = placementGroupNameVar
+			obj.Spec.Template.Spec.PlacementGroupName = placementGroupVar.Name
 
 			return nil
 		},

pkg/handlers/aws/mutation/placementgroup/inject_worker.go

@@ -30,7 +30,7 @@ var _ = Describe("Generate PlacementGroup patches for Worker", func() {
 			Vars: []runtimehooksv1.Variable{
 				capitest.VariableWithValue(
 					v1alpha1.WorkerConfigVariableName,
-					"pg-1234",
+					v1alpha1.PlacementGroup{Name: "pg-1234"},
 					v1alpha1.AWSVariableName,
 					VariableName,
 				),

pkg/handlers/aws/mutation/placementgroup/inject_worker_test.go

@@ -4,6 +4,7 @@
 package placementgroup
 
 import (
+	"strings"
 	"testing"
 
 	"k8s.io/utils/ptr"
@@ -26,11 +27,43 @@ func TestVariableValidation(t *testing.T) {
 				ControlPlane: &v1alpha1.AWSControlPlaneSpec{
 					AWS: &v1alpha1.AWSControlPlaneNodeSpec{
 						AWSGenericNodeSpec: v1alpha1.AWSGenericNodeSpec{
-							PlacementGroupName: "pg-1234",
+							PlacementGroup: &v1alpha1.PlacementGroup{
+								Name: "pg-1234",
+							},
 						},
 					},
 				},
 			},
 		},
+		capitest.VariableTestDef{
+			Name: "specified empty group name",
+			Vals: v1alpha1.AWSClusterConfigSpec{
+				ControlPlane: &v1alpha1.AWSControlPlaneSpec{
+					AWS: &v1alpha1.AWSControlPlaneNodeSpec{
+						AWSGenericNodeSpec: v1alpha1.AWSGenericNodeSpec{
+							PlacementGroup: &v1alpha1.PlacementGroup{
+								Name: "",
+							},
+						},
+					},
+				},
+			},
+			ExpectError: true,
+		},
+		capitest.VariableTestDef{
+			Name: "specified too long placement group name",
+			Vals: v1alpha1.AWSClusterConfigSpec{
+				ControlPlane: &v1alpha1.AWSControlPlaneSpec{
+					AWS: &v1alpha1.AWSControlPlaneNodeSpec{
+						AWSGenericNodeSpec: v1alpha1.AWSGenericNodeSpec{
+							PlacementGroup: &v1alpha1.PlacementGroup{
+								Name: strings.Repeat("a", 256), // 256 characters long
+							},
+						},
+					},
+				},
+			},
+			ExpectError: true,
+		},
 	)
 }