Merge pull request #2162 from balajiv113/grpc-go

Support for GRPC based guestagent communication

Author: AkihiroSuda

.github/workflows/test.yml

@@ -29,6 +29,12 @@ jobs:
     - uses: actions/setup-go@v5
       with:
         go-version: 1.22.x
+    - name: Install protoc
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y protobuf-compiler
+    - name: Verify generated files
+      run: make install-tools generate check-generated
     - name: Run golangci-lint
       uses: golangci/golangci-lint-action@v4.0.0
       with:

Makefile

@@ -231,8 +231,14 @@ uninstall:
 	if [ "$$(readlink "$(DEST)/bin/nerdctl")" = "nerdctl.lima" ]; then rm "$(DEST)/bin/nerdctl"; fi
 	if [ "$$(readlink "$(DEST)/bin/apptainer")" = "apptainer.lima" ]; then rm "$(DEST)/bin/apptainer"; fi
 
+.PHONY: check-generated
+check-generated:
+	@test -z "$$(git status --short | grep ".pb.desc" | tee /dev/stderr)" || \
+		((git diff $$(find . -name '*.pb.desc') | cat) && \
+		(echo "Please run 'make generate' when making changes to proto files and check-in the generated file changes" && false))
+
 .PHONY: lint
-lint:
+lint: check-generated
 	golangci-lint run ./...
 	yamllint .
 	find . -name '*.sh' | xargs shellcheck
@@ -242,6 +248,15 @@ lint:
 clean:
 	rm -rf _output vendor
 
+.PHONY: install-tools
+install-tools:
+	go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
+	go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
+
+.PHONY: generate
+generate:
+	go generate ./...
+
 .PHONY: artifacts-darwin
 artifacts-darwin:
 	mkdir -p _artifacts

cmd/lima-guestagent/daemon_linux.go

