feat: add tests for search and default dir

Author: pd93

internal/fsext/fs.go

@@ -8,6 +8,11 @@ import (
 	"github.com/go-task/task/v3/internal/sysinfo"
 )
 
+// DefaultDir will return the default directory given an entrypoint or
+// directory. If the directory is set, it will ensure it is an absolute path and
+// return it. If the entrypoint is set, but the directory is not, it will leave
+// the directory blank. If both are empty, it will default the directory to the
+// current working directory.
 func DefaultDir(entrypoint, dir string) string {
 	// If the directory is set, ensure it is an absolute path
 	if dir != "" {
@@ -51,6 +56,11 @@ func Search(entrypoint, dir string, possibleFilenames []string) (string, string,
 		}
 		if dir == "" {
 			dir = filepath.Dir(entrypoint)
+		} else {
+			dir, err = filepath.Abs(dir)
+			if err != nil {
+				return "", "", err
+			}
 		}
 		return entrypoint, dir, nil
 	}

internal/fsext/fs_test.go

@@ -0,0 +1,144 @@
+package fsext
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestDefaultDir(t *testing.T) {
+	wd, err := os.Getwd()
+	require.NoError(t, err)
+	tests := []struct {
+		name       string
+		entrypoint string
+		dir        string
+		expected   string
+	}{
+		{
+			name:       "default to current working directory",
+			entrypoint: "",
+			dir:        "",
+			expected:   wd,
+		},
+		{
+			name:       "resolves relative dir path",
+			entrypoint: "",
+			dir:        "./dir",
+			expected:   filepath.Join(wd, "dir"),
+		},
+		{
+			name:       "return entrypoint if set",
+			entrypoint: filepath.Join(wd, "entrypoint"),
+			dir:        "",
+			expected:   "",
+		},
+		{
+			name:       "if entrypoint and dir are set",
+			entrypoint: filepath.Join(wd, "entrypoint"),
+			dir:        filepath.Join(wd, "dir"),
+			expected:   filepath.Join(wd, "dir"),
+		},
+		{
+			name:       "if entrypoint and dir are set and dir is relative",
+			entrypoint: filepath.Join(wd, "entrypoint"),
+			dir:        "./dir",
+			expected:   filepath.Join(wd, "dir"),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			require.Equal(t, tt.expected, DefaultDir(tt.entrypoint, tt.dir))
+		})
+	}
+}
+
+func TestSearch(t *testing.T) {
+	wd, err := os.Getwd()
+	require.NoError(t, err)
+	tests := []struct {
+		name               string
+		entrypoint         string
+		dir                string
+		possibleFilenames  []string
+		expectedEntrypoint string
+		expectedDir        string
+	}{
+		{
+			name:               "find foo.txt using relative entrypoint",
+			entrypoint:         "./testdata/foo.txt",
+			possibleFilenames:  []string{"foo.txt"},
+			expectedEntrypoint: filepath.Join(wd, "testdata", "foo.txt"),
+			expectedDir:        filepath.Join(wd, "testdata"),
+		},
+		{
+			name:               "find foo.txt using absolute entrypoint",
+			entrypoint:         filepath.Join(wd, "testdata", "foo.txt"),
+			possibleFilenames:  []string{"foo.txt"},
+			expectedEntrypoint: filepath.Join(wd, "testdata", "foo.txt"),
+			expectedDir:        filepath.Join(wd, "testdata"),
+		},
+		{
+			name:               "find foo.txt using relative dir",
+			dir:                "./testdata",
+			possibleFilenames:  []string{"foo.txt"},
+			expectedEntrypoint: filepath.Join(wd, "testdata", "foo.txt"),
+			expectedDir:        filepath.Join(wd, "testdata"),
+		},
+		{
+			name:               "find foo.txt using absolute dir",
+			dir:                filepath.Join(wd, "testdata"),
+			possibleFilenames:  []string{"foo.txt"},
+			expectedEntrypoint: filepath.Join(wd, "testdata", "foo.txt"),
+			expectedDir:        filepath.Join(wd, "testdata"),
+		},
+		{
+			name:               "find foo.txt using relative dir and relative entrypoint",
+			entrypoint:         "./testdata/foo.txt",
+			dir:                "./testdata/some/other/dir",
+			possibleFilenames:  []string{"foo.txt"},
+			expectedEntrypoint: filepath.Join(wd, "testdata", "foo.txt"),
+			expectedDir:        filepath.Join(wd, "testdata", "some", "other", "dir"),
+		},
+		{
+			name:               "find fs.go using no entrypoint or dir",
+			entrypoint:         "",
+			dir:                "",
+			possibleFilenames:  []string{"fs.go"},
+			expectedEntrypoint: filepath.Join(wd, "fs.go"),
+			expectedDir:        wd,
+		},
+		{
+			name:               "find ../../Taskfile.yml using no entrypoint or dir by walking",
+			entrypoint:         "",
+			dir:                "",
+			possibleFilenames:  []string{"Taskfile.yml"},
+			expectedEntrypoint: filepath.Join(wd, "..", "..", "Taskfile.yml"),
+			expectedDir:        filepath.Join(wd, "..", ".."),
+		},
+		{
+			name:               "find foo.txt first if listed first in possible filenames",
+			entrypoint:         "./testdata",
+			possibleFilenames:  []string{"foo.txt", "bar.txt"},
+			expectedEntrypoint: filepath.Join(wd, "testdata", "foo.txt"),
+			expectedDir:        filepath.Join(wd, "testdata"),
+		},
+		{
+			name:               "find bar.txt first if listed first in possible filenames",
+			entrypoint:         "./testdata",
+			possibleFilenames:  []string{"bar.txt", "foo.txt"},
+			expectedEntrypoint: filepath.Join(wd, "testdata", "bar.txt"),
+			expectedDir:        filepath.Join(wd, "testdata"),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			entrypoint, dir, err := Search(tt.entrypoint, tt.dir, tt.possibleFilenames)
+			require.NoError(t, err)
+			require.Equal(t, tt.expectedEntrypoint, entrypoint)
+			require.Equal(t, tt.expectedDir, dir)
+		})
+	}
+}