Skip to content

Fix flakes in integration suite #991

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
merged 4 commits into from
May 23, 2025
Merged

Fix flakes in integration suite #991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de8c024
Fix deletion policy tests
Zerpet May 20, 2025
4d0d3cc
Use go run for ginkgo CLI
Zerpet May 20, 2025
cffee68
Refactor controller tests
Zerpet May 22, 2025
1bcc485
Fix vhost controller test flakes
Zerpet May 22, 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
9 changes: 6 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ export KUBEBUILDER_ASSETS = $(LOCAL_TESTBIN)/k8s/$(ENVTEST_K8S_VERSION)-$(platfo

.PHONY: kubebuilder-assets
kubebuilder-assets: $(KUBEBUILDER_ASSETS)
@echo "export KUBEBUILDER_ASSETS = $(LOCAL_TESTBIN)/k8s/$(ENVTEST_K8S_VERSION)-$(platform)-$(ARCHITECTURE)"

$(KUBEBUILDER_ASSETS):
setup-envtest --os $(platform) --arch $(ARCHITECTURE) --bin-dir $(LOCAL_TESTBIN) use $(ENVTEST_K8S_VERSION)
Expand All @@ -73,6 +74,8 @@ $(YTT): | $(LOCAL_BIN)
##############
#### Tests ###
##############
GINKGO := go run github.com/onsi/ginkgo/v2/ginkgo

.PHONY: unit-tests
unit-tests::install-tools ## Run unit tests
unit-tests::$(KUBEBUILDER_ASSETS)
Expand All @@ -84,7 +87,7 @@ unit-tests::just-unit-tests

.PHONY: just-unit-tests
just-unit-tests:
ginkgo -r --randomize-all api/ internal/ rabbitmqclient/
$(GINKGO) -r --randomize-all api/ internal/ rabbitmqclient/

.PHONY: integration-tests
integration-tests::install-tools ## Run integration tests. Use GINKGO_EXTRA="-some-arg" to append arguments to 'ginkgo run'
Expand All @@ -96,14 +99,14 @@ integration-tests::manifests
integration-tests::just-integration-tests

just-integration-tests: $(KUBEBUILDER_ASSETS)
ginkgo --randomize-all -r -p $(GINKGO_EXTRA) controllers/
$(GINKGO) --randomize-all -r -p $(GINKGO_EXTRA) controllers/

.PHONY: local-tests
local-tests: unit-tests integration-tests ## Run all local tests (unit & integration)

.PHONY: system-tests
system-tests: ## Run E2E tests using current context in ~/.kube/config. Expects cluster operator and topology operator to be installed in the cluster
NAMESPACE="rabbitmq-system" ginkgo --randomize-all -r $(GINKGO_EXTRA) system_tests/
NAMESPACE="rabbitmq-system" $(GINKGO) --randomize-all -r $(GINKGO_EXTRA) system_tests/


###################
Expand Down
63 changes: 47 additions & 16 deletions controllers/binding_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ import (
"bytes"
"context"
"errors"
"fmt"
"github.com/rabbitmq/cluster-operator/v2/api/v1beta1"
"github.com/rabbitmq/messaging-topology-operator/controllers"
"io"
"k8s.io/apimachinery/pkg/labels"
"net/http"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/cache"
Expand Down Expand Up @@ -34,14 +37,28 @@ var _ = Describe("bindingController", func() {
k8sClient runtimeClient.Client
)

BeforeEach(func() {
initialiseManager := func(keyValPair ...string) {
var sel labels.Selector
if len(keyValPair) == 2 {
var err error
sel, err = labels.Parse(fmt.Sprintf("%s == %s", keyValPair[0], keyValPair[1]))
Expect(err).NotTo(HaveOccurred())
}

var err error
bindingMgr, err = ctrl.NewManager(testEnv.Config, ctrl.Options{
Metrics: server.Options{
BindAddress: "0", // To avoid MacOS firewall pop-up every time you run this suite
},
Cache: cache.Options{
DefaultNamespaces: map[string]cache.Config{bindingNamespace: {}},
DefaultNamespaces: map[string]cache.Config{bindingNamespace: {
LabelSelector: sel,
}},
ByObject: map[runtimeClient.Object]cache.ByObject{
&v1beta1.RabbitmqCluster{}: {Namespaces: map[string]cache.Config{cache.AllNamespaces: {}}},
&corev1.Secret{}: {Namespaces: map[string]cache.Config{cache.AllNamespaces: {}}},
&corev1.Service{}: {Namespaces: map[string]cache.Config{cache.AllNamespaces: {}}},
},
},
Logger: GinkgoLogr,
Controller: config.Controller{
Expand All @@ -66,21 +83,9 @@ var _ = Describe("bindingController", func() {
RabbitmqClientFactory: fakeRabbitMQClientFactory,
ReconcileFunc: &controllers.BindingReconciler{},
}).SetupWithManager(bindingMgr)).To(Succeed())
})
}

AfterEach(func() {
managerCancel()
// Sad workaround to avoid controllers racing for the reconciliation of other's
// test cases. Without this wait, the last run test consistently fails because
// the previous cancelled manager is just in time to reconcile the Queue of the
// new/last test, and use the wrong/unexpected arguments in the queue declare call
//
// Eventual consistency is nice when you have good means of awaiting. That's not the
// case with testenv and kubernetes controllers.
<-time.After(time.Second)
})

JustBeforeEach(func() {
initialiseBinding := func() {
binding = topology.Binding{
ObjectMeta: metav1.ObjectMeta{
Name: bindingName,
Expand All @@ -92,6 +97,18 @@ var _ = Describe("bindingController", func() {
},
},
}
}

AfterEach(func() {
managerCancel()
// Sad workaround to avoid controllers racing for the reconciliation of other's
// test cases. Without this wait, the last run test consistently fails because
// the previous cancelled manager is just in time to reconcile the Queue of the
// new/last test, and use the wrong/unexpected arguments in the queue declare call
//
// Eventual consistency is nice when you have good means of awaiting. That's not the
// case with testenv and kubernetes controllers.
<-time.After(time.Second)
})

When("creating a binding", func() {
Expand All @@ -106,6 +123,9 @@ var _ = Describe("bindingController", func() {
Status: "418 I'm a teapot",
StatusCode: 418,
}, errors.New("some HTTP error"))
initialiseBinding()
binding.Labels = map[string]string{"test": "test-binding-http-error"}
initialiseManager("test", "test-binding-http-error")
})

It("sets the status condition to indicate a failure to reconcile", func() {
Expand All @@ -131,6 +151,9 @@ var _ = Describe("bindingController", func() {
BeforeEach(func() {
bindingName = "test-binding-go-error"
fakeRabbitMQClient.DeclareBindingReturns(nil, errors.New("hit a exception"))
initialiseBinding()
binding.Labels = map[string]string{"test": "test-binding-go-error"}
initialiseManager("test", "test-binding-go-error")
})

It("sets the status condition to indicate a failure to reconcile", func() {
Expand All @@ -155,6 +178,8 @@ var _ = Describe("bindingController", func() {

When("Deleting a binding", func() {
JustBeforeEach(func() {
// Must use a JustBeforeEach to extract this common behaviour
// JustBeforeEach runs AFTER all BeforeEach have completed
fakeRabbitMQClient.DeclareBindingReturns(&http.Response{
Status: "201 Created",
StatusCode: http.StatusCreated,
Expand Down Expand Up @@ -183,6 +208,9 @@ var _ = Describe("bindingController", func() {
StatusCode: http.StatusBadGateway,
Body: io.NopCloser(bytes.NewBufferString("Hello World")),
}, nil)
initialiseBinding()
binding.Labels = map[string]string{"test": "delete-binding-http-error"}
initialiseManager("test", "delete-binding-http-error")
})

It("raises an event to indicate a failure to delete", func() {
Expand All @@ -199,6 +227,9 @@ var _ = Describe("bindingController", func() {
BeforeEach(func() {
bindingName = "delete-binding-go-error"
fakeRabbitMQClient.DeleteBindingReturns(nil, errors.New("some error"))
initialiseBinding()
binding.Labels = map[string]string{"test": "delete-binding-go-error"}
initialiseManager("test", "delete-binding-go-error")
})

It("raises an event to indicate a failure to delete", func() {
Expand Down
72 changes: 53 additions & 19 deletions controllers/exchange_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ import (
"bytes"
"context"
"errors"
"fmt"
"github.com/rabbitmq/cluster-operator/v2/api/v1beta1"
"io"
"k8s.io/apimachinery/pkg/labels"
"net/http"
"time"

Expand Down Expand Up @@ -35,14 +38,28 @@ var _ = Describe("exchange-controller", func() {
k8sClient runtimeClient.Client
)

BeforeEach(func() {
initialiseManager := func(keyValPair ...string) {
var sel labels.Selector
if len(keyValPair) == 2 {
var err error
sel, err = labels.Parse(fmt.Sprintf("%s == %s", keyValPair[0], keyValPair[1]))
Expect(err).NotTo(HaveOccurred())
}

var err error
exchangeMgr, err = ctrl.NewManager(testEnv.Config, ctrl.Options{
Metrics: server.Options{
BindAddress: "0", // To avoid MacOS firewall pop-up every time you run this suite
},
Cache: cache.Options{
DefaultNamespaces: map[string]cache.Config{exchangeNamespace: {}},
DefaultNamespaces: map[string]cache.Config{exchangeNamespace: {
LabelSelector: sel,
}},
ByObject: map[runtimeClient.Object]cache.ByObject{
&v1beta1.RabbitmqCluster{}: {Namespaces: map[string]cache.Config{cache.AllNamespaces: {}}},
&corev1.Secret{}: {Namespaces: map[string]cache.Config{cache.AllNamespaces: {}}},
&corev1.Service{}: {Namespaces: map[string]cache.Config{cache.AllNamespaces: {}}},
},
},
Logger: GinkgoLogr,
Controller: config.Controller{
Expand All @@ -67,22 +84,9 @@ var _ = Describe("exchange-controller", func() {
RabbitmqClientFactory: fakeRabbitMQClientFactory,
ReconcileFunc: &controllers.ExchangeReconciler{},
}).SetupWithManager(exchangeMgr)).To(Succeed())
})
}

AfterEach(func() {
managerCancel()
// Sad workaround to avoid controllers racing for the reconciliation of other's
// test cases. Without this wait, the last run test consistently fails because
// the previous cancelled manager is just in time to reconcile the Queue of the
// new/last test, and use the wrong/unexpected arguments in the queue declare call
//
// Eventual consistency is nice when you have good means of awaiting. That's not the
// case with testenv and kubernetes controllers.
<-time.After(time.Second)
})

JustBeforeEach(func() {
// this will be executed after all BeforeEach have run
initialiseExchange := func() {
exchange = topology.Exchange{
ObjectMeta: metav1.ObjectMeta{
Name: exchangeName,
Expand All @@ -94,6 +98,18 @@ var _ = Describe("exchange-controller", func() {
},
},
}
}

AfterEach(func() {
managerCancel()
// Sad workaround to avoid controllers racing for the reconciliation of other's
// test cases. Without this wait, the last run test consistently fails because
// the previous cancelled manager is just in time to reconcile the Queue of the
// new/last test, and use the wrong/unexpected arguments in the queue declare call
//
// Eventual consistency is nice when you have good means of awaiting. That's not the
// case with testenv and kubernetes controllers.
<-time.After(time.Second)
})

Context("creation", func() {
Expand All @@ -108,6 +124,9 @@ var _ = Describe("exchange-controller", func() {
Status: "418 I'm a teapot",
StatusCode: 418,
}, errors.New("a failure"))
initialiseExchange()
exchange.Labels = map[string]string{"test": "test-http-error"}
initialiseManager("test", "test-http-error")
})

It("sets the status condition", func() {
Expand All @@ -133,6 +152,9 @@ var _ = Describe("exchange-controller", func() {
BeforeEach(func() {
exchangeName = "test-go-error"
fakeRabbitMQClient.DeclareExchangeReturns(nil, errors.New("a go failure"))
initialiseExchange()
exchange.Labels = map[string]string{"test": "test-go-error"}
initialiseManager("test", "test-go-error")
})

It("sets the status condition to indicate a failure to reconcile", func() {
Expand Down Expand Up @@ -162,8 +184,12 @@ var _ = Describe("exchange-controller", func() {
Status: "201 Created",
StatusCode: http.StatusCreated,
}, nil)
initialiseExchange()
exchange.Labels = map[string]string{"test": "test-last-transition-time"}
initialiseManager("test", "test-last-transition-time")
})

// TODO maybe this is a problem because the delete function does not have a fakeClient prepared to return OK for Delete requests
AfterEach(func() {
Expect(k8sClient.Delete(ctx, &exchange)).To(Succeed())
})
Expand All @@ -190,7 +216,7 @@ var _ = Describe("exchange-controller", func() {
Status: "204 No Content",
StatusCode: http.StatusNoContent,
}, nil)
exchange.Labels = map[string]string{"k1": "v1"}
exchange.Labels["k1"] = "v1"
Expect(k8sClient.Update(ctx, &exchange)).To(Succeed())
ConsistentlyWithOffset(1, func() []topology.Condition {
_ = k8sClient.Get(
Expand All @@ -210,7 +236,7 @@ var _ = Describe("exchange-controller", func() {
Status: "500 Internal Server Error",
StatusCode: http.StatusInternalServerError,
}, errors.New("something went wrong"))
exchange.Labels = map[string]string{"k1": "v2"}
exchange.Labels["k1"] = "v2"
Expect(k8sClient.Update(ctx, &exchange)).To(Succeed())
EventuallyWithOffset(1, func() []topology.Condition {
_ = k8sClient.Get(
Expand All @@ -231,6 +257,8 @@ var _ = Describe("exchange-controller", func() {

Context("deletion", func() {
JustBeforeEach(func() {
// Must use a JustBeforeEach to extract this common behaviour
// JustBeforeEach runs AFTER all BeforeEach have completed
fakeRabbitMQClient.DeclareExchangeReturns(&http.Response{
Status: "201 Created",
StatusCode: http.StatusCreated,
Expand Down Expand Up @@ -259,6 +287,9 @@ var _ = Describe("exchange-controller", func() {
StatusCode: http.StatusBadGateway,
Body: io.NopCloser(bytes.NewBufferString("Hello World")),
}, nil)
initialiseExchange()
exchange.Labels = map[string]string{"test": "delete-exchange-http-error"}
initialiseManager("test", "delete-exchange-http-error")
})

It("publishes a 'warning' event", func() {
Expand All @@ -275,6 +306,9 @@ var _ = Describe("exchange-controller", func() {
BeforeEach(func() {
exchangeName = "delete-go-error"
fakeRabbitMQClient.DeleteExchangeReturns(nil, errors.New("some error"))
initialiseExchange()
exchange.Labels = map[string]string{"test": "delete-go-error"}
initialiseManager("test", "delete-go-error")
})

It("publishes a 'warning' event", func() {
Expand Down
Loading
Loading