plugins

type Capabilities struct {
	Builder    shipwright.Builder
	Testers    []shipwright.Tester
	Artifactor shipwright.Artifactor
	Deployer   shipwright.Deployer
	Runner     shipwright.Runner
}

type MockConfiguration struct {
	AllFunc              func() map[string]any
	EnvironmentFunc      func() string
	GetBoolFunc          func(key string) bool
	GetConfigSummaryFunc func() string
	GetDurationFunc      func(key string) time.Duration
	GetFloatFunc         func(key string) float64
	GetFunc              func(key string) any
	GetIntFunc           func(key string) int
	GetStringFunc        func(key string) string
	HasFunc              func(key string) bool
	LoadFunc             func() error
	LoadWithDefaultsFunc func(defaults map[string]any) error
	LoggingFunc          func() interfaces.LoggingConfig
	PipelineFunc         func() interfaces.PipelineConfig
	RegistryFunc         func() interfaces.RegistryConfig
	SecurityFunc         func() interfaces.SecurityConfig
	SetFunc              func(key string, value any)
	ValidateFunc         func() error
}

type MockHookManager struct {
	ExecuteHooksFunc func(ctx context.Context, stepName string, hookType interfaces.HookType) error
	GetHooksFunc     func(stepName string, hookType interfaces.HookType) []interfaces.HookFunc
	RegisterHookFunc func(stepName string, hookType interfaces.HookType, hook interfaces.HookFunc) error
	RemoveHookFunc   func(stepName string, hookType interfaces.HookType, hook interfaces.HookFunc) error
}

type MockLogger struct {
	DebugFunc      func(msg string, fields ...any)
	ErrorFunc      func(msg string, fields ...any)
	FatalFunc      func(msg string, fields ...any)
	InfoFunc       func(msg string, fields ...any)
	WarnFunc       func(msg string, fields ...any)
	WithFieldFunc  func(key string, value any) interfaces.Logger
	WithFieldsFunc func(fields map[string]any) interfaces.Logger
}

type MockPlugin struct {
	CleanupFunc    func(ctx context.Context) error
	InitializeFunc func(ctx context.Context, pluginCtx PluginContext) error
	NameFunc       func() string
	VersionFunc    func() string
}

type MockPluginContext struct {
	GetConfigurationFunc    func() interfaces.Configuration
	GetDaggerClientFunc     func() (*dagger.Client, error)
	GetHookManagerFunc      func() interfaces.HookManager
	GetLoggerFunc           func() interfaces.Logger
	GetConfigFunc           func() pipelines.Config
	GetCapabilitiesFunc     func() Capabilities
	GetProviderRegistryFunc func() *providers.Registry
	GetStepRegistryFunc     func() interfaces.StepRegistry
}

type MockPluginLoader struct {
	ListBuiltinsFunc    func() []string
	LoadBuiltinFunc     func(ctx context.Context, name string) (Plugin, error)
	LoadFromConfigFunc  func(ctx context.Context, config map[string]interface{}) (Plugin, error)
	LoadFromFileFunc    func(ctx context.Context, filePath string) (Plugin, error)
	RegisterBuiltinFunc func(name string, factory func() Plugin)
}

type MockStepRegistry struct {
	ExecuteStepFunc       func(ctx context.Context, stepName string) error
	GetExecutionOrderFunc func() ([]string, error)
	GetStepConfigFunc     func(stepName string) (interfaces.StepConfig, error)
	GetStepHandlerFunc    func(stepName string) (interfaces.StepHandler, error)
	ListStepsFunc         func() []string
	RegisterStepFunc      func(stepName string, handler interfaces.StepHandler) error
	ValidateStepFunc      func(stepName string) error
}

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

type Plugin interface {
	// Name returns the unique name of the plugin.
	Name() string

	// Version returns the version of the plugin.
	Version() string

	// Initialize is called when the plugin is loaded.
	// The plugin can use this to register hooks, add steps, etc.
	Initialize(ctx context.Context, pluginCtx PluginContext) error

	// Cleanup is called when the plugin is unloaded or the pipeline completes.
	Cleanup(ctx context.Context) error
}

