测试 gRPC 服务

Question

我想测试一个用 Go 编写的 gRPC 服务。我使用的示例是来自 grpc-go repo 的 Hello World 服务器示例。

protobuf定义如下：

 syntax = "proto3";

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;
}

greeter_server main 中的类型是：

 // server is used to implement helloworld.GreeterServer.
type server struct{}

// SayHello implements helloworld.GreeterServer
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
    return &pb.HelloReply{Message: "Hello " + in.Name}, nil
}

我找过示例，但找不到任何关于如何在 Go 中为 gRPC 服务实施测试的信息。

原文由 joscas 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

我认为您正在寻找 google.golang.org/grpc/test/bufconn 包来帮助您避免使用真实端口号启动服务，但仍允许测试流式 RPC。

 import "google.golang.org/grpc/test/bufconn"

const bufSize = 1024 * 1024

var lis *bufconn.Listener

func init() {
    lis = bufconn.Listen(bufSize)
    s := grpc.NewServer()
    pb.RegisterGreeterServer(s, &server{})
    go func() {
        if err := s.Serve(lis); err != nil {
            log.Fatalf("Server exited with error: %v", err)
        }
    }()
}

func bufDialer(context.Context, string) (net.Conn, error) {
    return lis.Dial()
}

func TestSayHello(t *testing.T) {
    ctx := context.Background()
    conn, err := grpc.DialContext(ctx, "bufnet", grpc.WithContextDialer(bufDialer), grpc.WithInsecure())
    if err != nil {
        t.Fatalf("Failed to dial bufnet: %v", err)
    }
    defer conn.Close()
    client := pb.NewGreeterClient(conn)
    resp, err := client.SayHello(ctx, &pb.HelloRequest{"Dr. Seuss"})
    if err != nil {
        t.Fatalf("SayHello failed: %v", err)
    }
    log.Printf("Response: %+v", resp)
    // Test for output here.
}

这种方法的好处是您仍然可以获得网络行为，但是通过内存连接而不使用操作系统级资源，例如可能会或可能不会快速清理的端口。它允许您以实际使用的方式对其进行测试，并为您提供正确的流式传输行为。

我没有一个流式传输的例子，但神奇的酱汁就在上面。它为您提供正常网络连接的所有预期行为。诀窍是如图所示设置 WithDialer 选项，使用 bufconn 包创建一个公开其自己的拨号器的侦听器。我一直使用这种技术来测试 gRPC 服务并且效果很好。

原文由 shiblon 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 2

如果您想验证 gRPC 服务的实现是否符合您的预期，那么您可以只编写标准单元测试而完全忽略网络。

例如，制作 greeter_server_test.go ：

 func HelloTest(t *testing.T) {
    s := server{}

    // set up test cases
    tests := []struct{
        name string
        want string
    } {
        {
            name: "world",
            want: "Hello world",
        },
        {
            name: "123",
            want: "Hello 123",
        },
    }

    for _, tt := range tests {
        req := &pb.HelloRequest{Name: tt.name}
        resp, err := s.SayHello(context.Background(), req)
        if err != nil {
            t.Errorf("HelloTest(%v) got unexpected error")
        }
        if resp.Message != tt.want {
            t.Errorf("HelloText(%v)=%v, wanted %v", tt.name, resp.Message, tt.want)
        }
    }
}

我可能从记忆中弄乱了原型语法，但这就是我的想法。

原文由 Omar 发布，翻译遵循 CC BY-SA 3.0 许可协议