chore: replace PPRemoveAbsolutePaths with generic fixture template data

Author: pd93

executor_test.go

@@ -50,7 +50,8 @@ func NewExecutorTest(t *testing.T, opts ...ExecutorTestOption) {
 		task: "default",
 		vars: map[string]any{},
 		TaskTest: TaskTest{
-			experiments: map[*experiments.Experiment]int{},
+			experiments:         map[*experiments.Experiment]int{},
+			fixtureTemplateData: map[string]any{},
 		},
 	}
 	// Apply the functional options
@@ -232,7 +233,6 @@ func TestEmptyTaskfile(t *testing.T) {
 			task.WithDir("testdata/empty_taskfile"),
 		),
 		WithSetupError(),
-		WithPostProcessFn(PPRemoveAbsolutePaths),
 	)
 }
 
@@ -367,7 +367,6 @@ func TestSpecialVars(t *testing.T) {
 					task.WithVersionCheck(true),
 				),
 				WithTask(test),
-				WithPostProcessFn(PPRemoveAbsolutePaths),
 			)
 		}
 	}
@@ -551,7 +550,6 @@ func TestStatus(t *testing.T) {
 			task.WithVerbose(true),
 		),
 		WithTask("gen-silent-baz"),
-		WithPostProcessFn(PPRemoveAbsolutePaths),
 	)
 }
 
@@ -777,7 +775,6 @@ func TestForCmds(t *testing.T) {
 				task.WithForce(true),
 			),
 			WithTask(test.name),
