使用os/exec测试golang的cli工具，需先创建cmd对象并指定命令及参数，如cmd := exec.command(“mycli”, “–version”)；接着通过output()、combinedoutput()或run()执行命令并获取结果；检查退出状态码判断命令是否成功，0为成功，非0为失败；模拟用户输入可通过stdinpipe写入输入流；编写可维护测试建议封装函数并采用表格驱动测试；并发测试可用sync.waitgroup协调；避免文件系统副作用可利用testing.tempdir创建临时目录；模拟环境变量则使用os.setenv和os.unsetenv，并在测试后恢复原值。
测试Golang的CLI工具，核心在于模拟用户与命令行程序的交互，验证其功能是否符合预期。
os/exec
包提供了一种直接且强大的方式来实现这一点，它允许你在测试代码中执行外部命令，并检查其输出、退出状态等。
使用
os/exec
模拟命令行交互
测试CLI工具，不只是验证代码逻辑，更要确保它在实际使用场景下的表现。
os/exec
就是模拟这种场景的利器。
立即学习“go语言免费学习笔记（深入）”；
如何使用
os/exec
os/exec
执行命令？
首先，你需要创建一个
Cmd
对象，指定要执行的命令及其参数。例如，假设你的CLI工具名为
mycli
，你想测试它的
--version
选项：
cmd := exec.Command("mycli", "--version")
然后，你可以通过
cmd.Output()
、
cmd.CombinedOutput()
或
cmd.Run()
来执行命令并获取结果。
Output()
返回标准输出，
CombinedOutput()
返回标准输出和标准错误输出，
Run()
执行命令并返回错误（如果有）。
output, err := cmd.Output() if err != nil { // 处理错误，例如命令不存在或执行失败 log.Fatal(err) } fmt.Println(string(output)) // 打印输出
如何检查命令的退出状态？
命令的退出状态码可以告诉你命令是否成功执行。通常，0表示成功，非0表示失败。你可以通过检查
error
对象来获取退出状态码。
cmd := exec.Command("mycli", "some-command") err := cmd.Run() if err != nil { if exitError, ok := err.(*exec.ExitError); ok { // 命令执行失败 exitCode := exitError.ExitCode() fmt.Printf("命令执行失败，退出状态码: %dn", exitCode) } else { // 其他错误 log.Fatal(err) } } else { // 命令执行成功 fmt.Println("命令执行成功") }
如何模拟用户输入？
有些CLI工具需要用户输入。你可以使用
cmd.Stdin
来模拟用户输入。例如：
cmd := exec.Command("mycli", "interactive-command") stdin, err := cmd.StdinPipe() if err != nil { log.Fatal(err) } go func() { defer stdin.Close() io.WriteString(stdin, "some inputn") // 模拟用户输入 }() output, err := cmd.CombinedOutput() if err != nil { log.Fatal(err) } fmt.Println(string(output))
这里，我们创建了一个
stdin
管道，并在一个goroutine中向其写入模拟的用户输入。
如何编写可维护的测试？
测试代码也需要可维护性。将测试逻辑封装成函数，并使用表格驱动测试，可以提高测试代码的可读性和可维护性。
例如：
func TestMyCLI(t *testing.T) { testCases := []struct { name string command []string input string expectedOut string expectedErr error }{ { name: "version", command: []string{"--version"}, expectedOut: "mycli v1.0.0n", expectedErr: nil, }, { name: "interactive", command: []string{"interactive-command"}, input: "some inputn", expectedOut: "Received: some inputn", expectedErr: nil, }, } for _, tc := range testCases { t.Run(tc.name, func(t *testing.T) { cmd := exec.Command("mycli", tc.command...) if tc.input != "" { stdin, err := cmd.StdinPipe() if err != nil { t.Fatal(err) } go func() { defer stdin.Close() io.WriteString(stdin, tc.input) }() } output, err := cmd.CombinedOutput() if tc.expectedErr != nil { assert.Error(t, err, "Expected error") } else { assert.NoError(t, err, "Unexpected error") } assert.Equal(t, tc.expectedOut, string(output), "Unexpected output") }) } }
如何处理并发测试？
如果你的CLI工具涉及并发操作，你需要确保你的测试也能正确处理并发情况。可以使用
sync
包提供的工具，例如
WaitGroup
，来等待所有并发操作完成。
如何避免测试中的文件系统副作用？
CLI工具经常需要读写文件。在测试中，为了避免对真实文件系统产生副作用，可以使用临时目录。
testing.T
提供了
TempDir()
方法，可以创建一个临时的目录，并在测试结束后自动删除。
tempDir := t.TempDir() // 在tempDir中创建文件，进行测试
如何模拟不同的环境变量？
CLI工具可能依赖环境变量。你可以使用
os.Setenv()
和
os.Unsetenv()
来设置和取消环境变量，并在测试结束后恢复原始环境变量。
originalValue := os.Getenv("MY_ENV_VAR") os.Setenv("MY_ENV_VAR", "test value") defer func() { if originalValue != "" { os.Setenv("MY_ENV_VAR", originalValue) } else { os.Unsetenv("MY_ENV_VAR") } }()
这样，你就可以在测试中模拟不同的环境变量，确保CLI工具在各种环境下都能正常工作。
评论（已关闭）
评论已关闭