dockercompose

Documentation

Index

• Constants
• func FormatError(cmd *exec.Cmd, stdout []byte, err error) error
• type Action
  • func (a Action) MarshalJSON() ([]byte, error)
  • func (a Action) String() string
  • func (a *Action) UnmarshalJSON(b []byte) error
• type Attributes
• type DockerComposeClient
  • func NewDockerComposeClient(env docker.Env) DockerComposeClient
• type Event
  • func EventFromJsonStr(j string) (Event, error)
  • func (evt Event) GuessStatus() Status
  • func (evt Event) IsStartupEvent() bool
  • func (evt Event) IsStopEvent() bool
• type FakeDCClient
  • func NewFakeDockerComposeClient(t *testing.T, ctx context.Context) *FakeDCClient
  • func (c *FakeDCClient) Config(ctx context.Context, pathToConfig string) (string, error)
  • func (c *FakeDCClient) ContainerID(ctx context.Context, pathToConfig string, serviceName model.TargetName) (container.ID, error)
  • func (c *FakeDCClient) Down(ctx context.Context, pathToConfig string, stdout, stderr io.Writer) error
  • func (c *FakeDCClient) SendEvent(evt Event) error
  • func (c *FakeDCClient) Services(ctx context.Context, pathToConfig string) (string, error)
  • func (c *FakeDCClient) StreamEvents(ctx context.Context, pathToConfig string) (<-chan string, error)
  • func (c *FakeDCClient) StreamLogs(ctx context.Context, pathToConfig string, serviceName model.TargetName) (io.ReadCloser, error)
  • func (c *FakeDCClient) Up(ctx context.Context, pathToConfig string, serviceName model.TargetName, ...) error
• type State
  • func (s State) Log() model.Log
  • func (State) ResourceState()
  • func (s State) WithContainerID(cID container.ID) State
  • func (s State) WithCurrentLog(l model.Log) State
  • func (s State) WithStartTime(time time.Time) State
  • func (s State) WithStatus(status Status) State
  • func (s State) WithStopping(stopping bool) State
• type Status
• type Type
  • func (t Type) MarshalJSON() ([]byte, error)
  • func (t Type) String() string
  • func (t *Type) UnmarshalJSON(b []byte) error
• type UpCall

Constants

const (
	StatusDown   = Status("Down")
	StatusInProg = Status("In Progress")
	StatusUp     = Status("OK")
	StatusCrash  = Status("Crash")
)

Three hacky states just for now to get something into the hud.

Functions

func FormatError

func FormatError(cmd *exec.Cmd, stdout []byte, err error) error

Types

type Action

type Action int

const (

	// CONTAINER actions
	ActionUnknown Action = iota
	ActionAttach
	ActionCommit
	ActionCopy
	ActionCreate
	ActionDestroy
	ActionDie
	ActionExecCreate
	ActionExecDetach
	ActionExecDie
	ActionExecStart
	ActionExport
	ActionHealthStatus
	ActionKill
	ActionOom
	ActionPause
	ActionRename
	ActionResize
	ActionRestart
	ActionStart
	ActionStop
	ActionTop
	ActionUnpause
	ActionUpdate
)

func (Action) MarshalJSON

func (a Action) MarshalJSON() ([]byte, error)

func (Action) String

func (a Action) String() string

func (*Action) UnmarshalJSON

func (a *Action) UnmarshalJSON(b []byte) error

type Attributes

type Attributes struct {
	Name  string `json:"name"`
	Image string `json:"image"`
}

type DockerComposeClient

type DockerComposeClient interface {
	Up(ctx context.Context, configPath string, serviceName model.TargetName, shouldBuild bool, stdout, stderr io.Writer) error
	Down(ctx context.Context, configPath string, stdout, stderr io.Writer) error
	StreamLogs(ctx context.Context, configPath string, serviceName model.TargetName) (io.ReadCloser, error)
	StreamEvents(ctx context.Context, configPath string) (<-chan string, error)
	Config(ctx context.Context, configPath string) (string, error)
	Services(ctx context.Context, configPath string) (string, error)
	ContainerID(ctx context.Context, configPath string, serviceName model.TargetName) (container.ID, error)
}

