Make sure the Templates() function returns all templates from LIMA_TEMPLATES_PATH

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

Author: jandubois

pkg/templatestore/templatestore.go

@@ -4,11 +4,13 @@
 package templatestore
 
 import (
+	"cmp"
 	"errors"
 	"fmt"
 	"io/fs"
 	"os"
 	"path/filepath"
+	"slices"
 	"strings"
 	"unicode"
 
@@ -21,25 +23,33 @@ type Template struct {
 	Location string `json:"location"`
 }
 
-func Read(name string) ([]byte, error) {
-	var pathList []string
+func TemplatesPaths() ([]string, error) {
+	var paths []string
 	if tmplPath := os.Getenv("LIMA_TEMPLATES_PATH"); tmplPath != "" {
-		pathList = strings.Split(tmplPath, string(filepath.ListSeparator))
+		paths = strings.Split(tmplPath, string(filepath.ListSeparator))
 	} else {
 		dir, err := usrlocalsharelima.Dir()
 		if err != nil {
 			return nil, err
 		}
-		pathList = []string{filepath.Join(dir, "templates")}
+		paths = []string{filepath.Join(dir, "templates")}
+	}
+	return paths, nil
+}
+
+func Read(name string) ([]byte, error) {
+	paths, err := TemplatesPaths()
+	if err != nil {
+		return nil, err
 	}
 	ext := filepath.Ext(name)
 	// Append .yaml extension if name doesn't have an extension, or if it starts with a digit.
 	// So "docker.sh" would remain unchanged but "ubuntu-24.04" becomes "ubuntu-24.04.yaml".
 	if len(ext) < 2 || unicode.IsDigit(rune(ext[1])) {
 		name += ".yaml"
 	}
-	for _, path := range pathList {
-		filePath, err := securejoin.SecureJoin(path, name)
+	for _, templatesDir := range paths {
+		filePath, err := securejoin.SecureJoin(templatesDir, name)
 		if err != nil {
 			return nil, err
 		}
@@ -53,31 +63,36 @@ func Read(name string) ([]byte, error) {
 const Default = "default"
 
 func Templates() ([]Template, error) {
-	usrlocalsharelimaDir, err := usrlocalsharelima.Dir()
+	paths, err := TemplatesPaths()
 	if err != nil {
 		return nil, err
 	}
-	templatesDir := filepath.Join(usrlocalsharelimaDir, "templates")
 
-	var res []Template
-	walkDirFn := func(p string, _ fs.DirEntry, err error) error {
-		if err != nil {
-			return err
-		}
-		base := filepath.Base(p)
-		if strings.HasPrefix(base, ".") || !strings.HasSuffix(base, ".yaml") {
+	templates := make(map[string]string)
+	for _, templatesDir := range paths {
+		walkDirFn := func(p string, _ fs.DirEntry, err error) error {
+			if err != nil {
+				return err
+			}
+			base := filepath.Base(p)
+			if strings.HasPrefix(base, ".") || !strings.HasSuffix(base, ".yaml") {
+				return nil
+			}
+			// Name is like "default", "debian", "deprecated/centos-7", ...
+			name := strings.TrimSuffix(strings.TrimPrefix(p, templatesDir+"/"), ".yaml")
+			if _, ok := templates[name]; !ok {
+				templates[name] = p
+			}
 			return nil
 		}
-		x := Template{
-			// Name is like "default", "debian", "deprecated/centos-7", ...
-			Name:     strings.TrimSuffix(strings.TrimPrefix(p, templatesDir+"/"), ".yaml"),
-			Location: p,
+		if err = filepath.WalkDir(templatesDir, walkDirFn); err != nil {
+			return nil, err
 		}
-		res = append(res, x)
-		return nil
 	}
-	if err = filepath.WalkDir(templatesDir, walkDirFn); err != nil {
-		return nil, err
+	var res []Template
+	for name, loc := range templates {
+		res = append(res, Template{Name: name, Location: loc})
 	}
+	slices.SortFunc(res, func(i, j Template) int { return cmp.Compare(i.Name, j.Name) })
 	return res, nil
 }