Not detected if it is inside a test suite

[vitorf7]

Thanks for the amazing work on this linter.

I was just using it today and noticed that it was not picking up the usage of context.Background() when using it with a test suite.

For example this would not be caught:

type MyTestSuite struct {
	suite.Suite
	cntr       *cockroachdb.CockroachDBContainer
}

func (c *MyTestSuite) SetupTest() {
	ctx := context.Background() // This line should be detected

	cntr, err := cockroachdb.Run(ctx, "cockroachdb/cockroach:latest-v23.2")
	c.Require().NoError(err)
...
}

[ldez]

Hello, thanks,

This is expected because the linter detects test functions, test cases based onsuite.Suite from Testify are not test functions.

[HaraldNordgren]

@ldez Would it make more sense to add that to https://github.com/Antonboom/testifylint instead you think?

Now, it's a slightly weird when context.Background() blocks are changed, but the same doesn't happen inside suites 🤗

[vitorf7]

@ldez Would it make more sense to add that to https://github.com/Antonboom/testifylint instead you think?

Now, it's a slightly weird when context.Background() blocks are changed, but the same doesn't happen inside suites 🤗

Where I work I had begun doing a massive change in a monorepo we have but it was taking a while to get every team to approve the changes and/or make changes in their approach.
The way we were gonna try to do this was to introduce a custom go-ruleguard check.

//go:build ruleguard
// +build ruleguard

package ruleguard

import "github.com/quasilyte/go-ruleguard/dsl"

func suiteContext(m dsl.Matcher) {
	m.Match(
		`context.Background`,
		`context.TODO`,
	).
		Where(m.File().Name.Matches("_test.go") && m.File().Imports("github.com/stretchr/testify/suite")).
		Report(`use suite.T().Context() instead of context.Background() or context.TODO()`)
}