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

parser/gotest: Improve gotest output handling

Browse Source 
The reportBuilder has been updated to use the ordered output collector
to keep track of go test output. This makes it possible to include
benchmark output in the generated report and makes sure that output is
preserved when deleting subtest parents from the report.
This commit is contained in:
Joël Stemmer 2022-06-08 22:51:54 +01:00
parent 5331b9b8d6
commit cb055227b7
5 changed files with 56 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
parser/gotest/gotest_test.go
View File

@ -325,14 +325,17 @@ func TestReport(t *testing.T) {
func TestSubtestModes(t *testing.T) {
events := []Event{
{Type: "run_test", Name: "TestParent"},
{Type: "output", Data: "TestParent output"},
{Type: "output", Data: "TestParent before"},
{Type: "run_test", Name: "TestParent/Subtest#1"},
{Type: "output", Data: "Subtest#1 output"},
{Type: "run_test", Name: "TestParent/Subtest#2"},
{Type: "output", Data: "Subtest#2 output"},
{Type: "cont_test", Name: "TestParent"},
{Type: "output", Data: "TestParent after"},
{Type: "end_test", Name: "TestParent", Result: "PASS", Duration: 1 * time.Millisecond},
{Type: "end_test", Name: "TestParent/Subtest#1", Result: "FAIL", Duration: 2 * time.Millisecond},
{Type: "end_test", Name: "TestParent/Subtest#2", Result: "PASS", Duration: 3 * time.Millisecond},
{Type: "output", Data: "output"},
{Type: "summary", Result: "FAIL", Name: "package/name", Duration: 1 * time.Millisecond},
}
@ -356,7 +359,7 @@ func TestSubtestModes(t *testing.T) {
Name: "TestParent",
Duration: 1 * time.Millisecond,
Result: gtr.Pass,
Output: []string{"TestParent output"},
Output: []string{"TestParent before", "TestParent after"},
},
{
ID: 2,
@ -373,6 +376,7 @@ func TestSubtestModes(t *testing.T) {
Output: []string{"Subtest#2 output"},
},
},
Output: []string{"output"},
},
},
},
@ -402,6 +406,7 @@ func TestSubtestModes(t *testing.T) {
Output: []string{"Subtest#2 output"},
},
},
Output: []string{"TestParent before", "TestParent after", "output"},
},
},
},

66
parser/gotest/report_builder.go
View File

