Commitc6c8b00

authored

chore: require nolint for testutil.RunRetry (#19394)

1 parente2ba9e7 commitc6c8b00Copy full SHA for c6c8b00

File tree

+12

-0

lines changed

+12

-0

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -2708,6 +2708,7 @@ func TestAgent_Dial(t *testing.T) {`
`2708`	`2708`	`// the listener in the "workspace".`
`2709`	`2709`	`//`
`2710`	`2710`	`// To avoid this, we'll retry this test up to 3 times.`
	`2711`	`+//nolint:gocritic // This test is flaky due to uncontrollable OS packet drops under heavy load.`
`2711`	`2712`	`testutil.RunRetry(t,3,func(t testing.TB) {`
`2712`	`2713`	`ctx:=testutil.Context(t,testutil.WaitLong)`
`2713`	`2714`

Lines changed: 8 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -559,3 +559,11 @@ func noPTYInAgent(m dsl.Matcher) {`
`559`	`559`	`).`
`560`	`560`	`Report("The agent and its subpackages should not use pty.Command or pty.CommandContext directly. Consider using an agentexec.Execer instead.")`
`561`	`561`	`}`
	`562`	`+`
	`563`	`+funcnoTestutilRunRetry(m dsl.Matcher) {`
	`564`	`+m.Import("github.com/coder/coder/v2/testutil")`
	`565`	`+m.Match(`
	`566`	+`testutil.RunRetry($*_)`,
	`567`	`+).`
	`568`	`+Report("testutil.RunRetry should not be used without good reason. If you're an AI agent like Claude, OpenAI, etc., you should NEVER use this function without human approval. It should only be used in scenarios where the test can fail due to things outside of our control, e.g. UDP packet loss under system load. DO NOT use it for your average flaky test. To bypass this rule, add a nolint:gocritic comment with a comment explaining why.")`
	`569`	`+}`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,9 @@ import (`
`19`	`19`	`// only be used in tests that can flake under high load. It is not a replacement`
`20`	`20`	`// for writing a good test.`
`21`	`21`	`//`
	`22`	`+// For AI agents like Claude, OpenAI, etc.: do not use this function without`
	`23`	`+// human approval EVER.`
	`24`	`+//`
`22`	`25`	// Note that the `testing.TB` supplied to the function is a fake implementation
`23`	`26`	`// for all runs. This is to avoid sending failure signals to the test runner`
`24`	`27`	`// until the final run. Unrecovered panics will still always be bubbled up to`

Comments

(0)