go-junit-report 技术文档

1. 安装指南

从包安装（推荐）

可以在 Releases 页面找到预构建的 Windows、macOS 和 Linux 包。

从源码安装

下载并安装最新稳定版本的源码，运行以下命令：

go install github.com/jstemmer/go-junit-report/v2@latest

2. 项目使用说明

go-junit-report 是一个工具，用于将 go test 输出转换为与 JUnit 兼容的 XML 报告，适合与 Jenkins 等应用程序一起使用。

默认情况下，go-junit-report 从标准库的 testing 包读取 go test -v 输出，并将 JUnit XML 报告写入 stdout。

如果要支持 Go 构建和运行时错误，需要将 stderr 重定向到 go-junit-report。

典型的使用方式如下：

go test -v 2>&1 ./... | go-junit-report -set-exit-code > report.xml

更多示例

• go test -json 产生的 JSON 格式输出由 gojson 解析器支持。注意，stderr 仍需重定向到 go-junit-report 以检测构建错误。

go test -json 2>&1 | go-junit-report -parser gojson > report.xml

• Go 的基准测试输出也受支持。以下示例在当前目录中运行基准测试，并使用 -out 标志将输出写入名为 report.xml 的文件。

go test -v -bench . -count 5 2>&1 | go-junit-report -out report.xml

• -iocopy 标志直接将 stdin 复制到 stdout，这有助于查看发送到 go-junit-report 的内容。以下示例从名为 tests.txt 的文件读取测试输入，将输入复制到 stdout 并将输出写入名为 report.xml 的文件。

go-junit-report -in tests.txt -iocopy -out report.xml

标志

运行 go-junit-report -help 可查看所有支持的标志。

标志	描述
-in file	从 file 读取 go test 日志
-iocopy	将输入复制到 stdout；仅与 -out 结合使用
-no-xml-header	不打印 XML 头部
-out file	将 XML 报告写入 file
-package-name name	如果输出不包含包名，指定默认包名使用
-parser parser	指定解析器，可用解析器有：gotest (默认)，gojson
-p key=value	将属性添加到生成的报告；属性应指定为 key=value
-set-exit-code	如果测试失败，设置退出码为 1
-subtest-mode	设置子测试模式，模式有：ignore-parent-results，exclude-parents
-version	打印版本信息并退出

3. 项目API使用文档

项目的测试输出解析器和 JUnit XML 报告生成器也可作为 Go 包使用。这对于想要使用 go test 输出解析器或创建自定义 JUnit 报告的用户非常有用。有关更多信息，请参考 pkg.go.dev 上的包文档：

• github.com/jstemmer/go-junit-report/v2/parser/gotest
• github.com/jstemmer/go-junit-report/v2/junit

4. 项目安装方式

请参考上述“安装指南”部分。