Merge pull request #805 from AkihiroSuda/fix-785

limactl start: support subdirectories

Author: AkihiroSuda

cmd/limactl/start.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"io/fs"
 	"net/http"
 	"net/url"
 	"os"
@@ -14,6 +15,7 @@ import (
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/containerd/containerd/identifiers"
+	securejoin "github.com/cyphar/filepath-securejoin"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	networks "github.com/lima-vm/lima/pkg/networks/reconcile"
 	"github.com/lima-vm/lima/pkg/osutil"
@@ -63,10 +65,10 @@ func readTemplate(name string) ([]byte, error) {
 	if err != nil {
 		return nil, err
 	}
-	if strings.Contains(name, string(os.PathSeparator)) {
-		return nil, fmt.Errorf("invalid template name %q", name)
+	defaultYAMLPath, err := securejoin.SecureJoin(filepath.Join(dir, "examples"), name+".yaml")
+	if err != nil {
+		return nil, err
 	}
-	defaultYAMLPath := filepath.Join(dir, "examples", name+".yaml")
 	return os.ReadFile(defaultYAMLPath)
 }
 
@@ -91,10 +93,12 @@ func loadOrCreateInstance(cmd *cobra.Command, args []string) (*store.Instance, e
 	const yBytesLimit = 4 * 1024 * 1024 // 4MiB
 
 	if ok, u := argSeemsTemplateURL(arg); ok {
-		templateName := u.Host
+		// No need to use SecureJoin here. https://github.com/lima-vm/lima/pull/805#discussion_r853411702
+		templateName := filepath.Join(u.Host, u.Path)
 		logrus.Debugf("interpreting argument %q as a template name %q", arg, templateName)
 		if st.instName == "" {
-			st.instName = templateName
+			// e.g., templateName = "deprecated/centos-7" , st.instName = "centos-7"
+			st.instName = filepath.Base(templateName)
 		}
 		st.yBytes, err = readTemplate(templateName)
 		if err != nil {
@@ -340,21 +344,26 @@ func listTemplateYAMLs() ([]TemplateYAML, error) {
 		return nil, err
 	}
 	examplesDir := filepath.Join(usrlocalsharelimaDir, "examples")
-	glob := filepath.Join(examplesDir, "*.yaml")
-	globbed, err := filepath.Glob(glob)
-	if err != nil {
-		return nil, err
-	}
+
 	var res []TemplateYAML
-	for _, f := range globbed {
-		base := filepath.Base(f)
-		if strings.HasPrefix(base, ".") {
-			continue
+	walkDirFn := func(p string, d fs.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+		base := filepath.Base(p)
+		if strings.HasPrefix(base, ".") || !strings.HasSuffix(base, ".yaml") {
+			return nil
+		}
+		x := TemplateYAML{
+			// Name is like "default", "debian", "deprecated/centos-7", ...
+			Name:     strings.TrimSuffix(strings.TrimPrefix(p, examplesDir+"/"), ".yaml"),
+			Location: p,
 		}
-		res = append(res, TemplateYAML{
-			Name:     strings.TrimSuffix(filepath.Base(f), ".yaml"),
-			Location: f,
-		})
+		res = append(res, x)
+		return nil
+	}
+	if err = filepath.WalkDir(examplesDir, walkDirFn); err != nil {
+		return nil, err
 	}
 	return res, nil
 }

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/containerd/containerd v1.6.2
 	github.com/containerd/continuity v0.3.0
 	github.com/coreos/go-semver v0.3.0
+	github.com/cyphar/filepath-securejoin v0.2.3
 	github.com/digitalocean/go-qemu v0.0.0-20210326154740-ac9e0b687001
 	github.com/diskfs/go-diskfs v1.2.0
 	github.com/docker/go-units v0.4.0

go.sum

@@ -37,6 +37,8 @@ github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46t
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/creack/pty v1.1.17 h1:QeVUsEDNrLBW4tMgZHvxy18sKtr6VI492kBhUfhDJNI=
 github.com/creack/pty v1.1.17/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4=
+github.com/cyphar/filepath-securejoin v0.2.3 h1:YX6ebbZCZP7VkM3scTTokDgBL2TY741X51MTk3ycuNI=
+github.com/cyphar/filepath-securejoin v0.2.3/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=