fw

type Entrypoint struct {
	// Usage is the way to use the runner application.
	Usage string
	// Description is an extended description of what the runner does and how it works.
	Description string
	// Version is the version of the runner program.
	Version string
	// Author is the author of the runner program.
	Author string
	// Flags are any extra flags you want to handle. We use urfave/cli for managing flags.
	Flags []cli.Flag
	// TeardownTimeout is the amount of time to wait for the runner to tear down
	// everything so it can exit.
	TeardownTimeout time.Duration
	// Launch is the Runner intended to be executed.
	Launch Runner
	// contains filtered or unexported fields
}

type Runner interface {

	//
	// Lifecycle hooks
	//
	// Init is the entrypoint of the runner application and will be run shortly
	// after command line arguments are processed.
	Init(*fwcontext.Context) error
	// BeforeRun is executed to set up the run but not actually execute it.
	BeforeRun(*fwcontext.RunContext) error
	// Run is the actual running of the job. Errors from contexts are handled as
	// cancellations. The status (pass/fail) is returned as the primary value.
	Run(*fwcontext.RunContext) (bool, error)

	//
	// Data calls
	//
	// QueueName is the name of the queue to pull runs off of.
	QueueName() string
	// Hostname is the name of the host; a tag to uniquely identify it.
	Hostname() string

	//
	// Client acquisition
	//
	// QueueClient is a client to the queuesvc.
	QueueClient() *queue.Client
	// LogsvcClient is a client to the logsvc.
	LogsvcClient(*fwcontext.RunContext) *log.SubLogger
}

type SignalContext struct {
	// QueueClient is a client to the queuesvc
	QueueClient *queue.Client
	// RunContext is the run context
	RunContext *fwcontext.RunContext

	Ctx context.Context

	Log     *log.SubLogger
	Channel chan os.Signal

	Entrypoint *Entrypoint
}