Merge pull request #4111 from apostasie/ci-fix-debug

[CI]: quality of life: minor debugging output fixes

Author: AkihiroSuda

mod/tigron/internal/com/command.go

@@ -70,6 +70,7 @@ type Result struct {
 	Stderr   string
 	ExitCode int
 	Signal   os.Signal
+	Duration time.Duration
 }
 
 type execution struct {
@@ -102,9 +103,10 @@ type Command struct {
 	ptyStderr bool
 	ptyStdin  bool
 
-	exec   *execution
-	mutex  sync.Mutex
-	result *Result
+	exec      *execution
+	mutex     sync.Mutex
+	result    *Result
+	startTime time.Time
 }
 
 // Clone does just duplicate a command, resetting its execution.
@@ -184,12 +186,12 @@ func (gc *Command) Run(parentCtx context.Context) error {
 	)
 
 	// Get a timing-out context
-	timeout := gc.Timeout
-	if timeout == 0 {
-		timeout = defaultTimeout
+	if gc.Timeout == 0 {
+		gc.Timeout = defaultTimeout
 	}
 
-	ctx, ctxCancel = context.WithTimeout(parentCtx, timeout)
+	ctx, ctxCancel = context.WithTimeout(parentCtx, gc.Timeout)
+	gc.startTime = time.Now()
 
 	// Create a contextual command, set the logger
 	cmd = gc.buildCommand(ctx)
@@ -366,6 +368,7 @@ func (gc *Command) wrap() error {
 		Stderr:   pipes.fromStderr,
 		Environ:  cmd.Environ(),
 		Signal:   signal,
+		Duration: time.Since(gc.startTime),
 	}
 
 	if gc.exec.err == nil {

mod/tigron/internal/formatter/formatter.go

@@ -108,7 +108,10 @@ func chunk(s string, maxLength, maxLines int) []string {
 	}
 
 	if len(chunks) > maxLines {
-		chunks = append(chunks[0:maxLines], "...")
+		abbreviator := "..."
+		chunks = append(
+			append(chunks[0:maxLines/2], abbreviator+strings.Repeat(spacer, maxLength-len(abbreviator))),
+			chunks[len(chunks)-maxLines/2:]...)
 	} else if len(chunks) == 0 {
 		chunks = []string{strings.Repeat(spacer, maxLength)}
 	}

mod/tigron/test/case.go

@@ -233,7 +233,7 @@ func (test *Case) Run(t *testing.T) {
 				"\n\n" + formatter.Table(
 					[][]any{
 						{startDecorator, fmt.Sprintf("%q: starting test!", test.t.Name())},
-						{"cwd", test.Data.TempDir()},
+						{"temp", test.Data.TempDir()},
 						{"config", string(debugConfig)},
 						{"data", string(debugData)},
 					},

mod/tigron/test/command.go

@@ -39,6 +39,10 @@ const (
 	exitDecorator           = "⚠️"
 	stdoutDecorator         = "🟢"
 	stderrDecorator         = "🟠"
+	timeoutDecorator        = "⏰"
+	cwdDecorator            = "📁"
+	envDecorator            = "🌱"
+	sigDecorator            = "⚡"
 )
 
 // CustomizableCommand is an interface meant for people who want to heavily customize the base
@@ -138,6 +142,10 @@ func (gc *GenericCommand) WithBlacklist(env []string) {
 	gc.cmd.EnvBlackList = env
 }
 
+func (gc *GenericCommand) WithWhitelist(env []string) {
+	gc.cmd.EnvWhiteList = env
+}
+
 func (gc *GenericCommand) WithTimeout(timeout time.Duration) {
 	gc.cmd.Timeout = timeout
 }
@@ -193,12 +201,18 @@ func (gc *GenericCommand) Run(expect *Expected) {
 		}
 
 		if result.Signal != nil {
-			debug = append(debug, []any{"Signal", result.Signal.String()})
+			debug = append(debug, []any{"", sigDecorator + " " + result.Signal.String()})
+		}
+
+		duration := result.Duration.String()
+		if result.Duration < time.Second {
+			duration = "<1s"
 		}
 
 		debug = append(debug,
-			[]any{"Limit", gc.cmd.Timeout},
-			[]any{"Environ", strings.Join(result.Environ, "\n")},
+			[]any{envDecorator, strings.Join(result.Environ, "\n")},
+			[]any{timeoutDecorator, duration + " (limit: " + gc.cmd.Timeout.String() + ")"},
+			[]any{cwdDecorator, gc.cmd.WorkingDir},
 		)
 	}
 

pkg/testutil/nerdtest/command.go

@@ -82,17 +82,14 @@ func newNerdCommand(conf test.Config, t *testing.T) *nerdCommand {
 	}
 
 	ret.WithBinary(binary)
-	// Not interested in these - and insulate us from parent environment side effects
-	ret.WithBlacklist([]string{
-		"LS_COLORS",
-		"DOCKER_CONFIG",
-		"CONTAINERD_SNAPSHOTTER",
-		"NERDCTL_TOML",
-		"CONTAINERD_ADDRESS",
-		"CNI_PATH",
-		"NETCONFPATH",
-		"NERDCTL_EXPERIMENTAL",
-		"NERDCTL_HOST_GATEWAY_IP",
+	ret.WithWhitelist([]string{
+		"PATH",
+		"HOME",
+		"XDG_*",
+		// Windows needs ProgramData, AppData, etc
+		"Program*",
+		"PROGRAM*",
+		"APPDATA",
 	})
 	return ret
 }