User klog.Background() instead of textlogger (#1778)

Karthik-K-N · web-flow · commit 83e571fe6e85 · 2024-05-16T04:53:03.000-07:00
diff --git a/cloud/scope/cluster.go b/cloud/scope/cluster.go
@@ -26,7 +26,7 @@ import (
 	"github.com/IBM/go-sdk-core/v5/core"
 	"github.com/IBM/vpc-go-sdk/vpcv1"
 
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
@@ -74,7 +74,7 @@ func NewClusterScope(params ClusterScopeParams) (*ClusterScope, error) {
 	}
 
 	if params.Logger == (logr.Logger{}) {
-		params.Logger = textlogger.NewLogger(textlogger.NewConfig())
+		params.Logger = klog.Background()
 	}
 
 	helper, err := patch.NewHelper(params.IBMVPCCluster, params.Client)
diff --git a/cloud/scope/cluster_test.go b/cloud/scope/cluster_test.go
@@ -26,7 +26,7 @@ import (
 	"go.uber.org/mock/gomock"
 
 	"k8s.io/client-go/kubernetes/scheme"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
@@ -47,7 +47,7 @@ func setupClusterScope(clusterName string, mockvpc *mock.MockVpc) *ClusterScope
 	client := fake.NewClientBuilder().WithScheme(scheme.Scheme).WithObjects(initObjects...).Build()
 	return &ClusterScope{
 		Client:        client,
-		Logger:        textlogger.NewLogger(textlogger.NewConfig()),
+		Logger:        klog.Background(),
 		IBMVPCClient:  mockvpc,
 		Cluster:       cluster,
 		IBMVPCCluster: vpcCluster,
diff --git a/cloud/scope/machine.go b/cloud/scope/machine.go
@@ -28,7 +28,7 @@ import (
 
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"k8s.io/utils/ptr"
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -80,7 +80,7 @@ func NewMachineScope(params MachineScopeParams) (*MachineScope, error) {
 	}
 
 	if params.Logger == (logr.Logger{}) {
-		params.Logger = textlogger.NewLogger(textlogger.NewConfig())
+		params.Logger = klog.Background()
 	}
 
 	helper, err := patch.NewHelper(params.IBMVPCMachine, params.Client)
diff --git a/cloud/scope/machine_test.go b/cloud/scope/machine_test.go
@@ -29,7 +29,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes/scheme"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	capiv1beta1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
@@ -66,7 +66,7 @@ func setupMachineScope(clusterName string, machineName string, mockvpc *mock.Moc
 	client := fake.NewClientBuilder().WithScheme(scheme.Scheme).WithObjects(initObjects...).Build()
 	return &MachineScope{
 		Client:        client,
-		Logger:        textlogger.NewLogger(textlogger.NewConfig()),
+		Logger:        klog.Background(),
 		IBMVPCClient:  mockvpc,
 		Cluster:       cluster,
 		Machine:       machine,
diff --git a/cloud/scope/powervs_cluster.go b/cloud/scope/powervs_cluster.go
@@ -37,7 +37,7 @@ import (
 	"github.com/IBM/platform-services-go-sdk/resourcemanagerv2"
 	"github.com/IBM/vpc-go-sdk/vpcv1"
 
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"k8s.io/utils/ptr"
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -117,7 +117,7 @@ func NewPowerVSClusterScope(params PowerVSClusterScopeParams) (*PowerVSClusterSc
 		return nil, err
 	}
 	if params.Logger == (logr.Logger{}) {
-		params.Logger = textlogger.NewLogger(textlogger.NewConfig())
+		params.Logger = klog.Background()
 	}
 
 	helper, err := patch.NewHelper(params.IBMPowerVSCluster, params.Client)
diff --git a/cloud/scope/powervs_image.go b/cloud/scope/powervs_image.go
@@ -28,7 +28,7 @@ import (
 	"github.com/IBM/go-sdk-core/v5/core"
 	"github.com/IBM/platform-services-go-sdk/resourcecontrollerv2"
 
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
@@ -80,7 +80,7 @@ func NewPowerVSImageScope(params PowerVSImageScopeParams) (scope *PowerVSImageSc
 	scope.IBMPowerVSImage = params.IBMPowerVSImage
 
 	if params.Logger == (logr.Logger{}) {
-		params.Logger = textlogger.NewLogger(textlogger.NewConfig())
+		params.Logger = klog.Background()
 	}
 	scope.Logger = params.Logger
 
diff --git a/cloud/scope/powervs_image_test.go b/cloud/scope/powervs_image_test.go
@@ -27,7 +27,7 @@ import (
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes/scheme"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
@@ -63,7 +63,7 @@ func setupPowerVSImageScope(imageName string, mockpowervs *mock.MockPowerVS) *Po
 	client := fake.NewClientBuilder().WithScheme(scheme.Scheme).WithObjects(initObjects...).Build()
 	return &PowerVSImageScope{
 		Client:           client,
-		Logger:           textlogger.NewLogger(textlogger.NewConfig()),
+		Logger:           klog.Background(),
 		IBMPowerVSClient: mockpowervs,
 		IBMPowerVSImage:  powervsImage,
 	}
diff --git a/cloud/scope/powervs_machine.go b/cloud/scope/powervs_machine.go
@@ -46,7 +46,7 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/util/intstr"
 	"k8s.io/client-go/tools/cache"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"k8s.io/utils/ptr"
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -133,7 +133,7 @@ func NewPowerVSMachineScope(params PowerVSMachineScopeParams) (scope *PowerVSMac
 	scope.IBMPowerVSImage = params.IBMPowerVSImage
 
 	if params.Logger == (logr.Logger{}) {
-		params.Logger = textlogger.NewLogger(textlogger.NewConfig())
+		params.Logger = klog.Background()
 	}
 	if params.Logger.V(DEBUGLEVEL).Enabled() {
 		core.SetLoggingLevel(core.LevelDebug)
diff --git a/cloud/scope/powervs_machine_test.go b/cloud/scope/powervs_machine_test.go
@@ -33,7 +33,7 @@ import (
 	"k8s.io/apimachinery/pkg/util/intstr"
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/tools/cache"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"k8s.io/utils/ptr"
 	capiv1beta1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -89,7 +89,7 @@ func setupPowerVSMachineScope(clusterName string, machineName string, imageID *s
 	client := fake.NewClientBuilder().WithScheme(scheme.Scheme).WithObjects(initObjects...).Build()
 	return &PowerVSMachineScope{
 		Client:            client,
-		Logger:            textlogger.NewLogger(textlogger.NewConfig()),
+		Logger:            klog.Background(),
 		IBMPowerVSClient:  mockpowervs,
 		Cluster:           cluster,
 		Machine:           machine,
diff --git a/controllers/ibmpowervscluster_controller_test.go b/controllers/ibmpowervscluster_controller_test.go
@@ -24,7 +24,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes/scheme"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"k8s.io/utils/ptr"
 	capiv1beta1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/util"
@@ -178,7 +178,7 @@ func TestIBMPowerVSClusterReconciler_delete(t *testing.T) {
 		t.Run("Should reconcile successfully if no descendants are found", func(t *testing.T) {
 			g := NewWithT(t)
 			clusterScope = &scope.PowerVSClusterScope{
-				Logger: textlogger.NewLogger(textlogger.NewConfig()),
+				Logger: klog.Background(),
 				IBMPowerVSCluster: &infrav1beta2.IBMPowerVSCluster{
 					TypeMeta: metav1.TypeMeta{
 						Kind:       "IBMPowerVSCluster",
@@ -200,7 +200,7 @@ func TestIBMPowerVSClusterReconciler_delete(t *testing.T) {
 		t.Run("Should reconcile with requeue by deleting the cluster descendants", func(t *testing.T) {
 			g := NewWithT(t)
 			clusterScope = &scope.PowerVSClusterScope{
-				Logger: textlogger.NewLogger(textlogger.NewConfig()),
+				Logger: klog.Background(),
 				IBMPowerVSCluster: &infrav1beta2.IBMPowerVSCluster{
 					TypeMeta: metav1.TypeMeta{
 						Kind:       "IBMPowerVSCluster",
diff --git a/controllers/ibmpowervsimage_controller_test.go b/controllers/ibmpowervsimage_controller_test.go
@@ -28,7 +28,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/tools/record"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"k8s.io/utils/ptr"
 	capiv1beta1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/util"
@@ -151,7 +151,7 @@ func TestIBMPowerVSImageReconciler_reconcile(t *testing.T) {
 					Name: "capi-powervs-cluster"},
 			}
 			imageScope := &scope.PowerVSImageScope{
-				Logger: textlogger.NewLogger(textlogger.NewConfig()),
+				Logger: klog.Background(),
 				IBMPowerVSImage: &infrav1beta2.IBMPowerVSImage{
 					ObjectMeta: metav1.ObjectMeta{
 						Name: "capi-image",
@@ -204,7 +204,7 @@ func TestIBMPowerVSImageReconciler_reconcile(t *testing.T) {
 
 			mockclient := fake.NewClientBuilder().WithObjects([]client.Object{powervsCluster, powervsImage}...).Build()
 			imageScope := &scope.PowerVSImageScope{
-				Logger:           textlogger.NewLogger(textlogger.NewConfig()),
+				Logger:           klog.Background(),
 				Client:           mockclient,
 				IBMPowerVSImage:  powervsImage,
 				IBMPowerVSClient: mockpowervs,
@@ -337,7 +337,7 @@ func TestIBMPowerVSImageReconciler_delete(t *testing.T) {
 			Recorder: recorder,
 		}
 		imageScope = &scope.PowerVSImageScope{
-			Logger:           textlogger.NewLogger(textlogger.NewConfig()),
+			Logger:           klog.Background(),
 			IBMPowerVSImage:  &infrav1beta2.IBMPowerVSImage{},
 			IBMPowerVSClient: mockpowervs,
 		}
diff --git a/controllers/ibmpowervsmachine_controller_test.go b/controllers/ibmpowervsmachine_controller_test.go
@@ -31,7 +31,7 @@ import (
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/tools/cache"
 	"k8s.io/client-go/tools/record"
-	"k8s.io/klog/v2/textlogger"
+	"k8s.io/klog/v2"
 	"k8s.io/utils/ptr"
 	capiv1beta1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/util"
@@ -192,7 +192,7 @@ func TestIBMPowerVSMachineReconciler_Reconcile(t *testing.T) {
 			g := NewWithT(t)
 			reconciler := &IBMPowerVSMachineReconciler{
 				Client: testEnv.Client,
-				Log:    textlogger.NewLogger(textlogger.NewConfig()),
+				Log:    klog.Background(),
 			}
 			ns, err := testEnv.CreateNamespace(ctx, fmt.Sprintf("namespace-%s", util.RandomString(5)))
 			g.Expect(err).To(BeNil())
@@ -262,7 +262,7 @@ func TestIBMPowerVSMachineReconciler_Delete(t *testing.T) {
 		recorder := record.NewFakeRecorder(2)
 		reconciler = IBMPowerVSMachineReconciler{
 			Client:   testEnv.Client,
-			Log:      textlogger.NewLogger(textlogger.NewConfig()),
+			Log:      klog.Background(),
 			Recorder: recorder,
 		}
 	}
@@ -276,7 +276,7 @@ func TestIBMPowerVSMachineReconciler_Delete(t *testing.T) {
 			setup(t)
 			t.Cleanup(teardown)
 			machineScope = &scope.PowerVSMachineScope{
-				Logger:           textlogger.NewLogger(textlogger.NewConfig()),
+				Logger:           klog.Background(),
 				IBMPowerVSClient: mockpowervs,
 				IBMPowerVSMachine: &infrav1beta2.IBMPowerVSMachine{
 					ObjectMeta: metav1.ObjectMeta{
@@ -294,7 +294,7 @@ func TestIBMPowerVSMachineReconciler_Delete(t *testing.T) {
 			setup(t)
 			t.Cleanup(teardown)
 			machineScope = &scope.PowerVSMachineScope{
-				Logger:           textlogger.NewLogger(textlogger.NewConfig()),
+				Logger:           klog.Background(),
 				IBMPowerVSClient: mockpowervs,
 				IBMPowerVSMachine: &infrav1beta2.IBMPowerVSMachine{
 					ObjectMeta: metav1.ObjectMeta{
@@ -330,7 +330,7 @@ func TestIBMPowerVSMachineReconciler_Delete(t *testing.T) {
 			mockClient := fake.NewClientBuilder().WithObjects([]client.Object{secret}...).Build()
 			machineScope = &scope.PowerVSMachineScope{
 				Client:           mockClient,
-				Logger:           textlogger.NewLogger(textlogger.NewConfig()),
+				Logger:           klog.Background(),
 				IBMPowerVSClient: mockpowervs,
 				IBMPowerVSMachine: &infrav1beta2.IBMPowerVSMachine{
 					ObjectMeta: metav1.ObjectMeta{
@@ -377,7 +377,7 @@ func TestIBMPowerVSMachineReconciler_ReconcileOperations(t *testing.T) {
 		recorder := record.NewFakeRecorder(2)
 		reconciler = IBMPowerVSMachineReconciler{
 			Client:   testEnv.Client,
-			Log:      textlogger.NewLogger(textlogger.NewConfig()),
+			Log:      klog.Background(),
 			Recorder: recorder,
 		}
 	}
@@ -390,7 +390,7 @@ func TestIBMPowerVSMachineReconciler_ReconcileOperations(t *testing.T) {
 			setup(t)
 			t.Cleanup(teardown)
 			machineScope = &scope.PowerVSMachineScope{
-				Logger: textlogger.NewLogger(textlogger.NewConfig()),
+				Logger: klog.Background(),
 				Cluster: &capiv1beta1.Cluster{
 					Status: capiv1beta1.ClusterStatus{
 						InfrastructureReady: false,
@@ -408,7 +408,7 @@ func TestIBMPowerVSMachineReconciler_ReconcileOperations(t *testing.T) {
 			setup(t)
 			t.Cleanup(teardown)
 			machineScope = &scope.PowerVSMachineScope{
-				Logger: textlogger.NewLogger(textlogger.NewConfig()),
+				Logger: klog.Background(),
 				Cluster: &capiv1beta1.Cluster{
 					Status: capiv1beta1.ClusterStatus{
 						InfrastructureReady: true,
@@ -431,7 +431,7 @@ func TestIBMPowerVSMachineReconciler_ReconcileOperations(t *testing.T) {
 			setup(t)
 			t.Cleanup(teardown)
 			machineScope = &scope.PowerVSMachineScope{
-				Logger: textlogger.NewLogger(textlogger.NewConfig()),
+				Logger: klog.Background(),
 				Cluster: &capiv1beta1.Cluster{
 					Status: capiv1beta1.ClusterStatus{
 						InfrastructureReady: true,
@@ -457,7 +457,7 @@ func TestIBMPowerVSMachineReconciler_ReconcileOperations(t *testing.T) {
 			var instances = &models.PVMInstances{}
 			mockclient := fake.NewClientBuilder().WithScheme(scheme.Scheme).WithObjects().Build()
 			machineScope = &scope.PowerVSMachineScope{
-				Logger: textlogger.NewLogger(textlogger.NewConfig()),
+				Logger: klog.Background(),
 				Client: mockclient,
 				Cluster: &capiv1beta1.Cluster{
 					Status: capiv1beta1.ClusterStatus{
@@ -540,7 +540,7 @@ func TestIBMPowerVSMachineReconciler_ReconcileOperations(t *testing.T) {
 
 			mockclient := fake.NewClientBuilder().WithObjects([]client.Object{secret, pvsmachine, machine}...).Build()
 			machineScope = &scope.PowerVSMachineScope{
-				Logger: textlogger.NewLogger(textlogger.NewConfig()),
+				Logger: klog.Background(),
 				Client: mockclient,
 				Cluster: &capiv1beta1.Cluster{
 					Status: capiv1beta1.ClusterStatus{
diff --git a/controllers/ibmvpccluster_controller_test.go b/controllers/ibmvpccluster_controller_test.go
diff --git a/controllers/ibmvpcmachine_controller_test.go b/controllers/ibmvpcmachine_controller_test.go
diff --git a/main.go b/main.go
diff --git a/test/helpers/envtest.go b/test/helpers/envtest.go

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`	`"github.com/IBM/go-sdk-core/v5/core"`
`27`	`27`	`"github.com/IBM/vpc-go-sdk/vpcv1"`
`28`	`28`
`29`		`- "k8s.io/klog/v2/textlogger"`
	`29`	`+ "k8s.io/klog/v2"`
`30`	`30`
`31`	`31`	`"sigs.k8s.io/controller-runtime/pkg/client"`
`32`	`32`
`@@ -74,7 +74,7 @@ func NewClusterScope(params ClusterScopeParams) (*ClusterScope, error) {`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`if params.Logger == (logr.Logger{}) {`
`77`		`- params.Logger = textlogger.NewLogger(textlogger.NewConfig())`
	`77`	`+ params.Logger = klog.Background()`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`helper, err := patch.NewHelper(params.IBMVPCCluster, params.Client)`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ import (`
`28`	`28`
`29`	`29`	`corev1 "k8s.io/api/core/v1"`
`30`	`30`	`"k8s.io/apimachinery/pkg/types"`
`31`		`- "k8s.io/klog/v2/textlogger"`
	`31`	`+ "k8s.io/klog/v2"`
`32`	`32`	`"k8s.io/utils/ptr"`
`33`	`33`
`34`	`34`	`"sigs.k8s.io/controller-runtime/pkg/client"`
`@@ -80,7 +80,7 @@ func NewMachineScope(params MachineScopeParams) (*MachineScope, error) {`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`if params.Logger == (logr.Logger{}) {`
`83`		`- params.Logger = textlogger.NewLogger(textlogger.NewConfig())`
	`83`	`+ params.Logger = klog.Background()`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`helper, err := patch.NewHelper(params.IBMVPCMachine, params.Client)`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ import (`
`37`	`37`	`"github.com/IBM/platform-services-go-sdk/resourcemanagerv2"`
`38`	`38`	`"github.com/IBM/vpc-go-sdk/vpcv1"`
`39`	`39`
`40`		`- "k8s.io/klog/v2/textlogger"`
	`40`	`+ "k8s.io/klog/v2"`
`41`	`41`	`"k8s.io/utils/ptr"`
`42`	`42`
`43`	`43`	`"sigs.k8s.io/controller-runtime/pkg/client"`
`@@ -117,7 +117,7 @@ func NewPowerVSClusterScope(params PowerVSClusterScopeParams) (*PowerVSClusterSc`
`117`	`117`	`return nil, err`
`118`	`118`	`}`
`119`	`119`	`if params.Logger == (logr.Logger{}) {`
`120`		`- params.Logger = textlogger.NewLogger(textlogger.NewConfig())`
	`120`	`+ params.Logger = klog.Background()`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`helper, err := patch.NewHelper(params.IBMPowerVSCluster, params.Client)`