daemonize limactl start

Close issue 26

Signed-off-by: Akihiro Suda <[email protected]>

Author: AkihiroSuda

.github/workflows/release.yml

@@ -36,15 +36,11 @@ jobs:
           (Changes to be documented)
 
           ## Usage
-          Terminal 1:
           \`\`\`console
           [macOS]$ limactl start
           ...
           INFO[0029] READY. Run `lima` to open the shell.
-          \`\`\`
 
-          Terminal 2:
-          \`\`\`console
           [macOS]$ lima uname
           Linux
           \`\`\`

.github/workflows/test.yml

@@ -37,8 +37,8 @@ jobs:
           version: v1.35
           args: --verbose
 
-  tests:
-    name: Tests
+  unit:
+    name: Unit tests
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -50,12 +50,45 @@ jobs:
           go-version: 1.16.x
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 25
+          fetch-depth: 1
       - name: Make
         run: make
       - name: Unit tests
         run: go test -v ./...
 
+  integration:
+    name: Integration tests
+    runs-on: macos-10.15
+    timeout-minutes: 40
+    steps:
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.16.x
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+      - name: Make
+        run: make
+      - name: Install
+        run: make install
+      - name: Install QEMU
+        run: brew install qemu
+      - name: Prepare ssh
+        run: |
+          if [ -e ~/.ssh/id_rsa ]; then
+            echo "~/.ssh/id_rsa already exists"
+          else
+            echo "Generating ~/.ssh/id_rsa"
+            ssh-keygen -b 2048 -t rsa -f ~/.ssh/id_rsa -q -N ""
+          fi
+      - name: Smoke tests
+        run: |
+          limactl start --tty=false default
+          lima uname -a
+          echo "this file was created on macOS" > ~/foo
+          lima cat ~/foo
+          limactl stop default
+
   artifacts:
     name: Artifacts
     # the release pipeline uses Linux, so we Linux here as well
@@ -67,6 +100,6 @@ jobs:
           go-version: 1.16.x
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 25
+          fetch-depth: 1
       - name: Make artifacts
         run: make artifacts

README.md

@@ -97,15 +97,11 @@ To install from the source, run `make && make install`.
 
 ### Usage
 
-Terminal 1:
 ```console
 [macOS]$ limactl start
 ...
 INFO[0029] READY. Run `lima` to open the shell.
