Skip to content

suite: fix panic if a WithStats suite skips a test early #1802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+30 −2
Open

suite: fix panic if a WithStats suite skips a test early #1802

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11dce03
Fix panic if a WithStats suite skips a test during SetupTest or Befor…
FGasper Apr 2, 2025
6e0d4f8
alter bug fix
FGasper Apr 3, 2025
a92f108
Refactor: move test
segogoreng Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions suite/stats.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,15 @@ func (s *SuiteInformation) end(testName string, passed bool) {
if s == nil {
return
}
s.TestStats[testName].End = time.Now()
s.TestStats[testName].Passed = passed

testStats, started := s.TestStats[testName]

if !started {
return
}

testStats.End = time.Now()
testStats.Passed = passed
}

func (s *SuiteInformation) Passed() bool {
Expand Down
29 changes: 29 additions & 0 deletions suite/suite_stats_and_skip_test.go
View file
Open in desktop
Copy link
Author

@segogoreng segogoreng Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a new test file for this?
I feel like we can put this in the existing test file.

Copy link
Collaborator

@brackendawson brackendawson Sep 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so too. You might also find there's an existing substitute for mySuite.

Copy link
Author

@segogoreng segogoreng Sep 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the test to suite/suite_test.go and renamed mySuite to a more descriptive suiteSkipTestWithStats

Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package suite

import (
"testing"

"github.com/stretchr/testify/assert"
)

type mySuite struct {
Suite
}

func (s *mySuite) SetupTest() {
s.T().Skip("Just because!")
}
func (s *mySuite) HandleStats(_ string, _ *SuiteInformation) {}

func (s *mySuite) TestSomething() {
panic("Should not get here.")
}

func TestSuiteWithStatsAndSkip(t *testing.T) {
assert.NotPanics(
t,
func() {
Run(t, &mySuite{})
},
)
}