Merge pull request #47 from AkihiroSuda/dev

refactoring

Author: AkihiroSuda

cmd/lima

@@ -2,4 +2,18 @@
 set -eu
 : "${LIMA_INSTANCE:=default}"
 : "${LIMACTL:=limactl}"
+
+if [ "$#" -eq 1 ]; then
+  if [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
+    base="$(basename "$0")"
+    echo "Usage: ${base} [COMMAND...]"
+    echo
+    echo "${base} is an alias for \"${LIMACTL} shell ${LIMA_INSTANCE}\"."
+    echo "The instance name (\"${LIMA_INSTANCE}\") can be changed by specifying \$LIMA_INSTANCE."
+    echo
+    echo "See \`${LIMACTL} shell --help\` for further information."
+    exit 0
+  fi
+fi
+
 exec "$LIMACTL" shell "$LIMA_INSTANCE" "$@"

cmd/limactl/hostagent.go

@@ -13,7 +13,7 @@ import (
 var hostagentCommand = &cli.Command{
 	Name:      "hostagent",
 	Usage:     "DO NOT EXECUTE MANUALLY",
-	ArgsUsage: "NAME",
+	ArgsUsage: "INSTANCE",
 	Hidden:    true,
 	Flags: []cli.Flag{
 		&cli.StringFlag{

cmd/limactl/shell.go

@@ -19,8 +19,8 @@ import (
 var shellCommand = &cli.Command{
 	Name:      "shell",
 	Usage:     "Execute shell in Lima",
-	ArgsUsage: "[flags] INSTANCE [COMMAND...]",
-	Description: "`lima` command is provided as an alias for `limactl shell $LIMA_INSTANCE`. $LIMA_INSTANCE defaults to " + DefaultInstanceName + ".\n" +
+	ArgsUsage: "INSTANCE [COMMAND...]",
+	Description: "`lima` command is provided as an alias for `limactl shell $LIMA_INSTANCE`. $LIMA_INSTANCE defaults to \"" + DefaultInstanceName + "\".\n" +
 		"Hint: try --debug to show the detailed logs, if it seems hanging (mostly due to some SSH issue).",
 	Flags: []cli.Flag{
 		&cli.StringFlag{
@@ -57,7 +57,7 @@ func shellAction(clicontext *cli.Context) error {
 	if inst.Status == store.StatusStopped {
 		return errors.Errorf("instance %q is stopped, run `limactl start %s` to start the instance", instName, instName)
 	}
-	y, _, err := store.LoadYAMLByInstanceName(instName)
+	y, err := inst.LoadYAML()
 	if err != nil {
 		return err
 	}

cmd/limactl/start.go

@@ -11,6 +11,7 @@ import (
 	"github.com/AkihiroSuda/lima/pkg/limayaml"
 	"github.com/AkihiroSuda/lima/pkg/start"
 	"github.com/AkihiroSuda/lima/pkg/store"
+	"github.com/AkihiroSuda/lima/pkg/store/filenames"
 	"github.com/containerd/containerd/identifiers"
 	"github.com/mattn/go-isatty"
 	"github.com/norouter/norouter/cmd/norouter/editorcmd"
@@ -22,7 +23,7 @@ import (
 var startCommand = &cli.Command{
 	Name:      "start",
 	Usage:     fmt.Sprintf("Start an instance of Lima. If the instance does not exist, open an editor for creating new one, with name %q", DefaultInstanceName),
-	ArgsUsage: "[flags] NAME|FILE.yaml",
+	ArgsUsage: "NAME|FILE.yaml",
 	Flags: []cli.Flag{
 		&cli.BoolFlag{
 			Name:  "tty",
@@ -34,86 +35,88 @@ var startCommand = &cli.Command{
 	BashComplete: startBashComplete,
 }
 
-func loadOrCreateYAML(clicontext *cli.Context) (y *limayaml.LimaYAML, instDir string, err error) {
+func loadOrCreateInstance(clicontext *cli.Context) (*store.Instance, error) {
 	if clicontext.NArg() > 1 {
-		return nil, "", errors.Errorf("too many arguments")
+		return nil, errors.Errorf("too many arguments")
 	}
 
 	arg := clicontext.Args().First()
 	if arg == "" {
 		arg = DefaultInstanceName
 	}
 
-	yBytes := limayaml.DefaultTemplate
-	var instName string
+	var (
+		instName string
+		yBytes   = limayaml.DefaultTemplate
+		err      error
+	)
 
 	if argSeemsYAMLPath(arg) {
 		instName = instNameFromYAMLPath(arg)
 		logrus.Debugf("interpreting argument %q as a file path for instance %q", arg, instName)
 		yBytes, err = os.ReadFile(arg)
 		if err != nil {
-			return nil, "", err
+			return nil, err
 		}
 	} else {
 		instName = arg
 		logrus.Debugf("interpreting argument %q as an instance name %q", arg, instName)
-		if err = identifiers.Validate(instName); err != nil {
-			return nil, "", errors.Wrapf(err, "argument must be either an instance name or a YAML file path, got %q", instName)
+		if err := identifiers.Validate(instName); err != nil {
+			return nil, errors.Wrapf(err, "argument must be either an instance name or a YAML file path, got %q", instName)
 		}
-		y, instDir, err = store.LoadYAMLByInstanceName(instName)
-		if err == nil {
+		if inst, err := store.Inspect(instName); err == nil {
 			logrus.Infof("Using the existing instance %q", instName)
-			return y, instDir, nil
+			return inst, nil
 		} else {
 			if !errors.Is(err, os.ErrNotExist) {
-				return nil, "", err
+				return nil, err
 			}
 		}
 	}
 	// create a new instance from the template
-	instDir, err = store.InstanceDir(instName)
+	instDir, err := store.InstanceDir(instName)
 	if err != nil {
-		return nil, "", err
+		return nil, err
 	}
 
 	if _, err := os.Stat(instDir); !errors.Is(err, os.ErrNotExist) {
-		return nil, "", errors.Errorf("instance %q already exists (%q)", instName, instDir)
+		return nil, errors.Errorf("instance %q already exists (%q)", instName, instDir)
 	}
 
 	if clicontext.Bool("tty") {
 		yBytes, err = openEditor(clicontext, instName, yBytes)
 		if err != nil {
-			return nil, "", err
+			return nil, err
 		}
 		if len(yBytes) == 0 {
 			logrus.Info("Aborting, as requested by saving the file with empty content")
 			os.Exit(0)
-			return nil, "", errors.New("should not reach here")
+			return nil, errors.New("should not reach here")
 		}
 	} else {
 		logrus.Info("Terminal is not available, proceeding without opening an editor")
 	}
-	y, err = limayaml.Load(yBytes)
+	y, err := limayaml.Load(yBytes)
 	if err != nil {
-		return nil, "", err
+		return nil, err
 	}
 	if err := limayaml.Validate(*y); err != nil {
 		if !clicontext.Bool("tty") {
-			return nil, "", err
+			return nil, err
 		}
 		rejectedYAML := "lima.REJECTED.yaml"
 		if writeErr := os.WriteFile(rejectedYAML, yBytes, 0644); writeErr != nil {
-			return nil, "", errors.Wrapf(err, "the YAML is invalid, attempted to save the buffer as %q but failed: %v", rejectedYAML, writeErr)
+			return nil, errors.Wrapf(err, "the YAML is invalid, attempted to save the buffer as %q but failed: %v", rejectedYAML, writeErr)
 		}
-		return nil, "", errors.Wrapf(err, "the YAML is invalid, saved the buffer as %q", rejectedYAML)
+		return nil, errors.Wrapf(err, "the YAML is invalid, saved the buffer as %q", rejectedYAML)
 	}
 	if err := os.MkdirAll(instDir, 0700); err != nil {
-		return nil, "", err
+		return nil, err
 	}
-	if err := os.WriteFile(filepath.Join(instDir, store.YAMLFileName), yBytes, 0644); err != nil {
-		return nil, "", err
+	if err := os.WriteFile(filepath.Join(instDir, filenames.LimaYAML), yBytes, 0644); err != nil {
+		return nil, err
 	}
-	return y, instDir, nil
+	return store.Inspect(instName)
 }
 
 // openEditor opens an editor, and returns the content (not path) of the modified yaml.
@@ -164,16 +167,12 @@ func openEditor(clicontext *cli.Context, name string, initialContent []byte) ([]
 }
 
 func startAction(clicontext *cli.Context) error {
-	y, instDir, err := loadOrCreateYAML(clicontext)
-	if err != nil {
-		return err
-	}
-	instName, err := store.InstanceNameFromInstanceDir(instDir)
+	inst, err := loadOrCreateInstance(clicontext)
 	if err != nil {
 		return err
 	}
 	ctx := clicontext.Context
-	return start.Start(ctx, instName, instDir, y)
+	return start.Start(ctx, inst)
 }
 
 func argSeemsYAMLPath(arg string) bool {

cmd/limactl/stop.go

@@ -10,6 +10,7 @@ import (
 
 	hostagentapi "github.com/AkihiroSuda/lima/pkg/hostagent/api"
 	"github.com/AkihiroSuda/lima/pkg/store"
+	"github.com/AkihiroSuda/lima/pkg/store/filenames"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"
@@ -83,8 +84,8 @@ func waitForHostAgentTermination(ctx context.Context, inst *store.Instance) erro
 		return false
 	}
 
-	haStdoutPath := filepath.Join(inst.Dir, "ha.stdout.log")
-	haStderrPath := filepath.Join(inst.Dir, "ha.stderr.log")
+	haStdoutPath := filepath.Join(inst.Dir, filenames.HostAgentStdoutLog)
+	haStderrPath := filepath.Join(inst.Dir, filenames.HostAgentStderrLog)
 
 	if err := hostagentapi.WatchEvents(ctx2, haStdoutPath, haStderrPath, onEvent); err != nil {
 		return err

pkg/hostagent/hostagent.go

@@ -20,6 +20,7 @@ import (
 	"github.com/AkihiroSuda/lima/pkg/qemu"
 	"github.com/AkihiroSuda/lima/pkg/sshutil"
 	"github.com/AkihiroSuda/lima/pkg/store"
+	"github.com/AkihiroSuda/lima/pkg/store/filenames"
 	"github.com/AkihiroSuda/sshocker/pkg/ssh"
 	"github.com/digitalocean/go-qemu/qmp"
 	"github.com/digitalocean/go-qemu/qmp/raw"
@@ -56,22 +57,27 @@ func New(instName string, stdout, stderr io.Writer, sigintCh chan os.Signal) (*H
 		Level:     logrus.DebugLevel,
 	}
 
-	y, instDir, err := store.LoadYAMLByInstanceName(instName)
+	inst, err := store.Inspect(instName)
+	if err != nil {
+		return nil, err
+	}
+
+	y, err := inst.LoadYAML()
 	if err != nil {
 		return nil, err
 	}
 
 	qCfg := qemu.Config{
 		Name:        instName,
-		InstanceDir: instDir,
+		InstanceDir: inst.Dir,
 		LimaYAML:    y,
 	}
 	qExe, qArgs, err := qemu.Cmdline(qCfg)
 	if err != nil {
 		return nil, err
 	}
 
-	sshArgs, err := sshutil.SSHArgs(instDir)
+	sshArgs, err := sshutil.SSHArgs(inst.Dir)
 	if err != nil {
 		return nil, err
 	}
@@ -82,7 +88,7 @@ func New(instName string, stdout, stderr io.Writer, sigintCh chan os.Signal) (*H
 	a := &HostAgent{
 		l:             l,
 		y:             y,
-		instDir:       instDir,
+		instDir:       inst.Dir,
 		sshConfig:     sshConfig,
 		portForwarder: newPortForwarder(l, sshConfig, y.SSH.LocalPort),
 		qExe:          qExe,
@@ -134,7 +140,7 @@ func (a *HostAgent) Run(ctx context.Context) error {
 	}
 	defer logPipeRoutine(a.l, qStderr, "qemu[stderr]")
 
-	a.l.Infof("Starting QEMU (hint: to watch the boot progress, see %q)", filepath.Join(a.instDir, "serial.log"))
+	a.l.Infof("Starting QEMU (hint: to watch the boot progress, see %q)", filepath.Join(a.instDir, filenames.SerialLog))
 	a.l.Debugf("qCmd.Args: %v", qCmd.Args)
 	if err := qCmd.Start(); err != nil {
 		return err
@@ -188,7 +194,7 @@ func (a *HostAgent) Run(ctx context.Context) error {
 
 func (a *HostAgent) shutdownQEMU(ctx context.Context, timeout time.Duration, qCmd *exec.Cmd, qWaitCh <-chan error) error {
 	a.l.Info("Shutting down QEMU with ACPI")
-	qmpSockPath := filepath.Join(a.instDir, "qmp.sock")
+	qmpSockPath := filepath.Join(a.instDir, filenames.QMPSock)
 	qmpClient, err := qmp.NewSocketMonitor("unix", qmpSockPath, 5*time.Second)
 	if err != nil {
 		a.l.WithError(err).Warnf("failed to open the QMP socket %q, forcibly killing QEMU", qmpSockPath)
@@ -222,7 +228,7 @@ func (a *HostAgent) killQEMU(ctx context.Context, timeout time.Duration, qCmd *e
 	}
 	qWaitErr := <-qWaitCh
 	a.l.WithError(qWaitErr).Info("QEMU has exited, after killing forcibly")
-	qemuPIDPath := filepath.Join(a.instDir, "qemu.pid")
+	qemuPIDPath := filepath.Join(a.instDir, filenames.QemuPID)
 	_ = os.RemoveAll(qemuPIDPath)
 	return qWaitErr
 }
@@ -274,7 +280,7 @@ func (a *HostAgent) close() error {
 func (a *HostAgent) watchGuestAgentEvents(ctx context.Context) {
 	// TODO: use vSock (when QEMU for macOS gets support for vSock)
 
-	localUnix := filepath.Join(a.instDir, "ga.sock")
+	localUnix := filepath.Join(a.instDir, filenames.GuestAgentSock)
 	// guest should have same UID as the host (specified in cidata)
 	remoteUnix := fmt.Sprintf("/run/user/%d/lima-guestagent.sock", os.Getuid())
 

pkg/qemu/qemu.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/AkihiroSuda/lima/pkg/downloader"
 	"github.com/AkihiroSuda/lima/pkg/limayaml"
+	"github.com/AkihiroSuda/lima/pkg/store/filenames"
 	"github.com/docker/go-units"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
@@ -22,13 +23,13 @@ type Config struct {
 }
 
 func EnsureDisk(cfg Config) error {
-	diffDisk := filepath.Join(cfg.InstanceDir, "diffdisk")
+	diffDisk := filepath.Join(cfg.InstanceDir, filenames.DiffDisk)
 	if _, err := os.Stat(diffDisk); err == nil || !errors.Is(err, os.ErrNotExist) {
 		// disk is already ensured
 		return err
 	}
 
-	baseDisk := filepath.Join(cfg.InstanceDir, "basedisk")
+	baseDisk := filepath.Join(cfg.InstanceDir, filenames.BaseDisk)
 	if _, err := os.Stat(baseDisk); errors.Is(err, os.ErrNotExist) {
 		var ensuredBaseDisk bool
 		errs := make([]error, len(cfg.LimaYAML.Images))
@@ -120,10 +121,10 @@ func Cmdline(cfg Config) (string, []string, error) {
 	args = append(args, "-boot", "order=c,splash-time=0,menu=on")
 
 	// Root disk
-	args = append(args, "-drive", fmt.Sprintf("file=%s,if=virtio", filepath.Join(cfg.InstanceDir, "diffdisk")))
+	args = append(args, "-drive", fmt.Sprintf("file=%s,if=virtio", filepath.Join(cfg.InstanceDir, filenames.DiffDisk)))
 
 	// cloud-init
-	args = append(args, "-cdrom", filepath.Join(cfg.InstanceDir, "cidata.iso"))
+	args = append(args, "-cdrom", filepath.Join(cfg.InstanceDir, filenames.CIDataISO))
 
 	// Network
 	// CIDR is intentionally hardcoded to 192.168.5.0/24, as each of QEMU has its own independent slirp network.
@@ -155,11 +156,11 @@ func Cmdline(cfg Config) (string, []string, error) {
 	args = append(args, "-parallel", "none")
 
 	// Serial
-	serialSock := filepath.Join(cfg.InstanceDir, "serial.sock")
+	serialSock := filepath.Join(cfg.InstanceDir, filenames.SerialSock)
 	if err := os.RemoveAll(serialSock); err != nil {
 		return "", nil, err
 	}
-	serialLog := filepath.Join(cfg.InstanceDir, "serial.log")
+	serialLog := filepath.Join(cfg.InstanceDir, filenames.SerialLog)
 	if err := os.RemoveAll(serialLog); err != nil {
 		return "", nil, err
 	}
@@ -170,7 +171,7 @@ func Cmdline(cfg Config) (string, []string, error) {
 	// We also want to enable vsock and virtfs here, but QEMU does not support vsock and virtfs for macOS hosts
 
 	// QMP
-	qmpSock := filepath.Join(cfg.InstanceDir, "qmp.sock")
+	qmpSock := filepath.Join(cfg.InstanceDir, filenames.QMPSock)
 	if err := os.RemoveAll(qmpSock); err != nil {
 		return "", nil, err
 	}
@@ -180,7 +181,7 @@ func Cmdline(cfg Config) (string, []string, error) {
 
 	// QEMU process
 	args = append(args, "-name", "lima-"+cfg.Name)
-	args = append(args, "-pidfile", filepath.Join(cfg.InstanceDir, "qemu.pid"))
+	args = append(args, "-pidfile", filepath.Join(cfg.InstanceDir, filenames.QemuPID))
 
 	return exe, args, nil
 }

pkg/sshutil/sshutil.go

@@ -6,6 +6,7 @@ import (
 	"runtime"
 	"strings"
 
+	"github.com/AkihiroSuda/lima/pkg/store/filenames"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )
@@ -46,7 +47,7 @@ func DefaultPubKeys() []PubKey {
 }
 
 func SSHArgs(instDir string) ([]string, error) {
-	controlSock := filepath.Join(instDir, "ssh.sock")
+	controlSock := filepath.Join(instDir, filenames.SSHSock)
 	maxSockLen := 104
 	if runtime.GOOS == "linux" {
 		maxSockLen = 108