core

type AWSOptions struct {
	*GlobalOptions
	AWSAccessKeyID     string
	AWSSecretAccessKey string
	AWSRegion          string
	S3Bucket           string
	S3PartSize         int64
}

type AmazonAuth struct {
	AWSRegion     string `yaml:"aws-region"`
	AWSSecretKey  string `yaml:"aws-secret-key"`
	AWSAccessKey  string `yaml:"aws-access-key"`
	AWSRegistryID string `yaml:"aws-registry-id"`
	AWSStrictAuth bool   `yaml:"aws-strict-auth"`
}

type Artifact struct {
	ContainerID   string
	GuestPath     string
	HostTarPath   string
	HostPath      string
	ApplicationID string
	RunID         string
	RunStepID     string
	Bucket        string
	Key           string
	ContentType   string
	Meta          map[string]*string
}

type Authenticatable interface {
	ToAuthenticator(*util.Environment) (auth.Authenticator, error)
}

type AzureAuth struct {
	AzureClientID          string `yaml:"azure-client-id"`
	AzureClientSecret      string `yaml:"azure-client-secret"`
	AzureSubscriptionID    string `yaml:"azure-subscription-id"`
	AzureTenantID          string `yaml:"azure-tenant-id"`
	AzureResourceGroupName string `yaml:"azure-resource-group"`
	AzureRegistryName      string `yaml:"azure-registry-name"`
	AzureLoginServer       string `yaml:"azure-login-server"`
}

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

type BasePipelineOptions struct {
	Options    *PipelineOptions
	Config     *PipelineConfig
	Env        *util.Environment
	Box        Box
	Services   []ServiceBox
	Steps      []Step
	AfterSteps []Step
	Logger     *util.LogEntry
}

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

type BaseStepOptions struct {
	DisplayName string
	Env         *util.Environment
	ID          string
	Name        string
	Owner       string
	SafeID      string
	Version     string
	Cwd         string
	Checkpoint  string
}

type Box interface {
	GetName() string
	GetTag() string
	Repository() string
	Clean() error
	Stop()
	Commit(string, string, string, bool) (*docker.Image, error)
	Restart() (*docker.Container, error)
	AddService(ServiceBox)
	Fetch(context.Context, *util.Environment) (*docker.Image, error)
	Run(context.Context, *util.Environment) (*docker.Container, error)
	RecoverInteractive(string, Pipeline, Step) error
}

type BoxConfig struct {
	ID         string
	Name       string
	Tag        string
	Cmd        string
	Env        map[string]string
	Ports      []string
	Username   string
	Password   string
	Registry   string
	Entrypoint string
	URL        string
	Volumes    string
	Auth       Authenticatable
}

type BoxOptions struct {
	NetworkDisabled bool
}

type BuildFinishedArgs struct {
	Box     Box
	Options *PipelineOptions
	Result  string
}

type BuildStartedArgs struct {
	Options *PipelineOptions
}

type BuildStepFinishedArgs struct {
	Options     *PipelineOptions
	Box         Box
	Build       Pipeline
	Order       int
	Step        Step
	Successful  bool
	Message     string
	ArtifactURL string
	// Only applicable to the store step
	PackageURL string
	// Only applicable to the setup environment step
	WerckerYamlContents string
}

type BuildStepStartedArgs struct {
	Options *PipelineOptions
	Box     Box
	Build   Pipeline
	Order   int
	Step    Step
}

type BuildStepsAddedArgs struct {
	Build      Pipeline
	Options    *PipelineOptions
	Steps      []Step
	StoreStep  Step
	AfterSteps []Step
}

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

type Config struct {
	Box               *RawBoxConfig   `yaml:"box"`
	CommandTimeout    int             `yaml:"command-timeout"`
	NoResponseTimeout int             `yaml:"no-response-timeout"`
	Services          []*RawBoxConfig `yaml:"services"`
	SourceDir         string          `yaml:"source-dir"`
	IgnoreFile        string          `yaml:"ignore-file"`
	PipelinesMap      map[string]*RawPipelineConfig
}

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

type DetectOptions struct {
	*GlobalOptions
}

type DockerAuth struct {
	Username string
	Password string
	Registry string
}

type ExternalStep struct {
	*BaseStep
	// contains filtered or unexported fields
}

type FileCollector interface {
	Collect(path string) (*util.Archive, chan error)
}

type FullPipelineFinishedArgs struct {
	Options             *PipelineOptions
	MainSuccessful      bool
	RanAfterSteps       bool
	AfterStepSuccessful bool
}

type GitOptions struct {
	*GlobalOptions
	GitBranch     string
	GitCommit     string
	GitDomain     string
	GitOwner      string
	GitRepository string
}

type GlobalOptions struct {
	BaseURL    string
	Debug      bool
	Journal    bool
	Verbose    bool
	ShowColors bool

	// Auth
	AuthToken      string
	AuthTokenStore string
}

type InspectOptions struct {
	*PipelineOptions
}

type KeenOptions struct {
	*GlobalOptions
	KeenProjectID       string
	KeenProjectWriteKey string
	ShouldKeenMetrics   bool
}

type LoginOptions struct {
	*GlobalOptions
}

type LogoutOptions struct {
	*GlobalOptions
}

