Skip to content

ROX-30138: Add tests for WithSelector #496

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

ROX-30138: Add tests for WithSelector #496

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
24bd217
Add tests for WithSelector
kurlov Oct 20, 2025
25d253a
Fix lint
kurlov Oct 23, 2025
d486710
Small fix
kurlov Nov 3, 2025
23cd0b6
Apply suggestions from code review
kurlov Nov 4, 2025
0a43969
Fix indentation
kurlov Nov 4, 2025
072866a
Use hooks and add another test with two managers
kurlov Nov 27, 2025
25d4810
Fix linting
kurlov Nov 27, 2025
ae66a85
Improve assertion
kurlov Nov 27, 2025
bd631b6
Add managers cleanup and change Eventually asserting for mutex objects
kurlov Dec 1, 2025
9149213
return protobuf Size() method for label setup check
kurlov Dec 1, 2025
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
171 changes: 132 additions & 39 deletions pkg/reconciler/reconciler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import (
"errors"
"fmt"
"strconv"
"strings"
"sync"
"time"

. "github.com/onsi/ginkgo/v2"
Expand Down Expand Up @@ -49,6 +51,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
"sigs.k8s.io/controller-runtime/pkg/config"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
"sigs.k8s.io/controller-runtime/pkg/manager"
Expand Down Expand Up @@ -1492,45 +1495,6 @@ var _ = Describe("Reconciler", func() {
})
})
})
When("label selector set", func() {
It("reconcile only matching CR", func() {
By("adding selector to the reconciler", func() {
selectorFoo := metav1.LabelSelector{MatchLabels: map[string]string{"app": "foo"}}
Expect(WithSelector(selectorFoo)(r)).To(Succeed())
})

By("adding not matching label to the CR", func() {
Expect(mgr.GetClient().Get(ctx, objKey, obj)).To(Succeed())
obj.SetLabels(map[string]string{"app": "bar"})
Expect(mgr.GetClient().Update(ctx, obj)).To(Succeed())
})

By("reconciling skipped and no actions for the release", func() {
res, err := r.Reconcile(ctx, req)
Expect(res).To(Equal(reconcile.Result{}))
Expect(err).ToNot(HaveOccurred())
})

By("verifying the release has not changed", func() {
rel, err := ac.Get(obj.GetName())
Expect(err).ToNot(HaveOccurred())
Expect(rel).NotTo(BeNil())
Expect(*rel).To(Equal(*currentRelease))
})

By("adding matching label to the CR", func() {
Expect(mgr.GetClient().Get(ctx, objKey, obj)).To(Succeed())
obj.SetLabels(map[string]string{"app": "foo"})
Expect(mgr.GetClient().Update(ctx, obj)).To(Succeed())
})

By("successfully reconciling with correct labels", func() {
res, err := r.Reconcile(ctx, req)
Expect(res).To(Equal(reconcile.Result{}))
Expect(err).ToNot(HaveOccurred())
})
})
})
})
})
})
Expand All @@ -1545,6 +1509,135 @@ var _ = Describe("Reconciler", func() {
})
})

