devtest

type CommonT interface {
	Error(args ...any)
	Errorf(format string, args ...any)
	Fail()
	FailNow()
	SkipNow()

	TempDir() string
	TempDirWithPrefix(prefix string) string
	Cleanup(fn func())
	Log(args ...any)
	Logf(format string, args ...any)
	Helper()
	Name() string

	Logger() log.Logger
	Tracer() trace.Tracer
	Ctx() context.Context
	Require() *testreq.Assertions
}

type P interface {
	CommonT

	// WithCtx makes a copy of P with a specific context.
	// The ctx must match the test-scope of the existing context.
	// This function is used to create a P with annotated context, e.g. a specific resource.
	WithCtx(ctx context.Context) P

	// TempDir creates a temporary directory, and returns the file-path.
	// This directory is cleaned up at the end of the package,
	// and can be shared safely between tests that run in that package scope.
	TempDir() string

	// Cleanup runs the given function at the end of the package-scope.
	// This function will clean-up once the package-level testing is fully complete.
	// These resources can thus be shared safely between tests.
	Cleanup(fn func())

	// Close closes the testing handle. This cancels the context and runs all cleanup.
	Close()
	// contains filtered or unexported methods
}

type T interface {
	CommonT

	// TempDir creates a temporary directory, and returns the file-path.
	// This directory is cleaned up at the end of the test, and must not be shared between tests.
	TempDir() string

	// Cleanup runs the given function at the end of the test-scope,
	// or at the end of the sub-test (if this is a nested test).
	// This function will clean-up before the package-level testing scope may be complete.
	// Do not use the test-scope cleanup with shared resources.
	Cleanup(fn func())

	// Run runs the given function in as a sub-test.
	Run(name string, fn func(T))

	// Ctx returns a context that will be canceled at the end of this (sub) test-scope,
	// and inherits the context of the parent-test-scope.
	Ctx() context.Context

	// WithCtx makes a copy of T with a specific context.
	// The ctx must match the test-scope of the existing context.
	// This function is used to create a T with annotated context, e.g. a specific resource, rather than a sub-scope.
	WithCtx(ctx context.Context) T

	// Parallel signals that this test is to be run in parallel with (and only with) other parallel tests.
	Parallel()

	// Skip is equivalent to Log followed by SkipNow.
	Skip(args ...any)
	// Skipped reports whether the test was skipped.
	Skipped() bool
	// Skipf is equivalent to Logf followed by SkipNow.
	Skipf(format string, args ...any)
	// SkipNow marks the test as skipped and stops test execution.
	// It is remapped to FailNow if the env var DEVNET_EXPECT_PRECONDITIONS_MET is set to true.
	SkipNow()

	// Gate provides everything that Require does, but skips instead of fails the test upon error.
	Gate() *testreq.Assertions

	// MarkFlaky downgrades future test failures to skips unless DEVNET_FAIL_FLAKY_TESTS is set.
	// Call this near the top of the test, before storing any Require()-derived helper.
	MarkFlaky(reason string)

	// Deadline reports the time at which the test binary will have
	// exceeded the timeout specified by the -timeout flag.
	//
	// The ok result is false if the -timeout flag indicates "no timeout" (0).
	Deadline() (deadline time.Time, ok bool)

	// This distinguishes the interface from other testing interfaces,
	// such as the one used at package-level for shared system construction.
	TestOnly()
}