consul/sdk/testutil/retry/doc.go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

// Package retry provides support for repeating operations in tests.
//
// A sample retry operation looks like this:
//
//	func TestX(t *testing.T) {
//	    retry.Run(t, func(r *retry.R) {
//	        if err := foo(); err != nil {
//				r.Errorf("foo: %s", err)
//				return
//	        }
//	    })
//	}
//
// Run uses the DefaultFailer, which is a Timer with a Timeout of 7s,
// and a Wait of 25ms. To customize, use RunWith.
//
// WARNING: unlike *testing.T, *retry.R#Fatal and FailNow *do not*
// fail the test function entirely, only the current run the retry func
package retry
Retry lint fixes (#19151) * Add a make target to run lint-consul-retry on all the modules * Cleanup sdk/testutil/retry * Fix a bunch of retry.Run* usage to not use the outer testing.T * Fix some more recent retry lint issues and pin to v1.4.0 of lint-consul-retry * Fix codegen copywrite lint issues * Don’t perform cleanup after each retry attempt by default. * Use the common testutil.TestingTB interface in test-integ/tenancy * Fix retry tests * Update otel access logging extension test to perform requests within the retry block 12 months ago			`// Copyright (c) HashiCorp, Inc.`
			`// SPDX-License-Identifier: MPL-2.0`

			`// Package retry provides support for repeating operations in tests.`
			`//`
			`// A sample retry operation looks like this:`
			`//`
			`// func TestX(t *testing.T) {`
			`// retry.Run(t, func(r *retry.R) {`
			`// if err := foo(); err != nil {`
			`// r.Errorf("foo: %s", err)`
			`// return`
			`// }`
			`// })`
			`// }`
			`//`
			`// Run uses the DefaultFailer, which is a Timer with a Timeout of 7s,`
			`// and a Wait of 25ms. To customize, use RunWith.`
			`//`
			`// WARNING: unlike testing.T, retry.R#Fatal and FailNow do not`
			`// fail the test function entirely, only the current run the retry func`
			`package retry`