common

type ControlPlaneRefRequiredT bool

type EmptyControlPlaneRefAllowedT bool

type EventuallyConfig struct {
	// Timeout is the maximum time to wait for the condition to be true.
	Timeout time.Duration
	// Period is the time to wait between retries.
	Period time.Duration
}

type ObjectWithControlPlaneRef[T any] interface {
	client.Object
	DeepCopy() T
	SetConditions([]metav1.Condition)
	SetControlPlaneRef(*commonv1alpha1.ControlPlaneRef)
	GetControlPlaneRef() *commonv1alpha1.ControlPlaneRef
}

type ObjectWithParentRef[T any] interface {
	client.Object
	DeepCopy() T
	SetConditions([]metav1.Condition)
	SetParentRef(commonv1alpha1.ObjectRef)
	GetParentRef() commonv1alpha1.ObjectRef
}

type SupportedByKicT bool

type TestCase[T client.Object] struct {
	// Name is the name of the test case.
	Name string

	// SkipReason is the reason to skip the test case.
	SkipReason string

	// TestObject is the object to be tested.
	TestObject T

	// ExpectedErrorMessage is the expected error message when creating the object.
	ExpectedErrorMessage *string

	// ExpectedErrorEventuallyConfig is the configuration for assert.Eventually() which is used to assert the create error.
	// If not provided the error is checked immediately, just once.
	ExpectedErrorEventuallyConfig EventuallyConfig

	// ExpectedUpdateErrorMessage is the expected error message when updating the object.
	ExpectedUpdateErrorMessage *string

	// ExpectedStatusUpdateErrorMessage is the expected error message when updating the object status.
	ExpectedStatusUpdateErrorMessage *string

	// Update is a function that updates the object in the test case after it's created.
	// It can be used to verify CEL rules that verify the previous object's version against the new one.
	Update func(T)

	// StatusUpdate is a function that updates the status of the object in the test case after it's created.
	StatusUpdate func(T)

	// WarningCollector (optional) collects API server warnings emitted during operations.
	// If set together with ExpectedWarningMessage, the test will assert that a warning containing the
	// expected message substring was produced.
	WarningCollector *WarningCollector

	// ExpectedWarningMessage is the substring expected to be found in at least one collected warning.
	ExpectedWarningMessage *string

	// Assert is an optional function to perform additional assertions on the created object.
	// It is called after the object is created and before an update (if specified).
	Assert func(*testing.T, T)
}

type TestCasesGroup[T client.Object] []TestCase[T]

type WarningCollector struct {
	// contains filtered or unexported fields
}