Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Fix enabling of disabled bastion on upgrade to v1beta1 #2052

Merged
merged 1 commit into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion api/v1alpha6/openstackcluster_conversion.go
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,10 @@ func restorev1beta1Bastion(previous **infrav1.Bastion, dst **infrav1.Bastion) {

optional.RestoreString(&(*previous).FloatingIP, &(*dst).FloatingIP)
optional.RestoreString(&(*previous).AvailabilityZone, &(*dst).AvailabilityZone)
optional.RestoreBool(&(*previous).Enabled, &(*dst).Enabled)

if (*dst).Enabled != nil && !*(*dst).Enabled {
(*dst).Enabled = (*previous).Enabled
}
}

func Convert_v1alpha6_Bastion_To_v1beta1_Bastion(in *Bastion, out *infrav1.Bastion, s apiconversion.Scope) error {
Expand Down
4 changes: 2 additions & 2 deletions api/v1alpha6/zz_generated.conversion.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion api/v1alpha7/openstackcluster_conversion.go
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,10 @@ func restorev1beta1Bastion(previous **infrav1.Bastion, dst **infrav1.Bastion) {
restorev1beta1MachineSpec((*previous).Spec, (*dst).Spec)
optional.RestoreString(&(*previous).FloatingIP, &(*dst).FloatingIP)
optional.RestoreString(&(*previous).AvailabilityZone, &(*dst).AvailabilityZone)
optional.RestoreBool(&(*previous).Enabled, &(*dst).Enabled)

if (*dst).Enabled != nil && !*(*dst).Enabled {
(*dst).Enabled = (*previous).Enabled
}
}

func Convert_v1alpha7_Bastion_To_v1beta1_Bastion(in *Bastion, out *infrav1.Bastion, s apiconversion.Scope) error {
Expand Down
4 changes: 2 additions & 2 deletions api/v1alpha7/zz_generated.conversion.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/v1beta1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ type Bastion struct {
// waiting until the bastion has been deleted.
// +kubebuilder:default:=true
// +optional
Enabled optional.Bool `json:"enabled,omitempty"`
Enabled *bool `json:"enabled,omitempty"`

// Spec for the bastion itself
Spec *OpenStackMachineSpec `json:"spec,omitempty"`
Expand Down
18 changes: 18 additions & 0 deletions test/e2e/suites/apivalidations/openstackcluster_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -214,5 +214,23 @@ var _ = Describe("OpenStackCluster API validations", func() {
Expect(cluster.Spec.ControlPlaneEndpoint).To(Equal(*infrav1Cluster.Spec.ControlPlaneEndpoint), "Control plane endpoint should be restored")
Expect(cluster.Spec.IdentityRef.Kind).To(Equal("FakeKind"), "IdentityRef.Kind should be restored")
})

It("should not enable an explicitly disabled bastion when converting to v1beta1", func() {
cluster.Spec.Bastion = &infrav1alpha7.Bastion{Enabled: false}
Expect(create(cluster)).To(Succeed(), "OpenStackCluster creation should succeed")

// Fetch the infrav1 version of the cluster
infrav1Cluster := &infrav1.OpenStackCluster{}
Expect(k8sClient.Get(ctx, types.NamespacedName{Name: cluster.Name, Namespace: cluster.Namespace}, infrav1Cluster)).To(Succeed(), "OpenStackCluster fetch should succeed")

infrav1Bastion := infrav1Cluster.Spec.Bastion

// NOTE(mdbooth): It may be reasonable to remove the
// bastion if it is disabled with no other properties.
// It would be reasonable to update the assertions
// accordingly if we did that.
Expect(infrav1Bastion).ToNot(BeNil(), "Bastion should not have been removed")
Expect(infrav1Bastion.Enabled).To(Equal(ptr.To(false)), "Bastion should remain disabled")
})
})
})