CFServiceBinding and CFServiceInstance controllers pass logger in the…

… ctx [#1935]
cloudfoundry · Jun 23, 2023 · a8ebe9d · a8ebe9d
1 parent 5914feb
commit a8ebe9d
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 2 deletions.
diff --git a/controllers/controllers/services/cfservicebinding_controller.go b/controllers/controllers/services/cfservicebinding_controller.go
@@ -23,7 +23,9 @@ import (
 	"time"
 
 	korifiv1alpha1 "code.cloudfoundry.org/korifi/controllers/api/v1alpha1"
+	"code.cloudfoundry.org/korifi/controllers/controllers/shared"
 	"code.cloudfoundry.org/korifi/tools/k8s"
+
 	"github.com/go-logr/logr"
 	servicebindingv1beta1 "github.com/servicebinding/runtime/apis/v1beta1"
 	corev1 "k8s.io/api/core/v1"
@@ -71,7 +73,8 @@ func (r *CFServiceBindingReconciler) SetupWithManager(mgr ctrl.Manager) *builder
 //+kubebuilder:rbac:groups=servicebinding.io,resources=servicebindings,verbs=get;list;create;update;patch;watch
 
 func (r *CFServiceBindingReconciler) ReconcileResource(ctx context.Context, cfServiceBinding *korifiv1alpha1.CFServiceBinding) (ctrl.Result, error) {
-	log := r.log.WithValues("namespace", cfServiceBinding.Namespace, "name", cfServiceBinding.Name)
+	log := shared.ObjectLogger(r.log, cfServiceBinding)
+	ctx = logr.NewContext(ctx, log)
 
 	cfServiceBinding.Status.ObservedGeneration = cfServiceBinding.Generation
 	log.V(1).Info("set observed generation", "generation", cfServiceBinding.Status.ObservedGeneration)
@@ -224,13 +227,16 @@ func generateDesiredServiceBinding(actualServiceBinding *servicebindingv1beta1.S
 			Name:       cfServiceBinding.Name,
 		},
 	}
+
 	secretType, ok := secret.Data["type"]
 	if ok && len(secretType) > 0 {
 		desiredServiceBinding.Spec.Type = string(secretType)
 	}
+
 	secretProvider, ok := secret.Data["provider"]
 	if ok {
 		desiredServiceBinding.Spec.Provider = string(secretProvider)
 	}
+
 	return &desiredServiceBinding
 }
diff --git a/controllers/controllers/services/cfservicebinding_controller_test.go b/controllers/controllers/services/cfservicebinding_controller_test.go
@@ -11,6 +11,7 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	"github.com/onsi/gomega/gbytes"
 	. "github.com/onsi/gomega/gstruct"
 	servicebindingv1beta1 "github.com/servicebinding/runtime/apis/v1beta1"
 	corev1 "k8s.io/api/core/v1"
@@ -191,6 +192,10 @@ var _ = Describe("CFServiceBinding", func() {
 		}).Should(Succeed())
 	})
 
+	It("writes a log message", func() {
+		Eventually(logOutput).Should(gbytes.Say("set observed generation"))
+	})
+
 	When("the CFServiceBinding has a displayName set", func() {
 		var bindingName string
 

diff --git a/controllers/controllers/services/cfserviceinstance_controller.go b/controllers/controllers/services/cfserviceinstance_controller.go
@@ -21,6 +21,7 @@ import (
 	"time"
 
 	korifiv1alpha1 "code.cloudfoundry.org/korifi/controllers/api/v1alpha1"
+	"code.cloudfoundry.org/korifi/controllers/controllers/shared"
 	"code.cloudfoundry.org/korifi/tools/k8s"
 
 	"github.com/go-logr/logr"
@@ -61,8 +62,11 @@ func (r *CFServiceInstanceReconciler) SetupWithManager(mgr ctrl.Manager) *builde
 //+kubebuilder:rbac:groups=korifi.cloudfoundry.org,resources=cfserviceinstances/finalizers,verbs=update
 
 func (r *CFServiceInstanceReconciler) ReconcileResource(ctx context.Context, cfServiceInstance *korifiv1alpha1.CFServiceInstance) (ctrl.Result, error) {
+	log := shared.ObjectLogger(r.log, cfServiceInstance)
+	ctx = logr.NewContext(ctx, log)
+
 	cfServiceInstance.Status.ObservedGeneration = cfServiceInstance.Generation
-	r.log.V(1).Info("set observed generation", "generation", cfServiceInstance.Status.ObservedGeneration)
+	log.V(1).Info("set observed generation", "generation", cfServiceInstance.Status.ObservedGeneration)
 
 	secret := new(corev1.Secret)
 	err := r.k8sClient.Get(ctx, types.NamespacedName{Name: cfServiceInstance.Spec.SecretName, Namespace: cfServiceInstance.Namespace}, secret)
@@ -72,6 +76,7 @@ func (r *CFServiceInstanceReconciler) ReconcileResource(ctx context.Context, cfS
 			return ctrl.Result{RequeueAfter: 2 * time.Second}, nil
 		}
 
+		log.Info("failed to get secret", "reason", err)
 		cfServiceInstance.Status = bindSecretUnavailableStatus(cfServiceInstance, "UnknownError", "Error occurred while fetching secret: "+err.Error())
 		return ctrl.Result{}, err
 	}

diff --git a/controllers/controllers/services/cfserviceinstance_controller_test.go b/controllers/controllers/services/cfserviceinstance_controller_test.go
@@ -3,6 +3,7 @@ package services_test
 import (
 	"context"
 
+	"github.com/onsi/gomega/gbytes"
 	. "github.com/onsi/gomega/gstruct"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
@@ -84,6 +85,10 @@ var _ = Describe("CFServiceInstance", func() {
 		}).Should(Succeed())
 	})
 
+	It("writes a log message", func() {
+		Eventually(logOutput).Should(gbytes.Say("set observed generation"))
+	})
+
 	When("the referenced secret does not exist", func() {
 		BeforeEach(func() {
 			cfServiceInstance.Spec.SecretName = "other-secret-name"

diff --git a/controllers/controllers/services/suite_test.go b/controllers/controllers/services/suite_test.go
@@ -29,6 +29,7 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	"github.com/onsi/gomega/gbytes"
 	servicebindingv1beta1 "github.com/servicebinding/runtime/apis/v1beta1"
 	"k8s.io/client-go/kubernetes/scheme"
 	ctrl "sigs.k8s.io/controller-runtime"
@@ -47,6 +48,7 @@ var (
 	cancel    context.CancelFunc
 	testEnv   *envtest.Environment
 	k8sClient client.Client
+	logOutput *gbytes.Buffer
 )
 
 func TestAPIs(t *testing.T) {
@@ -58,6 +60,8 @@ func TestAPIs(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
+	logOutput = gbytes.NewBuffer()
+	GinkgoWriter.TeeTo(logOutput)
 	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	ctx, cancel = context.WithCancel(context.TODO())