add InspectStatus() to api and refactor wsl2

Signed-off-by: Ansuman Sahoo <[email protected]>

Author: unsuman

pkg/driver/driver.go

@@ -36,6 +36,7 @@ type Lifecycle interface {
 	Stop(_ context.Context) error
 
 	Delete(_ context.Context) error
+	InspectStatus(_ context.Context, instName string) string
 }
 
 // GUI defines GUI-related operations.

pkg/driver/external/client/methods.go

@@ -308,13 +308,18 @@ func (d *DriverClient) Configure(inst *limatype.Instance) *driver.ConfiguredDriv
 }
 
 func (d *DriverClient) Delete(ctx context.Context) error {
-	return errors.New("AcceptConfig not implemented in DriverClient")
+	return errors.New("Delete not implemented in DriverClient")
 }
 
 func (d *DriverClient) AcceptConfig(cfg *limatype.LimaYAML, filepath string) error {
 	return errors.New("AcceptConfig not implemented in DriverClient")
 }
 
 func (d *DriverClient) FillConfig(cfg *limatype.LimaYAML, filepath string) error {
-	return errors.New("AcceptConfig not implemented in DriverClient")
+	return errors.New("FillConfig not implemented in DriverClient")
+}
+
+// TODO: Implement InspectStatus in DriverClient
+func (d *DriverClient) InspectStatus(_ context.Context, _ string) string {
+	return ""
 }

pkg/driver/qemu/qemu_driver.go

@@ -641,6 +641,10 @@ func (l *LimaQemuDriver) Info() driver.Info {
 	return info
 }
 
+func (l *LimaQemuDriver) InspectStatus(_ context.Context, instName string) string {
+	return ""
+}
+
 func (l *LimaQemuDriver) Create(_ context.Context) error {
 	return nil
 }

pkg/driver/vz/vz_driver_darwin.go

@@ -316,6 +316,10 @@ func (l *LimaVzDriver) Info() driver.Info {
 	return info
 }
 
+func (l *LimaVzDriver) InspectStatus(_ context.Context, instName string) string {
+	return ""
+}
+
 func (l *LimaVzDriver) Delete(ctx context.Context) error {
 	return nil
 }

pkg/driver/wsl2/vm_windows.go

@@ -10,6 +10,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"regexp"
 	"strconv"
 	"strings"
 
@@ -18,7 +19,6 @@ import (
 	"github.com/lima-vm/lima/v2/pkg/executil"
 	"github.com/lima-vm/lima/v2/pkg/limatype"
 	"github.com/lima-vm/lima/v2/pkg/limatype/filenames"
-	"github.com/lima-vm/lima/v2/pkg/store"
 	"github.com/lima-vm/lima/v2/pkg/textutil"
 )
 
