如何在测试中捕获 os.Stdout 的输出到字符串？

“纵有疾风来，人生不言弃”，这句话送给正在学习Golang的朋友们，也希望在阅读本文《如何在测试中捕获 os.Stdout 的输出到字符串？》后，能够真的帮助到大家。我也会在后续的文章中，陆续更新Golang相关的技术文章，有好的建议欢迎大家在评论留言，非常感谢！

我有一个函数，可以将输出生成到 os.stdout，我想对其进行单元测试。如何将输出捕获到可以在单元测试中进行比较的字符串中？

func f() {
       // How to capture "hello\n"?
      fmt.Fprintln(out, "hello")
  }

正确答案

经典测试用例方法

编写函数以采用可选的 io.writer，默认为 stdout，但允许您传入 io.writer。这将使您能够将所有输出捕获到可在测试用例中使用的 bytes.buffer 中。

// f writes to stdout, or to an io.writer if passed in.
  func f(fd ...io.writer) {
      var out io.writer
      switch len(fd) {
      case 0:
          out = os.stdout
      case 1:
          out = fd[0]
      default:
          panic("called with too many parms")
      }
      fmt.fprintln(out, "hello")
  }

当您调用不带参数的函数时，您将获得通常预期的写入 stdout 的操作。

f()       // writes to stdout

为了测试，传递一个 bytes.buffer。当函数返回时，缓冲区将包含函数写入的输出，准备测试。

var b bytes.buffer  // capture output in b
      f(&b)

      fmt.printf("<%s>\n", b.string())

此方法的另一个好处是，如果需要，该函数现在可以轻松写入 stdout 以外的目标。

演示：https://go.dev/play/p/3Kn_ht3ylE-

一种选择是使用 os.Pipe，并使用 os.stdout 恢复它。一个问题是，在并发情况下捕获/恢复 os.stdout 可能存在潜在的竞争条件，但是，出于测试目的也许可以。

func main() {
    storeStdout := os.Stdout
    r, w, _ := os.Pipe()
    os.Stdout = w

    // call f()
    // for example just print hello
    fmt.Println("hello")

    w.Close()
    out, _ := io.ReadAll(r)
    // restore the stdout
    os.Stdout = storeStdout

    fmt.Printf("Got result: %s", out)
}

Playground

相关：请注意，log.SetOutput() 可用于捕获日志记录输出。

今天关于《如何在测试中捕获 os.Stdout 的输出到字符串？》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！