-			WithPostProcessFn(PPRemoveAbsolutePaths),
 		}
 		if test.wantErr {
 			opts = append(opts, WithRunError())
@@ -822,7 +819,6 @@ func TestForDeps(t *testing.T) {
 				task.WithOutputStyle(ast.Output{Name: "group"}),
 			),
 			WithTask(test.name),
-			WithPostProcessFn(PPRemoveAbsolutePaths),
 			WithPostProcessFn(PPSortedLines),
 		}
 		if test.wantErr {

formatter_test.go

@@ -44,7 +44,8 @@ func NewFormatterTest(t *testing.T, opts ...FormatterTestOption) {
 		task: "default",
 		vars: map[string]any{},
 		TaskTest: TaskTest{
-			experiments: map[*experiments.Experiment]int{},
+			experiments:         map[*experiments.Experiment]int{},
+			fixtureTemplateData: map[string]any{},
 		},
 	}
 	// Apply the functional options
@@ -222,19 +223,12 @@ func TestListDescInterpolation(t *testing.T) {
 func TestJsonListFormat(t *testing.T) {
 	t.Parallel()
 
-	fp, err := filepath.Abs("testdata/json_list_format/Taskfile.yml")
-	require.NoError(t, err)
 	NewFormatterTest(t,
 		WithExecutorOptions(
 			task.WithDir("testdata/json_list_format"),
 		),
 		WithListOptions(task.ListOptions{
 			FormatTaskListAsJSON: true,
 		}),
-		WithFixtureTemplateData(struct {
-			TaskfileLocation string
-		}{
-			TaskfileLocation: fp,
-		}),
 	)
 }

task_test.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"io"
 	"io/fs"
+	"maps"
 	rand "math/rand/v2"
 	"net/http"
 	"net/http/httptest"
@@ -45,7 +46,7 @@ type (
 		name                string
 		experiments         map[*experiments.Experiment]int
 		postProcessFns      []PostProcessFn
-		fixtureTemplateData any
+		fixtureTemplateData map[string]any
 	}
 )
 
@@ -80,11 +81,18 @@ func (tt *TaskTest) writeFixture(
 	if goldenFileSuffix != "" {
 		goldenFileName += "-" + goldenFileSuffix
 	}
+	// Create a set of data to be made available to every test fixture
+	wd, err := os.Getwd()
+	require.NoError(t, err)
+	fixtureTemplateData := map[string]any{
+		"TEST_NAME": t.Name(),
+		"TEST_DIR":  wd,
+	}
+	// If the test has additional template data, copy it into the map
 	if tt.fixtureTemplateData != nil {
-		g.AssertWithTemplate(t, goldenFileName, tt.fixtureTemplateData, b)
-	} else {
-		g.Assert(t, goldenFileName, b)
+		maps.Copy(fixtureTemplateData, tt.fixtureTemplateData)
 	}
+	g.AssertWithTemplate(t, goldenFileName, fixtureTemplateData, b)
 }
 
 // writeFixtureBuffer is a wrapper for writing the main output of the task to a
@@ -243,20 +251,21 @@ func (opt *setupErrorTestOption) applyToFormatterTest(t *FormatterTest) {
 // template. Useful if the golden file can change depending on the test.
 // Example template: {{ .Value }}
 // Example data definition: struct{ Value string }{Value: "value"}
-func WithFixtureTemplateData(data any) TestOption {
-	return &fixtureTemplateDataTestOption{data: data}
+func WithFixtureTemplateData(k string, v any) TestOption {
+	return &fixtureTemplateDataTestOption{k, v}
 }
 
 type fixtureTemplateDataTestOption struct {
-	data any
+	k string
+	v any
 }
 
 func (opt *fixtureTemplateDataTestOption) applyToExecutorTest(t *ExecutorTest) {
-	t.fixtureTemplateData = opt.data
+	t.fixtureTemplateData[opt.k] = opt.v
 }
 
 func (opt *fixtureTemplateDataTestOption) applyToFormatterTest(t *FormatterTest) {
-	t.fixtureTemplateData = opt.data
+	t.fixtureTemplateData[opt.k] = opt.v
 }
 
 // Post-processing
@@ -265,17 +274,6 @@ func (opt *fixtureTemplateDataTestOption) applyToFormatterTest(t *FormatterTest)
 // fixture before the file is written.
 type PostProcessFn func(*testing.T, []byte) []byte
 
-// PPRemoveAbsolutePaths removes any absolute paths from the output of the task.
-// This is useful when the task output contains paths that are can be different
-// in different environments such as home directories. The function looks for
-// any paths that contain the current working directory and truncates them.
-func PPRemoveAbsolutePaths(t *testing.T, b []byte) []byte {
-	t.Helper()
-	wd, err := os.Getwd()
-	require.NoError(t, err)
-	return bytes.ReplaceAll(b, []byte(wd), nil)
-}
-
 // PPSortedLines sorts the lines of the output of the task. This is useful when
 // the order of the output is not important, but the output is expected to be
 // the same each time the task is run (e.g. when running tasks in parallel).

testdata/empty_taskfile/testdata/TestEmptyTaskfile-err-setup.golden

@@ -1 +1 @@
-task: Missing schema version in Taskfile "/testdata/empty_taskfile/Taskfile.yml"
+task: Missing schema version in Taskfile "{{ .TEST_DIR }}/testdata/empty_taskfile/Taskfile.yml"

testdata/for/cmds/testdata/TestForCmds-loop-matrix-ref-error-err-run.golden

@@ -1,2 +1,2 @@
-task: Failed to parse /testdata/for/cmds/Taskfile.yml:
+task: Failed to parse {{ .TEST_DIR }}/testdata/for/cmds/Taskfile.yml:
 matrix reference ".NOT_A_LIST" must resolve to a list

testdata/for/deps/testdata/TestForDeps-loop-matrix-ref-error-err-run.golden

@@ -1,2 +1,2 @@
 matrix reference ".NOT_A_LIST" must resolve to a list
-task: Failed to parse /testdata/for/deps/Taskfile.yml:
+task: Failed to parse {{ .TEST_DIR }}/testdata/for/deps/Taskfile.yml:

testdata/json_list_format/testdata/TestJsonListFormat.golden

@@ -10,9 +10,9 @@
       "location": {
         "line": 4,
         "column": 3,
-        "taskfile": "{{ .TaskfileLocation }}"
+        "taskfile": "{{ .TEST_DIR }}/testdata/json_list_format/Taskfile.yml"
       }
     }
   ],
-  "location": "{{ .TaskfileLocation }}"
+  "location": "{{ .TEST_DIR }}/testdata/json_list_format/Taskfile.yml"
 }

testdata/special_vars/subdir/testdata/TestSpecialVars-testdata-special_vars-subdir-included-print-root-dir.golden

@@ -1 +1 @@
-/testdata/special_vars
+{{ .TEST_DIR }}/testdata/special_vars

testdata/special_vars/subdir/testdata/TestSpecialVars-testdata-special_vars-subdir-included-print-taskfile-dir.golden

@@ -1 +1 @@
-/testdata/special_vars/included
+{{ .TEST_DIR }}/testdata/special_vars/included

testdata/special_vars/subdir/testdata/TestSpecialVars-testdata-special_vars-subdir-included-print-taskfile.golden

@@ -1 +1 @@
-/testdata/special_vars/included/Taskfile.yml
+{{ .TEST_DIR }}/testdata/special_vars/included/Taskfile.yml