Skip to content

Commit 70b4a79

Browse files
bnallapetabnallapeta
committed
unit tests: add cases for nil network and SG override
Signed-off-by: Bharath Nallapeta <[email protected]>
1 parent 02169f4 commit 70b4a79

File tree

3 files changed

+116
-26
lines changed

3 files changed

+116
-26
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,
@@ -541,7 +552,7 @@ func openStackMachineSpecToOpenStackServerSpec(openStackMachineSpec *infrav1.Ope
541552
}
542553
openStackServerSpec.Ports = serverPorts
543554

544-
return openStackServerSpec
555+
return openStackServerSpec, nil
545556
}
546557

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

‎controllers/openstackmachine_controller_test.go‎

Lines changed: 86 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,6 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
8282
ID: ptr.To(openStackCluster.Status.Network.ID),
8383
},
8484
SecurityGroups: []infrav1.SecurityGroupParam{
85-
{
86-
ID: ptr.To(openStackCluster.Status.WorkerSecurityGroup.ID),
87-
},
8885
{
8986
ID: ptr.To(extraSecurityGroupUUID),
9087
},
@@ -95,9 +92,11 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
9592
tags := []string{"tag1", "tag2"}
9693
userData := &corev1.LocalObjectReference{Name: "server-data-secret"}
9794
tests := []struct {
98-
name string
99-
spec *infrav1.OpenStackMachineSpec
100-
want *infrav1alpha1.OpenStackServerSpec
95+
name string
96+
spec *infrav1.OpenStackMachineSpec
97+
clusterNetwork *infrav1.NetworkStatusWithSubnets
98+
want *infrav1alpha1.OpenStackServerSpec
99+
wantErr bool
101100
}{
102101
{
103102
name: "Test a minimum OpenStackMachineSpec to OpenStackServerSpec conversion",
@@ -106,6 +105,7 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
106105
Image: image,
107106
SSHKeyName: sshKeyName,
108107
},
108+
clusterNetwork: openStackCluster.Status.Network,
109109
want: &infrav1alpha1.OpenStackServerSpec{
110110
Flavor: ptr.To(flavorName),
111111
IdentityRef: identityRef,
@@ -128,6 +128,7 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
128128
},
129129
},
130130
},
131+
clusterNetwork: openStackCluster.Status.Network,
131132
want: &infrav1alpha1.OpenStackServerSpec{
132133
Flavor: ptr.To(flavorName),
133134
IdentityRef: identityRef,
@@ -146,6 +147,7 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
146147
Image: image,
147148
SSHKeyName: sshKeyName,
148149
},
150+
clusterNetwork: openStackCluster.Status.Network,
149151
want: &infrav1alpha1.OpenStackServerSpec{
150152
Flavor: ptr.To(flavorName),
151153
FlavorID: ptr.To(flavorUUID),
@@ -164,6 +166,7 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
164166
Image: image,
165167
SSHKeyName: sshKeyName,
166168
},
169+
clusterNetwork: openStackCluster.Status.Network,
167170
want: &infrav1alpha1.OpenStackServerSpec{
168171
FlavorID: ptr.To(flavorUUID),
169172
IdentityRef: identityRef,
@@ -174,12 +177,87 @@ func TestOpenStackMachineSpecToOpenStackServerSpec(t *testing.T) {
174177
UserDataRef: userData,
175178
},
176179
},
180+
{
181+
name: "Cluster network nil, machine defines port network and overrides SG",
182+
spec: &infrav1.OpenStackMachineSpec{
183+
Ports: []infrav1.PortOpts{{
184+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
185+
}},
186+
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(extraSecurityGroupUUID)}},
187+
},
188+
clusterNetwork: nil,
189+
want: &infrav1alpha1.OpenStackServerSpec{
190+
IdentityRef: identityRef,
191+
Ports: []infrav1.PortOpts{{
192+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
193+
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(extraSecurityGroupUUID)}},
194+
}},
195+
Tags: tags,
196+
UserDataRef: userData,
197+
},
198+
},
199+
{
200+
name: "Cluster network nil, machine defines port network and falls back to cluster SG",
201+
spec: &infrav1.OpenStackMachineSpec{
202+
Ports: []infrav1.PortOpts{{
203+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
204+
}},
205+
},
206+
clusterNetwork: nil,
207+
want: &infrav1alpha1.OpenStackServerSpec{
208+
IdentityRef: identityRef,
209+
Ports: []infrav1.PortOpts{{
210+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
211+
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(workerSecurityGroupUUID)}},
212+
}},
213+
Tags: tags,
214+
UserDataRef: userData,
215+
},
216+
},
217+
{
218+
name: "Error case: no cluster network and no machine ports",
219+
spec: &infrav1.OpenStackMachineSpec{
220+
Flavor: ptr.To(flavorName),
221+
Image: image,
222+
SSHKeyName: sshKeyName,
223+
// No ports defined
224+
},
225+
clusterNetwork: nil,
226+
want: nil,
227+
wantErr: true,
228+
},
229+
{
230+
name: "Empty cluster network ID, machine defines explicit ports",
231+
spec: &infrav1.OpenStackMachineSpec{
232+
Flavor: ptr.To(flavorName),
233+
Image: image,
234+
Ports: []infrav1.PortOpts{{
235+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
236+
}},
237+
},
238+
clusterNetwork: &infrav1.NetworkStatusWithSubnets{NetworkStatus: infrav1.NetworkStatus{ID: ""}},
239+
want: &infrav1alpha1.OpenStackServerSpec{
240+
Flavor: ptr.To(flavorName),
241+
IdentityRef: identityRef,
242+
Image: image,
243+
Ports: []infrav1.PortOpts{{
244+
Network: &infrav1.NetworkParam{ID: ptr.To(networkUUID)},
245+
SecurityGroups: []infrav1.SecurityGroupParam{{ID: ptr.To(workerSecurityGroupUUID)}},
246+
}},
247+
Tags: tags,
248+
UserDataRef: userData,
249+
},
250+
},
177251
}
178252
for i := range tests {
179253
tt := tests[i]
180254
t.Run(tt.name, func(t *testing.T) {
181-
spec := openStackMachineSpecToOpenStackServerSpec(tt.spec, identityRef, tags, "", userData, &openStackCluster.Status.WorkerSecurityGroup.ID, openStackCluster.Status.Network.ID)
182-
if !reflect.DeepEqual(spec, tt.want) {
255+
spec, err := openStackMachineSpecToOpenStackServerSpec(tt.spec, identityRef, tags, "", userData, &openStackCluster.Status.WorkerSecurityGroup.ID, tt.clusterNetwork)
256+
if (err != nil) != tt.wantErr {
257+
t.Errorf("openStackMachineSpecToOpenStackServerSpec() error = %v, wantErr %v", err, tt.wantErr)
258+
return
259+
}
260+
if !tt.wantErr && !reflect.DeepEqual(spec, tt.want) {
183261
t.Errorf("openStackMachineSpecToOpenStackServerSpec() got = %+v, want %+v", spec, tt.want)
184262
}
185263
})

0 commit comments

Comments
 (0)