autostart: Refactor to add autoStartManager

- Hide creating/deleting an autostart entry file into `Register`/`Unregister` as the implementation details.
- Separate the `launchd` and `systemd`-specific code into packages.

Signed-off-by: Norio Nomura <[email protected]>

Author: norio-nomura

cmd/limactl/delete.go

@@ -7,7 +7,6 @@ import (
 	"errors"
 	"fmt"
 	"os"
-	"runtime"
 
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -50,13 +49,16 @@ func deleteAction(cmd *cobra.Command, args []string) error {
 		if err := instance.Delete(cmd.Context(), inst, force); err != nil {
 			return fmt.Errorf("failed to delete instance %q: %w", instName, err)
 		}
-		if runtime.GOOS == "darwin" || runtime.GOOS == "linux" {
-			deleted, err := autostart.DeleteStartAtLoginEntry(ctx, runtime.GOOS, instName)
-			if err != nil && !errors.Is(err, os.ErrNotExist) {
-				logrus.WithError(err).Warnf("The autostart file for instance %q does not exist", instName)
-			} else if deleted {
-				logrus.Infof("The autostart file %q has been deleted", autostart.GetFilePath(runtime.GOOS, instName))
+		if registered, err := autostart.IsRegistered(ctx, inst); err != nil {
+			logrus.WithError(err).Warnf("Failed to check if the autostart entry for instance %q is registered", instName)
+		} else if registered {
+			if err := autostart.UnregisterFromStartAtLogin(ctx, inst); err != nil {
+				logrus.WithError(err).Warnf("Failed to unregister the autostart entry for instance %q", instName)
+			} else {
+				logrus.Infof("The autostart entry for instance %q has been unregistered", instName)
 			}
+		} else {
+			logrus.Infof("The autostart entry for instance %q is not registered", instName)
 		}
 		logrus.Infof("Deleted %q (%q)", instName, inst.Dir)
 	}

cmd/limactl/start-at-login_unix.go

@@ -7,8 +7,8 @@ package main
 
 import (
 	"errors"
+	"fmt"
 	"os"
-	"runtime"
 
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -38,18 +38,24 @@ func startAtLoginAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	if startAtLogin {
-		if err := autostart.CreateStartAtLoginEntry(ctx, runtime.GOOS, inst.Name, inst.Dir); err != nil {
-			logrus.WithError(err).Warnf("Can't create an autostart file for instance %q", inst.Name)
-		} else {
-			logrus.Infof("The autostart file %q has been created or updated", autostart.GetFilePath(runtime.GOOS, inst.Name))
+	if registered, err := autostart.IsRegistered(ctx, inst); err != nil {
+		return fmt.Errorf("failed to check if the autostart entry for instance %q is registered: %w", inst.Name, err)
+	} else if startAtLogin {
+		verb := "create"
+		if registered {
+			verb = "update"
+		}
+		if err := autostart.RegisterToStartAtLogin(ctx, inst); err != nil {
+			return fmt.Errorf("failed to %s the autostart entry for instance %q: %w", verb, inst.Name, err)
 		}
+		logrus.Infof("The autostart entry for instance %q has been %sd", inst.Name, verb)
 	} else {
-		deleted, err := autostart.DeleteStartAtLoginEntry(ctx, runtime.GOOS, instName)
-		if err != nil {
-			logrus.WithError(err).Warnf("The autostart file %q could not be deleted", instName)
-		} else if deleted {
-			logrus.Infof("The autostart file %q has been deleted", autostart.GetFilePath(runtime.GOOS, instName))
+		if !registered {
+			logrus.Infof("The autostart entry for instance %q is not registered", inst.Name)
+		} else if err := autostart.UnregisterFromStartAtLogin(ctx, inst); err != nil {
+			return fmt.Errorf("failed to unregister the autostart entry for instance %q: %w", inst.Name, err)
+		} else {
+			logrus.Infof("The autostart entry for instance %q has been unregistered", inst.Name)
 		}
 	}
 

pkg/autostart/autostart.go

@@ -6,118 +6,41 @@ package autostart
 
 import (
 	"context"
-	_ "embed"
-	"errors"
-	"fmt"
-	"os"
-	"os/exec"
-	"path"
-	"path/filepath"
-	"strconv"
-	"strings"
+	"runtime"
+	"sync"
 
-	"github.com/lima-vm/lima/v2/pkg/textutil"
+	"github.com/lima-vm/lima/v2/pkg/limatype"
 )
 
-//go:embed [email protected]
-var systemdTemplate string
-
-//go:embed io.lima-vm.autostart.INSTANCE.plist
-var launchdTemplate string
-
-// CreateStartAtLoginEntry respect host OS arch and create unit file.
-func CreateStartAtLoginEntry(ctx context.Context, hostOS, instName, workDir string) error {
-	unitPath := GetFilePath(hostOS, instName)
-	if _, err := os.Stat(unitPath); err != nil && !errors.Is(err, os.ErrNotExist) {
-		return err
-	}
-	tmpl, err := renderTemplate(hostOS, instName, workDir, os.Executable)
-	if err != nil {
-		return err
-	}
-	if err := os.MkdirAll(filepath.Dir(unitPath), os.ModePerm); err != nil {
-		return err
-	}
-	if err := os.WriteFile(unitPath, tmpl, 0o644); err != nil {
-		return err
-	}
-	return enableDisableService(ctx, "enable", hostOS, GetFilePath(hostOS, instName))
+// IsRegistered checks if the instance is registered to start at login.
+func IsRegistered(ctx context.Context, inst *limatype.Instance) (bool, error) {
+	return manager().IsRegistered(ctx, inst)
 }
 
-// DeleteStartAtLoginEntry respect host OS arch and delete unit file.
-// Return true, nil if unit file has been deleted.
-func DeleteStartAtLoginEntry(ctx context.Context, hostOS, instName string) (bool, error) {
-	unitPath := GetFilePath(hostOS, instName)
-	if _, err := os.Stat(unitPath); err != nil {
-		return false, err
-	}
-	if err := enableDisableService(ctx, "disable", hostOS, GetFilePath(hostOS, instName)); err != nil {
-		return false, err
-	}
-	if err := os.Remove(unitPath); err != nil {
-		return false, err
-	}
-	return true, nil
+// RegisterToStartAtLogin creates a start-at-login entry for the instance.
+func RegisterToStartAtLogin(ctx context.Context, inst *limatype.Instance) error {
+	return manager().RegisterToStartAtLogin(ctx, inst)
 }
 
-// GetFilePath returns the path to autostart file with respect of host.
-func GetFilePath(hostOS, instName string) string {
-	var fileTmpl string
-	if hostOS == "darwin" { // launchd plist
-		fileTmpl = fmt.Sprintf("%s/Library/LaunchAgents/io.lima-vm.autostart.%s.plist", os.Getenv("HOME"), instName)
-	}
-	if hostOS == "linux" { // systemd service
-		// Use instance name as argument to systemd service
-		// Instance name available in unit file as %i
-		xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
-		if xdgConfigHome == "" {
-			xdgConfigHome = filepath.Join(os.Getenv("HOME"), ".config")
-		}
-		fileTmpl = fmt.Sprintf("%s/systemd/user/lima-vm@%s.service", xdgConfigHome, instName)
-	}
-	return fileTmpl
+// UnregisterFromStartAtLogin deletes the start-at-login entry for the instance.
+func UnregisterFromStartAtLogin(ctx context.Context, inst *limatype.Instance) error {
+	return manager().UnregisterFromStartAtLogin(ctx, inst)
 }
 
-func enableDisableService(ctx context.Context, action, hostOS, serviceWithPath string) error {
-	// Get filename without extension
-	filename := strings.TrimSuffix(path.Base(serviceWithPath), filepath.Ext(path.Base(serviceWithPath)))
-
-	var args []string
-	if hostOS == "darwin" {
-		// man launchctl
-		args = append(args, []string{
-			"launchctl",
-			action,
-			fmt.Sprintf("gui/%s/%s", strconv.Itoa(os.Getuid()), filename),
-		}...)
-	} else {
-		args = append(args, []string{
-			"systemctl",
-			"--user",
-			action,
-			filename,
-		}...)
-	}
-	cmd := exec.CommandContext(ctx, args[0], args[1:]...)
-	cmd.Stdout = os.Stdout
-	cmd.Stderr = os.Stderr
-	return cmd.Run()
+type autoStartManager interface {
+	// Registration
+	IsRegistered(ctx context.Context, inst *limatype.Instance) (bool, error)
+	RegisterToStartAtLogin(ctx context.Context, inst *limatype.Instance) error
+	UnregisterFromStartAtLogin(ctx context.Context, inst *limatype.Instance) error
 }
 
-func renderTemplate(hostOS, instName, workDir string, getExecutable func() (string, error)) ([]byte, error) {
-	selfExeAbs, err := getExecutable()
-	if err != nil {
-		return nil, err
-	}
-	tmpToExecute := systemdTemplate
-	if hostOS == "darwin" {
-		tmpToExecute = launchdTemplate
+var manager = sync.OnceValue(func() autoStartManager {
+	switch runtime.GOOS {
+	case "darwin":
+		return Launchd
+	case "linux":
+		return Systemd
+	default:
+		return &notSupportedManager{}
 	}
-	return textutil.ExecuteTemplate(
-		tmpToExecute,
-		map[string]string{
-			"Binary":   selfExeAbs,
-			"Instance": instName,
-			"WorkDir":  workDir,
-		})
-}
+})

pkg/autostart/autostart_test.go

@@ -5,7 +5,6 @@ package autostart
 
 import (
 	"runtime"
-	"strings"
 	"testing"
 
 	"gotest.tools/v3/assert"
@@ -16,17 +15,17 @@ func TestRenderTemplate(t *testing.T) {
 		t.Skip("skipping testing on windows host")
 	}
 	tests := []struct {
+		Manager       *TemplateFileBasedManager
 		Name          string
 		InstanceName  string
-		HostOS        string
 		Expected      string
 		WorkDir       string
 		GetExecutable func() (string, error)
 	}{
 		{
+			Manager:      Launchd,
 			Name:         "render darwin launchd plist",
 			InstanceName: "default",
-			HostOS:       "darwin",
 			Expected: `<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
@@ -58,9 +57,9 @@ func TestRenderTemplate(t *testing.T) {
 			WorkDir: "/some/path",
 		},
 		{
+			Manager:      Systemd,
 			Name:         "render linux systemd service",
 			InstanceName: "default",
-			HostOS:       "linux",
 			Expected: `[Unit]
 Description=Lima - Linux virtual machines, with a focus on running containers.
 Documentation=man:lima(1)
@@ -82,46 +81,9 @@ WantedBy=default.target`,
 	}
 	for _, tt := range tests {
 		t.Run(tt.Name, func(t *testing.T) {
-			tmpl, err := renderTemplate(tt.HostOS, tt.InstanceName, tt.WorkDir, tt.GetExecutable)
+			tmpl, err := tt.Manager.renderTemplate(tt.InstanceName, tt.WorkDir, tt.GetExecutable)
 			assert.NilError(t, err)
 			assert.Equal(t, string(tmpl), tt.Expected)
 		})
 	}
 }
-
-func TestGetFilePath(t *testing.T) {
-	if runtime.GOOS == "windows" {
-		t.Skip("skipping testing on windows host")
-	}
-	tests := []struct {
-		Name         string
-		HostOS       string
-		InstanceName string
-		HomeEnv      string
-		Expected     string
-	}{
-		{
-			Name:         "darwin with docker instance name",
-			HostOS:       "darwin",
-			InstanceName: "docker",
-			Expected:     "Library/LaunchAgents/io.lima-vm.autostart.docker.plist",
-		},
-		{
-			Name:         "linux with docker instance name",
-			HostOS:       "linux",
-			InstanceName: "docker",
-			Expected:     ".config/systemd/user/[email protected]",
-		},
-		{
-			Name:         "empty with empty instance name",
-			HostOS:       "",
-			InstanceName: "",
-			Expected:     "",
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.Name, func(t *testing.T) {
-			assert.Check(t, strings.HasSuffix(GetFilePath(tt.HostOS, tt.InstanceName), tt.Expected))
-		})
-	}
-}

pkg/autostart/io.lima-vm.autostart.INSTANCE.plist renamed to pkg/autostart/launchd/io.lima-vm.autostart.INSTANCE.plist

@@ -0,0 +1,44 @@
+// SPDX-FileCopyrightText: Copyright The Lima Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package launchd
+
+import (
+	"context"
+	_ "embed"
+	"fmt"
+	"os"
+	"os/exec"
+
+	"github.com/sirupsen/logrus"
+)
+
+//go:embed io.lima-vm.autostart.INSTANCE.plist
+var Template string
+
+// GetPlistPath returns the path to the launchd plist file for the given instance name.
+func GetPlistPath(instName string) string {
+	return fmt.Sprintf("%s/Library/LaunchAgents/%s.plist", os.Getenv("HOME"), ServiceNameFrom(instName))
+}
+
+// ServiceNameFrom returns the launchd service name for the given instance name.
+func ServiceNameFrom(instName string) string {
+	return fmt.Sprintf("io.lima-vm.autostart.%s", instName)
+}
+
+// EnableDisableService enables or disables the launchd service for the given instance name.
+func EnableDisableService(ctx context.Context, enable bool, instName string) error {
+	action := "enable"
+	if !enable {
+		action = "disable"
+	}
+	return launchctl(ctx, action, fmt.Sprintf("gui/%d/%s", os.Getuid(), ServiceNameFrom(instName)))
+}
+
+func launchctl(ctx context.Context, args ...string) error {
+	cmd := exec.CommandContext(ctx, "launchctl", args...)
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	logrus.Debugf("running command: %v", cmd.Args)
+	return cmd.Run()
+}

pkg/autostart/launchd/launchd.go

@@ -0,0 +1,34 @@
+// SPDX-FileCopyrightText: Copyright The Lima Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package launchd
+
+import (
+	"runtime"
+	"strings"
+	"testing"
+
+	"gotest.tools/v3/assert"
+)
+
+func TestGetPlistPath(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("skipping testing on windows host")
+	}
+	tests := []struct {
+		Name         string
+		InstanceName string
+		Expected     string
+	}{
+		{
+			Name:         "darwin with docker instance name",
+			InstanceName: "docker",
+			Expected:     "Library/LaunchAgents/io.lima-vm.autostart.docker.plist",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.Name, func(t *testing.T) {
+			assert.Check(t, strings.HasSuffix(GetPlistPath(tt.InstanceName), tt.Expected))
+		})
+	}
+}