@@ -3,11 +3,9 @@ package main
 import (
 	"errors"
 	"net"
-	"net/http"
 	"os"
 	"time"
 
-	"github.com/gorilla/mux"
 	"github.com/lima-vm/lima/pkg/guestagent"
 	"github.com/lima-vm/lima/pkg/guestagent/api/server"
 	"github.com/lima-vm/lima/pkg/guestagent/serialport"
@@ -62,12 +60,6 @@ func daemonAction(cmd *cobra.Command, _ []string) error {
 	if err != nil {
 		return err
 	}
-	backend := &server.Backend{
-		Agent: agent,
-	}
-	r := mux.NewRouter()
-	server.AddRoutes(r, backend)
-	srv := &http.Server{Handler: r}
 	err = os.RemoveAll(socket)
 	if err != nil {
 		return err
@@ -99,5 +91,5 @@ func daemonAction(cmd *cobra.Command, _ []string) error {
 		l = socketL
 		logrus.Infof("serving the guest agent on %q", socket)
 	}
-	return srv.Serve(l)
+	return server.StartServer(l, &server.GuestServer{Agent: agent})
 }

pkg/guestagent/api/api.go

@@ -1,83 +1,53 @@
 package client
 
-// Forked from https://github.com/rootless-containers/rootlesskit/blob/v0.14.2/pkg/api/client/client.go
-// Apache License 2.0
-
 import (
 	"context"
-	"encoding/json"
-	"fmt"
 	"net"
-	"net/http"
+
+	"google.golang.org/grpc/credentials/insecure"
 
 	"github.com/lima-vm/lima/pkg/guestagent/api"
-	"github.com/lima-vm/lima/pkg/httpclientutil"
+	"google.golang.org/grpc"
+	"google.golang.org/protobuf/types/known/emptypb"
 )
 
-type GuestAgentClient interface {
-	HTTPClient() *http.Client
-	Info(context.Context) (*api.Info, error)
-	Events(context.Context, func(api.Event)) error
+type GuestAgentClient struct {
+	cli api.GuestServiceClient
 }
 
-// NewGuestAgentClient creates a client.
-// remote is a path to the UNIX socket, without unix:// prefix or a remote hostname/IP address.
-func NewGuestAgentClient(conn net.Conn) (GuestAgentClient, error) {
-	hc, err := httpclientutil.NewHTTPClientWithConn(conn)
-	if err != nil {
-		return nil, err
+func NewGuestAgentClient(dialFn func(ctx context.Context) (net.Conn, error)) (*GuestAgentClient, error) {
+	opts := []grpc.DialOption{
+		grpc.WithContextDialer(func(ctx context.Context, target string) (net.Conn, error) {
+			return dialFn(ctx)
+		}),
+		grpc.WithTransportCredentials(insecure.NewCredentials()),
 	}
-	return NewGuestAgentClientWithHTTPClient(hc), nil
-}
 
-func NewGuestAgentClientWithHTTPClient(hc *http.Client) GuestAgentClient {
-	return &client{
-		Client:    hc,
-		version:   "v1",
-		dummyHost: "lima-guestagent",
-	}
-}
-
-type client struct {
-	*http.Client
-	// version is always "v1"
-	// TODO(AkihiroSuda): negotiate the version
-	version   string
-	dummyHost string
-}
-
-func (c *client) HTTPClient() *http.Client {
-	return c.Client
-}
-
-func (c *client) Info(ctx context.Context) (*api.Info, error) {
-	u := fmt.Sprintf("http://%s/%s/info", c.dummyHost, c.version)
-	resp, err := httpclientutil.Get(ctx, c.HTTPClient(), u)
+	clientConn, err := grpc.Dial("", opts...)
 	if err != nil {
 		return nil, err
 	}
-	defer resp.Body.Close()
-	var info api.Info
-	dec := json.NewDecoder(resp.Body)
-	if err := dec.Decode(&info); err != nil {
-		return nil, err
-	}
-	return &info, nil
+	client := api.NewGuestServiceClient(clientConn)
+	return &GuestAgentClient{
+		cli: client,
+	}, nil
+}
+
+func (c *GuestAgentClient) Info(ctx context.Context) (*api.Info, error) {
+	return c.cli.GetInfo(ctx, &emptypb.Empty{})
 }
 
-func (c *client) Events(ctx context.Context, onEvent func(api.Event)) error {
-	u := fmt.Sprintf("http://%s/%s/events", c.dummyHost, c.version)
-	resp, err := httpclientutil.Get(ctx, c.HTTPClient(), u)
+func (c *GuestAgentClient) Events(ctx context.Context, eventCb func(response *api.Event)) error {
+	events, err := c.cli.GetEvents(ctx, &emptypb.Empty{})
 	if err != nil {
 		return err
 	}
-	defer resp.Body.Close()
-	dec := json.NewDecoder(resp.Body)
+
 	for {
-		var ev api.Event
-		if err := dec.Decode(&ev); err != nil {
+		recv, err := events.Recv()
+		if err != nil {
 			return err
 		}
-		onEvent(ev)
+		eventCb(recv)
 	}
 }

pkg/guestagent/api/client/client.go

@@ -0,0 +1,2 @@
+//go:generate protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative guestservice.proto --descriptor_set_out=guestservice.pb.desc
+package api

pkg/guestagent/api/gen.go

@@ -0,0 +1,17 @@
+
+�
+guestservice.protogoogle/protobuf/empty.protogoogle/protobuf/timestamp.proto"0
+Info(
+local_ports
 (2.IPPortR
+localPorts"�

+Event.
+time
 
(2.google.protobuf.TimestampRtime3
+local_ports_added (2.IPPortRlocalPortsAdded7
+local_ports_removed (2.IPPortRlocalPortsRemoved
+errors (	Rerrors",
+IPPort
+ip
 
(	Rip
+port 
(Rport2g
+GuestService(
+GetInfo.google.protobuf.Empty.Info-
+	GetEvents.google.protobuf.Empty.Event0
B!Zgithub.com/lima-vm/lima/pkg/apibproto3