Skip to content

Commit 8ce68fd

Browse files
committed
worked on PR comments: change in logic validation
Signed-off-by: Bharath Nallapeta <[email protected]>
1 parent 68f2229 commit 8ce68fd

File tree

3 files changed

+148
-88
lines changed

3 files changed

+148
-88
lines changed

controllers/openstackcluster_controller.go

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,10 @@ func (r *OpenStackClusterReconciler) reconcileBastionServer(ctx context.Context,
499499
}
500500

501501
// If the bastion is found but the spec has changed, we need to delete it and reconcile.
502-
bastionServerSpec := bastionToOpenStackServerSpec(openStackCluster)
502+
bastionServerSpec, err := bastionToOpenStackServerSpec(openStackCluster)
503+
if err != nil {
504+
return nil, true, err
505+
}
503506
if !bastionNotFound && server != nil && !apiequality.Semantic.DeepEqual(bastionServerSpec, &server.Spec) {
504507
scope.Logger().Info("Bastion spec has changed, re-creating the OpenStackServer object")
505508
if err := r.deleteBastion(ctx, scope, cluster, openStackCluster); err != nil {
@@ -545,7 +548,10 @@ func (r *OpenStackClusterReconciler) getBastionServer(ctx context.Context, openS
545548
// createBastionServer creates the OpenStackServer object for the bastion server.
546549
// It returns the OpenStackServer object and an error if any.
547550
func (r *OpenStackClusterReconciler) createBastionServer(ctx context.Context, openStackCluster *infrav1.OpenStackCluster, cluster *clusterv1.Cluster) (*infrav1alpha1.OpenStackServer, error) {
548-
bastionServerSpec := bastionToOpenStackServerSpec(openStackCluster)
551+
bastionServerSpec, err := bastionToOpenStackServerSpec(openStackCluster)
552+
if err != nil {
553+
return nil, err
554+
}
549555
bastionServer := &infrav1alpha1.OpenStackServer{
550556
ObjectMeta: metav1.ObjectMeta{
551557
Labels: map[string]string{
@@ -573,7 +579,7 @@ func (r *OpenStackClusterReconciler) createBastionServer(ctx context.Context, op
573579

574580
// bastionToOpenStackServerSpec converts the OpenStackMachineSpec for the bastion to an OpenStackServerSpec.
575581
// It returns the OpenStackServerSpec and an error if any.
576-
func bastionToOpenStackServerSpec(openStackCluster *infrav1.OpenStackCluster) *infrav1alpha1.OpenStackServerSpec {
582+
func bastionToOpenStackServerSpec(openStackCluster *infrav1.OpenStackCluster) (*infrav1alpha1.OpenStackServerSpec, error) {
577583
bastion := openStackCluster.Spec.Bastion
578584
if bastion == nil {
579585
bastion = &infrav1.Bastion{}
@@ -588,9 +594,12 @@ func bastionToOpenStackServerSpec(openStackCluster *infrav1.OpenStackCluster) *i
588594
if bastion.AvailabilityZone != nil {
589595
az = *bastion.AvailabilityZone
590596
}
591-
openStackServerSpec := openStackMachineSpecToOpenStackServerSpec(bastion.Spec, openStackCluster.Spec.IdentityRef, compute.InstanceTags(bastion.Spec, openStackCluster), az, nil, getBastionSecurityGroupID(openStackCluster), openStackCluster.Status.Network.ID)
597+
openStackServerSpec, err := openStackMachineSpecToOpenStackServerSpec(bastion.Spec, openStackCluster.Spec.IdentityRef, compute.InstanceTags(bastion.Spec, openStackCluster), az, nil, getBastionSecurityGroupID(openStackCluster), openStackCluster.Status.Network)
598+
if err != nil {
599+
return nil, err
600+
}
592601

593-
return openStackServerSpec
602+
return openStackServerSpec, nil
594603
}
595604

596605
func bastionName(clusterResourceName string) string {

controllers/openstackmachine_controller.go

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,18 @@ func (r *OpenStackMachineReconciler) getMachineServer(ctx context.Context, openS
480480

481481
// openStackMachineSpecToOpenStackServerSpec converts an OpenStackMachineSpec to an OpenStackServerSpec.
482482
// It returns the OpenStackServerSpec object and an error if there is any.
483-
func openStackMachineSpecToOpenStackServerSpec(openStackMachineSpec *infrav1.OpenStackMachineSpec, identityRef infrav1.OpenStackIdentityReference, tags []string, failureDomain string, userDataRef *corev1.LocalObjectReference, defaultSecGroup *string, defaultNetworkID string) *infrav1alpha1.OpenStackServerSpec {
483+
func openStackMachineSpecToOpenStackServerSpec(openStackMachineSpec *infrav1.OpenStackMachineSpec, identityRef infrav1.OpenStackIdentityReference, tags []string, failureDomain string, userDataRef *corev1.LocalObjectReference, defaultSecGroup *string, clusterNetwork *infrav1.NetworkStatusWithSubnets) (*infrav1alpha1.OpenStackServerSpec, error) {
484+
// Determine default network ID if the cluster status exposes one.
485+
var defaultNetworkID string
486+
if clusterNetwork != nil {
487+
defaultNetworkID = clusterNetwork.ID
488+
}
489+
490+
// If no cluster network is available AND the machine spec did not define any ports with a network, we cannot choose a network.
491+
if defaultNetworkID == "" && len(openStackMachineSpec.Ports) == 0 {
492+
return nil, capoerrors.Terminal(infrav1.InvalidMachineSpecReason, "no network configured: cluster network is missing and machine spec does not define ports with a network")
493+
}
494+
484495
openStackServerSpec := &infrav1alpha1.OpenStackServerSpec{
485496
AdditionalBlockDevices: openStackMachineSpec.AdditionalBlockDevices,
486497
ConfigDrive: openStackMachineSpec.ConfigDrive,
@@ -536,7 +547,7 @@ func openStackMachineSpecToOpenStackServerSpec(openStackMachineSpec *infrav1.Ope
536547
}
537548
openStackServerSpec.Ports = serverPorts
538549

539-
return openStackServerSpec
550+
return openStackServerSpec, nil
540551
}
541552

542553
// reconcileMachineServer reconciles the OpenStackServer object for the OpenStackMachine.
@@ -585,18 +596,10 @@ func (r *OpenStackMachineReconciler) getOrCreateMachineServer(ctx context.Contex
585596
}
586597
return openStackCluster.Spec.IdentityRef
587598
}()
588-
// Determine default network ID if the cluster status exposes one.
589-
var defaultNetworkID string
590-
if openStackCluster.Status.Network != nil {
591-
defaultNetworkID = openStackCluster.Status.Network.ID
592-
}
593-
594-
// If no cluster network is available AND the machine spec did not define any ports with a network, we cannot choose a network.
595-
if defaultNetworkID == "" && len(openStackMachine.Spec.Ports) == 0 {
596-
return nil, capoerrors.Terminal(infrav1.InvalidMachineSpecReason, "no network configured: cluster network is missing and machine spec does not define ports with a network")
599+
machineServerSpec, err := openStackMachineSpecToOpenStackServerSpec(&openStackMachine.Spec, identityRef, compute.InstanceTags(&openStackMachine.Spec, openStackCluster), failureDomain, userDataRef, getManagedSecurityGroup(openStackCluster, machine), openStackCluster.Status.Network)
600+
if err != nil {
601+
return nil, err
597602
}
598-
599-
machineServerSpec := openStackMachineSpecToOpenStackServerSpec(&openStackMachine.Spec, identityRef, compute.InstanceTags(&openStackMachine.Spec, openStackCluster), failureDomain, userDataRef, getManagedSecurityGroup(openStackCluster, machine), defaultNetworkID)
600603
machineServer = &infrav1alpha1.OpenStackServer{
601604
ObjectMeta: metav1.ObjectMeta{
602605
Labels: map[string]string{

controllers/openstackmachine_controller_test.go

Lines changed: 118 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -77,24 +77,25 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
7777
},
7878
}
7979
portOptsWithAdditionalSecurityGroup := []infrav1.PortOpts{
80-
{
81-
Network: &infrav1.NetworkParam{
82-
ID: ptr.To(openStackCluster.Status.Network.ID),
83-
},
84-
SecurityGroups: []infrav1.SecurityGroupParam{
85-
{
86-
ID: ptr.To(extraSecurityGroupUUID),
87-
},
88-
},
89-
},
90-
}
80+
{
81+
Network: &infrav1.NetworkParam{
82+
ID: ptr.To(openStackCluster.Status.Network.ID),
83+
},
84+
SecurityGroups: []infrav1.SecurityGroupParam{
85+
{
86+
ID: ptr.To(extraSecurityGroupUUID),
87+
},
88+
},
89+
},
90+
}
9191
image := infrav1.ImageParam{Filter: &infrav1.ImageFilter{Name: ptr.To("my-image")}}
9292
tags := []string{"tag1", "tag2"}
9393
userData := &corev1.LocalObjectReference{Name: "server-data-secret"}
9494
tests := []struct {
95-
name string
96-
spec *infrav1.OpenStackMachineSpec
97-
want *infrav1alpha1.OpenStackServerSpec
95+
name string
96+
spec *infrav1.OpenStackMachineSpec
97+
want *infrav1alpha1.OpenStackServerSpec
98+
wantErr bool
9899
}{
99100
{
100101
name: "Test a minimum OpenStackMachineSpec to OpenStackServerSpec conversion",
@@ -155,68 +156,115 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
155156
},
156157
},
157158
{
158-
name: "Test an OpenStackMachineSpec to OpenStackServerSpec conversion with flavorID specified but not flavor",
159-
spec: &infrav1.OpenStackMachineSpec{
160-
FlavorID: ptr.To(flavorUUID),
161-
Image: image,
162-
SSHKeyName: sshKeyName,
163-
},
164-
want: &infrav1alpha1.OpenStackServerSpec{
165-
FlavorID: ptr.To(flavorUUID),
166-
IdentityRef: identityRef,
167-
Image: image,
168-
SSHKeyName: sshKeyName,
169-
Ports: portOpts,
170-
Tags: tags,
171-
UserDataRef: userData,
172-
},
173-
},
174-
{
175-
name: "Cluster network nil, machine defines port network and overrides SG",
176-
spec: &infrav1.OpenStackMachineSpec{
177-
Ports: []infrav1.PortOpts{{
178-
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
179-
}},
180-
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(extraSecurityGroupUUID)}},
181-
},
182-
want: &infrav1alpha1.OpenStackServerSpec{
183-
IdentityRef: identityRef,
184-
Ports: []infrav1.PortOpts{{
185-
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
186-
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(extraSecurityGroupUUID)}},
187-
}},
188-
Tags: tags,
189-
UserDataRef: userData,
190-
},
191-
},
192-
{
193-
name: "Cluster network nil, machine defines port network and falls back to cluster SG",
194-
spec: &infrav1.OpenStackMachineSpec{
195-
Ports: []infrav1.PortOpts{{
196-
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
197-
}},
198-
},
199-
want: &infrav1alpha1.OpenStackServerSpec{
200-
IdentityRef: identityRef,
201-
Ports: []infrav1.PortOpts{{
202-
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
203-
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(workerSecurityGroupUUID)}},
204-
}},
205-
Tags: tags,
206-
UserDataRef: userData,
207-
},
208-
},
159+
name: "Test an OpenStackMachineSpec to OpenStackServerSpec conversion with flavorID specified but not flavor",
160+
spec: &infrav1.OpenStackMachineSpec{
161+
FlavorID: ptr.To(flavorUUID),
162+
Image: image,
163+
SSHKeyName: sshKeyName,
164+
},
165+
want: &infrav1alpha1.OpenStackServerSpec{
166+
FlavorID: ptr.To(flavorUUID),
167+
IdentityRef: identityRef,
168+
Image: image,
169+
SSHKeyName: sshKeyName,
170+
Ports: portOpts,
171+
Tags: tags,
172+
UserDataRef: userData,
173+
},
174+
},
175+
{
176+
name: "Cluster network nil, machine defines port network and overrides SG",
177+
spec: &infrav1.OpenStackMachineSpec{
178+
Ports: []infrav1.PortOpts{{
179+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
180+
}},
181+
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(extraSecurityGroupUUID)}},
182+
},
183+
want: &infrav1alpha1.OpenStackServerSpec{
184+
IdentityRef: identityRef,
185+
Ports: []infrav1.PortOpts{{
186+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
187+
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(extraSecurityGroupUUID)}},
188+
}},
189+
Tags: tags,
190+
UserDataRef: userData,
191+
},
192+
},
193+
{
194+
name: "Cluster network nil, machine defines port network and falls back to cluster SG",
195+
spec: &infrav1.OpenStackMachineSpec{
196+
Ports: []infrav1.PortOpts{{
197+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
198+
}},
199+
},
200+
want: &infrav1alpha1.OpenStackServerSpec{
201+
IdentityRef: identityRef,
202+
Ports: []infrav1.PortOpts{{
203+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
204+
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(workerSecurityGroupUUID)}},
205+
}},
206+
Tags: tags,
207+
UserDataRef: userData,
208+
},
209+
},
210+
{
211+
name: "Error case: no cluster network and no machine ports",
212+
spec: &infrav1.OpenStackMachineSpec{
213+
Flavor: ptr.To(flavorName),
214+
Image: image,
215+
SSHKeyName: sshKeyName,
216+
// No ports defined
217+
},
218+
want: nil,
219+
wantErr: true,
220+
},
221+
{
222+
name: "Empty cluster network ID, machine defines explicit ports",
223+
spec: &infrav1.OpenStackMachineSpec{
224+
Flavor: ptr.To(flavorName),
225+
Image: image,
226+
Ports: []infrav1.PortOpts{{
227+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
228+
}},
229+
},
230+
want: &infrav1alpha1.OpenStackServerSpec{
231+
Flavor: ptr.To(flavorName),
232+
IdentityRef: identityRef,
233+
Image: image,
234+
Ports: []infrav1.PortOpts{{
235+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
236+
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(workerSecurityGroupUUID)}},
237+
}},
238+
Tags: tags,
239+
UserDataRef: userData,
240+
},
241+
},
209242
}
210243
for i := range tests {
211244
tt := tests[i]
212245
t.Run(tt.name, func(t *testing.T) {
213-
defaultNetID := ""
214-
if openStackCluster.Status.Network != nil {
215-
defaultNetID = openStackCluster.Status.Network.ID
246+
// Handle special test cases
247+
var clusterNetwork *infrav1.NetworkStatusWithSubnets
248+
switch {
249+
case tt.wantErr && tt.name == "Error case: no cluster network and no machine ports":
250+
clusterNetwork = nil // Simulate nil cluster network for HCP scenario
251+
case tt.name == "Empty cluster network ID, machine defines explicit ports":
252+
// Create a cluster network with empty ID
253+
clusterNetwork = &infrav1.NetworkStatusWithSubnets{
254+
NetworkStatus: infrav1.NetworkStatus{
255+
ID: "", // Empty network ID
256+
},
257+
}
258+
default:
259+
clusterNetwork = openStackCluster.Status.Network
216260
}
217261

218-
spec := openStackMachineSpecToOpenStackServerSpec(tt.spec, identityRef, tags, "", userData, &openStackCluster.Status.WorkerSecurityGroup.ID, defaultNetID)
219-
if !reflect.DeepEqual(spec, tt.want) {
262+
spec, err := openStackMachineSpecToOpenStackServerSpec(tt.spec, identityRef, tags, "", userData, &openStackCluster.Status.WorkerSecurityGroup.ID, clusterNetwork)
263+
if (err != nil) != tt.wantErr {
264+
t.Errorf("openStackMachineSpecToOpenStackServerSpec() error = %v, wantErr %v", err, tt.wantErr)
265+
return
266+
}
267+
if !tt.wantErr && !reflect.DeepEqual(spec, tt.want) {
220268
t.Errorf("openStackMachineSpecToOpenStackServerSpec() got = %+v, want %+v", spec, tt.want)
221269
}
222270
})

0 commit comments

Comments
 (0)