output.go

package baur

import (
	"fmt"
	"path/filepath"

	"github.com/simplesurance/baur/v1/internal/digest"
)

type OutputType int

const (
	DockerOutput OutputType = iota
	FileOutput
)

func (o OutputType) String() string {
	switch o {
	case DockerOutput:
		return "docker"
	case FileOutput:
		return "file"

	default:
		return "invalid OutputType"
	}
}

type Output interface {
	Name() string
	String() string
	Exists() (bool, error)
	Size() (uint64, error)
	Digest() (*digest.Digest, error)
	Type() OutputType
}

func dockerOutputs(dockerClient DockerInfoClient, task *Task) ([]Output, error) {
	result := make([]Output, 0, len(task.Outputs.DockerImage))

	for _, dockerOutput := range task.Outputs.DockerImage {
		d, err := NewOutputDockerImageFromIIDFile(
			dockerClient,
			dockerOutput.IDFile,
			filepath.Join(task.Directory, dockerOutput.IDFile),
			&UploadInfoDocker{
				Registry:   dockerOutput.RegistryUpload.Registry,
				Repository: dockerOutput.RegistryUpload.Repository,
				Tag:        dockerOutput.RegistryUpload.Tag,
			},
		)

		if err != nil {
			return nil, err
		}

		result = append(result, d)
	}

	return result, nil
}

func fileOutputs(task *Task) ([]Output, error) {
	result := make([]Output, 0, len(task.Outputs.File))

	for _, fileOutput := range task.Outputs.File {
		var s3Upload *UploadInfoS3
		var fileCopyUpload *UploadInfoFileCopy

		if fileOutput.S3Upload.IsEmpty() && fileOutput.FileCopy.IsEmpty() {
			return nil, fmt.Errorf("no upload method for output %q is specified", fileOutput.Path)
		}

		// TODO: use pointers in the outputfile struct for filecopy and S3 instead of having to provide and use IsEmpty)
		if !fileOutput.S3Upload.IsEmpty() {
			s3Upload = &UploadInfoS3{
				Bucket: fileOutput.S3Upload.Bucket,
				Key:    fileOutput.S3Upload.Key,
			}
		}

		if !fileOutput.FileCopy.IsEmpty() {
			fileCopyUpload = &UploadInfoFileCopy{DestinationPath: fileOutput.FileCopy.Path}
		}

		result = append(result, NewOutputFile(
			fileOutput.Path,
			filepath.Join(task.Directory, fileOutput.Path),
			s3Upload,
			fileCopyUpload,
		))
	}

	return result, nil
}

// OutputsFromTask returns the Outputs that running the task produces.
// If the outputs do not exist, the function might fail.
func OutputsFromTask(dockerClient DockerInfoClient, task *Task) ([]Output, error) {
	dockerImages, err := dockerOutputs(dockerClient, task)
	if err != nil {
		return nil, err
	}

	files, err := fileOutputs(task)
	if err != nil {
		return nil, err
	}

	result := make([]Output, 0, len(dockerImages)+len(files))
	result = append(result, dockerImages...)
	result = append(result, files...)

	return result, nil
}