go_hook

type BindingAction struct {
	Name       string // binding name
	Action     string // Disable / UpdateKind
	Kind       string
	ApiVersion string
}

type FilterFunc func(*unstructured.Unstructured) (FilterResult, error)

type FilterResult any

type GoHook interface {
	Config() *HookConfig
	Run(input *sdkpkg.HookInput) error
}

type HookBindingContext struct {
	// Type of binding context: [Event, Synchronization, Group, Schedule]
	Type string
	// Binding is a related binding name.
	Binding string
	// Snapshots contain all objects for all bindings.
	Snapshots map[string][]types.ObjectAndFilterResult
}

type HookConfig struct {
	Schedule   []ScheduleConfig
	Kubernetes []KubernetesConfig
	// OnStartup runs hook on module/global startup
	// Attention! During the startup you don't have snapshots available
	// use native KubeClient to fetch resources
	OnStartup         *OrderedConfig
	OnBeforeHelm      *OrderedConfig
	OnAfterHelm       *OrderedConfig
	OnAfterDeleteHelm *OrderedConfig
	OnBeforeAll       *OrderedConfig
	OnAfterAll        *OrderedConfig
	AllowFailure      bool
	Queue             string
	Settings          *HookConfigSettings
	Logger            *log.Logger
}

type HookConfigLoader interface {
	GetConfigForModule(moduleKind string) (*config.HookConfig, error)
	GetOnStartup() *float64
	GetBeforeAll() *float64
	GetAfterAll() *float64
	GetAfterDeleteHelm() *float64
}

type HookConfigSettings struct {
	ExecutionMinInterval time.Duration
	ExecutionBurst       int

	// EnableSchedulesOnStartup
	// set to true, if you need to run 'Schedule' hooks without waiting addon-operator readiness
	EnableSchedulesOnStartup bool
}

type HookInput struct {
	Snapshots sdkpkg.Snapshots

	Values           sdkpkg.PatchableValuesCollector
	ConfigValues     sdkpkg.PatchableValuesCollector
	MetricsCollector sdkpkg.MetricsCollector
	PatchCollector   PatchCollector

	Logger Logger

	BindingActions *[]BindingAction
}

type HookMetadata struct {
	Name           string
	Path           string
	Global         bool
	EmbeddedModule bool
	ModuleName     string
}

type KubernetesConfig struct {
	// Name is a key in snapshots map.
	Name string
	// ApiVersion of objects. "v1" is used if not set.
	ApiVersion string
	// Kind of objects.
	Kind string
	// NameSelector used to subscribe on object by its name.
	NameSelector *types.NameSelector
	// NamespaceSelector used to subscribe on objects in namespaces.
	NamespaceSelector *types.NamespaceSelector
	// LabelSelector used to subscribe on objects by matching their labels.
	LabelSelector *v1.LabelSelector
	// FieldSelector used to subscribe on objects by matching specific fields (the list of fields is narrow, see shell-operator documentation).
	FieldSelector *types.FieldSelector
	// ExecuteHookOnEvents is true by default. Set to false if only snapshot update is needed.
	ExecuteHookOnEvents *bool
	// ExecuteHookOnSynchronization is true by default. Set to false if only snapshot update is needed.
	ExecuteHookOnSynchronization *bool
	// WaitForSynchronization is true by default. Set to false if beforeHelm is not required this snapshot on start.
	WaitForSynchronization *bool
	// FilterFunc used to filter object content for snapshot. Addon-operator use checksum of this filtered result to ignore irrelevant events.
	FilterFunc FilterFunc
}

type Logger interface {
	sdkpkg.Logger

	// Deprecated: use Debug instead
	Debugf(format string, args ...any)
	// Deprecated: use Error instead
	Errorf(format string, args ...any)
	// Deprecated: use Fatal instead
	Fatalf(format string, args ...any)
	// Deprecated: use Info instead
	Infof(format string, args ...any)
	// Deprecated: use Log instead
	Logf(ctx context.Context, level log.Level, format string, args ...any)
	// Deprecated: use Warn instead
	Warnf(format string, args ...any)
}

type OrderedConfig struct {
	Order float64
}

type PatchCollector interface {
	sdkpkg.PatchCollector

	PatchWithMutatingFunc(fn func(*unstructured.Unstructured) (*unstructured.Unstructured, error), apiVersion string, kind string, namespace string, name string, opts ...sdkpkg.PatchCollectorOption)
}

type ScheduleConfig struct {
	Name string
	// Crontab is a schedule config in crontab format. (5 or 6 fields)
	Crontab string
}

type Snapshots map[string][]sdkpkg.Snapshot

type Wrapped struct {
	Wrapped any
}