欺骗 grpc UnaryHandler 以在 Go 中对 gRPC 进行单元测试

Question

我正在努力提高我的 Go gRPC 服务器的覆盖率，但我在为服务器的拦截器函数编写测试时遇到了麻烦，因为我无法有意义地满足 UnaryHandler 类型。

我有一个函数Interceptor，签名如下：

Interceptor func(
  ctx context.Context,
  req interface{},
  info *grpc.UnaryServerInfo,
  handler grpc.UnaryHandler, // <- my issue comes from here
) (interface{}, error)

我假设任何 gRPC 方法都会满足 UnaryHandler 的签名：

type UnaryHandler func(ctx context.Context, req interface{}) (interface{}, error)

所以我尝试传入一个带有这个签名的方法：

GetToken(ctx context.Context, req *AuthData) (*Token, error)

我认为这会起作用，因为这就是拦截器实际上正在做的事情（转发该 RPC），但出于某种原因，Go 抱怨：

不能在 Interceptor 的参数中使用 authService.GetToken (type func(context.Context, *AuthData) (*Token, error)) 作为类型 grpc.UnaryHandler

我继续写了一个正确满足的虚拟函数：

func genericHandler(ctx context.Context, req interface{}) (interface{}, error) {
    return req, nil
}

这很好，因为我在测试拦截器时并不特别需要运行任何特定的方法。但是我很好奇为什么实际方法不满足约束，因为（根据我的理解）每当我在野外调用该 RPC 时，它都会被传递给幕后的拦截器函数。

最可能的解释是 grpc UnaryHandler 没有做我认为的那样，但是它做了什么？

Answer 1

不，函数

GetToken(ctx context.Context, req *AuthData) (*Token, error)

与

的类型不同

type UnaryHandler func(ctx context.Context, req interface{}) (interface{}, error)

在GetToken 中，第二个参数req 的类型为*AuthData，而UnaryHandler 中的req 的类型为interface{}。返回的*Token 与interface{} 的类型也不相同。这就是不能将GetToken 直接传递给拦截器的原因。

在您的 grpc 服务中，您可以编写类似

的方法

GetToken(ctx context.Context, req *AuthData) (*Token, error)

作为处理程序来执行您的服务器工作。然而，这并不是人们想象的UnaryHandler。

大部分转换是由 grpc/protobuf 代码生成器完成的。根据您的 proto 定义，它会生成一个接口，如下所示：

type XXXServer interface {
    GetToken(ctx context.Context, req *AuthData) (*Token, error)
}

您可以看到您的处理程序满足的正是这个接口（不是 UnaryHander）。

在后台，如果您查看生成的xxx.pb.go 文件，您会发现一些_XXX_GetToken_Handler 实际上正在执行处理程序工作。在这个函数中，一个（实际的）UnaryHandler 被定义为：

func _XXX_GetToken_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
    // skip other preparations...
    // 
    handler := func(ctx context.Context, req interface{}) (interface{}, error) {
        return srv.(XXXServer).GetToken(ctx, req.(*AuthData))
    }
    return interceptor(ctx, in, info, handler)
}

在这个UnaryHandler 中，它会将您的服务器转换为XXXServer 接口，然后调用您的处理程序（您的代码）。这显示了interceptor 的调用方式。