storage

type ArtifactType string

type Field int

type Filter struct {
	Field    Field
	Operator Op
	Value    any
}

type InputEnvVar struct {
	Name   string
	Digest string
}

type InputFile struct {
	Path   string
	Digest string
}

type InputString struct {
	String string
	Digest string
}

type InputTaskInfo struct {
	Name   string
	Digest string
}

type Inputs struct {
	Files                []*InputFile
	Strings              []*InputString
	EnvironmentVariables []*InputEnvVar
	TaskInfo             []*InputTaskInfo
}

type Op int

type Order int

type Output struct {
	Name      string
	Type      ArtifactType
	Digest    string
	SizeBytes uint64
	Uploads   []*Upload
}

type ReleaseTaskRunsResult struct {
	AppName      string
	TaskName     string
	RunID        int
	OutputID     int
	OutputName   string
	URI          string
	UploadMethod UploadMethod
}

type ReleasesDeleteResult struct {
	DeletedReleases int64
}

type Result string

type Sorter struct {
	Field Field
	Order Order
}

type Storer interface {
	Close() error

	// SchemaVersion returns the version of the schema that the storage is
	// using.
	SchemaVersion(ctx context.Context) (int32, error)
	// MaxSchemaVersion returns the max. supported database schema version.
	// It is also the version to that [Upgrade] can migrate the current
	// schema.
	MaxSchemaVersion() int32
	// IsCompatible verifies that the storage is compatible with the baur version
	IsCompatible(context.Context) error
	// Upgrade upgrades the schema to RequiredSchemaVersion().
	// If the database does not exist ErrNotExist is returned.
	Upgrade(ctx context.Context) error
	// Init initializes a storage, e.g. creating the database scheme.
	// If it already exist, ErrExist is returned.
	Init(context.Context) error

	SaveTaskRun(context.Context, *TaskRunFull) (id int, err error)
	LatestTaskRunByDigest(ctx context.Context, appName, taskName, totalInputDigest string) (*TaskRunWithID, error)

	TaskRun(ctx context.Context, id int) (*TaskRunWithID, error)
	// TaskRuns queries the storage for runs that match the filters.
	// A limit value of 0 will return all results.
	// The found results are passed in iterative manner to the callback
	// function. When the callback function returns an error, the iteration
	// stops.
	// When no matching records exist, the method returns ErrNotExist.
	TaskRuns(ctx context.Context,
		filters []*Filter,
		sorters []*Sorter,
		limit uint,
		callback func(*TaskRunWithID) error,
	) error
	TaskRunsDelete(ctx context.Context, before time.Time, pretend bool) (*TaskRunsDeleteResult, error)

	// Inputs returns the inputs of a task run. If no records were found,
	// the method returns ErrNotExist.
	Inputs(ctx context.Context, taskRunID int) (*Inputs, error)
	Outputs(ctx context.Context, taskRunID int) ([]*Output, error)

	// CreateRelease creates a new release called releaseName, that
	// consists of the passed task runs. Metadata is arbitrary data stored
	// together with the release, it is optional and can be nil.
	CreateRelease(_ context.Context, releaseName string, createdAt time.Time, taskRunIDs []int, metadata io.Reader) error
	ReleaseExists(_ context.Context, name string) (bool, error)
	// ReleaseTaskRuns the task runs and their outputs for the release
	// named releaseName.
	// If a task has no outputs the [ReleaseTaskRunsResult.OutputID]
	// [ReleaseTaskRunsResult.OutputName], [ReleaseTaskRunsResult.URI],
	// [ReleaseTaskRunsResult.UploadMethod] fields are unset.
	// If the release does not exist, ErrNotExist is returned.
	ReleaseTaskRuns(ctx context.Context, releaseName string) ([]*ReleaseTaskRunsResult, error)
	// ReleaseMetadata returns the metadata of a release.
	// If the release does not exist ErrNotExist is returned.
	// If the release has no metadata the returned []byte is empty.
	ReleaseMetadata(ctx context.Context, releaseName string) ([]byte, error)
	ReleasesDelete(ctx context.Context, before time.Time, pretend bool) (*ReleasesDeleteResult, error)
}

type TaskRun struct {
	ApplicationName  string
	TaskName         string
	VCSRevision      string
	VCSIsDirty       bool
	StartTimestamp   time.Time
	StopTimestamp    time.Time
	TotalInputDigest string
	Result           Result
}

type TaskRunFull struct {
	TaskRun
	Inputs  Inputs
	Outputs []*Output
}

type TaskRunWithID struct {
	ID int
	TaskRun
}

type TaskRunsDeleteResult struct {
	DeletedTaskRuns int64
	DeletedTasks    int64
	DeletedApps     int64
	DeletedOutputs  int64
	DeletedUploads  int64
	DeletedInputs   int64
	DeletedVCS      int64
}

type Upload struct {
	URI                  string
	UploadStartTimestamp time.Time
	UploadStopTimestamp  time.Time
	Method               UploadMethod
}

type UploadMethod string