Skip to content

Commit 20f060d

Browse files
hj-johannes-leehj-johannes-lee
authored
Merge pull request #1600 from mythi/PR-2023-056
logging: move away from klogr to ktesting/textlogger
2 parents 0927f7c + d799780 commit 20f060d

File tree

7 files changed

+31
-40
lines changed

7 files changed

+31
-40
lines changed

‎cmd/fpga_admissionwebhook/main.go

+4-5
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ import (
2020
"os"
2121

2222
"k8s.io/apimachinery/pkg/runtime"
23-
"k8s.io/klog/v2"
24-
"k8s.io/klog/v2/klogr"
23+
"k8s.io/klog/v2/textlogger"
2524
ctrl "sigs.k8s.io/controller-runtime"
2625
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
2726
"sigs.k8s.io/controller-runtime/pkg/webhook"
@@ -38,8 +37,6 @@ var (
3837
)
3938

4039
func init() {
41-
klog.InitFlags(nil)
42-
4340
_ = fpgav2.AddToScheme(scheme)
4441
}
4542

@@ -48,12 +45,14 @@ func main() {
4845
enableLeaderElection bool
4946
)
5047

48+
tlConf := textlogger.NewConfig()
49+
tlConf.AddFlags(flag.CommandLine)
5150
flag.BoolVar(&enableLeaderElection, "leader-elect", false,
5251
"Enable leader election for controller manager. "+
5352
"Enabling this will ensure there is only one active controller manager.")
5453
flag.Parse()
5554

56-
ctrl.SetLogger(klogr.New())
55+
ctrl.SetLogger(textlogger.NewLogger(tlConf))
5756

5857
tlsCfgFunc := func(cfg *tls.Config) {
5958
cfg.MinVersion = tls.VersionTLS13

‎cmd/operator/main.go

+5-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import (
2525
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2626
"k8s.io/apimachinery/pkg/runtime"
2727
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
28-
"k8s.io/klog/v2/klogr"
28+
"k8s.io/klog/v2/textlogger"
2929
ctrl "sigs.k8s.io/controller-runtime"
3030
"sigs.k8s.io/controller-runtime/pkg/healthz"
3131
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
@@ -108,7 +108,8 @@ func main() {
108108
pm *patcher.Manager
109109
)
110110

111-
ctrl.SetLogger(klogr.NewWithOptions(klogr.WithFormat(klogr.FormatKlog)))
111+
tlConf := textlogger.NewConfig()
112+
tlConf.AddFlags(flag.CommandLine)
112113

113114
flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
114115
flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
@@ -119,6 +120,8 @@ func main() {
119120
flag.Var(&devices, "devices", "Device(s) to set up.")
120121
flag.Parse()
121122

123+
ctrl.SetLogger(textlogger.NewLogger(tlConf))
124+
122125
if len(devices) == 0 {
123126
devices = supportedDevices
124127
}

‎cmd/sgx_admissionwebhook/main.go

+6-7
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ package main
1616

1717
import (
1818
"crypto/tls"
19+
"flag"
1920
"os"
2021

2122
sgxwebhook "github.com/intel/intel-device-plugins-for-kubernetes/pkg/webhooks/sgx"
2223
corev1 "k8s.io/api/core/v1"
23-
"k8s.io/klog/v2"
24-
"k8s.io/klog/v2/klogr"
24+
"k8s.io/klog/v2/textlogger"
2525
ctrl "sigs.k8s.io/controller-runtime"
2626
"sigs.k8s.io/controller-runtime/pkg/builder"
2727
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
@@ -32,12 +32,11 @@ var (
3232
setupLog = ctrl.Log.WithName("setup")
3333
)
3434

35-
func init() {
36-
klog.InitFlags(nil)
37-
}
38-
3935
func main() {
40-
ctrl.SetLogger(klogr.New())
36+
tlConf := textlogger.NewConfig()
37+
tlConf.AddFlags(flag.CommandLine)
38+
flag.Parse()
39+
ctrl.SetLogger(textlogger.NewLogger(tlConf))
4140

4241
tlsCfgFunc := func(cfg *tls.Config) {
4342
cfg.MinVersion = tls.VersionTLS13

‎pkg/fpgacontroller/fpgacontroller_test.go

+7-8
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,25 @@
1515
package fpgacontroller
1616

1717
import (
18-
"context"
1918
"errors"
2019
"testing"
2120

2221
apierrors "k8s.io/apimachinery/pkg/api/errors"
2322
"k8s.io/apimachinery/pkg/runtime"
2423
"k8s.io/apimachinery/pkg/runtime/schema"
25-
"k8s.io/klog/v2/klogr"
2624
ctrl "sigs.k8s.io/controller-runtime"
27-
"sigs.k8s.io/controller-runtime/pkg/log"
2825

2926
fpgav2 "github.com/intel/intel-device-plugins-for-kubernetes/pkg/apis/fpga/v2"
3027
"github.com/intel/intel-device-plugins-for-kubernetes/pkg/fpgacontroller/patcher"
28+
"k8s.io/klog/v2/ktesting"
3129
)
3230

3331
var (
3432
errClient = errors.New("client error")
35-
logger = ctrl.Log.WithName("test")
3633
scheme = runtime.NewScheme()
3734
)
3835

3936
func init() {
40-
ctrl.SetLogger(klogr.New())
41-
4237
_ = fpgav2.AddToScheme(scheme)
4338
}
4439

@@ -64,13 +59,13 @@ func TestAcceleratorFunctionReconcile(t *testing.T) {
6459

6560
for _, tt := range tcases {
6661
t.Run(tt.name, func(t *testing.T) {
62+
logger, ctx := ktesting.NewTestContext(t)
6763
reconciler := &AcceleratorFunctionReconciler{
6864
Client: &mockClient{
6965
getError: tt.getError,
7066
},
7167
PatcherManager: patcher.NewPatcherManager(logger),
7268
}
73-
ctx := log.IntoContext(context.Background(), logger)
7469
_, err := reconciler.Reconcile(ctx, ctrl.Request{})
7570
if err != nil && !tt.expectedErr {
7671
t.Errorf("unexpected error: %+v", err)
@@ -85,10 +80,12 @@ func TestAcceleratorFunctionReconcile(t *testing.T) {
8580
func TestAcceleratorFunctionSetupWithManager(t *testing.T) {
8681
r := &AcceleratorFunctionReconciler{}
8782

83+
logger, _ := ktesting.NewTestContext(t)
8884
err := r.SetupWithManager(&mockManager{
8985
scheme: scheme,
9086
log: logger,
9187
})
88+
9289
if err != nil {
9390
t.Errorf("unexpected error: %+v", err)
9491
}
@@ -116,13 +113,13 @@ func TestFpgaRegionReconcile(t *testing.T) {
116113

117114
for _, tt := range tcases {
118115
t.Run(tt.name, func(t *testing.T) {
116+
logger, ctx := ktesting.NewTestContext(t)
119117
reconciler := &FpgaRegionReconciler{
120118
Client: &mockClient{
121119
getError: tt.getError,
122120
},
123121
PatcherManager: patcher.NewPatcherManager(logger),
124122
}
125-
ctx := log.IntoContext(context.Background(), logger)
126123
_, err := reconciler.Reconcile(ctx, ctrl.Request{})
127124
if err != nil && !tt.expectedErr {
128125
t.Errorf("unexpected error: %+v", err)
@@ -137,10 +134,12 @@ func TestFpgaRegionReconcile(t *testing.T) {
137134
func TestFpgaRegionSetupWithManager(t *testing.T) {
138135
r := &FpgaRegionReconciler{}
139136

137+
logger, _ := ktesting.NewTestContext(t)
140138
err := r.SetupWithManager(&mockManager{
141139
scheme: scheme,
142140
log: logger,
143141
})
142+
144143
if err != nil {
145144
t.Errorf("unexpected error: %+v", err)
146145
}

‎pkg/fpgacontroller/patcher/patcher_test.go

+3-6
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
package patcher
1616

1717
import (
18-
"flag"
1918
"reflect"
2019
"testing"
2120

@@ -25,12 +24,9 @@ import (
2524
ctrl "sigs.k8s.io/controller-runtime"
2625

2726
fpgav2 "github.com/intel/intel-device-plugins-for-kubernetes/pkg/apis/fpga/v2"
27+
"k8s.io/klog/v2/ktesting"
2828
)
2929

30-
func init() {
31-
_ = flag.Set("v", "4")
32-
}
33-
3430
func checkExpectedError(t *testing.T, expectedErr bool, err error, testName string) {
3531
t.Helper()
3632

@@ -145,7 +141,8 @@ func TestPatcherStorageFunctions(t *testing.T) {
145141

146142
for _, tt := range tcases {
147143
t.Run(tt.name, func(t *testing.T) {
148-
p := newPatcher(ctrl.Log.WithName("test"))
144+
logger, _ := ktesting.NewTestContext(t)
145+
p := newPatcher(logger)
149146
for _, af := range tt.afsToAdd {
150147
err := p.AddAf(af)
151148
checkExpectedError(t, tt.expectedErr, err, tt.name)

‎pkg/fpgacontroller/patcher/patchermanager_test.go

+4-10
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
package patcher
1616

1717
import (
18-
"context"
1918
"encoding/json"
2019
"testing"
2120

@@ -24,19 +23,14 @@ import (
2423
"k8s.io/apimachinery/pkg/api/resource"
2524
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2625
"k8s.io/apimachinery/pkg/runtime"
27-
"k8s.io/klog/v2/klogr"
28-
ctrl "sigs.k8s.io/controller-runtime"
2926
"sigs.k8s.io/controller-runtime/pkg/webhook"
3027

3128
fpgav2 "github.com/intel/intel-device-plugins-for-kubernetes/pkg/apis/fpga/v2"
29+
"k8s.io/klog/v2/ktesting"
3230
)
3331

34-
func init() {
35-
ctrl.SetLogger(klogr.New())
36-
}
37-
3832
func TestGetPatcher(t *testing.T) {
39-
log := ctrl.Log.WithName("test")
33+
log, _ := ktesting.NewTestContext(t)
4034
namespace := "test"
4135
tcases := []struct {
4236
pm *Manager
@@ -165,7 +159,7 @@ func TestMutate(t *testing.T) {
165159

166160
for _, tcase := range tcases {
167161
t.Run(tcase.name, func(t *testing.T) {
168-
log := ctrl.Log.WithName("test")
162+
log, ctx := ktesting.NewTestContext(t)
169163
p := newPatcher(log)
170164
p.AddRegion(&fpgav2.FpgaRegion{
171165
ObjectMeta: metav1.ObjectMeta{
@@ -177,7 +171,7 @@ func TestMutate(t *testing.T) {
177171
})
178172
pm := NewPatcherManager(log)
179173
pm.patchers["default"] = p
180-
resp := pm.GetPodMutator()(context.TODO(), webhook.AdmissionRequest{AdmissionRequest: tcase.ar})
174+
resp := pm.GetPodMutator()(ctx, webhook.AdmissionRequest{AdmissionRequest: tcase.ar})
181175

182176
actualPatchOps := 0
183177
if tcase.expectedAllowed != resp.Allowed {

‎test/envtest/suite_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import (
3232
"k8s.io/apimachinery/pkg/util/uuid"
3333
"k8s.io/client-go/kubernetes/scheme"
3434
"k8s.io/client-go/rest"
35-
"k8s.io/klog/v2/klogr"
35+
"k8s.io/klog/v2/textlogger"
3636
ctrl "sigs.k8s.io/controller-runtime"
3737
"sigs.k8s.io/controller-runtime/pkg/client"
3838
"sigs.k8s.io/controller-runtime/pkg/envtest"
@@ -76,7 +76,7 @@ func TestAPIs(t *testing.T) {
7676
var _ = BeforeSuite(func() {
7777
By("bootstrapping test environment")
7878

79-
logf.SetLogger(klogr.NewWithOptions(klogr.WithFormat(klogr.FormatKlog)))
79+
logf.SetLogger(textlogger.NewLogger(textlogger.NewConfig()))
8080

8181
testEnv = &envtest.Environment{
8282
CRDDirectoryPaths: []string{filepath.Join("..", "..", "deployments", "operator", "crd", "bases")},

0 commit comments

Comments
 (0)