testoplugin

type FuncChdir func(dir string)

type FuncCleanup func(f func())

type FuncContext func() context.Context

type FuncDeadline func() (deadline time.Time, ok bool)

type FuncError func(args ...any)

type FuncFail func()

type FuncFailNow func()

type FuncFailed func() bool

type FuncFatal func(args ...any)

type FuncLog func(args ...any)

type FuncParallel func()

type FuncSetenv func(key, value string)

type FuncSkip func(args ...any)

type FuncSkipNow func()

type FuncSkipped func() bool

type FuncTempDir func() string

type Hook struct {
	// Priority defines execution order.
	// Lower values indicate that this hook should be run earlier than others and vice versa.
	// Zero value won't affect the order - it uses stable sort internally.
	//
	// See [TryFirst] and [TryLast] for predefined priority constants.
	Priority Priority

	// Func to be run for this hook.
	Func func()
}

type Hooks struct {
	// BeforeAll is called before all tests once.
	BeforeAll Hook

	// BeforeEach is called before each test.
	BeforeEach Hook

	// BeforeEachSub is called before each subtest.
	BeforeEachSub Hook

	// AfterEachSub is called after each subtest.
	//
	// WARN: this hook is defered to run at the end of the test.
	// If that test has sub-tests marked as parallel,
	// this hook will run BEFORE those sub-tests are finished.
	//
	// Unless you need to run sub-tests during this hook,
	// it is recommended to use t.Cleanup during BeforeEachSub.
	AfterEachSub Hook

	// AfterEach is called after each test.
	//
	// NOTE: this hook is defered to run at the end of the test.
	// If that test has sub-tests marked as parallel,
	// this hook will run BEFORE those sub-tests are finished.
	//
	// Unless you need to run sub-tests during this hook,
	// it is recommended to use t.Cleanup during BeforeEach.
	AfterEach Hook

	// AfterAll is called after all tests once.
	AfterAll Hook
}

type Option struct {
	// Value of this option.
	Value any

	// Propagate states whether this option
	// should be passed automatically to all subtests.
	Propagate bool
}

type Override[F any] func(f F) F

type Overrides struct {
	// Priority defines global priority for these overrides.
	// Overrides with lower priority values are called first.
	Priority Priority

	Log      Override[FuncLog]
	Parallel Override[FuncParallel]
	TempDir  Override[FuncTempDir]
	Deadline Override[FuncDeadline]
	Context  Override[FuncContext]
	Cleanup  Override[FuncCleanup]

	// Setenv calls Cleanup to restore an environment variable.
	// On error, it calls Fatal.
	Setenv Override[FuncSetenv]

	// Chdir calls Cleanup to restore a current directory.
	// On error, it calls Fatal.
	Chdir Override[FuncChdir]

	// Error calls Log followed by Fail.
	Error Override[FuncError]

	// Skip calls Log followed by SkipNow.
	Skip    Override[FuncSkip]
	SkipNow Override[FuncSkipNow]
	Skipped Override[FuncSkipped]
	Fail    Override[FuncFail]
	FailNow Override[FuncFailNow]
	Failed  Override[FuncFailed]

	// Fatal calls Log followed by FailNow.
	Fatal Override[FuncFatal]
}

type Plan struct {
	// Priority sets plan priority.
	// Plans with lower priority value are executed first.
	Priority Priority

	// Prepare may filter or re-order planned tests in-place.
	// Nil values are ignored.
	//
	// This function will be called once before running any top-level tests.
	// It will not receive subtests.
	Prepare func(suite testoreflect.SuiteInfo, tests *[]PlannedTest)
}

type PlannedTest interface {
	pragma.DoNotImplement

	// Info about this test.
	Info() testoreflect.TestInfo

	// Annotations of this test.
	Annotations() []Option
}

type Plugin interface {
	Plugin(parent Plugin, options ...Option) Spec
}

type Priority int

type Spec struct {
	Plan      Plan
	Hooks     Hooks
	Overrides Overrides
}