如何使用 Go 中的方法模拟虚拟 grpc 服务

Question

我需要为一个函数编写一个单元测试，该函数在其源代码中调用不同 gRPC 服务的 gRPC 方法。我的测试结果出现严重错误，因为 gRPC 服务未在我的计算机上运行。我想在测试中创建一个虚拟服务，并且该服务必须为源代码内的方法调用提供服务。我该怎么做？

编辑：详细信息 源函数：

func (s *mainType) MainGenerateBearerToken(inputs...)(output) {
        response, err := s.Subtype.SubGenerateBearerToken(context, authnPass, ttl)
        if err != nil {
            return nil, err
        }
        return &models.OCITokenResponse{Token: response.Token, ExpiresIn: ttl}, nil
    }

func(cl *Subtype) SubGenerateBearerToken(context,authnPass, ttl) (*BearerTokenResponse, error) {
    
    resp,err := pb.NewGrpcClient(cl.Conn).GetBearerToken_grpc(ctx, &pb.GetBearerTokenRequest{AuthnToken, BearerTtlValue:ttlNum)
    
    return &BearerTokenResponse{Token}, err
}

我正在为 MainGenerateBearerToken() 函数编写测试，该函数调用 SubGenerateBearerToken()，其中调用 grpc 方法。

Answer 1

gRPC 服务客户端是一个常规的 Go 接口。

您可以使用 gomock 或 moq 为任何 Go 接口生成模拟。

$ go install github.com/golang/mock/[email protected]
$ mockgen -source=my_service.pb.go MyServiceClient

或者

$ go install github.com/matryer/[email protected]
$ moq -pkg mock -out mock/my_service.go . MyServiceClient

这将生成实现 MyServiceClient 的 mock.MyServiceClientMock 。然后您可以在单元测试中使用它而不是真正的 gRPC 客户端。

使用起订量的完整示例：

my_service.proto：

syntax = "proto3";

package main;
option go_package = "main";

service MyService {
    rpc Hello(HelloMesage) returns (HelloMesage) {}
}

message HelloMesage {
  string msg = 1;
}

main.go：

package main

import context "context"

//go:generate protoc --go_out=plugins=grpc:. -I=. my_service.proto
//go:generate moq -out my_service_mock.go . MyServiceClient

func CallHello(myService MyServiceClient) (*HelloMesage, error) {
    return myService.Hello(context.TODO(), &HelloMesage{Msg: "hello"})
}

func main() {
    // (omitted) call grpc normally ...
}

main_test.go：

package main

import (
    context "context"
    "testing"

    "github.com/stretchr/testify/assert"
    grpc "google.golang.org/grpc"
)

func TestCallHello(t *testing.T) {
    myServiceClient := &MyServiceClientMock{
        HelloFunc: func(ctx context.Context, in *HelloMesage, opts ...grpc.CallOption) (*HelloMesage, error) {
            return &HelloMesage{Msg: in.Msg + " reply"}, nil
        },
    }
    res, err := CallHello(myServiceClient)
    assert.NoError(t, err)
    assert.Equal(t, "hello reply", res.Msg)

}

运行：

$ go mod init myservice
$ go mod tidy
$ go generate
$ go test

Answer 2

如果适合在 SubGenerateBearerToken 方法中删除 grpc 客户端创建（例如，将其保留在子类型中或作为参数传递），您可以轻松创建一个简单的假客户端：

type fakeClient struct {
    grpc.YourClient // a client interface from your *.pb.go file
}

func NewFakeClient(_ *grpc.ClientConn) *fakeClient {
    return &fakeClient{}
}

func (fc *fakeClient) GetBearerToken_grpc(ctx context.Context, in *pb.GetBearerTokenRequest, opts ...grpc.CallOption) (*pb.BearerTokenResponse, error) {
    return &pb.BearerTokenResponse{
        // your fake response...
    }, nil
}