devstep

type ConfigLoader interface {
	Load() (*ProjectConfig, error)
}

type DockerClient interface {
	Execute(*DockerExecOpts) error
	Run(*DockerRunOpts) (*DockerRunResult, error)
	RemoveContainer(string) error
	ContainerChanged(string) (bool, error)
	ContainerHasExecInstancesRunning(string) bool
	Commit(*DockerCommitOpts) error
	RemoveImage(string) error
	ListTags(string) ([]string, error)
	ListContainers(string) ([]string, error)
}

type DockerCommitOpts struct {
	ContainerID    string
	RepositoryName string
	Tag            string
}

type DockerExecOpts struct {
	ContainerID string
	User        string
	Cmd         []string
}

type DockerRunOpts struct {
	Name       string
	Detach     bool
	AutoRemove bool
	Pty        bool
	Workdir    string
	Hostname   string
	Privileged *bool
	Env        map[string]string
	Volumes    []string
	Links      []string
	Image      string
	Cmd        []string
	Publish    []string
}

type DockerRunResult struct {
	ContainerID string
	ExitCode    int
}

type PluginRuntime interface {
	Trigger(eventName string) error
	Load(pluginPath string) error
}

type Project interface {
	Config() *ProjectConfig
	Build(DockerClient, *DockerRunOpts) error
	Bootstrap(DockerClient, *DockerRunOpts) error
	Clean(DockerClient) error
	Hack(DockerClient, *DockerRunOpts) error
	Run(DockerClient, *DockerRunOpts) (*DockerRunResult, error)
	Exec(DockerClient, []string) error
}

type ProjectCommand struct {
	Name string
	DockerRunOpts
}

type ProjectConfig struct {
	SourceImage    string                     // image used when starting environments from scratch
	BaseImage      string                     // starting point for the project
	RepositoryName string                     // name of the docker repository this project should be commited
	HostDir        string                     // root directory of the project on the host machine
	GuestDir       string                     // directory where the project sources will be mounted on the container
	CacheDir       string                     // a directory on the host machine were we can place downloaded packages
	Defaults       *DockerRunOpts             // default options passed on to docker for all commands
	HackOpts       *DockerRunOpts             // `devstep hack` specific options passed to the container
	Commands       map[string]*ProjectCommand // shortcut for commands
}