diff --git a/plugin/ocgrpc/context_test.go b/plugin/ocgrpc/context_test.go new file mode 100644 index 000000000..f1227ba0f --- /dev/null +++ b/plugin/ocgrpc/context_test.go @@ -0,0 +1,238 @@ +package ocgrpc + +import ( + "context" + "fmt" + "log" + "net" + "testing" + + "go.opencensus.io/plugin/ocgrpc/helloworld" + "go.opencensus.io/trace" + "google.golang.org/grpc" + "google.golang.org/grpc/test/bufconn" +) + +type Recorder struct { + spans []*trace.SpanData +} + +func (r *Recorder) ExportSpan(s *trace.SpanData) { + r.spans = append(r.spans, s) +} + +func (r *Recorder) Flush() []*trace.SpanData { + spans := r.spans + r.spans = nil + return spans +} + +func initTracer() func() []*trace.SpanData { + recorder := &Recorder{} + trace.RegisterExporter(recorder) + trace.ApplyConfig(trace.Config{DefaultSampler: trace.AlwaysSample()}) + return recorder.Flush +} + +var _ helloworld.GreeterServer = server{} + +type server struct { + *helloworld.UnimplementedGreeterServer +} + +func (s server) SayHello(ctx context.Context, _ *helloworld.HelloRequest) (*helloworld.HelloReply, error) { + return &helloworld.HelloReply{Message: "Hallo"}, nil +} + +// createDialer creates a connection to be used as context dialer in GRPC +// communication. +func createDialer(s *grpc.Server) func(context.Context, string) (net.Conn, error) { + const bufSize = 1024 * 1024 + + listener := bufconn.Listen(bufSize) + conn := func(context.Context, string) (net.Conn, error) { + return listener.Dial() + } + + go func() { + if err := s.Serve(listener); err != nil { + log.Fatalf("Server exited with error: %v", err) + } + }() + + return conn +} + +func TestOutterSpanIsPassedToInterceptor(t *testing.T) { + flusher := initTracer() + + s := grpc.NewServer() + defer s.Stop() + + helloworld.RegisterGreeterServer(s, &server{}) + + dialer := createDialer(s) + ctx, outterSpan := trace.StartSpan(context.Background(), "outter_span", trace.WithSpanKind(1)) + fmt.Printf("outter span: %s\n", outterSpan.SpanContext().SpanID.String()) + + conn, err := grpc.Dial( + "bufnet", + grpc.WithContextDialer(dialer), + grpc.WithInsecure(), + grpc.WithBlock(), + grpc.WithStatsHandler(&ClientHandler{ + StartOptions: trace.StartOptions{ + Sampler: trace.AlwaysSample(), + }, + }), + grpc.WithUnaryInterceptor(func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error { + outterSpanID := outterSpan.SpanContext().SpanID + ctxSpanID := trace.FromContext(ctx).SpanContext().SpanID + fmt.Printf("interceptor context span: %s\n", ctxSpanID.String()) + if outterSpanID.String() == ctxSpanID.String() { + t.Error("span from context is the same as outter span") + } + return invoker(ctx, method, req, reply, cc, opts...) + }), + ) + if err != nil { + t.Fatalf("failed to dial bufnet: %v", err) + } + defer conn.Close() + + client := helloworld.NewGreeterClient(conn) + + _, err = client.SayHello( + ctx, + &helloworld.HelloRequest{ + Name: "Pupo", + }, + ) + if err != nil { + t.Fatalf("call to Register failed: %v", err) + } + outterSpan.End() + + reportedSpans := flusher() + + if want, have := 2, len(reportedSpans); want != have { + t.Errorf("unexpected number of spans") + } + + if want, have := "helloworld.Greeter.SayHello", reportedSpans[0].Name; want != have { + t.Fatalf("unexpected first span reported") + } + + fmt.Printf("client handler span: %s\n", reportedSpans[0].SpanID.String()) +} + +func TestClientInterceptorCannotAccessClientHandler(t *testing.T) { + flusher := initTracer() + + s := grpc.NewServer() + defer s.Stop() + + helloworld.RegisterGreeterServer(s, &server{}) + + dialer := createDialer(s) + + ctx := context.Background() + + conn, err := grpc.DialContext( + ctx, + "bufnet", + grpc.WithContextDialer(dialer), + grpc.WithInsecure(), + grpc.WithBlock(), + grpc.WithStatsHandler(&ClientHandler{ + StartOptions: trace.StartOptions{ + Sampler: trace.AlwaysSample(), + }, + }), + grpc.WithUnaryInterceptor(func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error { + s := trace.FromContext(ctx) + if s == nil { + t.Fatalf("interceptor span is nil") + } + return invoker(ctx, method, req, reply, cc, opts...) + }), + ) + if err != nil { + t.Fatalf("failed to dial bufnet: %v", err) + } + defer conn.Close() + + client := helloworld.NewGreeterClient(conn) + + _, err = client.SayHello( + context.Background(), + &helloworld.HelloRequest{ + Name: "Pupo", + }, + ) + if err != nil { + t.Fatalf("call to Register failed: %v", err) + } + + reportedSpans := flusher() + + if want, have := 1, len(reportedSpans); want != have { + t.Errorf("unexpected number of spans") + } + + if want, have := "helloworld.Greeter.SayHello", reportedSpans[0].Name; want != have { + t.Fatalf("unexpected first span reported") + } +} + +func TestServerRegisterPersonSuccess(t *testing.T) { + flusher := initTracer() + + s := grpc.NewServer( + grpc.StatsHandler(&ServerHandler{}), + grpc.UnaryInterceptor(func(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error) { + ctxSpan := trace.FromContext(ctx) + if ctxSpan == nil { + t.Fatalf("could not access to context span") + } + t.Logf("interceptor context span: %s\n", ctxSpan.SpanContext().SpanID.String()) + return handler(ctx, req) + }), + ) + defer s.Stop() + + helloworld.RegisterGreeterServer(s, &server{}) + + dialer := createDialer(s) + + ctx := context.Background() + conn, err := grpc.DialContext( + ctx, + "bufnet", + grpc.WithContextDialer(dialer), + grpc.WithInsecure(), + ) + if err != nil { + t.Fatalf("failed to dial bufnet: %v", err) + } + defer conn.Close() + + client := helloworld.NewGreeterClient(conn) + + _, err = client.SayHello(ctx, &helloworld.HelloRequest{ + Name: "Pupo", + }) + if err != nil { + t.Fatalf("call to Register failed: %v", err) + } + + reportedSpans := flusher() + + if want, have := 1, len(reportedSpans); want != have { + t.Errorf("unexpected number of spans") + } + + if want, have := "helloworld.Greeter.SayHello", reportedSpans[0].Name; want != have { + t.Fatalf("unexpected first span reported") + } +} diff --git a/plugin/ocgrpc/helloworld/helloworld.pb.go b/plugin/ocgrpc/helloworld/helloworld.pb.go new file mode 100644 index 000000000..de31bda56 --- /dev/null +++ b/plugin/ocgrpc/helloworld/helloworld.pb.go @@ -0,0 +1,221 @@ +// Code generated by protoc-gen-go. DO NOT EDIT. +// versions: +// protoc-gen-go v1.25.0 +// protoc v3.13.0 +// source: helloworld.proto + +package helloworld + +import ( + proto "github.com/golang/protobuf/proto" + 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) +) + +// This is a compile-time assertion that a sufficiently up-to-date version +// of the legacy proto package is being used. +const _ = proto.ProtoPackageIsVersion4 + +// The request message containing the user's name. +type HelloRequest struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` +} + +func (x *HelloRequest) Reset() { + *x = HelloRequest{} + if protoimpl.UnsafeEnabled { + mi := &file_helloworld_proto_msgTypes[0] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *HelloRequest) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*HelloRequest) ProtoMessage() {} + +func (x *HelloRequest) ProtoReflect() protoreflect.Message { + mi := &file_helloworld_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 HelloRequest.ProtoReflect.Descriptor instead. +func (*HelloRequest) Descriptor() ([]byte, []int) { + return file_helloworld_proto_rawDescGZIP(), []int{0} +} + +func (x *HelloRequest) GetName() string { + if x != nil { + return x.Name + } + return "" +} + +// The response message containing the greetings +type HelloReply struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"` +} + +func (x *HelloReply) Reset() { + *x = HelloReply{} + if protoimpl.UnsafeEnabled { + mi := &file_helloworld_proto_msgTypes[1] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *HelloReply) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*HelloReply) ProtoMessage() {} + +func (x *HelloReply) ProtoReflect() protoreflect.Message { + mi := &file_helloworld_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 HelloReply.ProtoReflect.Descriptor instead. +func (*HelloReply) Descriptor() ([]byte, []int) { + return file_helloworld_proto_rawDescGZIP(), []int{1} +} + +func (x *HelloReply) GetMessage() string { + if x != nil { + return x.Message + } + return "" +} + +var File_helloworld_proto protoreflect.FileDescriptor + +var file_helloworld_proto_rawDesc = []byte{ + 0x0a, 0x10, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x2e, 0x70, 0x72, 0x6f, + 0x74, 0x6f, 0x12, 0x0a, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x22, 0x22, + 0x0a, 0x0c, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 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, 0x26, 0x0a, 0x0a, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 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, 0x32, 0x49, 0x0a, 0x07, 0x47, 0x72, + 0x65, 0x65, 0x74, 0x65, 0x72, 0x12, 0x3e, 0x0a, 0x08, 0x53, 0x61, 0x79, 0x48, 0x65, 0x6c, 0x6c, + 0x6f, 0x12, 0x18, 0x2e, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x2e, 0x48, + 0x65, 0x6c, 0x6c, 0x6f, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x16, 0x2e, 0x68, 0x65, + 0x6c, 0x6c, 0x6f, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x2e, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x52, 0x65, + 0x70, 0x6c, 0x79, 0x22, 0x00, 0x42, 0x37, 0x5a, 0x35, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, + 0x67, 0x6f, 0x6c, 0x61, 0x6e, 0x67, 0x2e, 0x6f, 0x72, 0x67, 0x2f, 0x67, 0x72, 0x70, 0x63, 0x2f, + 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x73, 0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x77, 0x6f, + 0x72, 0x6c, 0x64, 0x2f, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x62, 0x06, + 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, +} + +var ( + file_helloworld_proto_rawDescOnce sync.Once + file_helloworld_proto_rawDescData = file_helloworld_proto_rawDesc +) + +func file_helloworld_proto_rawDescGZIP() []byte { + file_helloworld_proto_rawDescOnce.Do(func() { + file_helloworld_proto_rawDescData = protoimpl.X.CompressGZIP(file_helloworld_proto_rawDescData) + }) + return file_helloworld_proto_rawDescData +} + +var file_helloworld_proto_msgTypes = make([]protoimpl.MessageInfo, 2) +var file_helloworld_proto_goTypes = []interface{}{ + (*HelloRequest)(nil), // 0: helloworld.HelloRequest + (*HelloReply)(nil), // 1: helloworld.HelloReply +} +var file_helloworld_proto_depIdxs = []int32{ + 0, // 0: helloworld.Greeter.SayHello:input_type -> helloworld.HelloRequest + 1, // 1: helloworld.Greeter.SayHello:output_type -> helloworld.HelloReply + 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_helloworld_proto_init() } +func file_helloworld_proto_init() { + if File_helloworld_proto != nil { + return + } + if !protoimpl.UnsafeEnabled { + file_helloworld_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*HelloRequest); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_helloworld_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*HelloReply); 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_helloworld_proto_rawDesc, + NumEnums: 0, + NumMessages: 2, + NumExtensions: 0, + NumServices: 1, + }, + GoTypes: file_helloworld_proto_goTypes, + DependencyIndexes: file_helloworld_proto_depIdxs, + MessageInfos: file_helloworld_proto_msgTypes, + }.Build() + File_helloworld_proto = out.File + file_helloworld_proto_rawDesc = nil + file_helloworld_proto_goTypes = nil + file_helloworld_proto_depIdxs = nil +} diff --git a/plugin/ocgrpc/helloworld/helloworld.proto b/plugin/ocgrpc/helloworld/helloworld.proto new file mode 100644 index 000000000..1a92a0621 --- /dev/null +++ b/plugin/ocgrpc/helloworld/helloworld.proto @@ -0,0 +1,17 @@ +syntax = "proto3"; + +option go_package = "google.golang.org/grpc/examples/helloworld/helloworld"; + +package helloworld; + +// The greeting service definition. +service Greeter { + // Sends a greeting + rpc SayHello(HelloRequest) returns (HelloReply) {} +} + +// The request message containing the user's name. +message HelloRequest { string name = 1; } + +// The response message containing the greetings +message HelloReply { string message = 1; } \ No newline at end of file diff --git a/plugin/ocgrpc/helloworld/helloworld_grpc.pb.go b/plugin/ocgrpc/helloworld/helloworld_grpc.pb.go new file mode 100644 index 000000000..e47eab210 --- /dev/null +++ b/plugin/ocgrpc/helloworld/helloworld_grpc.pb.go @@ -0,0 +1,92 @@ +// Code generated by protoc-gen-go-grpc. DO NOT EDIT. + +package helloworld + +import ( + context "context" + grpc "google.golang.org/grpc" + codes "google.golang.org/grpc/codes" + status "google.golang.org/grpc/status" +) + +// 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 + +// GreeterClient is the client API for Greeter service. +// +// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream. +type GreeterClient interface { + // Sends a greeting + SayHello(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error) +} + +type greeterClient struct { + cc grpc.ClientConnInterface +} + +func NewGreeterClient(cc grpc.ClientConnInterface) GreeterClient { + return &greeterClient{cc} +} + +func (c *greeterClient) SayHello(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error) { + out := new(HelloReply) + err := c.cc.Invoke(ctx, "/helloworld.Greeter/SayHello", in, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +// GreeterServer is the server API for Greeter service. +// All implementations must embed UnimplementedGreeterServer +// for forward compatibility +type GreeterServer interface { + // Sends a greeting + SayHello(context.Context, *HelloRequest) (*HelloReply, error) + mustEmbedUnimplementedGreeterServer() +} + +// UnimplementedGreeterServer must be embedded to have forward compatible implementations. +type UnimplementedGreeterServer struct { +} + +func (*UnimplementedGreeterServer) SayHello(context.Context, *HelloRequest) (*HelloReply, error) { + return nil, status.Errorf(codes.Unimplemented, "method SayHello not implemented") +} +func (*UnimplementedGreeterServer) mustEmbedUnimplementedGreeterServer() {} + +func RegisterGreeterServer(s *grpc.Server, srv GreeterServer) { + s.RegisterService(&_Greeter_serviceDesc, srv) +} + +func _Greeter_SayHello_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { + in := new(HelloRequest) + if err := dec(in); err != nil { + return nil, err + } + if interceptor == nil { + return srv.(GreeterServer).SayHello(ctx, in) + } + info := &grpc.UnaryServerInfo{ + Server: srv, + FullMethod: "/helloworld.Greeter/SayHello", + } + handler := func(ctx context.Context, req interface{}) (interface{}, error) { + return srv.(GreeterServer).SayHello(ctx, req.(*HelloRequest)) + } + return interceptor(ctx, in, info, handler) +} + +var _Greeter_serviceDesc = grpc.ServiceDesc{ + ServiceName: "helloworld.Greeter", + HandlerType: (*GreeterServer)(nil), + Methods: []grpc.MethodDesc{ + { + MethodName: "SayHello", + Handler: _Greeter_SayHello_Handler, + }, + }, + Streams: []grpc.StreamDesc{}, + Metadata: "helloworld.proto", +}