pipeline

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

type CapsuleRequest interface {
	Request
	// Capsule returns a deepcopy of the capsule object being reconciled.
	Capsule() *v1alpha2.Capsule
	// MarkUsedObject marks the object as used by the Capsule which will be present in the Capsule's Status
	MarkUsedObject(res v1alpha2.UsedResource) error
}

type CapsuleRequestOption interface {
	// contains filtered or unexported methods
}

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

type ExecutableRequest[T Request] interface {
	GetRequest() T
	GetBase() *RequestBase
}

type Object struct {
	Current      client.Object
	New          client.Object
	Materialized client.Object
}

type ObjectKey struct {
	client.ObjectKey
	schema.GroupVersionKind
}

type ObjectStatusCallback interface {
	UpdateStatus(namespace string, capsule string, pluginID uuid.UUID, change *apiplugin.ObjectStatusChange)
}

type OutputObject struct {
	ObjectKey ObjectKey
	Object    client.Object
	State     ResourceState
}

type ProjectEnvironmentRequest interface {
	Request
	// ProjectEnvironment returns a deepcopy of the capsule object being reconciled.
	ProjectEnvironment() *v1alpha2.ProjectEnvironment
}

type Request interface {
	// Scheme returns the serialization scheme used by the rig operator.
	// It contains all the types used by a Capsule.
	Scheme() *runtime.Scheme
	// Reader is a Kubernetes reader with access to the cluster the rig operator is running in.
	Reader() client.Reader
	// GetExisting populates 'obj' with a copy of the corresponding object owned by the capsule currently present in the cluster.
	// If the name of 'obj' isn't set, it defaults to the Capsule name.
	GetExisting(gk schema.GroupKind, name string) (client.Object, error)
	GetExistingInto(obj client.Object) error
	// GetNew populates 'obj' with a copy of the corresponding object owned by the capsule about to be applied.
	// If the name of 'obj' isn't set, it defaults to the Capsule name.
	GetNew(gk schema.GroupKind, name string) (client.Object, error)
	GetNewInto(obj client.Object) error
	// Set updates the object recorded to be applied.
	// If the name of 'obj' isn't set, it defaults to the Capsule name.
	Set(obj client.Object) error
	// Delete records the given object to be deleted.
	// The behavior is such that that calling req.Delete(obj) and then req.GetNew(obj)
	// returns a not-found error from GetNew.
	// If an object of the given type and name is present in the cluster, calling req.GetExisting(obj) succeeds
	// as calls to Delete (or Set) will only be applied to the cluster at the very end of the reconcilliation.
	// If the name of 'obj' isn't set, it defaults to the Capsule name.
	Delete(gk schema.GroupKind, name string) error
	// ListExisting returns a list with a copy of the objects of the corresponding type owned by the capsule and currently present in the cluster.
	// If you want a slice of typed objects, use the generic free-standing ListExisting function.
	ListExisting(gk schema.GroupKind) ([]client.Object, error)
	// ListNew returns a list with a copy of the objects of the corresponding type owned by the capsule and about to be applied.
	// If you want a slice of typed objects, use the generic free-standing ListNew function.
	ListNew(gk schema.GroupKind) ([]client.Object, error)
}

type RequestBase struct {
	RequestDeps
	RequestState
	Strategies RequestStrategies
}

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

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

type RequestStrategies interface {
	// Status updating strategies
	UpdateStatusWithChanges(ctx context.Context, changes map[ObjectKey]*Change, generation int64) error
	UpdateStatusWithError(ctx context.Context, err error) error

	// Execution loop strategies
	LoadExistingObjects(ctx context.Context) error
	Prepare()
	OwnedLabel() string

	GetKey(gk schema.GroupKind, name string) (ObjectKey, error)
}

type ResourceState string

type Result struct {
	InputObjects  []client.Object
	OutputObjects []OutputObject
}

type Step[T Request] interface {
	Apply(ctx context.Context, req T) error
	WatchObjectStatus(ctx context.Context, namespace, capsule string, callback ObjectStatusCallback) error
	PluginIDs() []uuid.UUID
}