Testing a gRPC service

by

I think you’re looking for the google.golang.org/grpc/test/bufconn package to help you avoid starting up a service with a real port number, but still allowing testing of streaming RPCs.

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

The benefit of this approach is that you’re still getting network behavior, but over an in-memory connection without using OS-level resources like ports that may or may not clean up quickly. And it allows you to test it the way it’s actually used, and it gives you proper streaming behavior.

I don’t have a streaming example off the top of my head, but the magic sauce is all above. It gives you all of the expected behaviors of a normal network connection. The trick is setting the WithDialer option as shown, using the bufconn package to create a listener that exposes its own dialer. I use this technique all the time for testing gRPC services and it works great.

More Related Contents:

  1. Unable to install gRPC for go in mac os
  2. protoc-gen-go-grpc: program not found or is not executable
  3. What is the correct way to retrieve length of an array added a field in nested struct in golang
  4. &http.Client in Golang, Need Explanation
  5. slice member of a struct pointer is not updated [closed]
  6. How to print string with a carriage return
  7. how to send dynamic json key/value as request params
  8. How to stop a goroutine
  9. cancel a blocking operation in Go
  10. Explain Type Assertions in Go
  11. Is it safe to read a function pointer concurrently without a lock?
  12. Method Sets (Pointer vs Value Receiver)
  13. Golang append an item to a slice
  14. Concatenate two slices in Go
  15. Generic Structs with Go
  16. Close multiple goroutine if an error occurs in one in go
  17. How to escape back ticks
  18. What could happen if I don’t close response.Body?
  19. How to convert uint8 to string
  20. Is it OK to leave a channel open?
  21. how to listen to N channels? (dynamic select statement)
  22. Why does fmt.Println inside a goroutine not print a line?
  23. Application auto build versioning
  24. In Go generics, how to use a common method for types in a union constraint?
  25. Assigning null to JSON fields instead of empty strings
  26. If I am using channels properly should I need to use mutexes?
  27. How to round to nearest int when casting float to int in go
  28. Cross compile Go on OSX?
  29. What does an underscore in front of an import statement mean?
  30. How to cross compile from Windows to Linux?

Leave a Comment