state

Documentation

Overview

Package state contains the type that maintain the state during a run.

Index

• type State
  • func New() *State
  • func (st *State) GetDetached() []string
  • func (st *State) GetEnv() []string
  • func (st *State) GetRunning() []string
  • func (st *State) MapSlice(slice, fullEnv []string) ([]string, error)
  • func (st *State) MarkDetached(name string)
  • func (st *State) MarkRunning(name string)
  • func (st *State) MergeEnv(env []string)
  • func (st *State) UnmarkRunning(name string)
  • func (st *State) Valid() error
  • func (st *State) WrapWithExpandableEnv(env, expandable []string, delimiter string) *State

Types

type State

type State struct {
	CfgPath       string
	CleanupList   *cleanup.List
	Network       network.Network
	Workspace     workspace.Workspace
	KeepWorkspace bool

	DisableDeprecated bool
	ForceSequential   bool
	EnableSSHAgent    bool
	PlanTimeout       time.Duration

	DockerConfig string
	CPUShares    string
	Memory       string
	// contains filtered or unexported fields
}

State holds all of the runtime data during a run.

func New

func New() *State

New creates a new state.

func (*State) GetDetached

func (st *State) GetDetached() []string

GetDetached returns a list of all detached containers.

func (*State) GetEnv

func (st *State) GetEnv() []string

GetEnv gets the fullEnv with the wrapped environments applied.

func (*State) GetRunning

func (st *State) GetRunning() []string

GetRunning returns a list of all running containers.

func (*State) MapSlice

func (st *State) MapSlice(slice, fullEnv []string) ([]string, error)

MapSlice calls SliceMapper on the given environment, but also checks to see if the variable in the env parameter can be expanded into a list.

func (*State) MarkDetached

func (st *State) MarkDetached(name string)

MarkDetached will add the given container name into the list of containers running in detached mode which must be shut down at the end of the plan. This falls through directly to the root state so that states wrapping the global one do not have to sync additional detached container names.

func (*State) MarkRunning

func (st *State) MarkRunning(name string)

MarkRunning will add the given container name into the list of containers currently running. This falls through directly to the root state so that states wrapping the global one do not have to sync additional running container names.

func (*State) MergeEnv

func (st *State) MergeEnv(env []string)

MergeEnv adds additional environment arguments with lower precedence to the original state environment. If they duplicate an existing environment variable, that value will be unchanged.

func (*State) UnmarkRunning

func (st *State) UnmarkRunning(name string)

UnmarkRunning removes a container from the list of running containers.

func (*State) Valid

func (st *State) Valid() error

Valid validates whether the state is correct or not.

func (*State) WrapWithExpandableEnv

func (st *State) WrapWithExpandableEnv(env, expandable []string, delimiter string) *State

WrapWithExpandableEnv will create a shallow clone of the state with a reference to the current state as "parent" with a modified environment. This creates a local stack of states which do not interfere with other goroutines. A pop operation is the same as ignoring the wrapped values and using the underlying state. This stack is used to map a slice within an extended task.