storage

type BundleReference struct {
	// Repository is the bundle's repository in a registry, ghcr.io/sntns/whoami.
	Repository string `json:"repository,omitempty"`
	Version    string `json:"version,omitempty"`
	File       string `json:"file,omitempty"`
}

type Installation struct {
	SchemaVersion string `json:"schemaVersion"`
	InstallationSpec
	Target    target.Target    `json:"target"`
	Installer target.Installer `json:"installer"`
	// RelocationMap says where the bundle's images are, when it was pulled
	// from a registry: the next actions run them from there.
	RelocationMap relocation.ImageRelocationMap `json:"relocationMap,omitempty"`
	Status        InstallationStatus            `json:"status"`
}

type InstallationSpec struct {
	// Name is the installation's name, which is its bundle's.
	Name string `json:"name"`
	// Stack is the stack it belongs to, Porter's namespace. A stack file
	// gives its own to its installations.
	Stack  string          `json:"stack,omitempty"`
	Bundle BundleReference `json:"bundle"`
	// Parameters holds the values given, as text. The values of sensitive
	// parameters are never stored: they are given again.
	Parameters map[string]string `json:"parameters,omitempty"`
	// Credentials are the sources of the credentials, the strategies of a
	// CNAB credential set; their values are never stored.
	Credentials []valuesource.Strategy `json:"credentials,omitempty"`
}

type InstallationStatus struct {
	RunID        string     `json:"runId"`
	Action       string     `json:"action"`
	ResultID     string     `json:"resultId"`
	ResultStatus string     `json:"resultStatus"`
	Created      time.Time  `json:"created"`
	Modified     time.Time  `json:"modified"`
	Installed    *time.Time `json:"installed,omitempty"`
	Uninstalled  *time.Time `json:"uninstalled,omitempty"`
	// BundleReference is where the bundle came from: a bundle.json, or a
	// location, where its images are read from when they are loaded.
	BundleReference string `json:"bundleReference,omitempty"`
	BundleVersion   string `json:"bundleVersion"`
	BundleDigest    string `json:"bundleDigest,omitempty"`
}

type RunCustom struct {
	Target        target.Target                 `json:"target"`
	Installer     target.Installer              `json:"installer"`
	Credentials   []valuesource.Strategy        `json:"credentials,omitempty"`
	RelocationMap relocation.ImageRelocationMap `json:"relocationMap,omitempty"`
}

type Store interface {
	// GetInstallation returns the installation of the bundle in the stack,
	// or ErrNotFound.
	GetInstallation(ctx context.Context, stack, name string) (Installation, error)
	// ListInstallations returns the installations of the stack, by name.
	ListInstallations(ctx context.Context, stack string) ([]Installation, error)
	// SaveInstallation creates or replaces an installation.
	SaveInstallation(ctx context.Context, installation Installation) error
	// SaveRun records an action of an installation: its claim, then its
	// result and outputs once it ran.
	SaveRun(ctx context.Context, stack, name string, run cnab.Claim) error
	SaveResult(ctx context.Context, stack, name string, result cnab.Result, outputs map[string]string) error
	// GetRun returns the claim of an action of the installation.
	GetRun(ctx context.Context, stack, name, id string) (cnab.Claim, error)
	// ListRuns returns the claims of the installation's actions, oldest first.
	ListRuns(ctx context.Context, stack, name string) ([]cnab.Claim, error)
	// ListResults returns the results of the installation's actions, oldest first.
	ListResults(ctx context.Context, stack, name string) ([]cnab.Result, error)
	// GetOutputs returns the outputs a result recorded, by name.
	GetOutputs(ctx context.Context, stack, name, resultID string) (map[string]string, error)
}