Files
b792e5f14a Report timed out tests (#7144)
## What changed?
<!-- Describe what has changed in this PR -->

Extended the testrunner to scan the test output for timed out tests and
report these (1) in the logs and (2) in the JUnit report.

## Why?
<!-- Tell your future self why have you made these changes -->

To track timed out tests better.

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->

I set the test timeout to 5s. This is what you see, for example:

https://github.com/temporalio/temporal/actions/runs/12922374527/job/36038028569?pr=7144#step:8:52993

<img width="834" alt="image"
src="https://github.com/user-attachments/assets/41723e9a-c2a9-4e69-8b0a-df52d6c4fc52"
/>

The developer will still have to connect the the test/suite name to the
code location, but that shouldn't be too hard.

Also verified that the JUnit report is being written correctly.

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->

## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->

---------

Co-authored-by: Roey Berman <[email protected]>
2025-01-27 08:48:10 -08:00

90 lines
3.1 KiB
Go

// The MIT License
//
// Copyright (c) 2025 Temporal Technologies Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package testrunner
import (
"fmt"
"io"
"slices"
"strings"
"github.com/maruel/panicparse/v2/stack"
)
// parseTestTimeouts parses the stdout of a test run and returns the stacktrace and names of tests that timed out.
func parseTestTimeouts(stdout string) (stacktrace string, timedoutTests []string) {
lines := strings.Split(strings.ReplaceAll(stdout, "\r\n", "\n"), "\n")
for i := 0; i < len(lines); i++ {
line := lines[i]
if strings.HasPrefix(line, "FAIL") {
// ignore
} else if strings.HasPrefix(line, "panic: test timed out after") {
// parse names of tests that timed out
for {
i++
line = strings.TrimSpace(lines[i])
if strings.HasPrefix(line, "Test") {
timedoutTests = append(timedoutTests, strings.Split(line, " ")[0])
}
if line == "" {
break
}
}
} else if len(timedoutTests) > 0 {
// collect stracktrace
stacktrace += line + "\n"
}
}
stacktrace = fmt.Sprintf("%d timed out test(s):\n\t%v\n\n%v",
len(timedoutTests), strings.Join(timedoutTests, "\n\t"), testOnlyStacktrace(stacktrace))
return
}
// testOnlyStacktrace removes all but the test stacktraces from the full stacktrace.
func testOnlyStacktrace(stacktrace string) string {
var res string
snap, _, err := stack.ScanSnapshot(strings.NewReader(stacktrace), io.Discard, stack.DefaultOpts())
if err != nil && err != io.EOF {
return fmt.Sprintf("failed to parse stacktrace: %v", err)
}
if snap == nil {
return "failed to find a stacktrace"
}
res = "abridged stacktrace:\n"
for _, goroutine := range snap.Goroutines {
shouldPrint := slices.ContainsFunc(goroutine.Stack.Calls, func(call stack.Call) bool {
return strings.HasSuffix(call.RemoteSrcPath, "_test.go")
})
if shouldPrint {
res += fmt.Sprintf("\tgoroutine %d [%v]:\n", goroutine.ID, goroutine.State)
for _, call := range goroutine.Stack.Calls {
file := call.RemoteSrcPath
res += fmt.Sprintf("\t\t%s:%d\n", file, call.Line)
}
res += "\n"
}
}
return res
}