-
Notifications
You must be signed in to change notification settings - Fork 618
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a new public CLI command: `limactl (create|edit|start|delete) -…
…-start-at-login=<BOOL>`. This command facilitates the generation of unit files for `launchd/systemd`, providing users with a straightforward way to control `limactl` autostart behavior. Signed-off-by: roman-kiselenko <[email protected]>
- Loading branch information
1 parent
c339ef2
commit 166cb8e
Showing
7 changed files
with
345 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| // Package manage start at login unit files for darwin/linux | ||
| package autostart | ||
|
|
||
| import ( | ||
| _ "embed" | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "path" | ||
| "path/filepath" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/lima-vm/lima/pkg/textutil" | ||
| ) | ||
|
|
||
| //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(hostOS, instName, workDir string) error { | ||
| unitPath := GetStartAtLoginEntryPath(hostOS, instName) | ||
| if _, err := os.Stat(unitPath); !errors.Is(err, os.ErrNotExist) { | ||
| return err | ||
| } | ||
| tmpl, err := renderTemplate(hostOS, workDir, instName, os.Executable) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if err := os.WriteFile(unitPath, tmpl, 0o644); err != nil { | ||
| // Early return if error is unexpected | ||
| if !errors.Is(err, os.ErrExist) && !errors.Is(err, os.ErrNotExist) { | ||
| return err | ||
| } | ||
| // Unit file exists, return nil | ||
| if errors.Is(err, os.ErrExist) { | ||
| return nil | ||
| } | ||
| // config/.systemd folder might be unavailable | ||
| if errors.Is(err, os.ErrNotExist) && hostOS == "linux" { | ||
| if err := os.MkdirAll(filepath.Dir(unitPath), os.ModePerm); err != nil { | ||
| return err | ||
| } | ||
| // directory created try to create unit file | ||
| if err := os.WriteFile(unitPath, tmpl, 0o644); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } | ||
| return enableDisableService("enable", hostOS, GetStartAtLoginEntryPath(hostOS, instName)) | ||
| } | ||
|
|
||
| // DeleteStartAtLoginEntry respect host OS arch and delete unit file | ||
| func DeleteStartAtLoginEntry(hostOS, instName string) error { | ||
| unitPath := GetStartAtLoginEntryPath(hostOS, instName) | ||
| if _, err := os.Stat(unitPath); err != nil { | ||
| // Skip error log if file not present | ||
| if errors.Is(err, os.ErrNotExist) { | ||
| return nil | ||
| } | ||
| return err | ||
| } | ||
| if err := enableDisableService("disable", hostOS, GetStartAtLoginEntryPath(hostOS, instName)); err != nil { | ||
| return err | ||
| } | ||
| return os.Remove(unitPath) | ||
| } | ||
|
|
||
| // GetFilePath returns the path to autostart file with respect of host | ||
| func GetStartAtLoginEntryPath(hostOS, instName string) string { | ||
| var fileTmp string | ||
| if hostOS == "darwin" { // launchd plist | ||
| fileTmp = fmt.Sprintf("Library/LaunchAgents/io.lima-vm.autostart.%s.plist", instName) | ||
| } | ||
| if hostOS == "linux" { // systemd service | ||
| // Use instance name as argument to systemd service | ||
| // Instance name available in unit file as %i | ||
| fileTmp = fmt.Sprintf(".config/systemd/user/lima-vm@%s.service", instName) | ||
| } | ||
| return filepath.Join(os.Getenv("HOME"), fileTmp) | ||
| } | ||
|
|
||
| func enableDisableService(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.Command(args[0], args[1:]...) | ||
| cmd.Stdout = os.Stdout | ||
| cmd.Stderr = os.Stderr | ||
| return cmd.Run() | ||
| } | ||
|
|
||
| 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 | ||
| } | ||
| return textutil.ExecuteTemplate( | ||
| tmpToExecute, | ||
| map[string]string{ | ||
| "Binary": selfExeAbs, | ||
| "Instance": instName, | ||
| "WorkDir": workDir, | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| package autostart | ||
|
|
||
| import ( | ||
| "runtime" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "gotest.tools/v3/assert" | ||
| ) | ||
|
|
||
| func TestRenderTemplate(t *testing.T) { | ||
| if runtime.GOOS == "windows" { | ||
| t.Skip("skipping testing on windows host") | ||
| } | ||
| tests := []struct { | ||
| Name string | ||
| InstanceName string | ||
| HostOS string | ||
| Expected string | ||
| WorkDir string | ||
| GetExecutable func() (string, error) | ||
| }{ | ||
| { | ||
| 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"> | ||
| <dict> | ||
| <key>Label</key> | ||
| <string>io.lima-vm.autostart.default</string> | ||
| <key>ProgramArguments</key> | ||
| <array> | ||
| <string>/limactl</string> | ||
| <string>start</string> | ||
| <string>default</string> | ||
| <string>--foreground</string> | ||
| </array> | ||
| <key>RunAtLoad</key> | ||
| <true/> | ||
| <key>StandardErrorPath</key> | ||
| <string>launchd.stderr.log</string> | ||
| <key>StandardOutPath</key> | ||
| <string>launchd.stdout.log</string> | ||
| <key>WorkingDirectory</key> | ||
| <string>/some/path</string> | ||
| <key>ProcessType</key> | ||
| <string>Background</string> | ||
| </dict> | ||
| </plist>`, | ||
| GetExecutable: func() (string, error) { | ||
| return "/limactl", nil | ||
| }, | ||
| WorkDir: "/some/path", | ||
| }, | ||
| { | ||
| 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) | ||
| [Service] | ||
| ExecStart=/limactl start %i --foreground | ||
| WorkingDirectory=/some/path | ||
| Type=simple | ||
| TimeoutSec=10 | ||
| Restart=on-failure | ||
| [Install] | ||
| WantedBy=multi-user.target`, | ||
| GetExecutable: func() (string, error) { | ||
| return "/limactl", nil | ||
| }, | ||
| WorkDir: "/some/path", | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.Name, func(t *testing.T) { | ||
| tmpl, err := renderTemplate(tt.HostOS, 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(GetStartAtLoginEntryPath(tt.HostOS, tt.InstanceName), tt.Expected)) | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.