1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
|
package testjson
import (
"bufio"
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"sort"
"strings"
"sync"
"time"
"golang.org/x/sync/errgroup"
"gotest.tools/gotestsum/internal/log"
)
// Action of TestEvent
type Action string
// nolint: unused
const (
ActionRun Action = "run"
ActionPause Action = "pause"
ActionCont Action = "cont"
ActionPass Action = "pass"
ActionBench Action = "bench"
ActionFail Action = "fail"
ActionOutput Action = "output"
ActionSkip Action = "skip"
)
// IsTerminal returns true if the Action is one of: pass, fail, skip.
func (a Action) IsTerminal() bool {
switch a {
case ActionPass, ActionFail, ActionSkip:
return true
default:
return false
}
}
// TestEvent is a structure output by go tool test2json and go test -json.
type TestEvent struct {
// Time encoded as an RFC3339-format string
Time time.Time
Action Action
Package string
Test string
// Elapsed time in seconds
Elapsed float64
// Output of test or benchmark
Output string
// raw is the raw JSON bytes of the event
raw []byte
// RunID from the ScanConfig which produced this test event.
RunID int
}
// PackageEvent returns true if the event is a package start or end event
func (e TestEvent) PackageEvent() bool {
return e.Test == ""
}
// ElapsedFormatted returns Elapsed formatted in the go test format, ex (0.00s).
func (e TestEvent) ElapsedFormatted() string {
return fmt.Sprintf("(%.2fs)", e.Elapsed)
}
// Bytes returns the serialized JSON bytes that were parsed to create the event.
func (e TestEvent) Bytes() []byte {
return e.raw
}
// Package is the set of TestEvents for a single go package
type Package struct {
Total int
running map[string]TestCase
Failed []TestCase
Skipped []TestCase
Passed []TestCase
// elapsed time reported by the pass or fail event for the package.
elapsed time.Duration
// mapping of root TestCase ID to all sub test IDs. Used to mitigate
// github.com/golang/go/issues/29755, and github.com/golang/go/issues/40771.
// In the future when those bug are fixed this mapping can likely be removed.
subTests map[int][]int
// output printed by test cases, indexed by TestCase.ID. Package output is
// saved with key 0.
output map[int][]string
// coverage stores the code coverage output for the package without the
// trailing newline (ex: coverage: 91.1% of statements).
coverage string
// action identifies if the package passed or failed. A package may fail
// with no test failures if an init() or TestMain exits non-zero.
// skip indicates there were no tests.
action Action
// cached is true if the package was marked as (cached)
cached bool
// panicked is true if the package, or one of the tests in the package,
// contained output that looked like a panic. This is used to mitigate
// github.com/golang/go/issues/45508. This field may be removed in the future
// if the issue is fixed in Go.
panicked bool
// shuffleSeed is the seed used to shuffle the tests. The value is set when
// tests are run with -shuffle
shuffleSeed string
}
// Result returns if the package passed, failed, or was skipped because there
// were no tests.
func (p *Package) Result() Action {
return p.action
}
// Elapsed returns the elapsed time of the package, as reported by the
// pass or fail event for the package.
func (p *Package) Elapsed() time.Duration {
return p.elapsed
}
// TestCases returns all the test cases.
func (p *Package) TestCases() []TestCase {
tc := append([]TestCase{}, p.Passed...)
tc = append(tc, p.Failed...)
tc = append(tc, p.Skipped...)
return tc
}
// LastFailedByName returns the most recent test with name in the list of Failed
// tests. If no TestCase is found with that name, an empty TestCase is returned.
//
// LastFailedByName may be used by formatters to find the TestCase.ID for the current
// failing TestEvent. It is very likely the last TestCase in Failed, but this method
// provides a little more safety if that ever changes.
func (p *Package) LastFailedByName(name string) TestCase {
for i := len(p.Failed) - 1; i >= 0; i-- {
if p.Failed[i].Test.Name() == name {
return p.Failed[i]
}
}
return TestCase{}
}
// Output returns the full test output for a test.
//
// Unlike OutputLines() it does not return lines from subtests in some cases.
func (p *Package) Output(id int) string {
return strings.Join(p.output[id], "")
}
// OutputLines returns the full test output for a test as a slice of strings.
//
// As a workaround for test output being attributed to the wrong subtest, if:
// - the TestCase is a root TestCase (not a subtest), and
// - the TestCase has no subtest failures;
//
// then all output for every subtest under the root test is returned.
// See https://github.com/golang/go/issues/29755.
func (p *Package) OutputLines(tc TestCase) []string {
lines := p.output[tc.ID]
// If this is a subtest, or a root test case with subtest failures the
// subtest failure output should contain the relevant lines, so we don't need
// extra lines.
if tc.Test.IsSubTest() || tc.hasSubTestFailed {
return lines
}
result := make([]string, 0, len(lines)+1)
result = append(result, lines...)
for _, sub := range p.subTests[tc.ID] {
result = append(result, p.output[sub]...)
}
return result
}
func (p *Package) addOutput(id int, output string) {
if strings.HasPrefix(output, "panic: ") {
p.panicked = true
}
// TODO: limit size of buffered test output
p.output[id] = append(p.output[id], output)
}
type TestName string
func (n TestName) Split() (root string, sub string) {
parts := strings.SplitN(string(n), "/", 2)
if len(parts) < 2 {
return string(n), ""
}
return parts[0], parts[1]
}
// IsSubTest returns true if the name indicates the test is a subtest run using
// t.Run().
func (n TestName) IsSubTest() bool {
return strings.Contains(string(n), "/")
}
func (n TestName) Name() string {
return string(n)
}
func (p *Package) removeOutput(id int) {
delete(p.output, id)
skipped := tcIDSet(p.Skipped)
for _, sub := range p.subTests[id] {
if _, isSkipped := skipped[sub]; !isSkipped {
delete(p.output, sub)
}
}
}
func tcIDSet(skipped []TestCase) map[int]struct{} {
result := make(map[int]struct{})
for _, tc := range skipped {
result[tc.ID] = struct{}{}
}
return result
}
// TestMainFailed returns true if the package failed, but there were no tests.
// This may occur if the package init() or TestMain exited non-zero.
func (p *Package) TestMainFailed() bool {
return p.action == ActionFail && len(p.Failed) == 0
}
const neverFinished time.Duration = -1
// end adds any tests that were missing an ActionFail TestEvent to the list of
// Failed, and returns a slice of artificial TestEvent for the missing ones.
//
// This is done to work around 'go test' not sending the ActionFail TestEvents
// in some cases, when a test panics.
func (p *Package) end() []TestEvent {
result := make([]TestEvent, 0, len(p.running))
for k, tc := range p.running {
if tc.Test.IsSubTest() && rootTestPassed(p, tc) {
// mitigate github.com/golang/go/issues/40771 (gotestsum/issues/141)
// by skipping missing subtest end events when the root test passed.
continue
}
tc.Elapsed = neverFinished
p.Failed = append(p.Failed, tc)
result = append(result, TestEvent{
Action: ActionFail,
Package: tc.Package,
Test: tc.Test.Name(),
Elapsed: float64(neverFinished),
})
delete(p.running, k)
}
return result
}
// rootTestPassed looks for the root test associated with subtest and returns
// true if the root test passed. This is used to mitigate
// github.com/golang/go/issues/40771 (gotestsum/issues/141) and may be removed
// in the future since that issue was patched in go1.16.
//
// This function is slightly expensive because it has to scan every test in the
// package, but it should only run in the rare case where a subtest was missing
// an end event. Spending a little more time in that rare case is probably better
// than keeping extra mapping of tests in all cases.
func rootTestPassed(p *Package, subtest TestCase) bool {
root, _ := subtest.Test.Split()
for _, tc := range p.Passed {
if tc.Test.Name() != root {
continue
}
for _, subID := range p.subTests[tc.ID] {
if subID == subtest.ID {
return true
}
}
}
return false
}
// TestCase stores the name and elapsed time for a test case.
type TestCase struct {
// ID is unique ID for each test case. A test run may include multiple instances
// of the same Package and Name if -count is used, or if the input comes from
// multiple runs. The ID can be used to uniquely reference an instance of a
// test case.
ID int
Package string
Test TestName
Elapsed time.Duration
// RunID from the ScanConfig which produced this test case.
RunID int
// hasSubTestFailed is true when a subtest of this TestCase has failed. It is
// used to find root TestCases which have no failing subtests.
hasSubTestFailed bool
// Time when the test was run.
Time time.Time
}
func newPackage() *Package {
return &Package{
output: make(map[int][]string),
running: make(map[string]TestCase),
subTests: make(map[int][]int),
}
}
// Execution of one or more test packages
type Execution struct {
started time.Time
packages map[string]*Package
errorsLock sync.RWMutex
errors []string
done bool
lastRunID int
}
func (e *Execution) add(event TestEvent) {
pkg, ok := e.packages[event.Package]
if !ok {
pkg = newPackage()
e.packages[event.Package] = pkg
}
if event.PackageEvent() {
pkg.addEvent(event)
return
}
pkg.addTestEvent(event)
}
func (p *Package) addEvent(event TestEvent) {
switch event.Action {
case ActionPass, ActionFail:
p.action = event.Action
p.elapsed = elapsedDuration(event.Elapsed)
case ActionOutput:
if isCoverageOutput(event.Output) {
p.coverage = strings.TrimRight(event.Output, "\n")
}
if strings.Contains(event.Output, "\t(cached)") {
p.cached = true
}
if isShuffleSeedOutput(event.Output) {
p.shuffleSeed = strings.TrimRight(event.Output, "\n")
}
p.addOutput(0, event.Output)
}
}
func (p *Package) newTestCaseFromEvent(event TestEvent) TestCase {
// Incremental total before using it as the ID, because ID 0 is used for
// the package output
p.Total++
return TestCase{
Package: event.Package,
Test: TestName(event.Test),
ID: p.Total,
RunID: event.RunID,
Time: event.Time,
}
}
func (p *Package) addTestEvent(event TestEvent) {
if event.Action == ActionRun {
tc := p.newTestCaseFromEvent(event)
p.running[event.Test] = tc
if tc.Test.IsSubTest() {
root, _ := TestName(event.Test).Split()
rootID := p.running[root].ID
p.subTests[rootID] = append(p.subTests[rootID], tc.ID)
}
return
}
tc := p.running[event.Test]
// This appears to be a bug in 'go test' or test2json. This test is missing
// an Action=run event. Create one on the first event received from the test.
if tc.ID == 0 {
tc = p.newTestCaseFromEvent(event)
p.running[event.Test] = tc
}
switch event.Action {
case ActionOutput, ActionBench:
tc := p.running[event.Test]
p.addOutput(tc.ID, event.Output)
return
case ActionPause, ActionCont:
return
}
// the event.Action must be one of the three "test end" events
delete(p.running, event.Test)
tc.Elapsed = elapsedDuration(event.Elapsed)
switch event.Action {
case ActionFail:
p.Failed = append(p.Failed, tc)
// If this is a subtest, mark the root test as having a failed subtest
if tc.Test.IsSubTest() {
root, _ := TestName(event.Test).Split()
rootTestCase := p.running[root]
rootTestCase.hasSubTestFailed = true
p.running[root] = rootTestCase
}
case ActionSkip:
p.Skipped = append(p.Skipped, tc)
case ActionPass:
p.Passed = append(p.Passed, tc)
// Do not immediately remove output for subtests, to work around a bug
// in 'go test' where output is attributed to the wrong sub test.
// github.com/golang/go/issues/29755.
if tc.Test.IsSubTest() {
return
}
// Remove test output once a test passes, it wont be used.
p.removeOutput(tc.ID)
}
}
func elapsedDuration(elapsed float64) time.Duration {
return time.Duration(elapsed*1000) * time.Millisecond
}
func isCoverageOutput(output string) bool {
return all(
strings.HasPrefix(output, "coverage:"),
strings.Contains(output, "% of statements"))
}
func isShuffleSeedOutput(output string) bool {
return strings.HasPrefix(output, "-test.shuffle ")
}
func isWarningNoTestsToRunOutput(output string) bool {
return output == "testing: warning: no tests to run\n"
}
// OutputLines returns the full test output for a test as an slice of lines.
// This function is a convenient wrapper around Package.OutputLines() to
// support the hiding of output in the summary.
//
// See Package.OutLines() for more details.
func (e *Execution) OutputLines(tc TestCase) []string {
return e.packages[tc.Package].OutputLines(tc)
}
// Package returns the Package by name.
func (e *Execution) Package(name string) *Package {
return e.packages[name]
}
// Packages returns a sorted list of all package names.
func (e *Execution) Packages() []string {
return sortedKeys(e.packages)
}
var timeNow = time.Now
// Elapsed returns the time elapsed since the execution started.
func (e *Execution) Elapsed() time.Duration {
return timeNow().Sub(e.started)
}
// Failed returns a list of all the failed test cases.
func (e *Execution) Failed() []TestCase {
if e == nil {
return nil
}
var failed []TestCase //nolint:prealloc
for _, name := range sortedKeys(e.packages) {
pkg := e.packages[name]
// Add package-level failure output if there were no failed tests.
if pkg.TestMainFailed() {
failed = append(failed, TestCase{Package: name})
}
failed = append(failed, pkg.Failed...)
}
return failed
}
// FilterFailedUnique filters a slice of failed TestCases by removing root test
// case that have failed subtests.
func FilterFailedUnique(tcs []TestCase) []TestCase {
var result []TestCase
for _, tc := range tcs {
if !tc.hasSubTestFailed {
result = append(result, tc)
}
}
return result
}
func sortedKeys(pkgs map[string]*Package) []string {
keys := make([]string, 0, len(pkgs))
for key := range pkgs {
keys = append(keys, key)
}
sort.Strings(keys)
return keys
}
// Skipped returns a list of all the skipped test cases.
func (e *Execution) Skipped() []TestCase {
skipped := make([]TestCase, 0, len(e.packages))
for _, pkg := range sortedKeys(e.packages) {
skipped = append(skipped, e.packages[pkg].Skipped...)
}
return skipped
}
// Total returns a count of all test cases.
func (e *Execution) Total() int {
total := 0
for _, pkg := range e.packages {
total += pkg.Total
}
return total
}
func (e *Execution) addError(err string) {
// Build errors start with a header
if strings.HasPrefix(err, "# ") {
return
}
e.errorsLock.Lock()
e.errors = append(e.errors, err)
e.errorsLock.Unlock()
}
// Errors returns a list of all the errors.
func (e *Execution) Errors() []string {
e.errorsLock.RLock()
defer e.errorsLock.RUnlock()
return e.errors
}
// HasPanic returns true if at least one package had output that looked like a
// panic.
func (e *Execution) HasPanic() bool {
for _, pkg := range e.packages {
if pkg.panicked {
return true
}
}
return false
}
func (e *Execution) end() []TestEvent {
e.done = true
var result []TestEvent // nolint: prealloc
for _, pkg := range e.packages {
result = append(result, pkg.end()...)
}
return result
}
func (e *Execution) Started() time.Time {
return e.started
}
// newExecution returns a new Execution and records the current time as the
// time the test execution started.
func newExecution() *Execution {
return &Execution{
started: timeNow(),
packages: make(map[string]*Package),
}
}
// ScanConfig used by ScanTestOutput.
type ScanConfig struct {
// RunID is a unique identifier for the run. It may be set to the pid of the
// process, or some other identifier. It will stored as the TestCase.RunID.
RunID int
// Stdout is a reader that yields the test2json output stream.
Stdout io.Reader
// Stderr is a reader that yields stderr from the 'go test' process. Often
// it contains build errors, or panics. Stderr may be nil.
Stderr io.Reader
// Handler is a set of callbacks for receiving TestEvents and stderr text.
Handler EventHandler
// Execution to populate while scanning. If nil a new one will be created
// and returned from ScanTestOutput.
Execution *Execution
// Stop is called when ScanTestOutput fails during a scan.
Stop func()
// IgnoreNonJSONOutputLines causes ScanTestOutput to ignore non-JSON lines received from
// the Stdout reader. Instead of causing an error, the lines will be sent to Handler.Err.
IgnoreNonJSONOutputLines bool
}
// EventHandler is called by ScanTestOutput for each event and write to stderr.
type EventHandler interface {
// Event is called for every TestEvent, with the current value of Execution.
// It may return an error to stop scanning.
Event(event TestEvent, execution *Execution) error
// Err is called for every line from the Stderr reader and may return an
// error to stop scanning.
Err(text string) error
}
// ScanTestOutput reads lines from config.Stdout and config.Stderr, populates an
// Execution, calls the Handler for each event, and returns the Execution.
//
// If config.Handler is nil, a default no-op handler will be used.
func ScanTestOutput(config ScanConfig) (*Execution, error) {
if config.Stdout == nil {
return nil, fmt.Errorf("stdout reader must be non-nil")
}
if config.Handler == nil {
config.Handler = noopHandler{}
}
if config.Stderr == nil {
config.Stderr = new(bytes.Reader)
}
if config.Stop == nil {
config.Stop = func() {}
}
execution := config.Execution
if execution == nil {
execution = newExecution()
}
execution.done = false
execution.lastRunID = config.RunID
var group errgroup.Group
group.Go(func() error {
return stopOnError(config.Stop, readStdout(config, execution))
})
group.Go(func() error {
return stopOnError(config.Stop, readStderr(config, execution))
})
err := group.Wait()
for _, event := range execution.end() {
if err := config.Handler.Event(event, execution); err != nil {
return execution, err
}
}
return execution, err
}
func stopOnError(stop func(), err error) error {
if err != nil {
stop()
return err
}
return nil
}
func readStdout(config ScanConfig, execution *Execution) error {
scanner := bufio.NewScanner(config.Stdout)
for scanner.Scan() {
raw := scanner.Bytes()
event, err := parseEvent(raw)
switch {
case err == errBadEvent:
// nolint: errcheck
config.Handler.Err(errBadEvent.Error() + ": " + scanner.Text())
continue
case err != nil:
if config.IgnoreNonJSONOutputLines {
// nolint: errcheck
config.Handler.Err(string(raw))
continue
}
return fmt.Errorf("failed to parse test output: %s: %w", string(raw), err)
}
event.RunID = config.RunID
execution.add(event)
if err := config.Handler.Event(event, execution); err != nil {
return err
}
}
if err := scanner.Err(); err != nil {
return fmt.Errorf("failed to scan test output: %w", err)
}
return nil
}
func readStderr(config ScanConfig, execution *Execution) error {
scanner := bufio.NewScanner(config.Stderr)
for scanner.Scan() {
line := scanner.Text()
if err := config.Handler.Err(line); err != nil {
return fmt.Errorf("failed to handle stderr: %v", err)
}
if isGoModuleOutput(line) {
continue
}
if strings.HasPrefix(line, "warning:") {
continue
}
execution.addError(line)
}
if err := scanner.Err(); err != nil {
return fmt.Errorf("failed to scan stderr: %v", err)
}
return nil
}
func isGoModuleOutput(scannerText string) bool {
prefixes := []string{
"go: copying",
"go: creating",
"go: downloading",
"go: extracting",
"go: finding",
}
for _, prefix := range prefixes {
if strings.HasPrefix(scannerText, prefix) {
return true
}
}
return false
}
func parseEvent(raw []byte) (TestEvent, error) {
// TODO: this seems to be a bug in the `go test -json` output
if bytes.HasPrefix(raw, []byte("FAIL")) {
log.Warnf("invalid TestEvent: %v", string(raw))
return TestEvent{}, errBadEvent
}
event := TestEvent{}
err := json.Unmarshal(raw, &event)
event.raw = raw
return event, err
}
var errBadEvent = errors.New("bad output from test2json")
type noopHandler struct{}
func (s noopHandler) Event(TestEvent, *Execution) error {
return nil
}
func (s noopHandler) Err(string) error {
return nil
}
|