@@ -6,11 +6,19 @@ package logr_test
66import (
77 "context"
88 "fmt"
9+ "runtime"
10+ "strings"
11+ "testing"
912
1013 "github.com/go-logr/logr"
1114 "github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
15+ "github.com/grpc-ecosystem/go-grpc-middleware/v2/testing/testpb"
16+ "github.com/stretchr/testify/assert"
17+ "github.com/stretchr/testify/require"
18+ "github.com/stretchr/testify/suite"
1219 "google.golang.org/grpc"
1320 "k8s.io/klog/v2"
21+ "k8s.io/klog/v2/ktesting"
1422)
1523
1624// verbosity https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#what-method-to-use
@@ -25,7 +33,7 @@ const (
2533// This code is simple enough to be copied and not imported.
2634func InterceptorLogger (l logr.Logger ) logging.Logger {
2735 return logging .LoggerFunc (func (_ context.Context , lvl logging.Level , msg string , fields ... any ) {
28- l : =l .WithValues (fields ... )
36+ l = l .WithValues (fields ... )
2937 switch lvl {
3038 case logging .LevelDebug :
3139 l .V (debugVerbosity ).Info (msg )
@@ -76,3 +84,48 @@ func ExampleInterceptorLogger() {
7684 )
7785 // Output:
7886}
87+
88+ type logrExampleTestSuite struct {
89+ * testpb.InterceptorTestSuite
90+ logBuffer * ktesting.BufferTL
91+ }
92+
93+ func TestSuite (t * testing.T ) {
94+ if strings .HasPrefix (runtime .Version (), "go1.7" ) {
95+ t .Skipf ("Skipping due to json.RawMessage incompatibility with go1.7" )
96+ return
97+ }
98+
99+ buffer := & ktesting.BufferTL {}
100+ cfg := ktesting .NewConfig ()
101+ logger := InterceptorLogger (ktesting .NewLogger (buffer , cfg ))
102+
103+ s := & logrExampleTestSuite {
104+ InterceptorTestSuite : & testpb.InterceptorTestSuite {
105+ TestService : & testpb.TestPingService {},
106+ },
107+ logBuffer : buffer ,
108+ }
109+
110+ s .InterceptorTestSuite .ServerOpts = []grpc.ServerOption {
111+ grpc .StreamInterceptor (logging .StreamServerInterceptor (logger )),
112+ grpc .UnaryInterceptor (logging .UnaryServerInterceptor (logger )),
113+ }
114+
115+ suite .Run (t , s )
116+ }
117+
118+ func (s * logrExampleTestSuite ) TestPing () {
119+ ctx := context .Background ()
120+ _ , err := s .Client .Ping (ctx , testpb .GoodPing )
121+ assert .NoError (s .T (), err , "there must be not be an on a successful call" )
122+ logStr := s .logBuffer .String ()
123+ require .Contains (s .T (), logStr , "started call" )
124+ require .Contains (s .T (), logStr , "protocol=\" grpc\" " )
125+ require .Contains (s .T (), logStr , "grpc.component=\" server\" " )
126+ require .Contains (s .T (), logStr , "grpc.service=\" testing.testpb.v1.TestService\" " )
127+ require .Contains (s .T (), logStr , "grpc.method=\" Ping\" " )
128+ require .Contains (s .T (), logStr , "grpc.method_type=\" unary\" " )
129+ require .Contains (s .T (), logStr , "start_time=" )
130+ require .Contains (s .T (), logStr , "grpc.time_ms=" )
131+ }
0 commit comments