mirrors/pinniped
1
0
Fork 0
mirror of https://github.com/vmware-tanzu/pinniped.git synced 2026-01-07 05:57:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Use plog.Logger instead of logr.Logger wherever possible

Browse Source
This commit is contained in:
Joshua Casey
2024-05-12 19:11:16 -05:00
parent 247ac10215
commit c6463831ac
19 changed files with 586 additions and 448 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
internal/controller/authenticator/cachecleaner/cachecleaner.go
View File

@@ -7,7 +7,6 @@ package cachecleaner
import (
"fmt"
"github.com/go-logr/logr"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/klog/v2"
@@ -17,6 +16,7 @@ import (
"go.pinniped.dev/internal/controller/authenticator"
"go.pinniped.dev/internal/controller/authenticator/authncache"
"go.pinniped.dev/internal/controllerlib"
"go.pinniped.dev/internal/plog"
)
// New instantiates a new controllerlib.Controller which will garbage collect authenticators from the provided Cache.
@@ -24,7 +24,7 @@ func New(
cache *authncache.Cache,
webhooks authinformers.WebhookAuthenticatorInformer,
jwtAuthenticators authinformers.JWTAuthenticatorInformer,
log logr.Logger,
log plog.Logger,
) controllerlib.Controller {
return controllerlib.New(
controllerlib.Config{
@@ -53,7 +53,7 @@ type controller struct {
cache *authncache.Cache
webhooks authinformers.WebhookAuthenticatorInformer
jwtAuthenticators authinformers.JWTAuthenticatorInformer
log logr.Logger
log plog.Logger
}
// Sync implements controllerlib.Syncer.

17
internal/controller/authenticator/cachecleaner/cachecleaner_test.go
View File

@@ -4,6 +4,7 @@
package cachecleaner
import (
"bytes"
"context"
"testing"
@@ -18,7 +19,8 @@ import (
controllerAuthenticator "go.pinniped.dev/internal/controller/authenticator"
"go.pinniped.dev/internal/controller/authenticator/authncache"
"go.pinniped.dev/internal/controllerlib"
"go.pinniped.dev/internal/testutil/testlogger"
"go.pinniped.dev/internal/plog"
"go.pinniped.dev/internal/testutil"
)
func TestController(t *testing.T) {
@@ -126,8 +128,8 @@ func TestController(t *testing.T) {
},
},
wantLogs: []string{
`cachecleaner-controller "level"=0 "msg"="deleting authenticator from cache" "authenticator"={"name":"test-jwt-authenticator-name-two"} "kind"="JWTAuthenticator"`,
`cachecleaner-controller "level"=0 "msg"="deleting authenticator from cache" "authenticator"={"name":"test-webhook-name-two"} "kind"="WebhookAuthenticator"`,
`{"level":"info","timestamp":"2099-08-08T13:57:36.123456Z","logger":"cachecleaner-controller","caller":"cachecleaner/cachecleaner.go:<line>$cachecleaner.(*controller).Sync","message":"deleting authenticator from cache","authenticator":{"name":"test-jwt-authenticator-name-two"},"kind":"JWTAuthenticator"}`,
`{"level":"info","timestamp":"2099-08-08T13:57:36.123456Z","logger":"cachecleaner-controller","caller":"cachecleaner/cachecleaner.go:<line>$cachecleaner.(*controller).Sync","message":"deleting authenticator from cache","authenticator":{"name":"test-webhook-name-two"},"kind":"WebhookAuthenticator"}`,
},
wantCacheKeys: []authncache.Key{testWebhookKey1, testJWTAuthenticatorKey1, testKeyUnknownType},
},
@@ -142,11 +144,12 @@ func TestController(t *testing.T) {
if tt.initialCache != nil {
tt.initialCache(t, cache)
}
testLog := testlogger.NewLegacy(t) //nolint:staticcheck // old test with lots of log statements
webhooks := informers.Authentication().V1alpha1().WebhookAuthenticators()
jwtAuthenticators := informers.Authentication().V1alpha1().JWTAuthenticators()
controller := New(cache, webhooks, jwtAuthenticators, testLog.Logger)
var log bytes.Buffer
logger := plog.TestLogger(t, &log)
controller := New(cache, webhooks, jwtAuthenticators, logger)
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
@@ -167,7 +170,7 @@ func TestController(t *testing.T) {
} else {
require.NoError(t, err)
}
require.ElementsMatch(t, tt.wantLogs, testLog.Lines())
require.ElementsMatch(t, tt.wantLogs, testutil.SplitByNewline(log.String()))
require.ElementsMatch(t, tt.wantCacheKeys, cache.Keys())
})
}