clarify output limits and proxy test

Author: theodore-s-beers

checks/cli.go

@@ -17,9 +17,9 @@ import (
 )
 
 const (
-	cliCommandTimeout = 5 * time.Minute
-	maxCLIOutputBytes = 1024 * 1024
-	commandWaitDelay  = 2 * time.Second
+	cliCommandTimeout          = 5 * time.Minute
+	maxCLIOutputBytesPerStream = 1024 * 1024
+	commandWaitDelay           = 2 * time.Second
 )
 
 var errCLIOutputLimitExceeded = errors.New("CLI command output limit exceeded")
@@ -63,14 +63,14 @@ func (b *boundedBuffer) Truncated() bool {
 }
 
 func runCLICommand(command api.CLIStepCLICommand, variables map[string]string) (result api.CLICommandResult) {
-	return runCLICommandWithLimits(command, variables, cliCommandTimeout, maxCLIOutputBytes)
+	return runCLICommandWithLimits(command, variables, cliCommandTimeout, maxCLIOutputBytesPerStream)
 }
 
 func runCLICommandWithLimits(
 	command api.CLIStepCLICommand,
 	variables map[string]string,
 	timeout time.Duration,
-	maxOutputBytes int,
+	maxOutputBytesPerStream int,
 ) (result api.CLICommandResult) {
 	finalCommand := InterpolateVariables(command.Command, variables)
 	result.FinalCommand = finalCommand
@@ -94,8 +94,8 @@ func runCLICommandWithLimits(
 	cancelForOutputLimit := func() {
 		cancelCommand(errCLIOutputLimitExceeded)
 	}
-	stdout := newBoundedBuffer(maxOutputBytes, cancelForOutputLimit)
-	stderr := newBoundedBuffer(maxOutputBytes, cancelForOutputLimit)
+	stdout := newBoundedBuffer(maxOutputBytesPerStream, cancelForOutputLimit)
+	stderr := newBoundedBuffer(maxOutputBytesPerStream, cancelForOutputLimit)
 	cmd.Stdout = stdout
 	cmd.Stderr = stderr
 	err := cmd.Run()
@@ -112,7 +112,7 @@ func runCLICommandWithLimits(
 
 	switch {
 	case errors.Is(context.Cause(ctx), errCLIOutputLimitExceeded):
-		result.Err = fmt.Sprintf("command output exceeded the %d-byte limit", maxOutputBytes)
+		result.Err = fmt.Sprintf("command output exceeded the %d-byte per-stream limit", maxOutputBytesPerStream)
 		result.ExitCode = -2
 	case errors.Is(context.Cause(ctx), context.DeadlineExceeded):
 		result.Err = fmt.Sprintf("command timed out after %s", timeout)

checks/cli_test.go

@@ -57,8 +57,8 @@ func TestRunCLICommandCapsOutput(t *testing.T) {
 	)
 	elapsed := time.Since(start)
 
-	if !strings.Contains(result.Err, "command output exceeded") {
-		t.Fatalf("command error = %q, want output limit error", result.Err)
+	if !strings.Contains(result.Err, "per-stream limit") {
+		t.Fatalf("command error = %q, want per-stream output limit error", result.Err)
 	}
 	if result.ExitCode >= 0 {
 		t.Fatalf("exit code = %d, want internal failure", result.ExitCode)

version/version_test.go

@@ -11,12 +11,33 @@ import (
 )
 
 func TestGetLatestVersionRespectsGoProxyOff(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("test uses a POSIX executable script")
+	}
+
+	dir := t.TempDir()
+	fakeGo := filepath.Join(dir, "go")
+	script := `#!/bin/sh
+if [ "$GOPROXY" != "off" ]; then
+	echo "unexpected GOPROXY: $GOPROXY" >&2
+	exit 1
+fi
+printf '{"Version":"v1.2.3"}'
+`
+	if err := os.WriteFile(fakeGo, []byte(script), 0o755); err != nil {
+		t.Fatalf("create fake go command: %v", err)
+	}
+	t.Setenv("PATH", dir)
 	t.Setenv("GOPROXY", "off")
 	t.Setenv("GOPRIVATE", "")
 	t.Setenv("GONOPROXY", "none")
 
-	if _, err := getLatestVersionWithTimeout(time.Second); err == nil {
-		t.Fatal("expected GOPROXY=off to prevent the version lookup")
+	latest, err := getLatestVersionWithTimeout(time.Second)
+	if err != nil {
+		t.Fatalf("get latest version: %v", err)
+	}
+	if latest != "v1.2.3" {
+		t.Fatalf("latest version = %q, want v1.2.3", latest)
 	}
 }