feat: find[One]Executable in user-supplied paths

Implemented `findExecutable` with strong caching, extended from #3162.
Also implemented `findOneExecutable` to search for any one executable
from a list.

Resolves: #3141
Closes: #3162
Co-authored-by: Arran Ubels <arran4@gmail.com>

Author: arran4

assets/chezmoi.io/docs/reference/templates/functions/findExecutable.md

@@ -0,0 +1,29 @@
+# `findExecutable` *file* *path-list*
+
+`findExecutable` searches for an executable named *file* in directories
+identified by *path-list*. The result will be the executable file concatenated
+with the matching path. If an executable *file* cannot be found in *path-list*,
+`findExecutable` returns an empty string.
+
+`findExecutable` is provided as an alternative to
+[`lookPath`](/reference/templates/functions/lookPath) so that you can
+interrogate the system PATH as it would be configured after `chezmoi apply`.
+Like `lookPath`, `findExecutable` is not hermetic: its return value depends on
+the state of the filesystem at the moment the template is executed. Exercise
+caution when using it in your templates.
+
+The return value of the first successful call to `findExecutable` is cached, and
+future calls to `findExecutable` with the same parameters will return this path.
+
+!!! info
+
+    On Windows, the resulting path will contain the first found executable
+    extension as identified by the environment variable `%PathExt%`.
+
+!!! example
+
+    ```
+    {{ if findExecutable "rtx" (list "bin" "go/bin" ".cargo/bin" ".local/bin") }}
+    # $HOME/.cargo/bin/rtx exists and will probably be in $PATH after apply
+    {{ end }}
+    ```

assets/chezmoi.io/docs/reference/templates/functions/findOneExecutable.md

@@ -0,0 +1,32 @@
+# `findOneExecutable` *file-list* *path-list*
+
+`findOneExecutable` searches for an executable from *file-list* in directories
+identified by *path-list*, finding the first matching executable in the first
+matching directory (each directory is searched for matching executables in
+turn). The result will be the executable file concatenated with the matching
+path. If an executable from *file-list* cannot be found in *path-list*,
+`findOneExecutable` returns an empty string.
+
+`findOneExecutable` is provided as an alternative to
+[`lookPath`](/reference/templates/functions/lookPath) so that you can
+interrogate the system PATH as it would be configured after `chezmoi apply`.
+Like `lookPath`, `findOneExecutable` is not hermetic: its return value depends
+on the state of the filesystem at the moment the template is executed. Exercise
+caution when using it in your templates.
+
+The return value of the first successful call to `findOneExecutable` is cached,
+and future calls to `findOneExecutable` with the same parameters will return
+this path.
+
+!!! info
+
+    On Windows, the resulting path will contain the first found executable
+    extension as identified by the environment variable `%PathExt%`.
+
+!!! example
+
+    ```
+    {{ if findOneExecutable (list "eza" "exa") (list "bin" "go/bin" ".cargo/bin" ".local/bin") }}
+    # $HOME/.cargo/bin/exa exists and will probably be in $PATH after apply
+    {{ end }}
+    ```

assets/chezmoi.io/mkdocs.yml

@@ -187,6 +187,8 @@ nav:
       - deleteValueAtPath: reference/templates/functions/deleteValueAtPath.md
       - encrypt: reference/templates/functions/encrypt.md
       - eqFold: reference/templates/functions/eqFold.md
+      - findExecutable: reference/templates/functions/findExecutable.md
+      - findOneExecutable: reference/templates/functions/findOneExecutable.md
       - fromIni: reference/templates/functions/fromIni.md
       - fromJsonc: reference/templates/functions/fromJsonc.md
       - fromToml: reference/templates/functions/fromToml.md

internal/chezmoi/chezmoi_unix.go

@@ -15,6 +15,12 @@ func init() {
 	unix.Umask(int(Umask))
 }
 
