nhyatt/go-junit-report
1
0
Fork 0
mirror of https://github.com/jstemmer/go-junit-report.git synced 2025-04-05 05:00:15 -05:00
Code Issues Projects Releases Wiki Activity

Update README.md and mention support for go test -json + example

Browse Source
This commit is contained in:
Joël Stemmer 2022-04-02 00:41:20 +01:00
parent 1b70a28601
commit c289a62ec0
1 changed files with 26 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -28,39 +28,49 @@ 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.
By default, go-junit-report reads `go test -v` output generated by the standard
library [testing] package from `stdin` and writes a JUnit XML report to
`stdout`.
### Examples
Go build and runtime errors are also supported, but this requires that `stderr`
is redirected to go-junit-report as well.
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.
Typical use looks like this:
```bash
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`.
### More examples
JSON produced by `go test -json` is supported by the `gojson` parser. Note that
`stderr` still needs to be redirected to go-junit-report in order for build
errors to be detected. For example:
```bash
go test -json 2>&1 | go-junit-report -parser gojson > report.xml
```
Go benchmark output is also supported. The following example runs benchmarks for
the package in the current directory and uses the `-out` flag to write the
output to a file called `report.xml`.
```bash
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`.
The `-iocopy` flag copies `stdin` directly to `stdout`, which is helpful if you
want to see what was sent to go-junit-report. The following example reads test
input from a file called `tests.txt`, copies the input to `stdout` and writes
the output to a file called `report.xml`.
```bash
go-junit-report -in tests.txt -iocopy -out report.xml
```
### Options
### Flags
Run `go-junit-report -help` for a list of all supported options.
Run `go-junit-report -help` for a list of all supported flags.
| Flag | Description |
| -------------------- | ----------- |
@ -69,6 +79,7 @@ Run `go-junit-report -help` for a list of all supported options.
| `-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 |
| `-parser parser` | specify the parser to use, available parsers are: `gotest` (default)`, `gojson` |
| `-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 |