Files
tasks/tools/testrunner/testrunner_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

102 lines
4.1 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 (
"testing"
"github.com/stretchr/testify/require"
)
func TestRunnerSanitizeAndParseArgs(t *testing.T) {
t.Run("Passthrough", func(t *testing.T) {
r := newRunner("gotestsum")
args, err := r.sanitizeAndParseArgs([]string{"--junitfile", "f", "-foo", "bar"})
require.NoError(t, err)
require.Equal(t, []string{"-foo", "bar"}, args)
require.Equal(t, "f", r.junitOutputPath)
})
t.Run("RetriesTwoArgs", func(t *testing.T) {
r := newRunner("gotestsum")
args, err := r.sanitizeAndParseArgs([]string{"--junitfile", "f", "-foo", "bar", "-retries", "3"})
require.NoError(t, err)
require.Equal(t, []string{"-foo", "bar"}, args)
require.Equal(t, "f", r.junitOutputPath)
require.Equal(t, 3, r.retries)
})
t.Run("RetriesOneArg", func(t *testing.T) {
r := newRunner("gotestsum")
args, err := r.sanitizeAndParseArgs([]string{"--junitfile", "f", "-foo", "bar", "-retries=3"})
require.NoError(t, err)
require.Equal(t, []string{"-foo", "bar"}, args)
require.Equal(t, "f", r.junitOutputPath)
require.Equal(t, 3, r.retries)
})
t.Run("RetriesTwoArgsInvalid", func(t *testing.T) {
r := newRunner("gotestsum")
_, err := r.sanitizeAndParseArgs([]string{"-foo", "bar", "-retries", "invalid"})
require.ErrorContains(t, err, `strconv.Atoi: parsing "invalid"`)
})
t.Run("RetriesIncomplete", func(t *testing.T) {
r := newRunner("gotestsum")
_, err := r.sanitizeAndParseArgs([]string{"-foo", "bar", "-retries"})
require.ErrorContains(t, err, "incomplete command line arguments: got -retries flag with no value")
})
t.Run("RetriesOneArgInvalid", func(t *testing.T) {
r := newRunner("gotestsum")
_, err := r.sanitizeAndParseArgs([]string{"-foo", "bar", "-retries=invalid"})
require.ErrorContains(t, err, `strconv.Atoi: parsing "invalid"`)
})
t.Run("JuintfileSingleArg", func(t *testing.T) {
r := newRunner("gotestsum")
args, err := r.sanitizeAndParseArgs([]string{"-foo", "bar", "--junitfile=foo"})
require.NoError(t, err)
require.Equal(t, []string{"-foo", "bar"}, args)
require.Equal(t, "foo", r.junitOutputPath)
})
t.Run("JunitfileIncomplete", func(t *testing.T) {
r := newRunner("gotestsum")
_, err := r.sanitizeAndParseArgs([]string{"-foo", "bar", "--junitfile"})
require.ErrorContains(t, err, "incomplete command line arguments: got --junitfile flag with no value")
})
t.Run("DoubleDash", func(t *testing.T) {
r := newRunner("gotestsum")
args, err := r.sanitizeAndParseArgs([]string{"-foo", "bar", "--junitfile", "foo", "--", "-retries=3"})
require.NoError(t, err)
require.Equal(t, []string{"-foo", "bar", "--", "-retries=3"}, args)
require.Equal(t, 0, r.retries)
})
}
func TestStripRunFromArgs(t *testing.T) {
t.Run("OneArg", func(t *testing.T) {
args := stripRunFromArgs([]string{"-foo", "bar", "-run=A"})
require.Equal(t, []string{"-foo", "bar"}, args)
})
t.Run("TwoArgs", func(t *testing.T) {
args := stripRunFromArgs([]string{"-foo", "bar", "-run", "A"})
require.Equal(t, []string{"-foo", "bar"}, args)
})
}