Skip to content

Commit 15d36f2

Browse files
ChunyiLyuChunyiLyu
committed
Use client.Object instead of runtime.Object when necessary
- controller runtime helper functions use client.Object in version 0.7
1 parent 2f1c9fd commit 15d36f2

16 files changed

+40
-31
lines changed

‎controllers/rabbitmqcluster_controller.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ func (r *RabbitmqClusterReconciler) getRabbitmqCluster(ctx context.Context, name
305305
}
306306

307307
func (r *RabbitmqClusterReconciler) SetupWithManager(mgr ctrl.Manager) error {
308-
for _, resource := range []runtime.Object{&appsv1.StatefulSet{}, &corev1.ConfigMap{}, &corev1.Service{}} {
308+
for _, resource := range []client.Object{&appsv1.StatefulSet{}, &corev1.ConfigMap{}, &corev1.Service{}} {
309309
if err := mgr.GetFieldIndexer().IndexField(context.Background(), resource, ownerKey, addResourceToIndex); err != nil {
310310
return err
311311
}
@@ -323,7 +323,7 @@ func (r *RabbitmqClusterReconciler) SetupWithManager(mgr ctrl.Manager) error {
323323
Complete(r)
324324
}
325325

326-
func addResourceToIndex(rawObj runtime.Object) []string {
326+
func addResourceToIndex(rawObj client.Object) []string {
327327
switch resourceObject := rawObj.(type) {
328328
case *appsv1.StatefulSet:
329329
owner := metav1.GetControllerOf(resourceObject)

‎controllers/reconcile_rabbitmq_configurations.go

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ import (
1010
appsv1 "k8s.io/api/apps/v1"
1111
corev1 "k8s.io/api/core/v1"
1212
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
13-
"k8s.io/apimachinery/pkg/runtime"
1413
"k8s.io/apimachinery/pkg/types"
1514
clientretry "k8s.io/client-go/util/retry"
1615
"sigs.k8s.io/controller-runtime/pkg/client"
@@ -28,7 +27,7 @@ const (
2827
// These annotations are temporary markers used in later reconcile loops to perform some action (such as restarting the StatefulSet or executing RabbitMQ CLI commands)
2928
func (r *RabbitmqClusterReconciler) annotateIfNeeded(ctx context.Context, builder resource.ResourceBuilder, operationResult controllerutil.OperationResult, rmq *rabbitmqv1beta1.RabbitmqCluster) error {
3029
var (
31-
obj runtime.Object
30+
obj client.Object
3231
objName string
3332
annotationKey string
3433
)

‎controllers/reconcile_tls_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ var _ = Describe("Reconcile TLS", func() {
4444

4545
sts, err := clientSet.AppsV1().StatefulSets(cluster.Namespace).Get(ctx, cluster.ChildResourceName("server"), metav1.GetOptions{})
4646
Expect(err).NotTo(HaveOccurred())
47-
47+
4848
Expect(sts.Spec.Template.Spec.Volumes).To(ContainElement(corev1.Volume{
4949
Name: "rabbitmq-tls",
5050
VolumeSource: corev1.VolumeSource{

‎controllers/utils.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ package controllers
22

33
import (
44
"context"
5+
"sigs.k8s.io/controller-runtime/pkg/client"
56

67
rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
78
appsv1 "k8s.io/api/apps/v1"
89
corev1 "k8s.io/api/core/v1"
910
"k8s.io/apimachinery/pkg/api/errors"
1011
"k8s.io/apimachinery/pkg/api/meta"
11-
"k8s.io/apimachinery/pkg/runtime"
1212
"k8s.io/apimachinery/pkg/types"
1313
"k8s.io/client-go/util/retry"
1414
)
@@ -17,7 +17,7 @@ func (r *RabbitmqClusterReconciler) exec(namespace, podName, containerName strin
1717
return r.PodExecutor.Exec(r.Clientset, r.ClusterConfig, namespace, podName, containerName, command...)
1818
}
1919

20-
func (r *RabbitmqClusterReconciler) deleteAnnotation(ctx context.Context, obj runtime.Object, annotation string) error {
20+
func (r *RabbitmqClusterReconciler) deleteAnnotation(ctx context.Context, obj client.Object, annotation string) error {
2121
accessor, err := meta.Accessor(obj)
2222
if err != nil {
2323
return err
@@ -31,7 +31,7 @@ func (r *RabbitmqClusterReconciler) deleteAnnotation(ctx context.Context, obj ru
3131
return r.Update(ctx, obj)
3232
}
3333

34-
func (r *RabbitmqClusterReconciler) updateAnnotation(ctx context.Context, obj runtime.Object, namespace, objName, key, value string) error {
34+
func (r *RabbitmqClusterReconciler) updateAnnotation(ctx context.Context, obj client.Object, namespace, objName, key, value string) error {
3535
return retry.OnError(
3636
retry.DefaultRetry,
3737
errorIsConflictOrNotFound, // StatefulSet needs time to be found after it got created

‎internal/resource/configmap.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ package resource
1212
import (
1313
"bytes"
1414
"fmt"
15+
"sigs.k8s.io/controller-runtime/pkg/client"
1516

1617
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
1718

@@ -64,7 +65,7 @@ func (builder *RabbitmqResourceBuilder) ServerConfigMap() *ServerConfigMapBuilde
6465
}
6566
}
6667

67-
func (builder *ServerConfigMapBuilder) Build() (runtime.Object, error) {
68+
func (builder *ServerConfigMapBuilder) Build() (client.Object, error) {
6869
return &corev1.ConfigMap{
6970
ObjectMeta: metav1.ObjectMeta{
7071
Name: builder.Instance.ChildResourceName(ServerConfigMapName),
@@ -75,7 +76,7 @@ func (builder *ServerConfigMapBuilder) Build() (runtime.Object, error) {
7576
}, nil
7677
}
7778

78-
func (builder *ServerConfigMapBuilder) Update(object runtime.Object) error {
79+
func (builder *ServerConfigMapBuilder) Update(object client.Object) error {
7980
configMap := object.(*corev1.ConfigMap)
8081

8182
ini.PrettySection = false // Remove trailing new line because rabbitmq.conf has only a default section.

‎internal/resource/default_user_secret.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ package resource
1212
import (
1313
"bytes"
1414
"fmt"
15+
"sigs.k8s.io/controller-runtime/pkg/client"
1516

1617
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
1718

@@ -39,7 +40,7 @@ func (builder *RabbitmqResourceBuilder) DefaultUserSecret() *DefaultUserSecretBu
3940
}
4041
}
4142

42-
func (builder *DefaultUserSecretBuilder) Build() (runtime.Object, error) {
43+
func (builder *DefaultUserSecretBuilder) Build() (client.Object, error) {
4344
username, err := randomEncodedString(24)
4445
if err != nil {
4546
return nil, err
@@ -69,7 +70,7 @@ func (builder *DefaultUserSecretBuilder) Build() (runtime.Object, error) {
6970
}, nil
7071
}
7172

72-
func (builder *DefaultUserSecretBuilder) Update(object runtime.Object) error {
73+
func (builder *DefaultUserSecretBuilder) Update(object client.Object) error {
7374
secret := object.(*corev1.Secret)
7475
secret.Labels = metadata.GetLabels(builder.Instance.Name, builder.Instance.Labels)
7576
secret.Annotations = metadata.ReconcileAndFilterAnnotations(secret.GetAnnotations(), builder.Instance.Annotations)

‎internal/resource/erlang_cookie.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
"crypto/rand"
1414
"encoding/base64"
1515
"fmt"
16+
"sigs.k8s.io/controller-runtime/pkg/client"
1617
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
1718

1819
rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
@@ -38,7 +39,7 @@ func (builder *RabbitmqResourceBuilder) ErlangCookie() *ErlangCookieBuilder {
3839
}
3940
}
4041

41-
func (builder *ErlangCookieBuilder) Build() (runtime.Object, error) {
42+
func (builder *ErlangCookieBuilder) Build() (client.Object, error) {
4243
cookie, err := randomEncodedString(24)
4344
if err != nil {
4445
return nil, err
@@ -56,7 +57,7 @@ func (builder *ErlangCookieBuilder) Build() (runtime.Object, error) {
5657
}, nil
5758
}
5859

59-
func (builder *ErlangCookieBuilder) Update(object runtime.Object) error {
60+
func (builder *ErlangCookieBuilder) Update(object client.Object) error {
6061
secret := object.(*corev1.Secret)
6162
secret.Labels = metadata.GetLabels(builder.Instance.Name, builder.Instance.Labels)
6263
secret.Annotations = metadata.ReconcileAndFilterAnnotations(secret.GetAnnotations(), builder.Instance.Annotations)

‎internal/resource/headless_service.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ package resource
1111

1212
import (
1313
"fmt"
14+
"sigs.k8s.io/controller-runtime/pkg/client"
1415

1516
rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
1617
"github.com/rabbitmq/cluster-operator/internal/metadata"
@@ -37,7 +38,7 @@ func (builder *RabbitmqResourceBuilder) HeadlessService() *HeadlessServiceBuilde
3738
}
3839
}
3940

40-
func (builder *HeadlessServiceBuilder) Build() (runtime.Object, error) {
41+
func (builder *HeadlessServiceBuilder) Build() (client.Object, error) {
4142
return &corev1.Service{
4243
ObjectMeta: metav1.ObjectMeta{
4344
Name: builder.Instance.ChildResourceName(headlessServiceSuffix),
@@ -46,7 +47,7 @@ func (builder *HeadlessServiceBuilder) Build() (runtime.Object, error) {
4647
}, nil
4748
}
4849

49-
func (builder *HeadlessServiceBuilder) Update(object runtime.Object) error {
50+
func (builder *HeadlessServiceBuilder) Update(object client.Object) error {
5051
service := object.(*corev1.Service)
5152
service.Labels = metadata.GetLabels(builder.Instance.Name, builder.Instance.Labels)
5253
service.Annotations = metadata.ReconcileAndFilterAnnotations(service.GetAnnotations(), builder.Instance.Annotations)

‎internal/resource/rabbitmq_plugins.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package resource
22

33
import (
44
"fmt"
5+
"sigs.k8s.io/controller-runtime/pkg/client"
56
"strings"
67

78
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
@@ -33,7 +34,7 @@ func (builder *RabbitmqResourceBuilder) RabbitmqPluginsConfigMap() *RabbitmqPlug
3334
}
3435
}
3536

36-
func (builder *RabbitmqPluginsConfigMapBuilder) Build() (runtime.Object, error) {
37+
func (builder *RabbitmqPluginsConfigMapBuilder) Build() (client.Object, error) {
3738
return &corev1.ConfigMap{
3839
ObjectMeta: metav1.ObjectMeta{
3940
Name: builder.Instance.ChildResourceName(PluginsConfigName),
@@ -47,7 +48,7 @@ func (builder *RabbitmqPluginsConfigMapBuilder) Build() (runtime.Object, error)
4748
}, nil
4849
}
4950

50-
func (builder *RabbitmqPluginsConfigMapBuilder) Update(object runtime.Object) error {
51+
func (builder *RabbitmqPluginsConfigMapBuilder) Update(object client.Object) error {
5152
configMap := object.(*corev1.ConfigMap)
5253

5354
if configMap.Data == nil {

‎internal/resource/rabbitmq_resource_builder.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ package resource
1212
import (
1313
rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
1414
"k8s.io/apimachinery/pkg/runtime"
15+
"sigs.k8s.io/controller-runtime/pkg/client"
1516
)
1617

1718
type RabbitmqResourceBuilder struct {
@@ -20,8 +21,8 @@ type RabbitmqResourceBuilder struct {
2021
}
2122

2223
type ResourceBuilder interface {
23-
Build() (runtime.Object, error)
24-
Update(runtime.Object) error
24+
Build() (client.Object, error)
25+
Update(client.Object) error
2526
}
2627

2728
func (builder *RabbitmqResourceBuilder) ResourceBuilders() ([]ResourceBuilder, error) {

‎internal/resource/role.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ package resource
1111

1212
import (
1313
"fmt"
14+
"sigs.k8s.io/controller-runtime/pkg/client"
1415

1516
rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
1617
"github.com/rabbitmq/cluster-operator/internal/metadata"
@@ -36,7 +37,7 @@ func (builder *RabbitmqResourceBuilder) Role() *RoleBuilder {
3637
}
3738
}
3839

39-
func (builder *RoleBuilder) Build() (runtime.Object, error) {
40+
func (builder *RoleBuilder) Build() (client.Object, error) {
4041
return &rbacv1.Role{
4142
ObjectMeta: metav1.ObjectMeta{
4243
Namespace: builder.Instance.Namespace,
@@ -45,7 +46,7 @@ func (builder *RoleBuilder) Build() (runtime.Object, error) {
4546
}, nil
4647
}
4748

48-
func (builder *RoleBuilder) Update(object runtime.Object) error {
49+
func (builder *RoleBuilder) Update(object client.Object) error {
4950
role := object.(*rbacv1.Role)
5051
role.Labels = metadata.GetLabels(builder.Instance.Name, builder.Instance.Labels)
5152
role.Annotations = metadata.ReconcileAndFilterAnnotations(role.GetAnnotations(), builder.Instance.Annotations)

‎internal/resource/role_binding.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import (
1414
rbacv1 "k8s.io/api/rbac/v1"
1515
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1616
"k8s.io/apimachinery/pkg/runtime"
17+
"sigs.k8s.io/controller-runtime/pkg/client"
1718
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
1819

1920
rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
@@ -36,7 +37,7 @@ func (builder *RabbitmqResourceBuilder) RoleBinding() *RoleBindingBuilder {
3637
}
3738
}
3839

39-
func (builder *RoleBindingBuilder) Update(object runtime.Object) error {
40+
func (builder *RoleBindingBuilder) Update(object client.Object) error {
4041
roleBinding := object.(*rbacv1.RoleBinding)
4142
roleBinding.Labels = metadata.GetLabels(builder.Instance.Name, builder.Instance.Labels)
4243
roleBinding.Annotations = metadata.ReconcileAndFilterAnnotations(roleBinding.GetAnnotations(), builder.Instance.Annotations)
@@ -58,7 +59,7 @@ func (builder *RoleBindingBuilder) Update(object runtime.Object) error {
5859
return nil
5960
}
6061

61-
func (builder *RoleBindingBuilder) Build() (runtime.Object, error) {
62+
func (builder *RoleBindingBuilder) Build() (client.Object, error) {
6263
return &rbacv1.RoleBinding{
6364
ObjectMeta: metav1.ObjectMeta{
6465
Namespace: builder.Instance.Namespace,

‎internal/resource/service.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ package resource
1212
import (
1313
"encoding/json"
1414
"fmt"
15+
"sigs.k8s.io/controller-runtime/pkg/client"
1516

1617
"k8s.io/apimachinery/pkg/util/intstr"
1718
"k8s.io/apimachinery/pkg/util/strategicpatch"
@@ -40,7 +41,7 @@ func (builder *RabbitmqResourceBuilder) Service() *ServiceBuilder {
4041
}
4142
}
4243

43-
func (builder *ServiceBuilder) Build() (runtime.Object, error) {
44+
func (builder *ServiceBuilder) Build() (client.Object, error) {
4445
return &corev1.Service{
4546
ObjectMeta: metav1.ObjectMeta{
4647
Name: builder.Instance.ChildResourceName(ServiceSuffix),
@@ -49,7 +50,7 @@ func (builder *ServiceBuilder) Build() (runtime.Object, error) {
4950
}, nil
5051
}
5152

52-
func (builder *ServiceBuilder) Update(object runtime.Object) error {
53+
func (builder *ServiceBuilder) Update(object client.Object) error {
5354
service := object.(*corev1.Service)
5455
builder.setAnnotations(service)
5556
service.Labels = metadata.GetLabels(builder.Instance.Name, builder.Instance.Labels)

‎internal/resource/service_account.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ package resource
1111

1212
import (
1313
"fmt"
14+
"sigs.k8s.io/controller-runtime/pkg/client"
1415

1516
rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
1617
"github.com/rabbitmq/cluster-operator/internal/metadata"
@@ -36,7 +37,7 @@ func (builder *RabbitmqResourceBuilder) ServiceAccount() *ServiceAccountBuilder
3637
}
3738
}
3839

39-
func (builder *ServiceAccountBuilder) Build() (runtime.Object, error) {
40+
func (builder *ServiceAccountBuilder) Build() (client.Object, error) {
4041
return &corev1.ServiceAccount{
4142
ObjectMeta: metav1.ObjectMeta{
4243
Namespace: builder.Instance.Namespace,
@@ -45,7 +46,7 @@ func (builder *ServiceAccountBuilder) Build() (runtime.Object, error) {
4546
}, nil
4647
}
4748

48-
func (builder *ServiceAccountBuilder) Update(object runtime.Object) error {
49+
func (builder *ServiceAccountBuilder) Update(object client.Object) error {
4950
serviceAccount := object.(*corev1.ServiceAccount)
5051
serviceAccount.Labels = metadata.GetLabels(builder.Instance.Name, builder.Instance.Labels)
5152
serviceAccount.Annotations = metadata.ReconcileAndFilterAnnotations(serviceAccount.GetAnnotations(), builder.Instance.Annotations)

‎internal/resource/statefulset.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ package resource
1212
import (
1313
"encoding/json"
1414
"fmt"
15+
"sigs.k8s.io/controller-runtime/pkg/client"
1516

1617
"k8s.io/apimachinery/pkg/util/intstr"
1718

@@ -46,7 +47,7 @@ func (builder *RabbitmqResourceBuilder) StatefulSet() *StatefulSetBuilder {
4647
}
4748
}
4849

49-
func (builder *StatefulSetBuilder) Build() (runtime.Object, error) {
50+
func (builder *StatefulSetBuilder) Build() (client.Object, error) {
5051
// PVC, ServiceName & Selector: can't be updated without deleting the statefulset
5152
pvc, err := persistentVolumeClaim(builder.Instance, builder.Scheme)
5253
if err != nil {
@@ -98,7 +99,7 @@ func (builder *StatefulSetBuilder) Build() (runtime.Object, error) {
9899
return sts, nil
99100
}
100101

101-
func (builder *StatefulSetBuilder) Update(object runtime.Object) error {
102+
func (builder *StatefulSetBuilder) Update(object client.Object) error {
102103
sts := object.(*appsv1.StatefulSet)
103104

104105
//Replicas

‎system_tests/system_tests.go

-1
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,6 @@ CONSOLE_LOG=new`
380380
return actualCert
381381
}, 180, 10).ShouldNot(Equal(oldServerCert))
382382

383-
384383
Eventually(func() []byte {
385384
newServerCertificate := inspectServerCertificate(username, password, hostname, amqpsNodePort, caFilePath)
386385
return newServerCertificate

0 commit comments

Comments
 (0)