ci

Documentation

Index

• Variables
• func IsAvailable() bool
• func RegisterProvider(name string, available func() bool, create func() Provider)
• type Provider
  • func Detect() Provider
• type Runner
  • func NewRunner(c config.Project, cli *command.SauceCtlCli, seq fleet.Sequencer, ...) (*Runner, error)
  • func (r *Runner) RunProject() (int, error)

Variables

var NoProvider = &fakePipeline{CreatedAt: time.Now()}

NoProvider represents a NO-OP provider for cases where no supported CI provider was detected.

Functions

func IsAvailable

func IsAvailable() bool

IsAvailable detects whether this code is executed inside a CI environment

func RegisterProvider

func RegisterProvider(name string, available func() bool, create func() Provider)

RegisterProvider registers a "create" function that returns a new instance of the given Provider function. The "available" function should determine whether this Provider is actually available in the current environment.

Types

type Provider

type Provider interface {
	BuildID() string
	// SetBuildID overrides the CI provided build ID.
	SetBuildID(id string)
}

Provider represents the CI provider.

func Detect

func Detect() Provider

Detect detects which CI environment this code is executed in. It can only find the providers that were previous registered by calling RegisterProvider(). Returns NoProvider if no supported CI provider could be detected.

type Runner

type Runner struct {
	runner.BaseRunner
	CIProvider Provider
}

Runner represents the CI implementation of a runner.Testrunner.

func NewRunner

func NewRunner(c config.Project, cli *command.SauceCtlCli, seq fleet.Sequencer, rc config.RunnerConfiguration, cip Provider) (*Runner, error)

NewRunner creates a new Runner instance.

func (*Runner) RunProject

func (r *Runner) RunProject() (int, error)

RunProject runs the tests defined in config.Project.