Add linguist-generated and closed pipe test

kylecarbs · kylecarbs · commit 59992f197f8a · 2022-01-07T19:40:02.000Z
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1,2 @@
 # Generated files
-provisionersdk/proto/*.go
+provisionersdk/proto/*.go linguist-generated=true
diff --git a/provisionersdk/serve.go b/provisionersdk/serve.go
@@ -44,6 +44,10 @@ func Serve(ctx context.Context, server proto.DRPCProvisionerServer, options *Ser
 			return nil
 		}
 		if errors.Is(err, io.ErrClosedPipe) {
+			// This may occur if the transport on either end is
+			// closed before the context. It's fine to return
+			// nil here, since the server has nothing to
+			// communicate with.
 			return nil
 		}
 		return xerrors.Errorf("serve transport: %w", err)
diff --git a/provisionersdk/serve_test.go b/provisionersdk/serve_test.go
@@ -36,4 +36,14 @@ func TestProvisionerSDK(t *testing.T) {
 		_, err := api.Parse(context.Background(), &proto.Parse_Request{})
 		require.Equal(t, drpcerr.Unimplemented, int(drpcerr.Code(err)))
 	})
+	t.Run("ServeClosedPipe", func(t *testing.T) {
+		client, server := provisionersdk.TransportPipe()
+		_ = client.Close()
+		_ = server.Close()
+
+		err := provisionersdk.Serve(context.Background(), &proto.DRPCProvisionerUnimplementedServer{}, &provisionersdk.ServeOptions{
+			Transport: server,
+		})
+		require.NoError(t, err)
+	})
 }

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# Generated files`
`2`		`-provisionersdk/proto/*.go`
	`2`	`+provisionersdk/proto/*.go linguist-generated=true`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,10 @@ func Serve(ctx context.Context, server proto.DRPCProvisionerServer, options *Ser`
`44`	`44`	`return nil`
`45`	`45`	`}`
`46`	`46`	`if errors.Is(err, io.ErrClosedPipe) {`
	`47`	`+ // This may occur if the transport on either end is`
	`48`	`+ // closed before the context. It's fine to return`
	`49`	`+ // nil here, since the server has nothing to`
	`50`	`+ // communicate with.`
`47`	`51`	`return nil`
`48`	`52`	`}`
`49`	`53`	`return xerrors.Errorf("serve transport: %w", err)`