Merge pull request #413 from buildkite/fix-custom-runner-cmd-interpolation

Fix custom runner cmd interpolation

Author: nprizal

internal/runner/command.go

@@ -5,7 +5,6 @@ import (
 	"os"
 	"os/exec"
 	"os/signal"
-	"strings"
 	"syscall"
 )
 
@@ -18,7 +17,7 @@ func runAndForwardSignal(cmd *exec.Cmd) error {
 	finishCh := make(chan struct{})
 	defer close(finishCh)
 
-	fmt.Println(strings.Join(cmd.Args, " "))
+	fmt.Println(cmd.String())
 	fmt.Println("")
 
 	if err := cmd.Start(); err != nil {

internal/runner/custom.go

@@ -4,7 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os/exec"
-	"slices"
+	"strings"
 
 	"github.com/buildkite/test-engine-client/internal/debug"
 	"github.com/buildkite/test-engine-client/internal/plan"
@@ -87,7 +87,7 @@ func (r Custom) Run(result *RunResult, testCases []plan.TestCase, retry bool) er
 	tests, parseErr := parseTestEngineTestResult(r.ResultPath)
 
 	if parseErr != nil {
-		fmt.Printf("Buildkite Test Engine Client: Failed to read json output: %v", parseErr)
+		fmt.Println("Buildkite Test Engine Client: Failed to read json output:", parseErr)
 		return err
 	}
 
@@ -108,15 +108,12 @@ func (r Custom) Run(result *RunResult, testCases []plan.TestCase, retry bool) er
 }
 
 func (r Custom) commandNameAndArgs(cmd string, testCases []string) (string, []string, error) {
+	cmd = strings.Replace(cmd, "{{testExamples}}", strings.Join(testCases, " "), 1)
+
 	words, err := shellquote.Split(cmd)
 	if err != nil {
 		return "", []string{}, err
 	}
-	idx := slices.Index(words, "{{testExamples}}")
-
-	if idx >= 0 {
-		words = slices.Replace(words, idx, idx+1, testCases...)
-	}
 
 	return words[0], words[1:], nil
 }

internal/runner/custom_test.go

@@ -80,31 +80,48 @@ func TestCustom_GetFiles(t *testing.T) {
 }
 
 func TestCustom_CommandNameAndArgs(t *testing.T) {
-	custom, err := NewCustom(RunnerConfig{
-		TestCommand:     "bin/test -- {{testExamples}}",
-		TestFilePattern: "tests/**/test_*.sh",
-	})
-
-	if err != nil {
-		t.Fatalf("Failed to create Custom runner: %v", err)
-	}
-
 	testCases := []string{"tests/test_a.sh", "tests/test_b.sh"}
 
-	gotName, gotArgs, err := custom.commandNameAndArgs(custom.TestCommand, testCases)
-	if err != nil {
-		t.Errorf("Custom.cmdNameAndArgs() error = %v", err)
-	}
+	commands := []struct {
+		command  string
+		wantName string
+		wantArgs []string
+	}{
+		{
+			command:  "bin/test -- {{testExamples}}",
+			wantName: "bin/test",
+			wantArgs: []string{"--", "tests/test_a.sh", "tests/test_b.sh"},
+		},
+		{
+			command:  "rake test TEST_FILES='{{testExamples}}'",
+			wantName: "rake",
+			wantArgs: []string{"test", "TEST_FILES=tests/test_a.sh tests/test_b.sh"},
+		},
+	}
+
+	for _, tc := range commands {
+
+		custom, err := NewCustom(RunnerConfig{
+			TestCommand:     tc.command,
+			TestFilePattern: "tests/**/test_*.sh",
+		})
 
-	wantName := "bin/test"
-	wantArgs := []string{"--", "tests/test_a.sh", "tests/test_b.sh"}
+		if err != nil {
+			t.Fatalf("Failed to create Custom runner: %v", err)
+		}
 
-	if gotName != wantName {
-		t.Errorf("Custom.cmdNameAndArgs() name = %v, want %v", gotName, wantName)
-	}
+		gotName, gotArgs, err := custom.commandNameAndArgs(custom.TestCommand, testCases)
+		if err != nil {
+			t.Errorf("Custom.cmdNameAndArgs(%q, testCases) error = %v", tc.command, err)
+		}
+
+		if gotName != tc.wantName {
+			t.Errorf("Custom.cmdNameAndArgs(%q, testCases) name = %v, want %v", tc.command, gotName, tc.wantName)
+		}
 
-	if diff := cmp.Diff(gotArgs, wantArgs); diff != "" {
-		t.Errorf("Custom.cmdNameAndArgs() args diff (-got +want):\n%s", diff)
+		if diff := cmp.Diff(gotArgs, tc.wantArgs); diff != "" {
+			t.Errorf("Custom.cmdNameAndArgs(%q, testCases) args diff (-got +want):\n%s", tc.command, diff)
+		}
 	}
 }
 

internal/runner/pytest.go

@@ -79,7 +79,7 @@ func (p Pytest) Run(result *RunResult, testCases []plan.TestCase, retry bool) er
 	tests, parseErr := parseTestEngineTestResult(p.ResultPath)
 
 	if parseErr != nil {
-		fmt.Printf("Buildkite Test Engine Client: Failed to read json output, failed tests will not be retried: %v", parseErr)
+		fmt.Println("Buildkite Test Engine Client: Failed to read json output, failed tests will not be retried:", parseErr)
 		return err
 	}
 

internal/runner/pytest_pants.go

@@ -80,7 +80,7 @@ func (p PytestPants) Run(result *RunResult, testCases []plan.TestCase, retry boo
 	tests, parseErr := parseTestEngineTestResult(p.ResultPath)
 
 	if parseErr != nil {
-		fmt.Printf("Buildkite Test Engine Client: Failed to read json output, failed tests will not be retried: %v", parseErr)
+		fmt.Println("Buildkite Test Engine Client: Failed to read json output, failed tests will not be retried:", parseErr)
 		return err
 	}