Store Lima version in the instance directory

That way future Lima releases can make decisions about default settings
based on the Lima version that created the instance instead of the current
instance, and settings for existing instances will not change just because
the user updated Lima.

Signed-off-by: Jan Dubois <[email protected]>

Author: jandubois

cmd/limactl/start.go

@@ -23,6 +23,7 @@ import (
 	"github.com/lima-vm/lima/pkg/store/filenames"
 	"github.com/lima-vm/lima/pkg/templatestore"
 	"github.com/lima-vm/lima/pkg/uiutil"
+	"github.com/lima-vm/lima/pkg/version"
 	"github.com/lima-vm/lima/pkg/yqutil"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -332,6 +333,9 @@ func createInstance(ctx context.Context, st *creatorState, saveBrokenEditorBuffe
 	if err := os.WriteFile(filePath, st.yBytes, 0o644); err != nil {
 		return nil, err
 	}
+	if err := os.WriteFile(filepath.Join(instDir, filenames.LimaVersion), []byte(version.Version), 0o444); err != nil {
+		return nil, err
+	}
 
 	inst, err := store.Inspect(st.instName)
 	if err != nil {

pkg/store/filenames/filenames.go

@@ -27,6 +27,7 @@ const (
 
 const (
 	LimaYAML           = "lima.yaml"
+	LimaVersion        = "lima-version" // Lima version used to create instance
 	CIDataISO          = "cidata.iso"
 	CIDataISODir       = "cidata"
 	BaseDisk           = "basedisk"

pkg/store/instance.go

@@ -16,6 +16,7 @@ import (
 	"text/template"
 	"time"
 
+	"github.com/coreos/go-semver/semver"
 	"github.com/docker/go-units"
 	hostagentclient "github.com/lima-vm/lima/pkg/hostagent/api/client"
 	"github.com/lima-vm/lima/pkg/limayaml"
@@ -56,6 +57,7 @@ type Instance struct {
 	Config          *limayaml.LimaYAML `json:"config,omitempty"`
 	SSHAddress      string             `json:"sshAddress,omitempty"`
 	Protected       bool               `json:"protected"`
+	LimaVersion     string             `json:"limaVersion"`
 }
 
 func (inst *Instance) LoadYAML() (*limayaml.LimaYAML, error) {
@@ -167,6 +169,20 @@ func Inspect(instName string) (*Instance, error) {
 			}
 		}
 	}
+
+	limaVersionFile := filepath.Join(instDir, filenames.LimaVersion)
+	if version, err := os.ReadFile(limaVersionFile); err == nil {
+		limaVersion := strings.TrimSpace(string(version))
+		// Don't store invalid version strings because later code will not validate again
+		if _, err := parseLimaVersion(limaVersion); err == nil {
+			inst.LimaVersion = limaVersion
+		} else {
+			err = fmt.Errorf("cannot parse lima version %q from %q: %w", limaVersion, limaVersionFile, err)
+			inst.Errors = append(inst.Errors, err)
+		}
+	} else if !errors.Is(err, os.ErrNotExist) {
+		inst.Errors = append(inst.Errors, err)
+	}
 	return inst, nil
 }
 
@@ -423,3 +439,32 @@ func (inst *Instance) Unprotect() error {
 	inst.Protected = false
 	return nil
 }
+
+// parseLimaVersion parses a Lima version string by removing the leading "v" character and
+// stripping everything from the first "-" forward (which are `git describe` artifacts and
+// not semver pre-release markers). So "v0.19.1-16-gf3dc6ed.m" will be parsed as "0.19.1".
+func parseLimaVersion(version string) (*semver.Version, error) {
+	version = strings.TrimPrefix(version, "v")
+	version, _, _ = strings.Cut(version, "-")
+	return semver.NewVersion(version)
+}
+
+// LimaVersionGreaterThan returns true if the Lima version used to create an instance is greater
+// than a specific older version. Always returns false if the Lima version is the empty string.
+// This function compares `github describe` versions, not semantic versions. So "0.19.1-16-gf3dc6ed.m"
+// will be considered greater than "0.19.1".
+func LimaVersionGreaterThan(limaVersion, oldVersion string) bool {
+	if limaVersion == "" {
+		return false
+	}
+	version, _ := parseLimaVersion(limaVersion)
+	switch version.Compare(*semver.New(oldVersion)) {
+	case -1:
+		return false
+	case +1:
+		return true
+	case 0:
+		return strings.Contains(limaVersion, "-")
+	}
+	panic("unreachable")
+}

pkg/store/instance_test.go

@@ -155,3 +155,11 @@ func TestPrintInstanceTableTwo(t *testing.T) {
 	assert.NilError(t, err)
 	assert.Equal(t, tableTwo, buf.String())
 }
+
+func TestLimaVersionGreaterThan(t *testing.T) {
+	assert.Equal(t, LimaVersionGreaterThan("", "0.1.0"), false)
+	assert.Equal(t, LimaVersionGreaterThan("0.0.1", "0.1.0"), false)
+	assert.Equal(t, LimaVersionGreaterThan("0.1.0", "0.1.0"), false)
+	assert.Equal(t, LimaVersionGreaterThan("0.1.0-2", "0.1.0"), true)
+	assert.Equal(t, LimaVersionGreaterThan("0.2.0", "0.1.0"), true)
+}

website/content/en/docs/dev/Internals/_index.md

@@ -30,6 +30,7 @@ having to specify an identity explicitly.
 An instance directory contains the following files:
 
 Metadata:
+- `lima-version`: the Lima version used to create this instance
 - `lima.yaml`: the YAML
 - `protected`: empty file, used by `limactl protect`