flakytest

package

v1.101.0-pre Latest Latest Go to latest Published: Jun 3, 2026 License: BSD-3-Clause Imports: 8 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tailscale/tailscale

Links

Open Source Insights

Documentation ¶

Overview ¶

Package flakytest contains test helpers for marking a test as flaky.

Marking a test with Mark is not required for cmd/testwrapper to retry failed tests; the wrapper retries any failure within a per-test time budget and reports a test as flaky if it ever passes on retry. Mark is useful for tracking a known-flaky test against a GitHub issue and for the TS_SKIP_FLAKY_TESTS skip behavior used to keep CI green when a flake is being investigated.

Constants ¶

View Source

const FlakeAttemptEnv = "TS_TESTWRAPPER_ATTEMPT"

FlakeAttemptEnv is an environment variable that is set by cmd/testwrapper when a flaky test is being (re)tried. It contains the attempt number, starting at 1.

View Source

const FlakyTestLogMessage = "flakytest: this is a known flaky test"

FlakyTestLogMessage is a sentinel value that is printed to stderr when a flaky test is marked. This is used by cmd/testwrapper to detect flaky tests and retry them.

Variables ¶

This section is empty.

Functions ¶

func Mark ¶

func Mark(t testing.TB, issue string)

Mark sets the current test as a flaky test, such that if it fails, it will be retried a few times on failure. issue must be a GitHub issue that tracks the status of the flaky test being marked, of the format:

https://github.com/tailscale/myRepo-H3re/issues/12345

func Marked ¶ added in v1.82.0

func Marked(t testing.TB) bool

Marked reports whether the current test or one of its parents was marked flaky.

Types ¶

This section is empty.

Source Files ¶

View all Source files

flakytest.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL