Merge pull request #2438 from afbjorklund/guest-gzip

Allow compressing lima-guestagent with gzip

Author: jandubois

Kconfig

@@ -30,3 +30,9 @@ config GUESTAGENT_ARCH_RISCV64
 	help
 		Build lima-guestagent for "riscv64" Arch
 	default y
+
+config GUESTAGENT_COMPRESS
+	bool "guestagent compress"
+	help
+		Compress lima-guestagent
+	default n

Makefile

@@ -86,22 +86,26 @@ HELPERS = \
 	_output/bin/podman.lima \
 	_output/bin/kubectl.lima
 
+ifeq ($(CONFIG_GUESTAGENT_COMPRESS),y)
+gz = .gz
+endif
+
 ifeq ($(CONFIG_GUESTAGENT_OS_LINUX),y)
 ifeq ($(CONFIG_GUESTAGENT_ARCH_X8664),y)
 GUESTAGENT += \
-	_output/share/lima/lima-guestagent.Linux-x86_64
+	_output/share/lima/lima-guestagent.Linux-x86_64$(gz)
 endif
 ifeq ($(CONFIG_GUESTAGENT_ARCH_AARCH64),y)
 GUESTAGENT += \
-	_output/share/lima/lima-guestagent.Linux-aarch64
+	_output/share/lima/lima-guestagent.Linux-aarch64$(gz)
 endif
 ifeq ($(CONFIG_GUESTAGENT_ARCH_ARMV7L),y)
 GUESTAGENT += \
-	_output/share/lima/lima-guestagent.Linux-armv7l
+	_output/share/lima/lima-guestagent.Linux-armv7l$(gz)
 endif
 ifeq ($(CONFIG_GUESTAGENT_ARCH_RISCV64),y)
 GUESTAGENT += \
-	_output/share/lima/lima-guestagent.Linux-riscv64
+	_output/share/lima/lima-guestagent.Linux-riscv64$(gz)
 endif
 endif
 
@@ -188,6 +192,9 @@ _output/share/lima/lima-guestagent.Linux-riscv64:
 	GOOS=linux GOARCH=riscv64 CGO_ENABLED=0 $(GO_BUILD) -o $@ ./cmd/lima-guestagent
 	chmod 644 $@
 
+_output/share/lima/lima-guestagent.%.gz: _output/share/lima/lima-guestagent.%
+	gzip $<
+
 .PHONY: manpages
 manpages: _output/bin/limactl$(exe)
 	@mkdir -p _output/share/man/man1

config.mk

@@ -3,3 +3,4 @@ CONFIG_GUESTAGENT_ARCH_X8664=y
 CONFIG_GUESTAGENT_ARCH_AARCH64=y
 CONFIG_GUESTAGENT_ARCH_ARMV7L=y
 CONFIG_GUESTAGENT_ARCH_RISCV64=y
+CONFIG_GUESTAGENT_COMPRESS=n

pkg/cidata/cidata.go

@@ -1,6 +1,7 @@
 package cidata
 
 import (
+	"compress/gzip"
 	"errors"
 	"fmt"
 	"io"
@@ -341,14 +342,30 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML, udpDNSLocalPort
 		}
 	}
 
-	guestAgentBinary, err := GuestAgentBinary(*y.OS, *y.Arch)
+	guestAgentBinary, err := usrlocalsharelima.GuestAgentBinary(*y.OS, *y.Arch)
 	if err != nil {
 		return err
 	}
-	defer guestAgentBinary.Close()
+	var guestAgent io.ReadCloser
+	guestAgent, err = os.Open(guestAgentBinary)
+	if err != nil {
+		if !errors.Is(err, os.ErrNotExist) {
+			return err
+		}
+		compressedGuestAgent, err := os.Open(guestAgentBinary + ".gz")
+		if err != nil {
+			return err
+		}
+		logrus.Debugf("Decompressing %s.gz", guestAgentBinary)
+		guestAgent, err = gzip.NewReader(compressedGuestAgent)
+		if err != nil {
+			return err
+		}
+	}
+	defer guestAgent.Close()
 	layout = append(layout, iso9660util.Entry{
 		Path:   "lima-guestagent",
-		Reader: guestAgentBinary,
+		Reader: guestAgent,
 	})
 
 	if nerdctlArchive != "" {
@@ -375,21 +392,6 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML, udpDNSLocalPort
 	return iso9660util.Write(filepath.Join(instDir, filenames.CIDataISO), "cidata", layout)
 }
 
-func GuestAgentBinary(ostype limayaml.OS, arch limayaml.Arch) (io.ReadCloser, error) {
-	if ostype == "" {
-		return nil, errors.New("os must be set")
-	}
-	if arch == "" {
-		return nil, errors.New("arch must be set")
-	}
-	dir, err := usrlocalsharelima.Dir()
-	if err != nil {
-		return nil, err
-	}
-	gaPath := filepath.Join(dir, "lima-guestagent."+ostype+"-"+arch)
-	return os.Open(gaPath)
-}
-
 func getCert(content string) Cert {
 	lines := []string{}
 	for _, line := range strings.Split(content, "\n") {

pkg/usrlocalsharelima/usrlocalsharelima.go

@@ -55,8 +55,27 @@ func Dir() (string, error) {
 		} else if !errors.Is(err, os.ErrNotExist) {
 			return "", err
 		}
+		if _, err := os.Stat(gaCandidate + ".gz"); err == nil {
+			return filepath.Dir(gaCandidate), nil
+		} else if !errors.Is(err, os.ErrNotExist) {
+			return "", err
+		}
 	}
 
 	return "", fmt.Errorf("failed to find \"lima-guestagent.%s-%s\" binary for %q, attempted %v",
 		ostype, arch, self, gaCandidates)
 }
+
+func GuestAgentBinary(ostype limayaml.OS, arch limayaml.Arch) (string, error) {
+	if ostype == "" {
+		return "", errors.New("os must be set")
+	}
+	if arch == "" {
+		return "", errors.New("arch must be set")
+	}
+	dir, err := Dir()
+	if err != nil {
+		return "", err
+	}
+	return filepath.Join(dir, "lima-guestagent."+ostype+"-"+arch), nil
+}