首页
/ go-junit-report 技术文档

go-junit-report 技术文档

2024-12-29 09:09:20作者:魏献源Searcher

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-resultsexclude-parents
-version 打印版本信息并退出

3. 项目API使用文档

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

4. 项目安装方式

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

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
536
407
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
121
207
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
400
37
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.03 K
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
252
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
358
342
CS-BooksCS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
58
7
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
51
55