Files
tasks/tools/testrunner/junit_test.go
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

100 lines
3.2 KiB
Go

// The MIT License
//
// Copyright (c) 2024 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 (
"os"
"slices"
"testing"
"github.com/stretchr/testify/require"
)
func TestReadJUnitReport(t *testing.T) {
j := &junitReport{path: "testdata/junit-attempt-1.xml"}
require.NoError(t, j.read())
require.Len(t, j.Testsuites.Suites, 1)
require.Equal(t, 2, j.Testsuites.Failures)
require.Equal(t, []string{"TestCallbacksSuite/TestWorkflowCallbacks_InvalidArgument"}, j.collectTestCaseFailures())
}
func TestGenerateJUnitReportForTimedoutTests(t *testing.T) {
out, err := os.CreateTemp("", "junit-report-*.xml")
require.NoError(t, err)
defer os.Remove(out.Name())
j := generateForTimedoutTests([]string{
"TestCallbacksSuite/TestWorkflowCallbacks_1",
"TestCallbacksSuite/TestWorkflowCallbacks_2",
})
j.path = out.Name()
require.NoError(t, j.write())
expectedReport, err := os.ReadFile("testdata/junit-timeout-output.xml")
require.NoError(t, err)
actualReport, err := os.ReadFile(out.Name())
require.NoError(t, err)
require.Equal(t, string(expectedReport), string(actualReport))
}
func TestNode(t *testing.T) {
n := node{
children: map[string]node{
"a": {
children: map[string]node{
"b": {
children: make(map[string]node),
},
},
},
"b": {
children: make(map[string]node),
},
},
}
var paths []string
for p := range n.walk() {
paths = append(paths, p)
}
slices.Sort(paths)
require.Equal(t, []string{"a", "a/b", "b"}, paths)
}
func TestMergeReports(t *testing.T) {
j1 := &junitReport{path: "testdata/junit-attempt-1.xml"}
require.NoError(t, j1.read())
j2 := &junitReport{path: "testdata/junit-attempt-2.xml"}
require.NoError(t, j2.read())
report, err := mergeReports([]*junitReport{j1, j2})
require.NoError(t, err)
suites := report.Testsuites.Suites
require.Len(t, suites, 2)
require.Equal(t, 4, report.Testsuites.Failures)
require.Equal(t, "go.temporal.io/server/tests (retry 1)", suites[1].Name)
require.Len(t, suites[1].Testcases, 2)
require.Equal(t, "TestCallbacksSuite/TestWorkflowCallbacks_InvalidArgument (retry 1)", suites[1].Testcases[0].Name)
}