+// findExecutableExtensions returns valid OS executable extensions, on unix it
+// can be anything.
+func findExecutableExtensions(path string) []string {
+	return []string{path}
+}
+
 // IsExecutable returns if fileInfo is executable.
 func IsExecutable(fileInfo fs.FileInfo) bool {
 	return fileInfo.Mode().Perm()&0o111 != 0

internal/chezmoi/chezmoi_windows.go

@@ -13,6 +13,22 @@ const nativeLineEnding = "\r\n"
 
 var pathExts = strings.Split(os.Getenv("PATHEXT"), string(filepath.ListSeparator))
 
+// findExecutableExtensions returns valid OS executable extensions for the
+// provided file if it does not already have an extension. The executable
+// extensions are derived from %PathExt%.
+func findExecutableExtensions(path string) []string {
+	cmdExt := filepath.Ext(path)
+	if cmdExt != "" {
+		return []string{path}
+	}
+	result := make([]string, len(pathExts))
+	withoutSuffix := strings.TrimSuffix(path, cmdExt)
+	for i, ext := range pathExts {
+		result[i] = withoutSuffix + ext
+	}
+	return result
+}
+
 // IsExecutable checks if the file is a regular file and has an extension listed
 // in the PATHEXT environment variable as per
 // https://www.nextofwindows.com/what-is-pathext-environment-variable-in-windows.

internal/chezmoi/findexecutable.go

@@ -0,0 +1,66 @@
+package chezmoi
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+	"sync"
+)
+
+var (
+	foundExecutableCacheMutex sync.Mutex
+	foundExecutableCache      = make(map[string]string)
+)
+
+// FindExecutable is like LookPath except that:
+//
+//   - You can specify the needle as `string`, `[]string`, or `[]interface{}`
+//     (that converts to `[]string`).
+//   - You specify the haystack instead of relying on `$PATH`/`%PATH%`.
+//
+// This makes it useful for the resulting path of shell configurations
+// managed by chezmoi.
+func FindExecutable(files, paths []string) (string, error) {
+	foundExecutableCacheMutex.Lock()
+	defer foundExecutableCacheMutex.Unlock()
+
+	key := strings.Join(files, "\x00") + "\x01" + strings.Join(paths, "\x00")
+
+	if path, ok := foundExecutableCache[key]; ok {
+		return path, nil
+	}
+
+	var candidates []string
+
+	for _, file := range files {
+		candidates = append(candidates, findExecutableExtensions(file)...)
+	}
+
+	// based on /usr/lib/go-1.20/src/os/exec/lp_unix.go:52
+	for _, candidatePath := range paths {
+		if candidatePath == "" {
+			continue
+		}
+
+		for _, candidate := range candidates {
+			path := filepath.Join(candidatePath, candidate)
+
+			info, err := os.Stat(path)
+			if err != nil {
+				continue
+			}
+
+			// isExecutable doesn't care if it's a directory
+			if info.Mode().IsDir() {
+				continue
+			}
+
+			if IsExecutable(info) {
+				foundExecutableCache[key] = path
+				return path, nil
+			}
+		}
+	}
+
+	return "", nil
+}

internal/chezmoi/findexecutable_darwin_test.go

@@ -0,0 +1,62 @@
+package chezmoi
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/alecthomas/assert/v2"
+)
+
+func TestFindExecutable(t *testing.T) {
+	tests := []struct {
+		files    []string
+		paths    []string
+		expected string
+	}{
+		{
+			files:    []string{"sh"},
+			paths:    []string{"/usr/bin", "/bin"},
+			expected: "/bin/sh",
+		},
+		{
+			files:    []string{"sh"},
+			paths:    []string{"/bin", "/usr/bin"},
+			expected: "/bin/sh",
+		},
+		{
+			files:    []string{"chezmoish"},
+			paths:    []string{"/bin", "/usr/bin"},
+			expected: "",
+		},
+
+		{
+			files:    []string{"chezmoish", "sh"},
+			paths:    []string{"/usr/bin", "/bin"},
+			expected: "/bin/sh",
+		},
+		{
+			files:    []string{"chezmoish", "sh"},
+			paths:    []string{"/bin", "/usr/bin"},
+			expected: "/bin/sh",
+		},
+		{
+			files:    []string{"chezmoish", "chezvoush"},
+			paths:    []string{"/bin", "/usr/bin"},
+			expected: "",
+		},
+	}
+
+	for _, test := range tests {
+		name := fmt.Sprintf(
+			"FindExecutable %#v in %#v as %#v",
+			test.files,
+			test.paths,
+			test.expected,
+		)
+		t.Run(name, func(t *testing.T) {
+			actual, err := FindExecutable(test.files, test.paths)
+			assert.NoError(t, err)
+			assert.Equal(t, test.expected, actual)
+		})
+	}
+}