@@ -133,7 +133,7 @@ func provisionVM(ctx context.Context, instanceDir, instanceName, distroName stri
 		for {
 			<-ctx.Done()
 			logrus.Info("Context closed, stopping vm")
-			if status, err := store.GetWslStatus(instanceName); err == nil &&
+			if status, err := getWslStatus(instanceName); err == nil &&
 				status == limatype.StatusRunning {
 				_ = stopVM(ctx, distroName)
 			}
@@ -177,3 +177,54 @@ func unregisterVM(ctx context.Context, distroName string) error {
 	}
 	return nil
 }
+
+func getWslStatus(instName string) (string, error) {
+	distroName := "lima-" + instName
+	out, err := executil.RunUTF16leCommand([]string{
+		"wsl.exe",
+		"--list",
+		"--verbose",
+	})
+	if err != nil {
+		return "", fmt.Errorf("failed to run `wsl --list --verbose`, err: %w (out=%q)", err, out)
+	}
+
+	if out == "" {
+		return limatype.StatusBroken, fmt.Errorf("failed to read instance state for instance %q, try running `wsl --list --verbose` to debug, err: %w", instName, err)
+	}
+
+	// Check for edge cases first
+	if strings.Contains(out, "Windows Subsystem for Linux has no installed distributions.") {
+		if strings.Contains(out, "Wsl/WSL_E_DEFAULT_DISTRO_NOT_FOUND") {
+			return limatype.StatusBroken, fmt.Errorf(
+				"failed to read instance state for instance %q because no distro is installed,"+
+					"try running `wsl --install -d Ubuntu` and then re-running Lima", instName)
+		}
+		return limatype.StatusBroken, fmt.Errorf(
+			"failed to read instance state for instance %q because there is no WSL kernel installed,"+
+				"this usually happens when WSL was installed for another user, but never for your user."+
+				"Try running `wsl --install -d Ubuntu` and `wsl --update`, and then re-running Lima", instName)
+	}
+
+	var instState string
+	wslListColsRegex := regexp.MustCompile(`\s+`)
+	// wsl --list --verbose may have different headers depending on localization, just split by line
+	for _, rows := range strings.Split(strings.ReplaceAll(out, "\r\n", "\n"), "\n") {
+		cols := wslListColsRegex.Split(strings.TrimSpace(rows), -1)
+		nameIdx := 0
+		// '*' indicates default instance
+		if cols[0] == "*" {
+			nameIdx = 1
+		}
+		if cols[nameIdx] == distroName {
+			instState = cols[nameIdx+1]
+			break
+		}
+	}
+
+	if instState == "" {
+		return limatype.StatusUninitialized, nil
+	}
+
+	return instState, nil
+}

pkg/driver/wsl2/wsl_driver_windows.go

@@ -158,9 +158,32 @@ func (l *LimaWslDriver) Validate() error {
 	return nil
 }
 
+func (l *LimaWslDriver) InspectStatus(ctx context.Context, instName string) string {
+	status, err := getWslStatus(instName)
+	if err != nil {
+		l.Instance.Status = limatype.StatusBroken
+		l.Instance.Errors = append(l.Instance.Errors, err)
+	} else {
+		l.Instance.Status = status
+	}
+
+	l.Instance.SSHLocalPort = 22
+
+	if l.Instance.Status == limatype.StatusRunning {
+		sshAddr, err := store.GetSSHAddress(instName)
+		if err == nil {
+			l.Instance.SSHAddress = sshAddr
+		} else {
+			l.Instance.Errors = append(l.Instance.Errors, err)
+		}
+	}
+
+	return l.Instance.Status
+}
+
 func (l *LimaWslDriver) Delete(ctx context.Context) error {
 	distroName := "lima-" + l.Instance.Name
-	status, err := store.GetWslStatus(l.Instance.Name)
+	status, err := getWslStatus(l.Instance.Name)
 	if err != nil {
 		return err
 	}
@@ -175,7 +198,7 @@ func (l *LimaWslDriver) Delete(ctx context.Context) error {
 
 func (l *LimaWslDriver) Start(ctx context.Context) (chan error, error) {
 	logrus.Infof("Starting WSL VM")
-	status, err := store.GetWslStatus(l.Instance.Name)
+	status, err := getWslStatus(l.Instance.Name)
 	if err != nil {
 		return nil, err
 	}

pkg/registry/registry_test.go

@@ -48,6 +48,7 @@ func (m *mockDriver) Info() driver.Info
 func (m *mockDriver) Configure(_ *limatype.Instance) *driver.ConfiguredDriver    { return nil }
 func (m *mockDriver) AcceptConfig(_ *limatype.LimaYAML, _ string) error          { return nil }
 func (m *mockDriver) FillConfig(_ *limatype.LimaYAML, _ string) error            { return nil }
+func (m *mockDriver) InspectStatus(_ context.Context, _ string) string           { return "" }
 
 func TestRegister(t *testing.T) {
 	BackupRegistry(t)

pkg/store/instance.go

@@ -21,6 +21,7 @@ import (
 	"github.com/docker/go-units"
 	"github.com/sirupsen/logrus"
 
+	"github.com/lima-vm/lima/v2/pkg/driverutil"
 	hostagentclient "github.com/lima-vm/lima/v2/pkg/hostagent/api/client"
 	"github.com/lima-vm/lima/v2/pkg/instance/hostname"
 	"github.com/lima-vm/lima/v2/pkg/limatype"
@@ -147,6 +148,27 @@ func Inspect(instName string) (*limatype.Instance, error) {
 	return inst, nil
 }
 
+func inspectStatus(instDir string, inst *limatype.Instance, y *limatype.LimaYAML) {
+	driver, err := driverutil.CreateConfiguredDriver(inst, inst.SSHLocalPort)
+	if err != nil {
+		inst.Errors = append(inst.Errors, fmt.Errorf("failed to create driver instance: %w", err))
+		inst.Status = limatype.StatusBroken
+		return
+	}
+
+	status := driver.InspectStatus(context.Background(), inst.Name)
+	if status == "" {
+		inspectStatusWithPIDFiles(instDir, inst, y)
+		return
+	}
+
+	inst.Status = status
+}
+
+func GetSSHAddress(_ string) (string, error) {
+	return "127.0.0.1", nil
+}
+
 func inspectStatusWithPIDFiles(instDir string, inst *limatype.Instance, y *limatype.LimaYAML) {
 	var err error
 	inst.DriverPID, err = ReadPIDFile(filepath.Join(instDir, filenames.PIDFile(*y.VMType)))