resourcehelpers

type Registry interface {
	// GetSpecDefinition returns the definition of a resource spec
	// in the registry.
	GetSpecDefinition(
		ctx context.Context,
		resourceType string,
		input *provider.ResourceGetSpecDefinitionInput,
	) (*provider.ResourceGetSpecDefinitionOutput, error)

	// GetTypeDescription returns the description of a resource type
	// in the registry.
	GetTypeDescription(
		ctx context.Context,
		resourceType string,
		input *provider.ResourceGetTypeDescriptionInput,
	) (*provider.ResourceGetTypeDescriptionOutput, error)

	// HasResourceType checks if a resource type is available in the registry.
	HasResourceType(ctx context.Context, resourceType string) (bool, error)

	// ListResourceTypes returns a list of all resource types available in the registry.
	ListResourceTypes(ctx context.Context) ([]string, error)

	// CustomValidate allows for custom validation of a resource of a given type.
	CustomValidate(
		ctx context.Context,
		resourceType string,
		input *provider.ResourceValidateInput,
	) (*provider.ResourceValidateOutput, error)

	// Deploy deals with the deployment of a resource of a given type.
	// The caller can specify whether or not to wait until the resource is considered
	// stable.
	Deploy(
		ctx context.Context,
		resourceType string,
		input *provider.ResourceDeployServiceInput,
	) (*provider.ResourceDeployOutput, error)

	// Destroy deals with the destruction of a resource of a given type.
	Destroy(
		ctx context.Context,
		resourceType string,
		input *provider.ResourceDestroyInput,
	) error

	// StabilisedDependencies lists the resource types that are required to be stable
	// when a resource that is a dependency of the given resource type is being deployed.
	GetStabilisedDependencies(
		ctx context.Context,
		resourceType string,
		input *provider.ResourceStabilisedDependenciesInput,
	) (*provider.ResourceStabilisedDependenciesOutput, error)

	// LookupResourceInState retrieves a resource of a given type
	// from the blueprint state.
	LookupResourceInState(
		ctx context.Context,
		input *provider.ResourceLookupInput,
	) (*state.ResourceState, error)

	// HasResourceInState checks if a resource of a given type
	// exists in the blueprint state.
	HasResourceInState(
		ctx context.Context,
		input *provider.ResourceLookupInput,
	) (bool, error)

	// AcquireResourceLock acquires a lock on a resource
	// in the blueprint state to ensure that no other operations
	// are modifying the resource at the same time.
	// This is useful for links that need to update existing resources
	// in the same blueprint as a part of the intermediary resources update phase.
	// The blueprint container will ensure that the lock is released after the
	// update intermediary resources phase is complete for the current link.
	// The lock will be released if the link update fails or by the resource registry
	// if a lock timeout occurs.
	AcquireResourceLock(
		ctx context.Context,
		input *provider.AcquireResourceLockInput,
	) error

	// ReleaseResourceLock releases a lock on a resource of a given type
	// in the blueprint state.
	// This is to be used by the deployment orchestrator to release the lock
	// after the link update phase is complete or the link update fails.
	ReleaseResourceLock(
		ctx context.Context,
		instanceID string,
		resourceName string,
	)

	// ReleaseResourceLocks releases all resource locks
	// that have been acquired for the given instance ID.
	ReleaseResourceLocks(ctx context.Context, instanceID string)

	// ReleaseResourceLocksAcquiredBy releases all resource locks
	// that have been acquired by a specific caller (e.g. a link).
	// This is useful for releasing locks proactively instead of waiting
	// for the lock timeout to occur.
	ReleaseResourceLocksAcquiredBy(ctx context.Context, instanceID string, acquiredBy string)

	// WithParams creates a new registry derived from the current registry
	// with the given parameters.
	WithParams(
		params core.BlueprintParams,
	) Registry
}

type RegistryOption func(*registryFromProviders)