type PluginContext interface {
	// GetDaggerClient returns the Dagger client for container operations.
	GetDaggerClient() (*dagger.Client, error)

	// GetConfiguration returns the pipeline configuration.
	GetConfiguration() interfaces.Configuration

	// GetHookManager returns the hook manager for registering hooks.
	GetHookManager() interfaces.HookManager

	// GetStepRegistry returns the step registry for adding custom steps.
	//
	// Deprecated as an extension point: nothing in the workflow engine
	// executes StepRegistry steps — see the Plugin doc comment.
	GetStepRegistry() interfaces.StepRegistry

	// GetCapabilities returns the Layer 1 capability bundle wired for the
	// current run (replaces the retired GetPipeline()).
	GetCapabilities() Capabilities

	// GetProviderRegistry returns the typed provider registry
	// (internal/workflow/providers, WU7) the current workflow run resolves
	// every manifest step against, so a plugin can CONTRIBUTE a capability
	// implementation into it during Initialize:
	//
	//	reg := pluginCtx.GetProviderRegistry()
	//	reg.RegisterDeployer(providers.Ref{Name: "nomad-deploy", Version: "1"},
	//	    providers.WithSchema{...}, func(v providers.Values) shipwright.Deployer { ... })
	//
	// This is deliberately the registry ITSELF rather than one new Plugin
	// method per capability: WU7 already ships, and already tests, five typed
	// Register*/Resolve* pairs, so the bridge adds one accessor instead of a
	// parallel five-method surface that would have to be kept in sync.
	//
	// Returns nil when the current run wired no registry (for example a unit
	// test constructing a bare PluginContext). A plugin MUST treat nil as
	// "no provider extension point available" and skip registration rather
	// than panic.
	//
	// SECURITY (design.md D-I): the returned registry only ever receives
	// factories from Go code compiled into this binary. Plugins reaching this
	// accessor are loaded through PluginRegistry.LoadBuiltinPlugins, which
	// resolves ONLY compile-time-registered builtin factories and never
	// touches PluginLoader.LoadFromFile/LoadFromConfig — the two paths that
	// can reach plugin.Open. A plugin-contributed provider is therefore still
	// "already compiled, self-registered" exactly as D-I requires.
	GetProviderRegistry() *providers.Registry

	// GetConfig returns the pipeline-specific configuration (replaces the
	// retired GetPipelineConfig()).
	GetConfig() pipelines.Config

	// GetLogger returns the logger instance.
	GetLogger() interfaces.Logger
}

type PluginLoader interface {
	// LoadFromFile loads a plugin from a Go file.
	LoadFromFile(ctx context.Context, filePath string) (Plugin, error)

	// LoadFromConfig loads a plugin from configuration.
	LoadFromConfig(ctx context.Context, config map[string]interface{}) (Plugin, error)

	// LoadBuiltin loads a built-in plugin by name.
	LoadBuiltin(ctx context.Context, name string) (Plugin, error)

	// RegisterBuiltin registers a built-in plugin factory.
	RegisterBuiltin(name string, factory func() Plugin)

	// ListBuiltins returns the names of every compile-time-registered
	// builtin plugin factory, in unspecified order. This is what lets
	// PluginRegistry.LoadBuiltinPlugins load the full builtin set WITHOUT
	// going through configuration — the config path is the only one that can
	// reach plugin.Open.
	ListBuiltins() []string
}

type PluginRegistry interface {
	// RegisterPlugin registers a plugin with the registry.
	RegisterPlugin(plugin Plugin) error

	// LoadPlugin loads a plugin by name from configuration or file.
	LoadPlugin(ctx context.Context, name string, pluginCtx PluginContext) error

	// LoadPluginsFromConfig loads all plugins specified in configuration.
	//
	// SECURITY: this path can reach PluginLoader.LoadFromConfig, whose
	// `type: file` branch calls plugin.Open on a config-supplied path
	// (arbitrary in-process native code). It is NOT used by the --workflow
	// entrypoint — see LoadBuiltinPlugins — and must stay reserved for
	// operator-initiated, out-of-band plugin installation (the security
	// skill's "prefer LoadBuiltin over LoadFromFile" rule).
	LoadPluginsFromConfig(ctx context.Context, pluginCtx PluginContext) error

	// LoadBuiltinPlugins registers and initializes every plugin the
	// PluginLoader has a compile-time builtin factory for
	// (PluginLoader.RegisterBuiltin, called from the DI container's
	// registerPluginComponents). This is the ONLY plugin load path the
	// --workflow CLI entrypoint uses.
	//
	// It never consults configuration and never calls LoadFromConfig or
	// LoadFromFile, so plugin.Open is unreachable from it — the fail-closed
	// counterpart to design.md D-I's "providers resolve only to already
	// compiled, self-registered implementations".
	//
	// Already-registered plugins are skipped, so calling it more than once in
	// a process is safe.
	LoadBuiltinPlugins(ctx context.Context, pluginCtx PluginContext) error

	// GetPlugin retrieves a registered plugin by name.
	GetPlugin(name string) (Plugin, error)

	// ListPlugins returns all registered plugin names.
	ListPlugins() []string

	// InitializeAll initializes all registered plugins.
	InitializeAll(ctx context.Context, pluginCtx PluginContext) error

	// CleanupAll cleans up all registered plugins.
	CleanupAll(ctx context.Context) error
}