Files
fn-serverless/vendor/github.com/grpc-ecosystem/go-grpc-middleware/recovery/interceptors_test.go
Andrea Rosa e637661ea2 Adding a way to inject a request ID (#1046)
* Adding a way to inject a request ID

It is very useful to associate a request ID to each incoming request,
this change allows to provide a function to do that via Server Option.
The change comes with a default function which will generate a new
request ID. The request ID is put in the request context along with a
common logger which always logs the request-id

We add gRPC interceptors to the server so it can get the request ID out
of the gRPC metadata and put it in the common logger stored in the
context so as all the log lines using the common logger from the context
will have the request ID logged
2018-06-14 10:40:55 +01:00

144 lines
5.1 KiB
Go

// Copyright 2017 David Ackroyd. All Rights Reserved.
// See LICENSE for licensing terms.
package grpc_recovery_test
import (
"testing"
"github.com/grpc-ecosystem/go-grpc-middleware"
"github.com/grpc-ecosystem/go-grpc-middleware/recovery"
"github.com/grpc-ecosystem/go-grpc-middleware/testing"
pb_testproto "github.com/grpc-ecosystem/go-grpc-middleware/testing/testproto"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"golang.org/x/net/context"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
)
var (
goodPing = &pb_testproto.PingRequest{Value: "something", SleepTimeMs: 9999}
panicPing = &pb_testproto.PingRequest{Value: "panic", SleepTimeMs: 9999}
)
type recoveryAssertService struct {
pb_testproto.TestServiceServer
}
func (s *recoveryAssertService) Ping(ctx context.Context, ping *pb_testproto.PingRequest) (*pb_testproto.PingResponse, error) {
if ping.Value == "panic" {
panic("very bad thing happened")
}
return s.TestServiceServer.Ping(ctx, ping)
}
func (s *recoveryAssertService) PingList(ping *pb_testproto.PingRequest, stream pb_testproto.TestService_PingListServer) error {
if ping.Value == "panic" {
panic("very bad thing happened")
}
return s.TestServiceServer.PingList(ping, stream)
}
func TestRecoverySuite(t *testing.T) {
s := &RecoverySuite{
InterceptorTestSuite: &grpc_testing.InterceptorTestSuite{
TestService: &recoveryAssertService{TestServiceServer: &grpc_testing.TestPingService{T: t}},
ServerOpts: []grpc.ServerOption{
grpc_middleware.WithStreamServerChain(
grpc_recovery.StreamServerInterceptor()),
grpc_middleware.WithUnaryServerChain(
grpc_recovery.UnaryServerInterceptor()),
},
},
}
suite.Run(t, s)
}
type RecoverySuite struct {
*grpc_testing.InterceptorTestSuite
}
func (s *RecoverySuite) TestUnary_SuccessfulRequest() {
_, err := s.Client.Ping(s.SimpleCtx(), goodPing)
require.NoError(s.T(), err, "no error must occur")
}
func (s *RecoverySuite) TestUnary_PanickingRequest() {
_, err := s.Client.Ping(s.SimpleCtx(), panicPing)
require.Error(s.T(), err, "there must be an error")
assert.Equal(s.T(), codes.Internal, grpc.Code(err), "must error with internal")
assert.Equal(s.T(), "very bad thing happened", grpc.ErrorDesc(err), "must error with message")
}
func (s *RecoverySuite) TestStream_SuccessfulReceive() {
stream, err := s.Client.PingList(s.SimpleCtx(), goodPing)
require.NoError(s.T(), err, "should not fail on establishing the stream")
pong, err := stream.Recv()
require.NoError(s.T(), err, "no error must occur")
require.NotNil(s.T(), pong, "pong must not be nil")
}
func (s *RecoverySuite) TestStream_PanickingReceive() {
stream, err := s.Client.PingList(s.SimpleCtx(), panicPing)
require.NoError(s.T(), err, "should not fail on establishing the stream")
_, err = stream.Recv()
require.Error(s.T(), err, "there must be an error")
assert.Equal(s.T(), codes.Internal, grpc.Code(err), "must error with internal")
assert.Equal(s.T(), "very bad thing happened", grpc.ErrorDesc(err), "must error with message")
}
func TestRecoveryOverrideSuite(t *testing.T) {
opts := []grpc_recovery.Option{
grpc_recovery.WithRecoveryHandler(func(p interface{}) (err error) {
return grpc.Errorf(codes.Unknown, "panic triggered: %v", p)
}),
}
s := &RecoveryOverrideSuite{
InterceptorTestSuite: &grpc_testing.InterceptorTestSuite{
TestService: &recoveryAssertService{TestServiceServer: &grpc_testing.TestPingService{T: t}},
ServerOpts: []grpc.ServerOption{
grpc_middleware.WithStreamServerChain(
grpc_recovery.StreamServerInterceptor(opts...)),
grpc_middleware.WithUnaryServerChain(
grpc_recovery.UnaryServerInterceptor(opts...)),
},
},
}
suite.Run(t, s)
}
type RecoveryOverrideSuite struct {
*grpc_testing.InterceptorTestSuite
}
func (s *RecoveryOverrideSuite) TestUnary_SuccessfulRequest() {
_, err := s.Client.Ping(s.SimpleCtx(), goodPing)
require.NoError(s.T(), err, "no error must occur")
}
func (s *RecoveryOverrideSuite) TestUnary_PanickingRequest() {
_, err := s.Client.Ping(s.SimpleCtx(), panicPing)
require.Error(s.T(), err, "there must be an error")
assert.Equal(s.T(), codes.Unknown, grpc.Code(err), "must error with unknown")
assert.Equal(s.T(), "panic triggered: very bad thing happened", grpc.ErrorDesc(err), "must error with message")
}
func (s *RecoveryOverrideSuite) TestStream_SuccessfulReceive() {
stream, err := s.Client.PingList(s.SimpleCtx(), goodPing)
require.NoError(s.T(), err, "should not fail on establishing the stream")
pong, err := stream.Recv()
require.NoError(s.T(), err, "no error must occur")
require.NotNil(s.T(), pong, "pong must not be nil")
}
func (s *RecoveryOverrideSuite) TestStream_PanickingReceive() {
stream, err := s.Client.PingList(s.SimpleCtx(), panicPing)
require.NoError(s.T(), err, "should not fail on establishing the stream")
_, err = stream.Recv()
require.Error(s.T(), err, "there must be an error")
assert.Equal(s.T(), codes.Unknown, grpc.Code(err), "must error with unknown")
assert.Equal(s.T(), "panic triggered: very bad thing happened", grpc.ErrorDesc(err), "must error with message")
}