Golang中cmd.Start()-cmd.Wait()执行失败仅返回退出状态，需获取错误原因

问题场景 #

使用cmd.Start()和cmd.Wait()执行外部命令时，仅能获取到命令的退出状态错误，无法拿到命令本身输出的具体错误信息。尝试通过重定向Stderr到bytes.Buffer捕获错误时，部分命令会出现ContextDeadlineExceed问题，导致无法正常获取错误原因。

原代码实现：

cmd := command(comm, args...)
err := cmd.Start()

if err != nil {
    return fmt.Errorf("Mount: cmd start failed: <%s>\nargs: <%s>\nerror: <%v>", comm, args, err)
}
err = cmd.Wait()
if err != nil {
    return fmt.Errorf("Mount: cmd wait failed: <%s>\nargs: <%s>\nerror: <%v>", comm, args, err)
}

尝试重定向Stderr的代码片段：

var stderr bytes.Buffer
cmd.Stderr = &stderr

解决思路与完整实现 #

核心是结合上下文超时控制、异步等待命令执行、确保命令终止后收集完整输出，避免超时错误覆盖实际命令输出。

package main

import (
	"bytes"
	"context"
	"fmt"
	"os/exec"
	"time"
)

func runCommandWithTimeout(ctx context.Context, comm string, args ...string) error {
	var stdout, stderr bytes.Buffer

	// 绑定上下文的命令，超时后自动触发终止信号
	cmd := exec.CommandContext(ctx, comm, args...)
	cmd.Stdout = &stdout
	cmd.Stderr = &stderr

	// 启动命令
	if err := cmd.Start(); err != nil {
		return fmt.Errorf("启动命令失败: 命令<%s>, 参数<%v>, 错误<%v>", comm, args, err)
	}

	// 异步等待命令执行完成
	done := make(chan error, 1)
	go func() {
		done <- cmd.Wait()
	}()

	select {
	case err := <-done:
		if err != nil {
			// 命令执行失败，拼接stderr输出
			return fmt.Errorf("命令执行失败: 命令<%s>, 参数<%v>, 错误<%v>, 标准错误输出:\n%s", comm, args, err, stderr.String())
		}
		return nil
	case <-ctx.Done():
		// 超时后强制杀死进程，避免僵尸进程
		if killErr := cmd.Process.Kill(); killErr != nil {
			return fmt.Errorf("超时后终止命令失败: 命令<%s>, 参数<%v>, 错误<%v>", comm, args, killErr)
		}
		// 等待进程退出，确保输出缓冲区被读取
		<-done
		return fmt.Errorf("命令执行超时: 命令<%s>, 参数<%v>, 已收集的标准错误输出:\n%s", comm, args, stderr.String())
	}
}

// 示例调用
func main() {
	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
	defer cancel()

	// 执行一个会超时的命令
	if err := runCommandWithTimeout(ctx, "sleep", "5"); err != nil {
		fmt.Println(err)
	}
}

方案说明 #

1. 上下文绑定：使用exec.CommandContext将命令与上下文关联，当上下文超时或被取消时，命令会收到终止信号，避免命令无限制运行。
2. 输出捕获：同时捕获Stdout和Stderr，防止因输出缓冲区未读取导致命令阻塞（部分命令会大量输出内容，不读取会卡住进程）。
3. 异步等待：通过goroutine异步执行cmd.Wait()，结合select同时监听命令完成和上下文超时事件，确保两种场景都能正确处理。
4. 超时处理：超时后先强制杀死进程，再等待进程退出，确保已输出的错误信息被完整收集，不会被ContextDeadlineExceed错误覆盖。

内容的提问来源于stack exchange，提问作者ambikanair