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

gtr: add documentation to exported types and methods

Browse Source
This commit is contained in:
Joël Stemmer 2022-03-14 23:01:04 +00:00
parent 5e492f8212
commit 0e7d095a28
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
pkg/gtr/gtr.go
View File

@ -8,10 +8,14 @@ import (
"time" "time"
) )
// Report contains the build, test and/or benchmark results of a collection of
// packages.
type Report struct { type Report struct {
Packages []Package Packages []Package
} }
// IsSuccessful returns true if none of the packages in this report have build
// or runtime errors and all tests passed without failures or were skipped.
func (r *Report) IsSuccessful() bool { func (r *Report) IsSuccessful() bool {
for _, pkg := range r.Packages { for _, pkg := range r.Packages {
if pkg.BuildError.Name != "" || pkg.RunError.Name != "" { if pkg.BuildError.Name != "" || pkg.RunError.Name != "" {
@ -26,6 +30,7 @@ func (r *Report) IsSuccessful() bool {
return true return true
} }
// Package contains build, test and/or benchmark results for a single package.
type Package struct { type Package struct {
Name string Name string
Duration time.Duration Duration time.Duration
@ -40,6 +45,9 @@ type Package struct {
RunError Error RunError Error
} }
// SetProperty stores a key/value property in the current package. If a
// property with the given key already exists, its old value will be
// overwritten with the given value.
func (p *Package) SetProperty(key, value string) { func (p *Package) SetProperty(key, value string) {
if p.Properties == nil { if p.Properties == nil {
p.Properties = make(map[string]string) p.Properties = make(map[string]string)
@ -47,6 +55,7 @@ func (p *Package) SetProperty(key, value string) {
p.Properties[key] = value p.Properties[key] = value
} }
// Test contains the results of a single test.
type Test struct { type Test struct {
Name string Name string
Duration time.Duration Duration time.Duration
@ -55,6 +64,7 @@ type Test struct {
Output []string Output []string
} }
// Benchmark contains the results of a single benchmark.
type Benchmark struct { type Benchmark struct {
Name string Name string
Result Result Result Result
@ -66,6 +76,7 @@ type Benchmark struct {
AllocsPerOp int64 AllocsPerOp int64
} }
// Error contains details of a build or runtime error.
type Error struct { type Error struct {
Name string Name string
Duration time.Duration Duration time.Duration