internal/chezmoi/findexecutable_unix_test.go

@@ -0,0 +1,63 @@
+//go:build !windows && !darwin
+
+package chezmoi
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/alecthomas/assert/v2"
+)
+
+func TestFindExecutable(t *testing.T) {
+	tests := []struct {
+		files    []string
+		paths    []string
+		expected string
+	}{
+		{
+			files:    []string{"yes"},
+			paths:    []string{"/usr/bin", "/bin"},
+			expected: "/usr/bin/yes",
+		},
+		{
+			files:    []string{"sh"},
+			paths:    []string{"/bin", "/usr/bin"},
+			expected: "/bin/sh",
+		},
+		{
+			files:    []string{"chezmoish"},
+			paths:    []string{"/bin", "/usr/bin"},
+			expected: "",
+		},
+		{
+			files:    []string{"chezmoish", "yes"},
+			paths:    []string{"/usr/bin", "/bin"},
+			expected: "/usr/bin/yes",
+		},
+		{
+			files:    []string{"chezmoish", "sh"},
+			paths:    []string{"/bin", "/usr/bin"},
+			expected: "/bin/sh",
+		},
+		{
+			files:    []string{"chezmoish", "chezvoush"},
+			paths:    []string{"/bin", "/usr/bin"},
+			expected: "",
+		},
+	}
+
+	for _, test := range tests {
+		name := fmt.Sprintf(
+			"FindExecutable %#v in %#v as %#v",
+			test.files,
+			test.paths,
+			test.expected,
+		)
+		t.Run(name, func(t *testing.T) {
+			actual, err := FindExecutable(test.files, test.paths)
+			assert.NoError(t, err)
+			assert.Equal(t, test.expected, actual)
+		})
+	}
+}

internal/chezmoi/findexecutable_windows_test.go

@@ -0,0 +1,101 @@
+//go:build windows
+
+package chezmoi
+
+import (
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/alecthomas/assert/v2"
+)
+
+func TestFindExecutable(t *testing.T) {
+	tests := []struct {
+		files    []string
+		paths    []string
+		expected string
+	}{
+		{
+			files: []string{"powershell.exe"},
+			paths: []string{
+				"c:\\windows\\system32",
+				"c:\\windows\\system64",
+				"C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0",
+			},
+			expected: "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
+		},
+		{
+			files: []string{"powershell"},
+			paths: []string{
+				"c:\\windows\\system32",
+				"c:\\windows\\system64",
+				"C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0",
+			},
+			expected: "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
+		},
+		{
+			files: []string{"weakshell.exe"},
+			paths: []string{
+				"c:\\windows\\system32",
+				"c:\\windows\\system64",
+				"C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0",
+			},
+			expected: "",
+		},
+		{
+			files: []string{"weakshell"},
+			paths: []string{
+				"c:\\windows\\system32",
+				"c:\\windows\\system64",
+				"C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0",
+			},
+			expected: "",
+		},
+		{
+			files: []string{"weakshell.exe", "powershell.exe"},
+			paths: []string{
+				"c:\\windows\\system32",
+				"c:\\windows\\system64",
+				"C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0",
+			},
+			expected: "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
+		},
+		{
+			files: []string{"weakshell", "powershell"},
+			paths: []string{
+				"c:\\windows\\system32",
+				"c:\\windows\\system64",
+				"C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0",
+			},
+			expected: "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
+		},
+		{
+			files: []string{"weakshell.exe", "chezmoishell.exe"},
+			paths: []string{
+				"c:\\windows\\system32",
+				"c:\\windows\\system64",
+				"C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0",
+			},
+			expected: "",
+		},
+		{
+			files: []string{"weakshell", "chezmoishell"},
+			paths: []string{
+				"c:\\windows\\system32",
+				"c:\\windows\\system64",
+				"C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0",
+			},
+			expected: "",
+		},
+	}
+
+	for _, test := range tests {
+		name := fmt.Sprintf("FindExecutable %v in %#v as %v", test.files, test.paths, test.expected)
+		t.Run(name, func(t *testing.T) {
+			actual, err := FindExecutable(test.files, test.paths)
+			assert.NoError(t, err)
+			assert.Equal(t, strings.ToLower(test.expected), strings.ToLower(actual))
+		})
+	}
+}

