0b843fc2b7
The ReportBuilder was made specifically for building a gtr.Report from parsed go test output. At this point it's unclear whether this will be reusable if we ever introduce other parser. For now let's move it closer to where it's used and let's not make it part of the public API yet.
go-junit-report
go-junit-report is a tool that converts go test output to a JUnit compatible
XML report, suitable for use with applications such as Jenkins.
The test output parser and JUnit XML report generator are also available as Go packages. This can be helpful if you want to create your own custom JUnit reports for example. See the package documentation on pkg.go.dev for more information:
Install from package (recommended)
Pre-built packages for Windows, macOS and Linux are found on the Releases page.
Install from source
Download and install the latest stable version from source by running:
go install github.com/jstemmer/go-junit-report@latest
Usage
By default, go-junit-report reads the go test -v output generated by the
standard library testing package from stdin and writes a JUnit XML report to
stdout. Go benchmark output and general Go build and runtime errors are also
supported. Note that in order to capture build and runtime errors, stderr
needs to be redirected to go-junit-report as well.
Examples
Run tests for all packages in the current directory and its subdirectories,
write the output to a file called report.xml and exit with a non-zero exit
code when encountering any test failures or build errors.
go test -v 2>&1 ./... | go-junit-report -set-exit-code > report.xml
Run benchmarks for the package in the current directory, write the output to a
file called report.xml.
go test -v -bench . -count 5 2>&1 | go-junit-report -out report.xml
Read test input from a file called tests.txt, copy the input directly to
stdout and write the report to a file called report.xml.
go-junit-report -in tests.txt -iocopy -out report.xml
Options
Run go-junit-report -help for a list of all supported options.
| Flag | Description |
|---|---|
-in file |
read go test log from file |
-iocopy |
copy input to stdout; can only be used in conjunction with -out |
-no-xml-header |
do not print xml header |
-out file |
write XML report to file |
-package-name name |
specify a default package name to use if output does not contain a package name |
-prop key=value |
add property to generated report; properties should be specified as key=value |
-set-exit-code |
set exit code to 1 if tests failed |
-version |
print version and exit |
Contributing
See CONTRIBUTING.md.