provider

Documentation

Index

• Constants
• type ContainerRequest
• type DockerProvider
  • func NewDocker(name string, req DockerRequest) (*DockerProvider, error)
  • func (p *DockerProvider) Exec(ctx context.Context, config ExecConfig) (io.Reader, error)
  • func (p *DockerProvider) Start(ctx context.Context) error
  • func (p *DockerProvider) Teardown(ctx context.Context) error
• type DockerRequest
• type Env
  • func (e Env) ToSlice() []string
• type ExecConfig
• type File
• type Provider

Constants

const DockerProviderName = "docker"

Types

type ContainerRequest

type ContainerRequest struct {
	Image      string
	Entrypoint []string
	User       string // uid:gid
	Env        Env
	Cmd        []string
	Networks   []string
	Privileged bool
	Files      []File
}

type DockerProvider

type DockerProvider struct {
	// contains filtered or unexported fields
}

func NewDocker

func NewDocker(name string, req DockerRequest) (*DockerProvider, error)

func (*DockerProvider) Exec

func (p *DockerProvider) Exec(ctx context.Context, config ExecConfig) (io.Reader, error)

Exec implements Provider.

func (*DockerProvider) Start

func (p *DockerProvider) Start(ctx context.Context) error

Start implements Provider.

func (*DockerProvider) Teardown

func (p *DockerProvider) Teardown(ctx context.Context) error

Teardown implements Provider.

type DockerRequest

type DockerRequest struct {
	ContainerRequest
	Mounts []mount.Mount
}

type Env

type Env map[string]string

func (Env) ToSlice

func (e Env) ToSlice() []string

type ExecConfig

type ExecConfig struct {
	// The command to be executed in the provider
	Command string

	// The working directory to be used to execute the command
	WorkingDir string
}

type File

type File struct {
	Contents io.Reader
	Target   string
	Mode     int64
}

type Provider

type Provider interface {
	Start(ctx context.Context) error
	Teardown(ctx context.Context) error
	Exec(ctx context.Context, config ExecConfig) (io.Reader, error)
}