一個命令列工具與一組函式庫,可將 Dart 測試的 JSON 輸出轉換為 JUnit XML 格式,非常適合用於 CI/CD 整合。它也提供結構化模型,以開發者友善的方式解析測試結果。專為使用 Flutter 或 Dart 專案的團隊設計,可在 Android、iOS、Web、macOS、Windows 與 Linux 等平台實現標準化的測試報告。此套件簡化了測試結果分析,並提升自動化流程中的可見性。
適用情境
CI/CD 測試報告
與 Jenkins 或 GitHub Actions 集成
產生標準化測試報告
以程式化方式解析測試結果
跨平台測試驗證
提高測試結果的可讀性
主要特色
將測試 JSON 轉換為 JUnit XML
提供開發者友善的測試結果模型
支援多個平台
輕鬆整合 CLI
可擴充的解析工具
乾淨、結構化的輸出
適合對象
使用 Flutter 和 Dart 的團隊
CI/CD 流水線開發者
測試自動化工程師
需要 JUnit 兼容性的專案
需要結構化測試資料的開發人員
使用建議
需要 Dart 測試 JSON 輸入
需要在 CI 工作流程中進行設定
僅限測試報告使用案例
不支援即時測試
依賴外部測試框架的輸出
原始 README
以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。
better_test_reporter
Introduction
This is an application/library heavily inspired by
dart-junitreport and
dart-testreport. It takes what was
done in those two packages and brings them under a single umbrella, updates to
null-safety, and makes various code style improvements.
The purpose of this package is three-fold:
Firstly, it provides models by which output from the test json
reporter
can be decoded.
Secondly, it provides a processor that will take a full json
report from the test json reporter and generate a more developer-friendly report
model structure that is agnostic to the protocol version of the test json
reporter.
Thirdly, it is a command-line application(report_to_junit) that
can be used to take in a full json report from the test json reporter and
generate a junit XML report(usable by many CI tools)
Experimental nature
This package is still experimental as we continue to build out more functionality. It's current state is barebones as we investigate ways to make the junit output more useful and ways to produce better testing reports for use outside of just junit.
Getting Started
In order to start using the report_to_junit command, install the latest
better_test_reporter as a global package via pub.dev.
pub global activate better_test_reporter
Options
Details on all options for report_to_junit can be found by running report_to_junit --help
> report_to_junit --help
-i, --input the path to the 'json' file containing the output of 'pub run test'.
if missing, <stdin> will be used
-o, --output the path of the to be generated junit xml file.
if missing, <stdout> will be used
-b, --base the part to strip from the 'path' elements in the source
(defaults to the current working directory)
-p, --package the part to prepend to the 'path' elements in the source
(defaults to "")
-t, --timestamp the timestamp to be used in the report
- 'now' will use the current date/time
- 'none' will suppress timestamps altogether
- a date formatted 'yyyy-MM-ddThh:mm:ss' will be used as UTC date/time
- if no value is provided
- if'--input' is specified the file modification date/time is used
- otherwise the current date/time is used
-h, --help display this help text
Misc
Differences from original implementation in dart-junitreport and dart-testreport
When generating the XML for a problem during a test, dart-junitreport had a
special case for only one problem occurred. The multiple problem case also
handled the case for a single problem. We found the special case for a single
problem unneeded and a little buggy, so it was removed in
better_test_reporter.
When parsing the test reporter json into a report,
dart-testreport set tests as not hidden if they encountered any problems while
running. In better_test_reporter, the hidden attribute on a test will be
purely based on whether the test was explicitly hidden based on the
TestDoneEvent json. That said, we maintained the hidden behavior for the
output junit xml by shifting that decision out of the report and up to whatever
consumes the report.
When generating the XML for a test case, better_test_reporter defaults to
stripping the current working directory out of the classname.