From 5d6ce8673b04a214baf5719ea9d61716a97ffbad Mon Sep 17 00:00:00 2001 From: Artem A <6892867+TheRTK@users.noreply.github.com> Date: Sat, 25 Feb 2023 22:46:57 +0500 Subject: [PATCH 1/2] feat: gzip support (#1) * gzip support with example and integration test --- .github/workflows/integration-test.yml | 4 + example/simple-with-gzip/client/main.go | 44 +++ example/simple-with-gzip/entrypoint.sh | 10 + .../simple-with-gzip/simple-with-gzip.proto | 23 ++ .../stub/simple-with-gzip.json | 32 ++ protoc-gen-gripmock/server.tmpl | 1 + .../simple-with-gzip/simple-with-gzip.pb.go | 314 ++++++++++++++++++ .../simple-with-gzip/simple-with-gzip.proto | 23 ++ 8 files changed, 451 insertions(+) create mode 100644 example/simple-with-gzip/client/main.go create mode 100755 example/simple-with-gzip/entrypoint.sh create mode 100644 example/simple-with-gzip/simple-with-gzip.proto create mode 100644 example/simple-with-gzip/stub/simple-with-gzip.json create mode 100644 protogen/example/simple-with-gzip/simple-with-gzip.pb.go create mode 100644 protogen/example/simple-with-gzip/simple-with-gzip.proto diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index 0f8cd06b..fd6a9fe3 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -42,3 +42,7 @@ jobs: uses: ./ with: entrypoint: example/stub-subfolders/entrypoint.sh + - name: Run gzip example + uses: ./ + with: + entrypoint: example/simple-with-gzip/entrypoint.sh diff --git a/example/simple-with-gzip/client/main.go b/example/simple-with-gzip/client/main.go new file mode 100644 index 00000000..8a1992f2 --- /dev/null +++ b/example/simple-with-gzip/client/main.go @@ -0,0 +1,44 @@ +package main + +import ( + "context" + "log" + "os" + "time" + + pb "github.com/tokopedia/gripmock/protogen/example/simple-with-gzip" + "google.golang.org/grpc" + "google.golang.org/grpc/encoding/gzip" +) + +func main() { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + defer cancel() + + // Set up a connection to the server. + conn, err := grpc.DialContext(ctx, "localhost:4770", grpc.WithInsecure(), grpc.WithBlock()) + if err != nil { + log.Fatalf("did not connect: %v", err) + } + defer conn.Close() + + c := pb.NewGripmockClient(conn) + + // Contact the server and print out its response. + name := "tokopedia" + if len(os.Args) > 1 { + name = os.Args[1] + } + r, err := c.SayHello(context.Background(), &pb.Request{Name: name}, grpc.UseCompressor(gzip.Name)) + if err != nil { + log.Fatalf("error from grpc: %v", err) + } + log.Printf("Greeting: %s (return code %d)", r.Message, r.ReturnCode) + + name = "world" + r, err = c.SayHello(context.Background(), &pb.Request{Name: name}, grpc.UseCompressor(gzip.Name)) + if err != nil { + log.Fatalf("error from grpc: %v", err) + } + log.Printf("Greeting: %s (return code %d)", r.Message, r.ReturnCode) +} diff --git a/example/simple-with-gzip/entrypoint.sh b/example/simple-with-gzip/entrypoint.sh new file mode 100755 index 00000000..c89edd32 --- /dev/null +++ b/example/simple-with-gzip/entrypoint.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env sh + +# this file is used by .github/workflows/integration-test.yml + +gripmock --stub=example/simple-with-gzip/stub example/simple-with-gzip/simple-with-gzip.proto & + +# wait for generated files to be available and gripmock is up +sleep 2 + +go run example/simple-with-gzip/client/*.go diff --git a/example/simple-with-gzip/simple-with-gzip.proto b/example/simple-with-gzip/simple-with-gzip.proto new file mode 100644 index 00000000..fb76f921 --- /dev/null +++ b/example/simple-with-gzip/simple-with-gzip.proto @@ -0,0 +1,23 @@ +syntax = "proto3"; +option go_package = "github.com/tokopedia/gripmock/protogen/data/protogen/example/simple-with-gzip"; + +package simple_with_gzip; + + + +// The Gripmock service definition. +service Gripmock { + // simple unary method + rpc SayHello (Request) returns (Reply); +} + +// The request message containing the user's name. +message Request { + string name = 1; +} + +// The response message containing the greetings +message Reply { + string message = 1; + int32 return_code = 2; +} diff --git a/example/simple-with-gzip/stub/simple-with-gzip.json b/example/simple-with-gzip/stub/simple-with-gzip.json new file mode 100644 index 00000000..1b942ceb --- /dev/null +++ b/example/simple-with-gzip/stub/simple-with-gzip.json @@ -0,0 +1,32 @@ +[ + { + "service": "Gripmock", + "method": "SayHello", + "input": { + "equals": { + "name": "tokopedia" + } + }, + "output": { + "data": { + "message": "Hello Tokopedia", + "return_code": 1 + } + } + }, + { + "service": "Gripmock", + "method": "SayHello", + "input": { + "equals": { + "name": "world" + } + }, + "output": { + "data": { + "message": "Hello World", + "return_code": 1 + } + } + } +] diff --git a/protoc-gen-gripmock/server.tmpl b/protoc-gen-gripmock/server.tmpl index 13531f71..deec5e92 100644 --- a/protoc-gen-gripmock/server.tmpl +++ b/protoc-gen-gripmock/server.tmpl @@ -14,6 +14,7 @@ import ( "github.com/golang/protobuf/jsonpb" "golang.org/x/net/context" "google.golang.org/grpc" + _ "google.golang.org/grpc/encoding/gzip" "google.golang.org/grpc/reflection" "google.golang.org/protobuf/runtime/protoiface" ) diff --git a/protogen/example/simple-with-gzip/simple-with-gzip.pb.go b/protogen/example/simple-with-gzip/simple-with-gzip.pb.go new file mode 100644 index 00000000..a0a1d32e --- /dev/null +++ b/protogen/example/simple-with-gzip/simple-with-gzip.pb.go @@ -0,0 +1,314 @@ +// Code generated by protoc-gen-go. DO NOT EDIT. +// versions: +// protoc-gen-go v1.26.0 +// protoc v3.21.9 +// source: simple-with-gzip.proto + +package simple_with_gzip + +import ( + context "context" + grpc "google.golang.org/grpc" + codes "google.golang.org/grpc/codes" + status "google.golang.org/grpc/status" + protoreflect "google.golang.org/protobuf/reflect/protoreflect" + protoimpl "google.golang.org/protobuf/runtime/protoimpl" + reflect "reflect" + sync "sync" +) + +const ( + // Verify that this generated code is sufficiently up-to-date. + _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) + // Verify that runtime/protoimpl is sufficiently up-to-date. + _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) +) + +// The request message containing the user's name. +type Request struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` +} + +func (x *Request) Reset() { + *x = Request{} + if protoimpl.UnsafeEnabled { + mi := &file_simple_with_gzip_proto_msgTypes[0] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *Request) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*Request) ProtoMessage() {} + +func (x *Request) ProtoReflect() protoreflect.Message { + mi := &file_simple_with_gzip_proto_msgTypes[0] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use Request.ProtoReflect.Descriptor instead. +func (*Request) Descriptor() ([]byte, []int) { + return file_simple_with_gzip_proto_rawDescGZIP(), []int{0} +} + +func (x *Request) GetName() string { + if x != nil { + return x.Name + } + return "" +} + +// The response message containing the greetings +type Reply struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"` + ReturnCode int32 `protobuf:"varint,2,opt,name=return_code,json=returnCode,proto3" json:"return_code,omitempty"` +} + +func (x *Reply) Reset() { + *x = Reply{} + if protoimpl.UnsafeEnabled { + mi := &file_simple_with_gzip_proto_msgTypes[1] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *Reply) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*Reply) ProtoMessage() {} + +func (x *Reply) ProtoReflect() protoreflect.Message { + mi := &file_simple_with_gzip_proto_msgTypes[1] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use Reply.ProtoReflect.Descriptor instead. +func (*Reply) Descriptor() ([]byte, []int) { + return file_simple_with_gzip_proto_rawDescGZIP(), []int{1} +} + +func (x *Reply) GetMessage() string { + if x != nil { + return x.Message + } + return "" +} + +func (x *Reply) GetReturnCode() int32 { + if x != nil { + return x.ReturnCode + } + return 0 +} + +var File_simple_with_gzip_proto protoreflect.FileDescriptor + +var file_simple_with_gzip_proto_rawDesc = []byte{ + 0x0a, 0x16, 0x73, 0x69, 0x6d, 0x70, 0x6c, 0x65, 0x2d, 0x77, 0x69, 0x74, 0x68, 0x2d, 0x67, 0x7a, + 0x69, 0x70, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x10, 0x73, 0x69, 0x6d, 0x70, 0x6c, 0x65, + 0x5f, 0x77, 0x69, 0x74, 0x68, 0x5f, 0x67, 0x7a, 0x69, 0x70, 0x22, 0x1d, 0x0a, 0x07, 0x52, 0x65, + 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, + 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x22, 0x42, 0x0a, 0x05, 0x52, 0x65, 0x70, + 0x6c, 0x79, 0x12, 0x18, 0x0a, 0x07, 0x6d, 0x65, 0x73, 0x73, 0x61, 0x67, 0x65, 0x18, 0x01, 0x20, + 0x01, 0x28, 0x09, 0x52, 0x07, 0x6d, 0x65, 0x73, 0x73, 0x61, 0x67, 0x65, 0x12, 0x1f, 0x0a, 0x0b, + 0x72, 0x65, 0x74, 0x75, 0x72, 0x6e, 0x5f, 0x63, 0x6f, 0x64, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, + 0x05, 0x52, 0x0a, 0x72, 0x65, 0x74, 0x75, 0x72, 0x6e, 0x43, 0x6f, 0x64, 0x65, 0x32, 0x4a, 0x0a, + 0x08, 0x47, 0x72, 0x69, 0x70, 0x6d, 0x6f, 0x63, 0x6b, 0x12, 0x3e, 0x0a, 0x08, 0x53, 0x61, 0x79, + 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x12, 0x19, 0x2e, 0x73, 0x69, 0x6d, 0x70, 0x6c, 0x65, 0x5f, 0x77, + 0x69, 0x74, 0x68, 0x5f, 0x67, 0x7a, 0x69, 0x70, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, + 0x1a, 0x17, 0x2e, 0x73, 0x69, 0x6d, 0x70, 0x6c, 0x65, 0x5f, 0x77, 0x69, 0x74, 0x68, 0x5f, 0x67, + 0x7a, 0x69, 0x70, 0x2e, 0x52, 0x65, 0x70, 0x6c, 0x79, 0x42, 0x4f, 0x5a, 0x4d, 0x67, 0x69, 0x74, + 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x74, 0x6f, 0x6b, 0x6f, 0x70, 0x65, 0x64, 0x69, + 0x61, 0x2f, 0x67, 0x72, 0x69, 0x70, 0x6d, 0x6f, 0x63, 0x6b, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, + 0x67, 0x65, 0x6e, 0x2f, 0x64, 0x61, 0x74, 0x61, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x67, 0x65, + 0x6e, 0x2f, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x2f, 0x73, 0x69, 0x6d, 0x70, 0x6c, 0x65, + 0x2d, 0x77, 0x69, 0x74, 0x68, 0x2d, 0x67, 0x7a, 0x69, 0x70, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, + 0x6f, 0x33, +} + +var ( + file_simple_with_gzip_proto_rawDescOnce sync.Once + file_simple_with_gzip_proto_rawDescData = file_simple_with_gzip_proto_rawDesc +) + +func file_simple_with_gzip_proto_rawDescGZIP() []byte { + file_simple_with_gzip_proto_rawDescOnce.Do(func() { + file_simple_with_gzip_proto_rawDescData = protoimpl.X.CompressGZIP(file_simple_with_gzip_proto_rawDescData) + }) + return file_simple_with_gzip_proto_rawDescData +} + +var file_simple_with_gzip_proto_msgTypes = make([]protoimpl.MessageInfo, 2) +var file_simple_with_gzip_proto_goTypes = []interface{}{ + (*Request)(nil), // 0: simple_with_gzip.Request + (*Reply)(nil), // 1: simple_with_gzip.Reply +} +var file_simple_with_gzip_proto_depIdxs = []int32{ + 0, // 0: simple_with_gzip.Gripmock.SayHello:input_type -> simple_with_gzip.Request + 1, // 1: simple_with_gzip.Gripmock.SayHello:output_type -> simple_with_gzip.Reply + 1, // [1:2] is the sub-list for method output_type + 0, // [0:1] is the sub-list for method input_type + 0, // [0:0] is the sub-list for extension type_name + 0, // [0:0] is the sub-list for extension extendee + 0, // [0:0] is the sub-list for field type_name +} + +func init() { file_simple_with_gzip_proto_init() } +func file_simple_with_gzip_proto_init() { + if File_simple_with_gzip_proto != nil { + return + } + if !protoimpl.UnsafeEnabled { + file_simple_with_gzip_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*Request); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_simple_with_gzip_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*Reply); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + } + type x struct{} + out := protoimpl.TypeBuilder{ + File: protoimpl.DescBuilder{ + GoPackagePath: reflect.TypeOf(x{}).PkgPath(), + RawDescriptor: file_simple_with_gzip_proto_rawDesc, + NumEnums: 0, + NumMessages: 2, + NumExtensions: 0, + NumServices: 1, + }, + GoTypes: file_simple_with_gzip_proto_goTypes, + DependencyIndexes: file_simple_with_gzip_proto_depIdxs, + MessageInfos: file_simple_with_gzip_proto_msgTypes, + }.Build() + File_simple_with_gzip_proto = out.File + file_simple_with_gzip_proto_rawDesc = nil + file_simple_with_gzip_proto_goTypes = nil + file_simple_with_gzip_proto_depIdxs = nil +} + +// Reference imports to suppress errors if they are not otherwise used. +var _ context.Context +var _ grpc.ClientConnInterface + +// This is a compile-time assertion to ensure that this generated file +// is compatible with the grpc package it is being compiled against. +const _ = grpc.SupportPackageIsVersion6 + +// GripmockClient is the client API for Gripmock service. +// +// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. +type GripmockClient interface { + // simple unary method + SayHello(ctx context.Context, in *Request, opts ...grpc.CallOption) (*Reply, error) +} + +type gripmockClient struct { + cc grpc.ClientConnInterface +} + +func NewGripmockClient(cc grpc.ClientConnInterface) GripmockClient { + return &gripmockClient{cc} +} + +func (c *gripmockClient) SayHello(ctx context.Context, in *Request, opts ...grpc.CallOption) (*Reply, error) { + out := new(Reply) + err := c.cc.Invoke(ctx, "/simple_with_gzip.Gripmock/SayHello", in, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +// GripmockServer is the server API for Gripmock service. +type GripmockServer interface { + // simple unary method + SayHello(context.Context, *Request) (*Reply, error) +} + +// UnimplementedGripmockServer can be embedded to have forward compatible implementations. +type UnimplementedGripmockServer struct { +} + +func (*UnimplementedGripmockServer) SayHello(context.Context, *Request) (*Reply, error) { + return nil, status.Errorf(codes.Unimplemented, "method SayHello not implemented") +} + +func RegisterGripmockServer(s *grpc.Server, srv GripmockServer) { + s.RegisterService(&_Gripmock_serviceDesc, srv) +} + +func _Gripmock_SayHello_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { + in := new(Request) + if err := dec(in); err != nil { + return nil, err + } + if interceptor == nil { + return srv.(GripmockServer).SayHello(ctx, in) + } + info := &grpc.UnaryServerInfo{ + Server: srv, + FullMethod: "/simple_with_gzip.Gripmock/SayHello", + } + handler := func(ctx context.Context, req interface{}) (interface{}, error) { + return srv.(GripmockServer).SayHello(ctx, req.(*Request)) + } + return interceptor(ctx, in, info, handler) +} + +var _Gripmock_serviceDesc = grpc.ServiceDesc{ + ServiceName: "simple_with_gzip.Gripmock", + HandlerType: (*GripmockServer)(nil), + Methods: []grpc.MethodDesc{ + { + MethodName: "SayHello", + Handler: _Gripmock_SayHello_Handler, + }, + }, + Streams: []grpc.StreamDesc{}, + Metadata: "simple-with-gzip.proto", +} diff --git a/protogen/example/simple-with-gzip/simple-with-gzip.proto b/protogen/example/simple-with-gzip/simple-with-gzip.proto new file mode 100644 index 00000000..a0265f66 --- /dev/null +++ b/protogen/example/simple-with-gzip/simple-with-gzip.proto @@ -0,0 +1,23 @@ +syntax = "proto3"; +option go_package = "github.com/tokopedia/gripmock/protogen/example/simple-with-gzip"; + +package simple_with_gzip; + + + +// The Gripmock service definition. +service Gripmock { + // simple unary method + rpc SayHello (Request) returns (Reply); +} + +// The request message containing the user's name. +message Request { + string name = 1; +} + +// The response message containing the greetings +message Reply { + string message = 1; + int32 return_code = 2; +} From 04a21719722c29bf41c6416d8e729975ce039d74 Mon Sep 17 00:00:00 2001 From: Artem Abubakirov <6892867+TheRTK@users.noreply.github.com> Date: Sat, 25 Feb 2023 23:50:51 +0500 Subject: [PATCH 2/2] fix integration test with gzip --- example/simple-with-gzip/simple-with-gzip.proto | 2 +- example/simple-with-gzip/stub/simple-with-gzip.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/example/simple-with-gzip/simple-with-gzip.proto b/example/simple-with-gzip/simple-with-gzip.proto index fb76f921..e43582ee 100644 --- a/example/simple-with-gzip/simple-with-gzip.proto +++ b/example/simple-with-gzip/simple-with-gzip.proto @@ -1,5 +1,5 @@ syntax = "proto3"; -option go_package = "github.com/tokopedia/gripmock/protogen/data/protogen/example/simple-with-gzip"; +option go_package = "github.com/tokopedia/gripmock/example/simple-with-gzip"; package simple_with_gzip; diff --git a/example/simple-with-gzip/stub/simple-with-gzip.json b/example/simple-with-gzip/stub/simple-with-gzip.json index 1b942ceb..2438a3c9 100644 --- a/example/simple-with-gzip/stub/simple-with-gzip.json +++ b/example/simple-with-gzip/stub/simple-with-gzip.json @@ -29,4 +29,4 @@ } } } -] +] \ No newline at end of file