Skip to content

fix: check unprefixed os.unmanaged annotation in reset plan selection #1024

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.

Sign up for GitHub

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

Draft
aeltai wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: check unprefixed os.unmanaged annotation in reset plan selection #1024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion controllers/machineinventory_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,12 @@ func (r *MachineInventoryReconciler) updatePlanSecretWithReset(ctx context.Conte
networkNeedsReset := mInventory.Spec.Network.Configurator != network.ConfiguratorNone

unmanaged, unmanagedFound := mInventory.Annotations[elementalv1.MachineInventoryOSUnmanagedAnnotation]
if unmanagedFound && unmanaged == "true" {
// Backward-compat / labelPrefix edge-case:
// When MachineRegistration.spec.labelPrefix is "-", prefixing of client-sent
// dynamic annotations is disabled, which may result in the operator storing
// the unmanaged flag under the unprefixed key "os.unmanaged".
unmanagedUnprefixed, unmanagedUnprefixedFound := mInventory.Annotations["os.unmanaged"]
if (unmanagedFound && unmanaged == "true") || (unmanagedUnprefixedFound && unmanagedUnprefixed == "true") {
checksum, resetPlan, err = r.newUnmanagedResetPlan(ctx)
} else {
checksum, resetPlan, err = r.newResetPlan(ctx, networkNeedsReset)
Expand Down
36 changes: 36 additions & 0 deletions controllers/machineinventory_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,6 +754,42 @@ var _ = Describe("handle unmanaged finalizer", func() {
}, mInventory)).To(Succeed())
})

It("should update secret with reset plan when unprefixed os.unmanaged annotation is true", func() {
// Remove the prefixed annotation so the test only passes if the
// controller also checks the unprefixed key.
delete(mInventory.Annotations, elementalv1.MachineInventoryOSUnmanagedAnnotation)

Expect(cl.Get(ctx, client.ObjectKey{
Name: planSecret.Name,
Namespace: planSecret.Namespace,
}, planSecret)).To(Succeed())
Expect(cl.Get(ctx, client.ObjectKey{
Name: mInventory.Name,
Namespace: mInventory.Namespace,
}, mInventory)).To(Succeed())

delete(mInventory.Annotations, elementalv1.MachineInventoryOSUnmanagedAnnotation)
mInventory.Annotations["os.unmanaged"] = "true"
Expect(cl.Update(ctx, mInventory)).To(Succeed())

_, wantPlan, err := r.newUnmanagedResetPlan(ctx)
Expect(err).ToNot(HaveOccurred())

// Check we are holding on the MachineInventory (preventing actual deletion)
_, err = r.Reconcile(ctx, reconcile.Request{
NamespacedName: types.NamespacedName{
Namespace: mInventory.Namespace,
Name: mInventory.Name,
},
})
Expect(err).ToNot(HaveOccurred())

Expect(planSecret.Annotations[elementalv1.PlanTypeAnnotation]).To(Equal(elementalv1.PlanTypeReset))
Expect(string(planSecret.Data["plan"])).To(Equal(string(wantPlan)))
Expect(string(planSecret.Data["applied-checksum"])).To(Equal(""))
Expect(string(planSecret.Data["failed-checksum"])).To(Equal(""))
})

It("should remove finalizer on unmanaged reset plan applied", func() {
// 6. Mark the reset plan as applied
Expect(cl.Get(ctx, client.ObjectKey{
Expand Down