_ = Describe("WithSelector test", func() {
var (
mgr manager.Manager
ctx context.Context
cancel context.CancelFunc
reconciledCRs []string
reconciledCRsMutex sync.Mutex
labeledObj *unstructured.Unstructured
unlabeledObj *unstructured.Unstructured
labeledObjKey types.NamespacedName
unlabeledObjKey types.NamespacedName
)

BeforeEach(func() {
reconciledCRs = []string{}
mgr = getManagerOrFail()
matchingLabels := map[string]string{"app": "foo"}

r, err := New(
WithGroupVersionKind(gvk),
WithChart(chrt),
WithSelector(metav1.LabelSelector{MatchLabels: matchingLabels}),
)
Expect(err).ToNot(HaveOccurred())

reconciler := reconcile.Func(func(ctx context.Context, req reconcile.Request) (reconcile.Result, error) {
reconciledCRsMutex.Lock()
reconciledCRs = append(reconciledCRs, req.NamespacedName.String())
reconciledCRsMutex.Unlock()
return r.Reconcile(ctx, req)
})

controllerName := fmt.Sprintf("%v-controller", strings.ToLower(gvk.Kind))
Expect(r.addDefaults(mgr, controllerName)).To(Succeed())
r.setupScheme(mgr)

c, err := controller.New(controllerName, mgr, controller.Options{
Reconciler: reconciler,
MaxConcurrentReconciles: 1,
})
Expect(err).ToNot(HaveOccurred())
Expect(r.setupWatches(mgr, c)).To(Succeed())
Copy link
Member

@porridge porridge Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This duplicates a bunch of code from SetupWithManager. I don't think we should be doing this, it makes the test brittle. I guess the reason is that you want to append to reconciledCRs? Perhaps consider using a hook for this instead?

Copy link
Contributor Author

@kurlov kurlov Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a great idea. I changed the test to use hooks


labeledObj = testutil.BuildTestCR(gvk)
labeledObj.SetName("labeled-cr")
labeledObj.SetLabels(matchingLabels)
labeledObjKey = types.NamespacedName{Namespace: labeledObj.GetNamespace(), Name: labeledObj.GetName()}

unlabeledObj = testutil.BuildTestCR(gvk)
unlabeledObj.SetName("unlabeled-cr")
unlabeledObjKey = types.NamespacedName{Namespace: unlabeledObj.GetNamespace(), Name: unlabeledObj.GetName()}

ctx, cancel = context.WithCancel(context.Background())
go func() {
Expect(mgr.Start(ctx)).To(Succeed())
}()
Expect(mgr.GetCache().WaitForCacheSync(ctx)).To(BeTrue())
})

AfterEach(func() {
By("ensuring the labeled CR is deleted", func() {
err := mgr.GetAPIReader().Get(ctx, labeledObjKey, labeledObj)
if !apierrors.IsNotFound(err) {
Expect(err).ToNot(HaveOccurred())
labeledObj.SetFinalizers([]string{})
Expect(mgr.GetClient().Update(ctx, labeledObj)).To(Succeed())
Expect(mgr.GetClient().Delete(ctx, labeledObj)).To(Succeed())
}
})

By("ensuring the unlabeled CR is deleted", func() {
err := mgr.GetAPIReader().Get(ctx, unlabeledObjKey, unlabeledObj)
if !apierrors.IsNotFound(err) {
Expect(err).ToNot(HaveOccurred())
unlabeledObj.SetFinalizers([]string{})
Expect(mgr.GetClient().Update(ctx, unlabeledObj)).To(Succeed())
Expect(mgr.GetClient().Delete(ctx, unlabeledObj)).To(Succeed())
}
})

cancel()
})

It("should only reconcile CRs matching the label selector", func() {
By("creating a CR with matching labels", func() {
Expect(mgr.GetClient().Create(ctx, labeledObj)).To(Succeed())
})

By("creating a CR without matching labels", func() {
Expect(mgr.GetClient().Create(ctx, unlabeledObj)).To(Succeed())
})

By("waiting for reconciliations to complete", func() {
Eventually(func() []string {
reconciledCRsMutex.Lock()
defer reconciledCRsMutex.Unlock()
return reconciledCRs
Copy link
Member

@porridge porridge Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that since this returns a slice pointing at the same backing array, the caller will race with other accesses 🤔
Perhaps instead check the existence of desired element in the Eventually, in the scope of the lock, and then make Should just check for true return value?

Copy link
Contributor Author

@kurlov kurlov Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might not understand the comment correctly but there is mutex in write/read to prevent data race. And the Eventually() matches synchronously after the function returns but before the mutex is unlocked. Also tests run with -race flag and during the development I had a few data race issues but all of them resolved. So I believe it should be fine.

In addition the using of slice/map is more accurate (not perfect though) than bool var because bool in Eventually() will match even when reconciler reconciled two different label selectors

Copy link
Member

@porridge porridge Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the Eventually() matches synchronously after the function returns but before the mutex is unlocked.

I don't think this is true. Mutex is released when the func completes, and then the Eventually works on a copy of the returned slice with the same backing array as the mutex-protected slice. This program shows the data corruption that can happen. After running it a few times I got it to produce:

Image

I don't think I get the point behind slice vs bool.. you can have the bool mean anything you need inside the func...

Copy link
Contributor Author

@kurlov kurlov Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I got your point and moved assertions inside Eventually() and just check the predicate with .Should(BeTrue())

}, "5s", "100ms").Should(ContainElement(labeledObjKey.String()))
})

By("verifying only the labeled CR was reconciled", func() {
reconciledCRsMutex.Lock()
defer reconciledCRsMutex.Unlock()
Expect(reconciledCRs).To(ContainElement(labeledObjKey.String()))
Expect(reconciledCRs).NotTo(ContainElement(unlabeledObjKey.String()))
})

By("updating the unlabeled CR to have matching labels", func() {
Expect(mgr.GetClient().Get(ctx, unlabeledObjKey, unlabeledObj)).To(Succeed())
unlabeledObj.SetLabels(map[string]string{"app": "foo"})
Expect(mgr.GetClient().Update(ctx, unlabeledObj)).To(Succeed())
})

By("waiting for the previously unlabeled CR to be reconciled", func() {
Eventually(func() []string {
reconciledCRsMutex.Lock()
defer reconciledCRsMutex.Unlock()
return reconciledCRs
}, "5s", "100ms").Should(ContainElement(unlabeledObjKey.String()))
})

By("verifying the previously unlabeled CR was reconciled after label change", func() {
reconciledCRsMutex.Lock()
defer reconciledCRsMutex.Unlock()
Expect(reconciledCRs).To(ContainElement(unlabeledObjKey.String()))
})
})
})

_ = Describe("Test custom controller setup", func() {
var (
mgr manager.Manager
Expand Down