@ -5,6 +5,11 @@ import (
"time"
"github.com/jstemmer/go-junit-report/v2/gtr"
"github.com/jstemmer/go-junit-report/v2/parser/gotest/internal/collector"
)
const (
globalID = 0
)
// reportBuilder helps build a test Report from a collection of events.
@ -23,11 +28,11 @@ type reportBuilder struct {
runErrors map[int]gtr.Error
// state
nextID int // next free unused id
lastID int // most recently created id
output []string // output that does not belong to any test
coverage float64 // coverage percentage
parentIDs map[int]struct{} // set of test id's that contain subtests
nextID int // next free unused id
lastID int // most recently created id
output *collector.Output // output collected for each id
coverage float64 // coverage percentage
parentIDs map[int]struct{} // set of test id's that contain subtests
// options
packageName string
@ -43,6 +48,7 @@ func newReportBuilder() *reportBuilder {
buildErrors: make(map[int]gtr.Error),
runErrors: make(map[int]gtr.Error),
nextID: 1,
output: collector.New(),
parentIDs: make(map[int]struct{}),
timestampFunc: time.Now,
}
@ -202,6 +208,8 @@ func (b *reportBuilder) CreatePackage(name, result string, duration time.Duratio
buildErr.ID = id
buildErr.Duration = duration
buildErr.Cause = data
buildErr.Output = b.output.Get(id)
pkg.BuildError = buildErr
b.packages = append(b.packages, pkg)
@ -214,17 +222,15 @@ func (b *reportBuilder) CreatePackage(name, result string, duration time.Duratio
// If we've collected output, but there were no tests or benchmarks then
// either there were no tests, or there was some other non-build error.
if len(b.output) > 0 && len(b.tests) == 0 && len(b.benchmarks) == 0 {
if b.output.Contains(globalID) && len(b.tests) == 0 && len(b.benchmarks) == 0 {
if parseResult(result) == gtr.Fail {
pkg.RunError = gtr.Error{
Name: name,
Output: b.output,
Output: b.output.Get(globalID),
}
}
b.packages = append(b.packages, pkg)
// TODO: reset state
b.output = nil
b.output.Clear(globalID)
return
}
@ -233,9 +239,9 @@ func (b *reportBuilder) CreatePackage(name, result string, duration time.Duratio
if parseResult(result) == gtr.Fail && (len(b.tests) > 0 || len(b.benchmarks) > 0) && !b.containsFailingTest() {
pkg.RunError = gtr.Error{
Name: name,
Output: b.output,
Output: b.output.Get(globalID),
}
b.output = nil
b.output.Clear(globalID)
}
// Collect tests and benchmarks for this package, maintaining insertion order.
@ -247,28 +253,31 @@ func (b *reportBuilder) CreatePackage(name, result string, duration time.Duratio
if b.subtestMode == IgnoreParentResults {
t.Result = gtr.Pass
} else if b.subtestMode == ExcludeParents {
b.output.Merge(id, globalID)
continue
}
}
t.Output = b.output.Get(id)
tests = append(tests, t)
continue
}
if bm, ok := b.benchmarks[id]; ok {
bm.Output = b.output.Get(id)
benchmarks = append(benchmarks, bm)
continue
}
}
pkg.Coverage = b.coverage
pkg.Output = b.output
pkg.Output = b.output.Get(globalID)
pkg.Tests = tests
pkg.Benchmarks = groupBenchmarksByName(benchmarks)
pkg.Benchmarks = b.groupBenchmarksByName(benchmarks)
b.packages = append(b.packages, pkg)
// reset state, except for nextID to ensure all id's are unique.
b.lastID = 0
b.output = nil
b.output.Clear(globalID)
b.coverage = 0
b.tests = make(map[int]gtr.Test)
b.benchmarks = make(map[int]gtr.Benchmark)
@ -280,26 +289,10 @@ func (b *reportBuilder) Coverage(pct float64, packages []string) {
b.coverage = pct
}
// AppendOutput appends the given line to the currently active context. If no
// AppendOutput appends the given text to the currently active context. If no
// active context exists, the output is assumed to belong to the package.
func (b *reportBuilder) AppendOutput(line string) {
if b.lastID <= 0 {
b.output = append(b.output, line)
return
}
if t, ok := b.tests[b.lastID]; ok {
t.Output = append(t.Output, line)
b.tests[b.lastID] = t
} else if bm, ok := b.benchmarks[b.lastID]; ok {
bm.Output = append(bm.Output, line)
b.benchmarks[b.lastID] = bm
} else if be, ok := b.buildErrors[b.lastID]; ok {
be.Output = append(be.Output, line)
b.buildErrors[b.lastID] = be
} else {
b.output = append(b.output, line)
}
func (b *reportBuilder) AppendOutput(text string) {
b.output.Append(b.lastID, text)
}
// findTest returns the id of the most recently created test with the given
@ -382,7 +375,7 @@ func parseResult(r string) gtr.Result {
}
}
func groupBenchmarksByName(benchmarks []gtr.Benchmark) []gtr.Benchmark {
func (b *reportBuilder) groupBenchmarksByName(benchmarks []gtr.Benchmark) []gtr.Benchmark {
if len(benchmarks) == 0 {
return nil
}
@ -397,8 +390,10 @@ func groupBenchmarksByName(benchmarks []gtr.Benchmark) []gtr.Benchmark {
}
for i, group := range grouped {
var ids []int
count := 0
for _, bm := range byName[group.Name] {
ids = append(ids, bm.ID)
if bm.Result != gtr.Pass {
continue
}
@ -411,6 +406,7 @@ func groupBenchmarksByName(benchmarks []gtr.Benchmark) []gtr.Benchmark {
}
group.Result = groupResults(byName[group.Name])
group.Output = b.output.GetAll(ids...)
if count > 0 {
group.NsPerOp /= float64(count)
group.MBPerSec /= float64(count)

3
parser/gotest/report_builder_test.go
View File

@ -43,7 +43,8 @@ func TestGroupBenchmarksByName(t *testing.T) {
}
for _, test := range tests {
got := groupBenchmarksByName(test.in)
b := newReportBuilder()
got := b.groupBenchmarksByName(test.in)
if diff := cmp.Diff(test.want, got); diff != "" {
t.Errorf("groupBenchmarksByName result incorrect, diff (-want, +got):\n%s\n", diff)
}

9
testdata/022-report.xml vendored
View File

@ -7,7 +7,14 @@
<testcase name="TestOne" classname="package/bench" time="0.000">
<system-out><![CDATA[ bench_test.go:9: test log]]></system-out>
</testcase>
<testcase name="BenchmarkOne" classname="package/bench" time="0.000000000"></testcase>
<testcase name="BenchmarkOne" classname="package/bench" time="0.000000000">
<system-out><![CDATA[ bench_test.go:13: benchmark log (1)
bench_test.go:13: benchmark log (100)
bench_test.go:13: benchmark log (10000)
bench_test.go:13: benchmark log (1000000)
bench_test.go:13: benchmark log (100000000)
bench_test.go:13: benchmark log (1000000000)]]></system-out>
</testcase>
<testcase name="BenchmarkTwo" classname="package/bench" time="1.305496599"></testcase>
<system-out><![CDATA[goos: linux
goarch: amd64

9
testdata/109-report.xml vendored
View File

@ -10,7 +10,14 @@
<testcase name="TestZ" classname="package/name/bench" time="0.000">
<system-out><![CDATA[ z_test.go:6: ok]]></system-out>
</testcase>
<testcase name="BenchmarkTest" classname="package/name/bench" time="0.000000000"></testcase>
<testcase name="BenchmarkTest" classname="package/name/bench" time="0.000000000">
<system-out><![CDATA[ bench_test.go:12: 1
bench_test.go:12: 100
bench_test.go:12: 10000
bench_test.go:12: 1000000
bench_test.go:12: 100000000
bench_test.go:12: 1000000000]]></system-out>
</testcase>
<testcase name="BenchmarkOtherTest" classname="package/name/bench" time="0.000000000"></testcase>
<system-out><![CDATA[goos: linux
goarch: amd64