type LogsArgs struct {
	Build   Pipeline
	Options *PipelineOptions
	Order   int
	Step    Step
	Logs    string
	Stream  string
	Hidden  bool
}

type NormalizedEmitter struct {
	*emission.Emitter
	// contains filtered or unexported fields
}

type Pipeline interface {
	// Getters
	Env() *util.Environment // base
	Box() Box               // base
	Services() []ServiceBox //base
	Steps() []Step          // base
	AfterSteps() []Step     // base

	// Methods
	CommonEnv() [][]string     // base
	InitEnv(*util.Environment) // impl
	CollectArtifact(string) (*Artifact, error)
	CollectCache(string) error
	LocalSymlink()
	SetupGuest(context.Context, *Session) error
	ExportEnvironment(context.Context, *Session) error
	SyncEnvironment(context.Context, *Session) error

	LogEnvironment()
	DockerRepo() string
	DockerTag() string
	DockerMessage() string
}

type PipelineConfig struct {
	Box        *RawBoxConfig
	Steps      RawStepsConfig
	AfterSteps RawStepsConfig `yaml:"after-steps"`
	StepsMap   map[string][]*RawStepConfig
	Services   []*RawBoxConfig `yaml:"services"`
	BasePath   string          `yaml:"base-path"`
}

type PipelineDefaultsUsed struct {
	IgnoreFile bool
}

type PipelineOptions struct {
	*GlobalOptions
	*AWSOptions
	// *DockerOptions
	*GitOptions
	*KeenOptions
	*ReporterOptions

	// TODO(termie): i'd like to remove this, it is only used in a couple
	//               places by BasePipeline
	HostEnv *util.Environment

	RunID        string
	DeployTarget string
	Pipeline     string

	ApplicationID            string
	ApplicationName          string
	ApplicationOwnerName     string
	ApplicationStartedByName string

	WerckerContainerRegistry *url.URL

	ShouldCommit  bool
	Repository    string
	Tag           string
	Message       string
	ShouldStoreS3 bool

	WorkingDir string

	GuestRoot  string
	MntRoot    string
	ReportRoot string
	// will be set by pipeline when it initializes
	PipelineBasePath string

	ProjectID   string
	ProjectURL  string
	ProjectPath string

	CommandTimeout    int
	NoResponseTimeout int
	ShouldArtifacts   bool
	ShouldRemove      bool
	SourceDir         string
	IgnoreFile        string

	AttachOnError  bool
	DirectMount    bool
	EnableDevSteps bool
	PublishPorts   []string
	ExposePorts    bool
	EnableVolumes  bool
	WerckerYml     string
	Checkpoint     string

	DefaultsUsed PipelineDefaultsUsed
}

type PipelineResult struct {
	Success           bool
	FailedStepName    string
	FailedStepMessage string
}

type PullOptions struct {
	*GlobalOptions

	Repository string
	Branch     string
	Commit     string
	Status     string
	Result     string
	Output     string
	Load       bool
	Force      bool
}

type RawBoxConfig struct {
	*BoxConfig
}

type RawConfig struct {
	*Config
}

type RawPipelineConfig struct {
	*PipelineConfig
}

type RawStepConfig struct {
	*StepConfig
}

type RawStepsConfig []*RawStepConfig

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

type ReporterOptions struct {
	*GlobalOptions
	ReporterHost string
	ReporterKey  string
	ShouldReport bool
}

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

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

type ServiceBox interface {
	Run(context.Context, *util.Environment, []string) (*docker.Container, error)
	Fetch(ctx context.Context, env *util.Environment) (*docker.Image, error)
	Link() string
	GetID() string
	GetName() string
}

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

type Step interface {
	// Bunch of getters
	DisplayName() string
	Env() *util.Environment
	Cwd() string
	ID() string
	Name() string
	Owner() string
	SafeID() string
	Version() string
	ShouldSyncEnv() bool
	Checkpoint() string

	// Actual methods
	Fetch() (string, error)

	InitEnv(*util.Environment)
	Execute(context.Context, *Session) (int, error)
	CollectFile(string, string, string, io.Writer) error
	CollectArtifact(string) (*Artifact, error)
	// TODO(termie): don't think this needs to be universal
	ReportPath(...string) string
}

type StepConfig struct {
	ID         string
	Cwd        string
	Name       string
	Data       map[string]string
	Checkpoint string
}

type StepDesc struct {
	Name        string
	Version     string
	Description string
	Keywords    []string
	Properties  map[string]StepDescProperty
}

type StepDescProperty struct {
	Default  string
	Required bool
	Type     string
}

type Store interface {
	// StoreFromFile copies a file from local disk to the store
	StoreFromFile(*StoreFromFileArgs) error
}

type StoreFromFileArgs struct {
	// Path to the local file.
	Path string

	// Key of the file as stored in the store.
	Key string

	// ContentType hints to the content-type of the file (might be ignored)
	ContentType string

	// Meta data associated with the upload (might be ignored)
	Meta map[string]*string

	// MaxTries is the maximum that a store should retry should the store fail.
	MaxTries int
}

type Transport interface {
	Attach(context.Context, io.Reader, io.Writer, io.Writer) (context.Context, error)
}

type VersionOptions struct {
	OutputJSON     bool
	BetaChannel    bool
	CheckForUpdate bool
}