-```
 
-Terminal 2:
-```console
 [macOS]$ lima uname
 Linux
 ```
@@ -118,12 +114,14 @@ Detailed usage:
   Wait until "READY" to be printed on the host terminal.
 
 - Run `limactl shell <INSTANCE> <COMMAND>` to launch `<COMMAND>` on Linux.
-  For the "default" instance, this command can be shortened as just `lima <COMMAND>`.
+  For the "default" instance, this command can be shortened as `lima <COMMAND>`.
   The `lima` command also accepts the instance name as the environment variable `$LIMA_INSTANCE`.
 
-- Run `limactl ls` to show the instances.
+- Run `limactl list [--json]` to show the instances.
+
+- Run `limactl stop [--force] <INSTANCE>` to stop the instance.
 
-- Run `limactl delete <INSTANCE>` to delete the instance.
+- Run `limactl delete [--force] <INSTANCE>` to delete the instance.
 
 - To enable bash completion, add `source <(limactl completion bash)` to `~/.bash_profile`.
 

cmd/limactl/delete.go

@@ -10,9 +10,17 @@ import (
 )
 
 var deleteCommand = &cli.Command{
-	Name:         "delete",
-	Usage:        "Delete an instance of Lima.",
-	ArgsUsage:    "INSTANCE [INSTANCE, ...]",
+	Name:      "delete",
+	Aliases:   []string{"remove", "rm"},
+	Usage:     "Delete an instance of Lima.",
+	ArgsUsage: "INSTANCE [INSTANCE, ...]",
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:    "force",
+			Aliases: []string{"f"},
+			Usage:   "forcibly kill the processes",
+		},
+	},
 	Action:       deleteAction,
 	BashComplete: deleteBashComplete,
 }
@@ -21,19 +29,33 @@ func deleteAction(clicontext *cli.Context) error {
 	if clicontext.NArg() == 0 {
 		return errors.Errorf("requires at least 1 argument")
 	}
+	force := clicontext.Bool("force")
 	for _, instName := range clicontext.Args().Slice() {
-		instDir, err := store.InstanceDir(instName)
+		inst, err := store.Inspect(instName)
 		if err != nil {
+			if errors.Is(err, os.ErrNotExist) {
+				logrus.Warnf("Ignoring non-existent instance %q", instName)
+				continue
+			}
 			return err
 		}
-		if _, err := os.Stat(instDir); errors.Is(err, os.ErrNotExist) {
-			logrus.Warnf("Ignoring non-existent instance %q (%q)", instName, instDir)
-			return nil
+		if err := deleteInstance(inst, force); err != nil {
+			return errors.Wrapf(err, "failed to delete instance %q", instName)
 		}
-		if err := os.RemoveAll(instDir); err != nil {
-			return errors.Wrapf(err, "failed to remove %q", instDir)
-		}
-		logrus.Infof("Deleted %q (%q)", instName, instDir)
+		logrus.Infof("Deleted %q (%q)", instName, inst.Dir)
+	}
+	return nil
+}
+
+func deleteInstance(inst *store.Instance, force bool) error {
+	if !force && inst.Status != store.StatusStopped {
+		return errors.Errorf("expected status %q, got %q", store.StatusStopped, inst.Status)
+	}
+
+	stopInstanceForcibly(inst)
+
+	if err := os.RemoveAll(inst.Dir); err != nil {
+		return errors.Wrapf(err, "failed to remove %q", inst.Dir)
 	}
 	return nil
 }

cmd/limactl/hostagent.go

@@ -0,0 +1,56 @@
+package main
+
+import (
+	"os"
+	"os/signal"
+	"strconv"
+
+	"github.com/AkihiroSuda/lima/pkg/hostagent"
+	"github.com/pkg/errors"
+	"github.com/urfave/cli/v2"
+)
+
+var hostagentCommand = &cli.Command{
+	Name:      "hostagent",
+	Usage:     "DO NOT EXECUTE MANUALLY",
+	ArgsUsage: "NAME",
+	Hidden:    true,
+	Flags: []cli.Flag{
+		&cli.StringFlag{
+			Name:  "pidfile",
+			Usage: "PID file",
+		},
+	},
+
+	Action: hostagentAction,
+}
+
+func hostagentAction(clicontext *cli.Context) error {
+	if pidfile := clicontext.String("pidfile"); pidfile != "" {
+		if _, err := os.Stat(pidfile); !errors.Is(err, os.ErrNotExist) {
+			return errors.Errorf("pidfile %q already exists", pidfile)
+		}
+		if err := os.WriteFile(pidfile, []byte(strconv.Itoa(os.Getpid())+"\n"), 0644); err != nil {
+			return err
+		}
+		defer os.RemoveAll(pidfile)
+	}
+
+	if clicontext.NArg() != 1 {
+		return errors.Errorf("requires exactly 1 argument")
+	}
+
+	instName := clicontext.Args().First()
+
+	sigintCh := make(chan os.Signal, 1)
+	signal.Notify(sigintCh, os.Interrupt)
+
+	stdout := clicontext.App.Writer
+	stderr := clicontext.App.ErrWriter
+
+	ha, err := hostagent.New(instName, stdout, stderr, sigintCh)
+	if err != nil {
+		return err
+	}
+	return ha.Run(clicontext.Context)
+}

cmd/limactl/list.go

@@ -0,0 +1,96 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"text/tabwriter"
+
+	"github.com/AkihiroSuda/lima/pkg/store"
+	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
+	"github.com/urfave/cli/v2"
+)
+
+var listCommand = &cli.Command{
+	Name:    "list",
+	Aliases: []string{"ls"},
+	Usage:   "List instances of Lima.",
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:  "json",
+			Usage: "JSONify output",
+		},
+		&cli.BoolFlag{
+			Name:    "quiet",
+			Aliases: []string{"q"},
+			Usage:   "Only show names",
+		},
+	},
+
+	Action: listAction,
+}
+
+func listAction(clicontext *cli.Context) error {
+	if clicontext.NArg() > 0 {
+		return errors.New("too many arguments")
+	}
+
+	if clicontext.Bool("quiet") && clicontext.Bool("json") {
+		return errors.New("option --quiet conflicts with --json")
+	}
+
+	instances, err := store.Instances()
+	if err != nil {
+		return err
+	}
+
+	if clicontext.Bool("quiet") {
+		for _, instName := range instances {
+			fmt.Fprintln(clicontext.App.Writer, instName)
+		}
+		return nil
+	}
+
+	if clicontext.Bool("json") {
+		for _, instName := range instances {
+			inst, err := store.Inspect(instName)
+			if err != nil {
+				logrus.WithError(err).Errorf("instance %q does not exist?", instName)
+				continue
+			}
+			b, err := json.Marshal(inst)
+			if err != nil {
+				return err
+			}
+			fmt.Fprintln(clicontext.App.Writer, string(b))
+		}
+		return nil
+	}
+
+	w := tabwriter.NewWriter(clicontext.App.Writer, 4, 8, 4, ' ', 0)
+	fmt.Fprintln(w, "NAME\tSTATUS\tSSH\tARCH\tDIR")
+
+	if len(instances) == 0 {
+		logrus.Warn("No instance found. Run `limactl start` to create an instance.")
+	}
+
+	for _, instName := range instances {
+		inst, err := store.Inspect(instName)
+		if err != nil {
+			logrus.WithError(err).Errorf("instance %q does not exist?", instName)
+			continue
+		}
+		if len(inst.Errors) > 0 {
+			logrus.WithField("errors", inst.Errors).Warnf("instance %q has errors", instName)
+		}
+		fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n",
+			inst.Name,
+			inst.Status,
+			fmt.Sprintf("127.0.0.1:%d", inst.SSHLocalPort),
+			inst.Arch,
+			inst.Dir,
+		)
+	}
+
+	return w.Flush()
+}