Skip to content

Traits: Only reconcile after onboarding and before decomissioning #191

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

Merged
fwiesel merged 1 commit into from
Dec 4, 2025
Merged

Traits: Only reconcile after onboarding and before decomissioning #191

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: 5 additions & 2 deletions internal/controller/traits_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ import (
ctrl "sigs.k8s.io/controller-runtime"
k8sclient "sigs.k8s.io/controller-runtime/pkg/client"
logger "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/predicate"

"github.com/gophercloud/gophercloud/v2"
"github.com/gophercloud/gophercloud/v2/openstack/placement/v1/resourceproviders"
Expand Down Expand Up @@ -73,6 +72,11 @@ func (tc *TraitsController) Reconcile(ctx context.Context, req ctrl.Request) (ct
return ctrl.Result{RequeueAfter: 10 * time.Second}, nil
}

if !meta.IsStatusConditionFalse(hv.Status.Conditions, ConditionTypeOnboarding) ||
meta.IsStatusConditionTrue(hv.Status.Conditions, kvmv1.ConditionTypeTerminating) {
return ctrl.Result{}, nil
}

customTraitsApplied := slices.Collect(func(yield func(string) bool) {
for _, trait := range hv.Status.Traits {
if strings.HasPrefix(trait, customPrefix) && !yield(trait) {
Expand Down Expand Up @@ -178,6 +182,5 @@ func (tc *TraitsController) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
Named(TraitsControllerName).
For(&kvmv1.Hypervisor{}).
WithEventFilter(predicate.GenerationChangedPredicate{}).
Complete(tc)
}
137 changes: 107 additions & 30 deletions internal/controller/traits_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,16 @@ import (
)

var _ = Describe("TraitsController", func() {
var (
tc *TraitsController
fakeServer testhelper.FakeServer
)

const TraitsBody = `
const (
TraitsBody = `
{
"resource_provider_generation": 1,
"traits": [
"CUSTOM_FOO",
"HW_CPU_X86_VMX"
]
}`
const TraitsBodyUpdated = `
TraitsBodyUpdated = `
{
"resource_provider_generation": 2,
"traits": [
Expand All @@ -57,12 +53,20 @@ var _ = Describe("TraitsController", func() {
"HW_CPU_X86_VMX"
]
}`
)

var (
tc *TraitsController
fakeServer testhelper.FakeServer
hypervisorName = types.NamespacedName{Name: "hv-test"}
)

// Setup and teardown

BeforeEach(func(ctx context.Context) {
By("Setting up the OpenStack http mock server")
fakeServer = testhelper.SetupHTTP()
DeferCleanup(fakeServer.Teardown)

By("Creating the TraitsController")
tc = &TraitsController{
Expand All @@ -74,39 +78,26 @@ var _ = Describe("TraitsController", func() {
By("Creating a Hypervisor resource")
hypervisor := &kvmv1.Hypervisor{
ObjectMeta: v1.ObjectMeta{
Name: "hv-test",
Namespace: "default",
Name: hypervisorName.Name,
},
Spec: kvmv1.HypervisorSpec{
LifecycleEnabled: true,
CustomTraits: []string{"CUSTOM_FOO", "CUSTOM_BAR"},
},
}
Expect(k8sClient.Create(ctx, hypervisor)).To(Succeed())
// Ensure the resource status is being updated
meta.SetStatusCondition(&hypervisor.Status.Conditions, v1.Condition{
Type: kvmv1.ConditionTypeReady,
Status: v1.ConditionTrue,
Reason: "UnitTest",
})
hypervisor.Status.Traits = []string{"CUSTOM_FOO", "HW_CPU_X86_VMX"}
hypervisor.Status.HypervisorID = "1234"
Expect(k8sClient.Status().Update(ctx, hypervisor)).To(Succeed())
})

AfterEach(func() {
By("Deleting the Hypervisor resource")
hypervisor := &kvmv1.Hypervisor{}
Expect(tc.Client.Get(ctx, types.NamespacedName{Name: "hv-test", Namespace: "default"}, hypervisor)).To(Succeed())
Expect(tc.Client.Delete(ctx, hypervisor)).To(Succeed())

By("Tearing down the OpenStack http mock server")
fakeServer.Teardown()
DeferCleanup(func(ctx context.Context) {
By("Deleting the Hypervisor resource")
hypervisor := &kvmv1.Hypervisor{}
Expect(tc.Client.Get(ctx, hypervisorName, hypervisor)).To(Succeed())
Expect(tc.Client.Delete(ctx, hypervisor)).To(Succeed())
})
})

// Tests

Context("Reconcile", func() {
Context("Reconcile after onboarding before decomissioning", func() {
BeforeEach(func() {
// Mock resourceproviders.GetTraits
fakeServer.Mux.HandleFunc("GET /resource_providers/1234/traits", func(w http.ResponseWriter, r *http.Request) {
Expand Down Expand Up @@ -142,17 +133,103 @@ var _ = Describe("TraitsController", func() {
_, err = fmt.Fprint(w, TraitsBodyUpdated)
Expect(err).NotTo(HaveOccurred())
})

hypervisor := &kvmv1.Hypervisor{}
Expect(k8sClient.Get(ctx, hypervisorName, hypervisor)).To(Succeed())
meta.SetStatusCondition(&hypervisor.Status.Conditions, v1.Condition{
Type: ConditionTypeOnboarding,
Status: v1.ConditionFalse,
Reason: "UnitTest",
})
hypervisor.Status.HypervisorID = "1234"
hypervisor.Status.Traits = []string{"CUSTOM_FOO", "HW_CPU_X86_VMX"}
Expect(k8sClient.Status().Update(ctx, hypervisor)).To(Succeed())
})

It("should update traits and set status condition when traits differ", func() {
req := ctrl.Request{NamespacedName: types.NamespacedName{Name: "hv-test", Namespace: "default"}}
req := ctrl.Request{NamespacedName: hypervisorName}
_, err := tc.Reconcile(ctx, req)
Expect(err).NotTo(HaveOccurred())

updated := &kvmv1.Hypervisor{}
Expect(tc.Client.Get(ctx, req.NamespacedName, updated)).To(Succeed())
Expect(tc.Client.Get(ctx, hypervisorName, updated)).To(Succeed())
Expect(updated.Status.Traits).To(ContainElements("CUSTOM_FOO", "CUSTOM_BAR", "HW_CPU_X86_VMX"))
Expect(meta.IsStatusConditionTrue(updated.Status.Conditions, ConditionTypeTraitsUpdated)).To(BeTrue())
})
})

Context("Reconcile before onboarding", func() {
BeforeEach(func() {
// Mock resourceproviders.GetTraits
fakeServer.Mux.HandleFunc("GET /resource_providers/1234/traits", func(w http.ResponseWriter, r *http.Request) {
defer GinkgoRecover()
Fail("should not be called")
})
// Mock resourceproviders.UpdateTraits
fakeServer.Mux.HandleFunc("PUT /resource_providers/1234/traits", func(w http.ResponseWriter, r *http.Request) {
defer GinkgoRecover()
Fail("should not be called")
})

hypervisor := &kvmv1.Hypervisor{}
Expect(k8sClient.Get(ctx, hypervisorName, hypervisor)).To(Succeed())
hypervisor.Status.HypervisorID = "1234"
hypervisor.Status.Traits = []string{"CUSTOM_FOO", "HW_CPU_X86_VMX"}
Expect(k8sClient.Status().Update(ctx, hypervisor)).To(Succeed())
})

It("should not update traits", func() {
req := ctrl.Request{NamespacedName: hypervisorName}
_, err := tc.Reconcile(ctx, req)
Expect(err).NotTo(HaveOccurred())

updated := &kvmv1.Hypervisor{}
Expect(tc.Client.Get(ctx, hypervisorName, updated)).To(Succeed())
Expect(updated.Status.Traits).NotTo(ContainElements("CUSTOM_FOO", "CUSTOM_BAR", "HW_CPU_X86_VMX"))
Expect(meta.IsStatusConditionTrue(updated.Status.Conditions, ConditionTypeTraitsUpdated)).To(BeFalse())
})
})

Context("Reconcile when terminating", func() {
BeforeEach(func() {
// Mock resourceproviders.GetTraits
fakeServer.Mux.HandleFunc("GET /resource_providers/1234/traits", func(w http.ResponseWriter, r *http.Request) {
defer GinkgoRecover()
Fail("should not be called")
})
// Mock resourceproviders.UpdateTraits
fakeServer.Mux.HandleFunc("PUT /resource_providers/1234/traits", func(w http.ResponseWriter, r *http.Request) {
defer GinkgoRecover()
Fail("should not be called")
})

hypervisor := &kvmv1.Hypervisor{}
Expect(k8sClient.Get(ctx, hypervisorName, hypervisor)).To(Succeed())
meta.SetStatusCondition(&hypervisor.Status.Conditions, v1.Condition{
Type: ConditionTypeOnboarding,
Status: v1.ConditionFalse,
Reason: "UnitTest",
})
meta.SetStatusCondition(&hypervisor.Status.Conditions, v1.Condition{
Type: kvmv1.ConditionTypeTerminating,
Status: v1.ConditionTrue,
Reason: "UnitTest",
})
hypervisor.Status.Traits = []string{"CUSTOM_FOO", "HW_CPU_X86_VMX"}
hypervisor.Status.HypervisorID = "1234"
Expect(k8sClient.Status().Update(ctx, hypervisor)).To(Succeed())

})

It("should not update traits", func() {
req := ctrl.Request{NamespacedName: hypervisorName}
_, err := tc.Reconcile(ctx, req)
Expect(err).NotTo(HaveOccurred())

updated := &kvmv1.Hypervisor{}
Expect(tc.Client.Get(ctx, hypervisorName, updated)).To(Succeed())
Expect(updated.Status.Traits).NotTo(ContainElements("CUSTOM_FOO", "CUSTOM_BAR", "HW_CPU_X86_VMX"))
Expect(meta.IsStatusConditionTrue(updated.Status.Conditions, ConditionTypeTraitsUpdated)).To(BeFalse())
})
})
})
Loading