internal/cmd/config.go

@@ -408,6 +408,8 @@ func newConfig(options ...configOption) (*Config, error) {
 		"ejsonDecryptWithKey":      c.ejsonDecryptWithKeyTemplateFunc,
 		"encrypt":                  c.encryptTemplateFunc,
 		"eqFold":                   c.eqFoldTemplateFunc,
+		"findExecutable":           c.findExecutableTemplateFunc,
+		"findOneExecutable":        c.findOneExecutableTemplateFunc,
 		"fromIni":                  c.fromIniTemplateFunc,
 		"fromJsonc":                c.fromJsoncTemplateFunc,
 		"fromToml":                 c.fromTomlTemplateFunc,
@@ -450,8 +452,8 @@ func newConfig(options ...configOption) (*Config, error) {
 		"output":                   c.outputTemplateFunc,
 		"pass":                     c.passTemplateFunc,
 		"passFields":               c.passFieldsTemplateFunc,
-		"passRaw":                  c.passRawTemplateFunc,
 		"passhole":                 c.passholeTemplateFunc,
+		"passRaw":                  c.passRawTemplateFunc,
 		"pruneEmptyDicts":          c.pruneEmptyDictsTemplateFunc,
 		"quoteList":                c.quoteListTemplateFunc,
 		"rbw":                      c.rbwTemplateFunc,

internal/cmd/templatefuncs.go

@@ -133,6 +133,40 @@ func (c *Config) eqFoldTemplateFunc(first, second string, more ...string) bool {
 	return false
 }
 
+func (c *Config) findExecutableTemplateFunc(file string, pathList []any) string {
+	files := []string{file}
+	paths, err := anySliceToStringSlice(pathList)
+	if err != nil {
+		panic(fmt.Errorf("path list: %w", err))
+	}
+
+	switch path, err := chezmoi.FindExecutable(files, paths); {
+	case err == nil:
+		return path
+	default:
+		panic(err)
+	}
+}
+
+func (c *Config) findOneExecutableTemplateFunc(fileList, pathList []any) string {
+	files, err := anySliceToStringSlice(fileList)
+	if err != nil {
+		panic(fmt.Errorf("file list: %w", err))
+	}
+
+	paths, err := anySliceToStringSlice(pathList)
+	if err != nil {
+		panic(fmt.Errorf("path list: %w", err))
+	}
+
+	switch path, err := chezmoi.FindExecutable(files, paths); {
+	case err == nil:
+		return path
+	default:
+		panic(err)
+	}
+}
+
 func (c *Config) fromIniTemplateFunc(s string) map[string]any {
 	file, err := ini.Load([]byte(s))
 	if err != nil {

internal/cmd/testdata/scripts/templatefuncs.txtar

@@ -78,6 +78,38 @@ stdout ^true$
 exec chezmoi execute-template '{{ isExecutable "bin/not-executable" }}'
 stdout ^false$
 
+# test findExecutable template function to find in specified script varargs - success
+[!windows] exec chezmoi execute-template '{{ findExecutable "echo" (list "/lib" "/bin" "/usr/bin") }}'
+[!windows] stdout ^/bin/echo$
+
+# test findOneExecutable template function to find in specified script varargs - success
+[!windows] exec chezmoi execute-template '{{ findOneExecutable (list "chezmoish" "echo") (list "/lib" "/bin" "/usr/bin") }}'
+[!windows] stdout ^/bin/echo$
+
+# test findExecutable template function to find in specified script varargs - failure
+[!windows] exec chezmoi execute-template '{{ findExecutable "echo" (list "/lib") }}'
+[!windows] stdout ^$
+
+# test findExecutable template function to find in specified script - success
+[!windows] exec chezmoi execute-template '{{ findExecutable "echo" (list "/lib" "/bin" "/usr/bin") }}'
+[!windows] stdout ^/bin/echo$
+
+# test findExecutable template function to find in specified script - failure
+[!windows] exec chezmoi execute-template '{{ findExecutable "echo" (list "/lib") }}'
+[!windows] stdout ^$
+
+# test findExecutable template function to find in specified script - success with extension
+[windows] exec chezmoi execute-template '{{ findExecutable "git.exe" (list "c:\\windows\\system32" "c:\\windows\\system64" "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0" "C:\\Program Files\\Git\\cmd") }}'
+[windows] stdout 'git'
+
+# test findExecutable template function to find in specified script - success without extension
+[windows] exec chezmoi execute-template '{{ findExecutable "git" (list "c:\\windows\\system32" "c:\\windows\\system64" "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0" "C:\\Program Files\\Git\\cmd") }}'
+[windows] stdout 'git'
+
+# test findExecutable template function to find in specified script - failure
+[windows] exec chezmoi execute-template '{{ findExecutable "asdf" (list "c:\\windows\\system32" "c:\\windows\\system64" "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0" "C:\\Program Files\\Git\\cmd") }}'
+[windows] stdout '^$'
+
 # test lookPath template function to find in PATH
 exec chezmoi execute-template '{{ lookPath "go" }}'
 stdout go$exe

internal/cmd/util.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"reflect"
 	"strings"
 	"unicode"
 )
@@ -143,3 +144,20 @@ func upperSnakeCaseToCamelCaseMap[V any](m map[string]V) map[string]V {
 	}
 	return result
 }
+
+func flattenStringList(vpaths []any) []string {
+	var paths []string
+	for i := range vpaths {
+		switch path := vpaths[i].(type) {
+		case []string:
+			paths = append(paths, path...)
+		case string:
+			paths = append(paths, path)
+		case []any:
+			paths = append(paths, flattenStringList(path)...)
+		default:
+			panic("unknown type: " + reflect.TypeOf(path).String())
+		}
+	}
+	return paths
+}

internal/cmd/util_test.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"reflect"
+	"strings"
 	"testing"
 
 	"github.com/alecthomas/assert/v2"
@@ -148,3 +150,47 @@ func TestUpperSnakeCaseToCamelCaseMap(t *testing.T) {
 		"id":           "",
 	}, actual)
 }
+
+func Test_flattenStringList(t *testing.T) {
+	tests := []struct {
+		name   string
+		vpaths []any
+		want   []string
+	}{
+		{
+			name: "Nothing",
+		},
+		{
+			name:   "Just a string",
+			vpaths: []any{"1"},
+			want:   []string{"1"},
+		},
+		{
+			name:   "Just a array of string",
+			vpaths: []any{[]string{"1", "2"}},
+			want:   []string{"1", "2"},
+		},
+		{
+			name:   "Just a array of any containing string",
+			vpaths: []any{[]any{"1", "2"}},
+			want:   []string{"1", "2"},
+		},
+		{
+			name:   "Just a array of any containing string",
+			vpaths: []any{[]any{"1", "2"}},
+			want:   []string{"1", "2"},
+		},
+		{
+			name:   "Hybrid",
+			vpaths: []any{"0", []any{"1", "2"}, []any{[]string{"3", "4"}}, []any{[]any{"5", "6"}}},
+			want:   strings.Split("0123456", ""),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := flattenStringList(tt.vpaths); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("flattenStringList() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}