Golang人性化格式化测试输出插件库gotestfmt的使用

gotestfmt是一个用于格式化Golang测试输出的工具，它能将原始的go test输出转换为更易读、结构化的格式。

安装gotestfmt

手动安装

你可以从发布页面手动下载二进制文件，这些文件没有依赖，可以在列出的任何操作系统上运行。

使用go install

go install github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest

使用容器

go test -json ./... | docker run ghcr.io/gotesttools/gotestfmt:latest

基本使用

set -euo pipefail
go test -json -v ./... 2>&1 | tee /tmp/gotest.log | gotestfmt

这个命令会：

1. 运行go test并输出JSON格式的结果
2. 同时将原始日志保存到/tmp/gotest.log
3. 通过管道将输出传递给gotestfmt进行格式化

CI系统集成

GitHub Actions示例

jobs:
  build:
    name: Test
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: 1.16

      - name: Set up gotestfmt
        uses: gotesttools/gotestfmt-action@v2
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Run tests
        run: |
          set -euo pipefail
          go test -json -v ./... 2>&1 | tee /tmp/gotest.log | gotestfmt

      - name: Upload test log
        uses: actions/upload-artifact@v2
        if: always()
        with:
          name: test-log
          path: /tmp/gotest.log
          if-no-files-found: error

自定义输出

你可以通过创建.gotestfmt文件夹并添加以下模板文件来自定义输出：

1. downloads.tpl - 控制包下载的输出
2. package.tpl - 控制单个包测试结果的输出

常见问题

如何减少输出冗余？

使用-hide参数可以隐藏某些输出：

gotestfmt -hide "successful-tests,successful-downloads"

如何格式化测试中的日志行？

从v2.2.0开始支持外部格式化器：

go test -json -v ./... 2>&1 | gotestfmt -formatter "/path/to/your/formatter"

为什么gotestfmt会以非零状态退出？

从v2.3.0开始，当测试失败时gotestfmt会返回非零退出状态。可以使用-nofail参数禁用此行为。

示例项目结构

project/
├── .github/
│   └── workflows/
│       └── test.yml    # GitHub Actions配置文件
├── .gotestfmt/         # 自定义模板目录(可选)
│   ├── downloads.tpl
│   └── package.tpl
├── go.mod
├── go.sum
└── ...                 # 你的项目代码

gotestfmt通过解析go test -json的输出并将其重新格式化为更易读的形式，特别适合在CI系统中使用，能显著提高测试结果的可读性。