From 9167a5d41de62ef8c78dc5eef357419222f0d560 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=ABl=20Stemmer?= <stemmertech@gmail.com>
Date: Sun, 6 Oct 2019 23:37:51 +0100
Subject: [PATCH] gtr: Add support for runtime/init errors

---
 pkg/gtr/builder.go | 26 +++++++++++++++++++++++---
 pkg/gtr/gtr.go     | 30 +++++++++++++++++++++++-------
 2 files changed, 46 insertions(+), 10 deletions(-)

diff --git a/pkg/gtr/builder.go b/pkg/gtr/builder.go
index 69323ad..068a71e 100644
--- a/pkg/gtr/builder.go
+++ b/pkg/gtr/builder.go
@@ -10,7 +10,8 @@ type ReportBuilder struct {
 	packages    []Package
 	tests       map[int]Test
 	benchmarks  map[int]Benchmark
-	buildErrors map[int]BuildError
+	buildErrors map[int]Error
+	runErrors   map[int]Error
 
 	// state
 	nextId   int // next free id
@@ -26,7 +27,8 @@ func NewReportBuilder(packageName string) *ReportBuilder {
 	return &ReportBuilder{
 		tests:       make(map[int]Test),
 		benchmarks:  make(map[int]Benchmark),
-		buildErrors: make(map[int]BuildError),
+		buildErrors: make(map[int]Error),
+		runErrors:   make(map[int]Error),
 		nextId:      1,
 		packageName: packageName,
 	}
@@ -79,7 +81,7 @@ func (b *ReportBuilder) Benchmark(name string, iterations int64, nsPerOp, mbPerS
 }
 
 func (b *ReportBuilder) CreateBuildError(packageName string) {
-	b.buildErrors[b.newId()] = BuildError{Name: packageName}
+	b.buildErrors[b.newId()] = Error{Name: packageName}
 }
 
 func (b *ReportBuilder) CreatePackage(name string, duration time.Duration, data string) {
@@ -91,16 +93,34 @@ func (b *ReportBuilder) CreatePackage(name string, duration time.Duration, data
 			if len(b.tests) > 0 || len(b.benchmarks) > 0 {
 				panic("unexpected tests and/or benchmarks found in build error package")
 			}
+			buildErr.Duration = duration
 			buildErr.Cause = data
 			b.packages = append(b.packages, Package{
 				Name:       name,
 				BuildError: buildErr,
 			})
 			delete(b.buildErrors, id)
+			// TODO: reset state
 			return
 		}
 	}
 
+	// If we've collected output, but there were no tests or benchmarks then
+	// there was some other error.
+	if len(b.output) > 0 && len(b.tests) == 0 && len(b.benchmarks) == 0 {
+		b.packages = append(b.packages, Package{
+			Name:     name,
+			Duration: duration,
+			RunError: Error{
+				Name:   name,
+				Output: b.output,
+			},
+		})
+		b.output = nil
+		// TODO: reset state
+		return
+	}
+
 	// Collect tests and benchmarks for this package, maintaining insertion order.
 	var tests []Test
 	var benchmarks []Benchmark
diff --git a/pkg/gtr/gtr.go b/pkg/gtr/gtr.go
index e9e9945..0feae78 100644
--- a/pkg/gtr/gtr.go
+++ b/pkg/gtr/gtr.go
@@ -39,7 +39,8 @@ type Package struct {
 	Tests      []Test
 	Benchmarks []Benchmark
 
-	BuildError BuildError
+	BuildError Error
+	RunError   Error
 }
 
 type Test struct {
@@ -60,10 +61,11 @@ type Benchmark struct {
 	AllocsPerOp int64
 }
 
-type BuildError struct {
-	Name   string
-	Cause  string
-	Output []string
+type Error struct {
+	Name     string
+	Duration time.Duration
+	Cause    string
+	Output   []string
 }
 
 // FromEvents creates a Report from the given list of events.
@@ -111,8 +113,9 @@ func JUnit(report Report) junit.Testsuites {
 			}
 		}
 
-		// JUnit doesn't have a good way of dealing with build errors, so we
-		// create a single failing test that contains the build error details.
+		// JUnit doesn't have a good way of dealing with build or runtime
+		// errors that happen before a test has started, so we create a single
+		// failing test that contains the build error details.
 		if pkg.BuildError.Name != "" {
 			tc := junit.Testcase{
 				Classname: pkg.BuildError.Name,
@@ -126,6 +129,19 @@ func JUnit(report Report) junit.Testsuites {
 			suite.AddTestcase(tc)
 		}
 
+		if pkg.RunError.Name != "" {
+			tc := junit.Testcase{
+				Classname: pkg.RunError.Name,
+				Name:      "Failure",
+				Time:      junit.FormatDuration(0),
+				Failure: &junit.Result{
+					Message: "Failed",
+					Data:    strings.Join(pkg.RunError.Output, "\n"),
+				},
+			}
+			suite.AddTestcase(tc)
+		}
+
 		for _, test := range pkg.Tests {
 			duration += test.Duration