types

type BytesProducer func(context.Context) ([]byte, error)

type BytesScrubber func([]byte) []byte

type Config struct {
	FilePath      string   `json:"file_path"`
	Args          []string `json:"args"`
	Image         string   `json:"image"`
	EnablePull    bool     `json:"enable_pull"`
	ContainerID   string   `json:"container_id"`
	ContainerName string   `json:"container_name"`
	Command       string   `json:"command"`
	Scrub         Scrub    `json:"scrub"` // TODO: should we pull scrub up one level into Spec?
}

type Doc struct {
	Specs []Spec
}

type DockerRunCommandOptions struct {
	ContainerCreateConfig dockertypes.ContainerCreateConfig
	EnablePull            bool
}

type Planner func(Spec) []Task

type Plugin map[string]Planner

type Result struct {
	Description string `json:"description"`
	// The subpath within the bundle
	Path  string `json:"path"`
	Error error  `json:"error,omitempty"`
}

type Scrub struct {
	Regex   string `json:"regex"`
	Replace string `json:"replace"`
}

type Spec struct {
	ID             string
	Builtin        string
	TimeoutSeconds int
	// paths
	Raw   string
	JSON  string
	Human string

	// Plan-specific config
	Config Config

	// New plan-specific config
	// TODO: new format for all tasks
	DockerRunCommand *DockerRunCommandOptions `json:"docker.run-command,omitempty"`
}

type StreamProducer func(context.Context) (io.Reader, error)

type StreamsProducer func(context.Context) (map[string]io.Reader, error)

type StructuredProducer func(context.Context) (interface{}, error)

type Task interface {
	Exec(ctx context.Context, rootDir string) []*Result
}