core

type App interface {
	Name() string
	Config(namespace string, conf interface{}) error
	GlobalConfig(conf interface{}) error
	Shutdown()

	// AppLocation will return the physical filesystem location of this app
	AppLocation() string

	// SendEvent is a dispatcher, it will send this string across all the apps integrations and also Core
	SendEvent(event string)

	// Listen will provide a channel to select on for a given regular expression
	// returned map is the captured groups and values
	// the returned EventHandler can be used to cancel a listener
	Listen(event string, listener func(map[string]string)) EventHandler

	RemoveEventHandler(EventHandler)

	// NewBuild will be used by github and the like to create new builds for this app whenever they deem so
	NewBuild(group string, config *BuildConfig) (token string, err error)
	GetBuild(token string) (Build, error)
	GetBuildHistory(group string) []Build

	// logging functions, logs sent here will go to stdout and on the app bus as log messages
	Loginfof(string, ...interface{})
	Logwarnf(string, ...interface{})
	Logcritf(string, ...interface{})
}

type Build interface {
	Start() error
	Stop() error

	Ref()
	Unref()

	Token() string
	Group() string

	HasStarted() bool
	HasStopped() bool

	// NewBuild() Will be used by slack and the like, /rebuild <token> or buttons or whatever will just lookup the build
	// and call NewBuild() to run the exact same build again
	NewBuild() (token string, err error)

	// Stdout/Stderr give you what you would expect, io.Reader's that will let you access the entire stdout/err output
	Stdout() (io.Reader, error)
	Stderr() (io.Reader, error)

	// ExitCode returns 0, ErrProcessNotFinished
	ExitCode() (int, error)

	// Artifact will return a series of filepaths, artifacts are part of the app config in a map[string][]string format
	// that is, a given named artifact can have many paths associated with it
	// this should be used by say, code coverage tools to generate coverage reports by grabbing artifacts listed here
	Artifact(name string) []string

	BuildTime() time.Duration

	History() []Build

	Config() *BuildConfig

	WebStatusURL() string
}

type BuildConfig struct {

	// Required block
	Title string
	URL   string

	HeadRepo   string
	HeadBranch string
	HeadHash   string

	BaseRepo   string
	BaseBranch string
	BaseHash   string

	Group string

	Integrations []Integration `json:"-"`

	// Should be an executable of some sort, if not set, set by app.NewBuild
	BuildRunner string
	Deadline    time.Duration
	// contains filtered or unexported fields
}

type EventHandler uint32

type Integration interface {
	// Identifier should return what integration this is, "github", "slack", that kind of thing
	Identifier() string

	// IsProvider will when given a string, indicate whether this integration can provide for it
	// strings would be something like
	// http://github.com/foo/bar, or gitlab or git@github.com:foo/bar.git
	IsProvider(string) bool

	// ProvideFor will be called on the integration when it is expected to provide for a build
	// generally this means checkout git repositories into the given directory
	ProvideFor(c *BuildConfig, directory string) error

	// AttachToApp will order the ingeration to do whatever it does, with the given app.
	AttachToApp(App) error

	// Shutdown will be called whenever we are closing, anything the integration needs to do, it has to do syncronously
	Shutdown()
}