func NewDockerComposeClient

func NewDockerComposeClient(env docker.Env) DockerComposeClient

TODO(dmiller): we might want to make this take a path to the docker-compose config so we don't have to keep passing it in.

type Event

type Event struct {
	Time       string     `json:"time"` // todo: time
	Type       Type       `json:"type"`
	Action     Action     `json:"action"`
	ID         string     `json:"id"` // todo: type?
	Service    string     `json:"service"`
	Attributes Attributes `json:"attributes"`
}

func EventFromJsonStr

func EventFromJsonStr(j string) (Event, error)

func (Event) GuessStatus

func (evt Event) GuessStatus() Status

func (Event) IsStartupEvent

func (evt Event) IsStartupEvent() bool

func (Event) IsStopEvent

func (evt Event) IsStopEvent() bool

type FakeDCClient

type FakeDCClient struct {
	RunLogOutput      map[model.TargetName]<-chan string
	ContainerIdOutput container.ID

	ConfigOutput   string
	ServicesOutput string

	UpCalls []UpCall
	// contains filtered or unexported fields
}

func NewFakeDockerComposeClient

func NewFakeDockerComposeClient(t *testing.T, ctx context.Context) *FakeDCClient

func (*FakeDCClient) Config

func (c *FakeDCClient) Config(ctx context.Context, pathToConfig string) (string, error)

func (*FakeDCClient) ContainerID

func (c *FakeDCClient) ContainerID(ctx context.Context, pathToConfig string, serviceName model.TargetName) (container.ID, error)

func (*FakeDCClient) Down

func (c *FakeDCClient) Down(ctx context.Context, pathToConfig string, stdout, stderr io.Writer) error

func (*FakeDCClient) SendEvent

func (c *FakeDCClient) SendEvent(evt Event) error

func (*FakeDCClient) Services

func (c *FakeDCClient) Services(ctx context.Context, pathToConfig string) (string, error)

func (*FakeDCClient) StreamEvents

func (c *FakeDCClient) StreamEvents(ctx context.Context, pathToConfig string) (<-chan string, error)

func (*FakeDCClient) StreamLogs

func (c *FakeDCClient) StreamLogs(ctx context.Context, pathToConfig string, serviceName model.TargetName) (io.ReadCloser, error)

func (*FakeDCClient) Up

func (c *FakeDCClient) Up(ctx context.Context, pathToConfig string, serviceName model.TargetName,
	shouldBuild bool, stdout, stderr io.Writer) error

type State

type State struct {
	Status      Status
	ContainerID container.ID
	CurrentLog  model.Log
	StartTime   time.Time
	IsStopping  bool
}

func (State) Log

func (s State) Log() model.Log

func (State) ResourceState

func (State) ResourceState()

func (State) WithContainerID

func (s State) WithContainerID(cID container.ID) State

func (State) WithCurrentLog

func (s State) WithCurrentLog(l model.Log) State

func (State) WithStartTime

func (s State) WithStartTime(time time.Time) State

func (State) WithStatus

func (s State) WithStatus(status Status) State

func (State) WithStopping

func (s State) WithStopping(stopping bool) State

type Status

type Status string

type Type

type Type int

https://docs.docker.com/engine/reference/commandline/events/

const (
	// Add 'types' here (and to `stringToType` below) as we support them
	TypeUnknown Type = iota
	TypeContainer
)

func (Type) MarshalJSON

func (t Type) MarshalJSON() ([]byte, error)

func (Type) String

func (t Type) String() string

func (*Type) UnmarshalJSON

func (t *Type) UnmarshalJSON(b []byte) error

type UpCall

type UpCall struct {
	PathToConfig string
	ServiceName  model.TargetName
	ShouldBuild  bool
}

Represents a single call to Up