tart

Documentation

Index

• Variables
• func Cleanup() error
• func Cmd(ctx context.Context, additionalEnvironment map[string]string, args ...string) (string, string, error)
• func CmdWithLogger(ctx context.Context, additionalEnvironment map[string]string, ...) (string, string, error)
• type Option
  • func WithLogger(logger logger.Lightweight) Option
  • func WithMountTemporaryWorkingDirectoryFromHost() Option
  • func WithSoftnet() Option
• type Tart
  • func New(vmName string, sshUser string, sshPassword string, cpu uint32, memory uint32, ...) (*Tart, error)
  • func (tart *Tart) Close() error
  • func (tart *Tart) Run(ctx context.Context, config *runconfig.RunConfig) (err error)
  • func (tart *Tart) WorkingDirectory(projectDir string, dirtyMode bool) string
• type VM
  • func NewVMClonedFrom(ctx context.Context, from string, to string, cpu uint32, memory uint32, ...) (*VM, error)
  • func (vm *VM) Close() error
  • func (vm *VM) ErrChan() chan error
  • func (vm *VM) Ident() string
  • func (vm *VM) RetrieveIP(ctx context.Context) (string, error)
  • func (vm *VM) Start(softnet bool, directoryMounts []directoryMount)

Variables

var (
	ErrTartNotFound = errors.New("tart command not found")
	ErrTartFailed   = errors.New("tart command returned non-zero exit code")
)

var (
	ErrFailed     = errors.New("tart isolation failed")
	ErrSyncFailed = errors.New("failed to sync project directory")
)

Functions

func Cleanup

func Cleanup() error

func Cmd

func Cmd(
	ctx context.Context,
	additionalEnvironment map[string]string,
	args ...string,
) (string, string, error)

func CmdWithLogger

func CmdWithLogger(
	ctx context.Context,
	additionalEnvironment map[string]string,
	logger *echelon.Logger,
	args ...string,
) (string, string, error)

Types

type Option

type Option func(*Tart)

func WithLogger

func WithLogger(logger logger.Lightweight) Option

func WithMountTemporaryWorkingDirectoryFromHost

func WithMountTemporaryWorkingDirectoryFromHost() Option

func WithSoftnet

func WithSoftnet() Option

type Tart

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

func New

func New(vmName string, sshUser string, sshPassword string, cpu uint32, memory uint32, opts ...Option) (*Tart, error)

func (*Tart) Close

func (tart *Tart) Close() error

func (*Tart) Run

func (tart *Tart) Run(ctx context.Context, config *runconfig.RunConfig) (err error)

func (*Tart) WorkingDirectory

func (tart *Tart) WorkingDirectory(projectDir string, dirtyMode bool) string

type VM

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

func NewVMClonedFrom

func NewVMClonedFrom(
	ctx context.Context,
	from string,
	to string,
	cpu uint32,
	memory uint32,
	lazyPull bool,
	env map[string]string,
	logger *echelon.Logger,
) (*VM, error)

func (*VM) Close

func (vm *VM) Close() error

func (*VM) ErrChan

func (vm *VM) ErrChan() chan error

func (*VM) Ident

func (vm *VM) Ident() string

func (*VM) RetrieveIP

func (vm *VM) RetrieveIP(ctx context.Context) (string, error)

func (*VM) Start

func (vm *VM) Start(
	softnet bool,
	directoryMounts []directoryMount,
)