gRPCサービスのテスト

質問

Go で書かれた gRPC サービスをテストしたいと思います。私が使用しているのは、Hello World サーバーの例で、これは grpc-go レポ .

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 のメインは

// 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サービスのテストを実装する方法については見つかりませんでした。

どのように解決するのですか？

あなたが探しているのは 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.
}

このアプローチの利点は、ネットワークの動作はそのままに、インメモリ接続で、ポートのようなOSレベルのリソースを使用せず、すぐにクリーンアップできるかどうかということです。そして、実際に使用される方法でテストすることができ、適切なストリーミング動作が得られます。

頭の中にストリーミングの例がないのですが、マジックソースは上記のすべてです。これは、通常のネットワーク接続の期待される動作のすべてを提供します。トリックは、図のように WithDialer オプションを設定し、bufconn パッケージを使用して、独自のダイヤラーを公開するリスナーを作成することです。私は gRPC サービスをテストするためにいつもこのテクニックを使用していますが、とてもうまくいきます。