runner

Documentation

Index

• type Run
  • func (r *Run) AfterRun() error
  • func (r *Run) BeforeRun() error
  • func (r *Run) Name() string
  • func (r *Run) Run() (bool, error)
  • func (r *Run) RunContext() *fwcontext.RunContext
  • func (r *Run) String() string
• type Runner
  • func (r *Runner) AfterRun(string, *fwcontext.RunContext)
  • func (r *Runner) Hostname() string
  • func (r *Runner) Init(ctx *fwcontext.Context) error
  • func (r *Runner) LogsvcClient(ctx *fwcontext.RunContext) *log.SubLogger
  • func (r *Runner) MakeRun(name string, runCtx *fwcontext.RunContext) (fw.Run, error)
  • func (r *Runner) QueueClient() *queue.Client
  • func (r *Runner) QueueName() string
  • func (r *Runner) Ready() bool

Types

type Run

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

Run is a single run

func (*Run) AfterRun

func (r *Run) AfterRun() error

AfterRun does nothing in the null-runner.

func (*Run) BeforeRun

func (r *Run) BeforeRun() error

BeforeRun is executed before the next run is started.

func (*Run) Name

func (r *Run) Name() string

Name is the name of the run

func (*Run) Run

func (r *Run) Run() (bool, error)

Run runs the CI job.

func (*Run) RunContext

func (r *Run) RunContext() *fwcontext.RunContext

RunContext returns the context for this run

func (*Run) String

func (r *Run) String() string

type Runner

type Runner struct {
	sync.Mutex
	Config    *config.Config
	NextState bool
}

Runner encapsulates an infinite lifecycle overlay-runner.

func (*Runner) AfterRun

func (r *Runner) AfterRun(string, *fwcontext.RunContext)

AfterRun does nothing in this runner.

func (*Runner) Hostname

func (r *Runner) Hostname() string

Hostname is the reported hostname of the machine; an identifier. Not necessary for anything and insecure, just ornamental.

func (*Runner) Init

func (r *Runner) Init(ctx *fwcontext.Context) error

Init is the bootstrap of the runner.

func (*Runner) LogsvcClient

func (r *Runner) LogsvcClient(ctx *fwcontext.RunContext) *log.SubLogger

LogsvcClient returns the system log client. Must be called after configuration is initialized

func (*Runner) MakeRun

func (r *Runner) MakeRun(name string, runCtx *fwcontext.RunContext) (fw.Run, error)

MakeRun makes a new run for the framework to use.

func (*Runner) QueueClient

func (r *Runner) QueueClient() *queue.Client

QueueClient returns the queue client

func (*Runner) QueueName

func (r *Runner) QueueName() string

QueueName is the name of the queue this runner should be processing.

func (*Runner) Ready

func (r *Runner) Ready() bool

Ready indicates the null runner is ready