From 56a6e43839a99e1fc6283af4f38e495d6e3b911b Mon Sep 17 00:00:00 2001 From: k1LoW Date: Fri, 22 Sep 2023 22:15:19 +0900 Subject: [PATCH] Add Stringer for Request type --- go.mod | 4 ++++ go.sum | 30 +++++++++++++++++++++++++ grpcstub.go | 24 ++++++++++++++++++++ grpcstub_test.go | 35 ++++++++++++++++++++++++++++++ testdata/request_stringer_0.golden | 7 ++++++ testdata/request_stringer_1.golden | 2 ++ 6 files changed, 102 insertions(+) create mode 100644 testdata/request_stringer_0.golden create mode 100644 testdata/request_stringer_1.golden diff --git a/go.mod b/go.mod index fe97e92..f817dc9 100644 --- a/go.mod +++ b/go.mod @@ -9,15 +9,19 @@ require ( github.com/jaswdr/faker v1.16.0 github.com/jhump/protoreflect/v2 v2.0.0-20230705224148-00680b949112 github.com/minio/pkg v1.6.4 + github.com/tenntenn/golden v0.5.1 google.golang.org/grpc v1.57.0 google.golang.org/protobuf v1.31.0 ) require ( github.com/golang/protobuf v1.5.3 // indirect + github.com/josharian/mapfs v0.0.0-20210615234106-095c008854e6 // indirect + github.com/josharian/txtarfs v0.0.0-20210615234325-77aca6df5bca // indirect golang.org/x/net v0.9.0 // indirect golang.org/x/sync v0.3.0 // indirect golang.org/x/sys v0.7.0 // indirect golang.org/x/text v0.9.0 // indirect + golang.org/x/tools v0.6.0 // indirect google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19 // indirect ) diff --git a/go.sum b/go.sum index 7b09bc1..f928b2b 100644 --- a/go.sum +++ b/go.sum @@ -13,19 +13,49 @@ github.com/jaswdr/faker v1.16.0 h1:5ZjusQbqIZwJnUymPirNKJI1yFCuozdSR9oeYPgD5Uk= github.com/jaswdr/faker v1.16.0/go.mod h1:x7ZlyB1AZqwqKZgyQlnqEG8FDptmHlncA5u2zY/yi6w= github.com/jhump/protoreflect/v2 v2.0.0-20230705224148-00680b949112 h1:DKASUy0S/ca+GoYZJ77VQefLyID0wn4isJcoQ4pd/WY= github.com/jhump/protoreflect/v2 v2.0.0-20230705224148-00680b949112/go.mod h1:PKDh3b1I/ISNmawcTX+YMYDYx3tA5zLUp3B1N2wmXWs= +github.com/josharian/mapfs v0.0.0-20210615234106-095c008854e6 h1:c+ctPFdISggaSNCfU1IueNBAsqetJSvMcpQlT+0OVdY= +github.com/josharian/mapfs v0.0.0-20210615234106-095c008854e6/go.mod h1:Rv/momJI8DgrWnBZip+SgagpcgORIZQE5SERlxNb8LY= +github.com/josharian/txtarfs v0.0.0-20210615234325-77aca6df5bca h1:a8xeK4GsWLE4LYo5VI4u1Cn7ZvT1NtXouXR3DdKLB8Q= +github.com/josharian/txtarfs v0.0.0-20210615234325-77aca6df5bca/go.mod h1:UbC32ft9G/jG+sZI8wLbIBNIrYr7vp/yqMDa9SxVBNA= github.com/minio/pkg v1.6.4 h1:k6XlhyJ8zOn90PI4csuMeePx7BQrcX1jorKriR5J2fo= github.com/minio/pkg v1.6.4/go.mod h1:0iX1IuJGSCnMvIvrEJauk1GgQSX9JdU6Kh0P3EQRGkI= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/tenntenn/golden v0.5.1 h1:LQHiiTgbm+XwnTFnP8e/Nwjm2qYErQJzI1mbqfRLJi8= +github.com/tenntenn/golden v0.5.1/go.mod h1:0xI/4lpoHR65AUTmd1RKR9S1Uv0JR3yR2Q1Ob2bKqQA= +github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= golang.org/x/net v0.9.0 h1:aWJ/m6xSmxWBx+V0XRHTlrYrPG56jKsLdTFmsSsCzOM= golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E= golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.7.0 h1:3jlCCIQZPdOYu1h8BkNvLz8Kgwtae2cagcG/VamtZRU= golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= +golang.org/x/tools v0.6.0 h1:BOw41kyTf3PuCW1pVQf8+Cyg8pMlkYB1oo9iJ6D/lKM= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19 h1:0nDDozoAU19Qb2HwhXadU8OcsiO/09cnTqhUtq2MEOM= google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19/go.mod h1:66JfowdXAEgad5O9NnYcsNPLCPZJD++2L9X0PCMODrA= google.golang.org/grpc v1.57.0 h1:kfzNeI/klCGD2YPMUlaGNT3pxvYfga7smW3Vth8Zsiw= diff --git a/grpcstub.go b/grpcstub.go index 937be27..970148a 100644 --- a/grpcstub.go +++ b/grpcstub.go @@ -10,6 +10,7 @@ import ( "io" "net" "path/filepath" + "sort" "strings" "sync" "testing" @@ -56,6 +57,29 @@ type Request struct { Message Message } +func (r Request) String() string { + var s []string + s = append(s, fmt.Sprintf("%s/%s", r.Service, r.Method)) + if len(r.Headers) > 0 { + var keys []string + for k := range r.Headers { + keys = append(keys, k) + } + sort.SliceStable(keys, func(i, j int) bool { + return keys[i] < keys[j] + }) + for _, k := range keys { + s = append(s, fmt.Sprintf(`%s: %s`, k, strings.Join(r.Headers.Get(k), ", "))) + } + } + s = append(s, "") + if r.Message != nil { + b, _ := json.MarshalIndent(r.Message, "", " ") + s = append(s, string(b)) + } + return strings.Join(s, "\n") + "\n" +} + func newRequest(md protoreflect.MethodDescriptor, message Message) *Request { service, method := splitMethodFullName(md.FullName()) return &Request{ diff --git a/grpcstub_test.go b/grpcstub_test.go index 618a8f6..ffa8b5e 100644 --- a/grpcstub_test.go +++ b/grpcstub_test.go @@ -12,6 +12,7 @@ import ( "github.com/jhump/protoreflect/v2/grpcreflect" "github.com/k1LoW/grpcstub/testdata/hello" "github.com/k1LoW/grpcstub/testdata/routeguide" + "github.com/tenntenn/golden" "google.golang.org/grpc" "google.golang.org/grpc/codes" healthpb "google.golang.org/grpc/health/grpc_health_v1" @@ -621,3 +622,37 @@ func TestReflection(t *testing.T) { }) } } + +func TestRequestStringer(t *testing.T) { + tests := []struct { + r *Request + }{ + { + &Request{ + Service: "helloworld.Greeter", + Method: "SayHello", + Message: map[string]any{"name": "alice"}, + Headers: map[string][]string{"foo": {"bar", "barbar"}, "baz": {"qux"}}, + }, + }, + { + &Request{ + Service: "helloworld.Greeter", + Method: "SayHello", + }, + }, + } + for i, tt := range tests { + t.Run(fmt.Sprintf("%d", i), func(t *testing.T) { + got := tt.r.String() + f := fmt.Sprintf("request_stringer_%d", i) + if os.Getenv("UPDATE_GOLDEN") != "" { + golden.Update(t, "testdata", f, got) + return + } + if diff := golden.Diff(t, "testdata", f, got); diff != "" { + t.Error(diff) + } + }) + } +} diff --git a/testdata/request_stringer_0.golden b/testdata/request_stringer_0.golden new file mode 100644 index 0000000..f2ff0b1 --- /dev/null +++ b/testdata/request_stringer_0.golden @@ -0,0 +1,7 @@ +helloworld.Greeter/SayHello +baz: qux +foo: bar, barbar + +{ + "name": "alice" +} diff --git a/testdata/request_stringer_1.golden b/testdata/request_stringer_1.golden new file mode 100644 index 0000000..657e89a --- /dev/null +++ b/testdata/request_stringer_1.golden @@ -0,0 +1,2 @@ +helloworld.Greeter/SayHello +