bootstrap

Documentation

Index

• type DBOptions
• type Duration
  • func (d *Duration) MarshalTOML() ([]byte, error)
  • func (d *Duration) UnmarshalText(text []byte) error
• type Info
• type NewRunner
• type NilValidator
  • func (v *NilValidator) Validate() error
• type Runner
• type TaskMaster
  • func NewTaskMaster(appName string, initFn NewRunner, options Validator) *TaskMaster
  • func (tm *TaskMaster) AppName() string
  • func (tm *TaskMaster) AppOpt() interface{}
  • func (tm *TaskMaster) Description(description string) *TaskMaster
  • func (tm *TaskMaster) FileOpts() *TaskMaster
  • func (tm *TaskMaster) GetBusOpts() *bus.Options
  • func (tm *TaskMaster) GetFileOpts() *file.Options
  • func (tm *TaskMaster) HandleRequest(w http.ResponseWriter, r *http.Request)
  • func (tm *TaskMaster) HttpPort() int
  • func (tm *TaskMaster) Initialize() *TaskMaster
  • func (tm *TaskMaster) Log(format string, v ...interface{})
  • func (tm *TaskMaster) Logger() *log.Logger
  • func (tm *TaskMaster) MySQLDB() *sql.DB
  • func (tm *TaskMaster) MySQLOpts() *TaskMaster
  • func (tm *TaskMaster) NewConsumer() bus.Consumer
  • func (tm *TaskMaster) NewProducer() bus.Producer
  • func (tm *TaskMaster) PostgresDB() *sql.DB
  • func (tm *TaskMaster) PostgresOpts() *TaskMaster
  • func (tm *TaskMaster) Run()
  • func (tm *TaskMaster) SetHandler(fn func(http.ResponseWriter, *http.Request))
  • func (tm *TaskMaster) SetLogger(lgr *log.Logger) *TaskMaster
  • func (tm *TaskMaster) Version(version string) *TaskMaster
• type Utility
  • func NewUtility(name string, config interface{}) *Utility
  • func (u *Utility) AddInfo(info func() interface{}, port int) *Utility
  • func (u *Utility) Description(description string) *Utility
  • func (u *Utility) Initialize()
  • func (u *Utility) Version(version string) *Utility
• type Validator
• type Worker
  • func NewWorkerApp(tskType string, newWkr task.NewWorker, options Validator) *Worker
  • func (w *Worker) Description(description string) *Worker
  • func (w *Worker) FileOpts() *Worker
  • func (w *Worker) GetFileOpts() *file.Options
  • func (w *Worker) HandleRequest(wr http.ResponseWriter, r *http.Request)
  • func (w *Worker) HttpPort() int
  • func (w *Worker) InfoStats() Info
  • func (w *Worker) Initialize() *Worker
  • func (w *Worker) Log(format string, v ...interface{})
  • func (w *Worker) Logger() *log.Logger
  • func (w *Worker) MySQLDB() *sql.DB
  • func (w *Worker) MySQLOpts() *Worker
  • func (w *Worker) NewConsumer(topic, channel string) bus.Consumer
  • func (w *Worker) NewProducer() bus.Producer
  • func (w *Worker) PostgresDB() *sql.DB
  • func (w *Worker) PostgresOpts() *Worker
  • func (w *Worker) Run()
  • func (w *Worker) SetLogger(lgr *log.Logger) *Worker
  • func (w *Worker) TaskType() string
  • func (w *Worker) Version(version string) *Worker

Types

type DBOptions

type DBOptions struct {
	Username     string `toml:"username" commented:"true"`
	Password     string `toml:"password" commented:"true"`
	Host         string `toml:"host" comment:"host can be 'host:port', 'host', 'host:' or ':port'"`
	DBName       string `toml:"dbname"`
	Serializable bool   `toml:"serializable" comment:"set isolation level to serializable, required for proper writing to database" commented:"true"`
}

type Duration

type Duration struct {
	time.Duration
}

Duration is a wrapper around time.Duration and allows for automatic toml string parsing of time.Duration values. Use this type in a custom config for automatic serializing and de-serializing of time.Duration.

func (*Duration) MarshalTOML

func (d *Duration) MarshalTOML() ([]byte, error)

func (*Duration) UnmarshalText

func (d *Duration) UnmarshalText(text []byte) error

type Info

type Info struct {
	AppName       string             `json:"app_name"`
	LauncherStats task.LauncherStats `json:"launcher,omitempty"`
	ProducerStats *info.Producer     `json:"producer,omitempty"`
	ConsumerStats *info.Consumer     `json:"consumer,omitempty"`
}

type NewRunner

type NewRunner func(*TaskMaster) Runner

type NilValidator

type NilValidator struct{}

NilValidator satisfies the Validator interface but does nothing.

func (*NilValidator) Validate

func (v *NilValidator) Validate() error

type Runner

type Runner interface {
	Run(ctx context.Context) error
	Info() interface{}
}

type TaskMaster

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

func NewTaskMaster

func NewTaskMaster(appName string, initFn NewRunner, options Validator) *TaskMaster

NewTaskMaster will create a new taskmaster bootstrap application. *appName: defines the taskmaster name; acts as a name for identification and easy-of-use (required) *mkr: MakeWorker function that the launcher will call to create a new worker. *options: a struct pointer to additional specific application config options. Note that

the bootstrapped WorkerApp already provides bus and launcher config options and the user
can request to add postgres and mysql config options.

func (*TaskMaster) AppName

func (tm *TaskMaster) AppName() string

AppName returns the AppName initialized with the WorkerApp.

func (*TaskMaster) AppOpt

func (tm *TaskMaster) AppOpt() interface{}

func (*TaskMaster) Description

func (tm *TaskMaster) Description(description string) *TaskMaster

Description allows the user to set a description of the worker that will be shown with the help screen.

The description should also include information about what the worker expects from the NewWorker 'info' string.

func (*TaskMaster) FileOpts

func (tm *TaskMaster) FileOpts() *TaskMaster

FileOpts provides file options such as aws connection info.

func (*TaskMaster) GetBusOpts

func (tm *TaskMaster) GetBusOpts() *bus.Options

func (*TaskMaster) GetFileOpts

func (tm *TaskMaster) GetFileOpts() *file.Options

func (*TaskMaster) HandleRequest

func (tm *TaskMaster) HandleRequest(w http.ResponseWriter, r *http.Request)

HandleRequest is a simple http handler function that takes the compiled status functions that are called and the results marshaled to return as the body of the response

func (*TaskMaster) HttpPort

func (tm *TaskMaster) HttpPort() int

HttpPort gets the application http port for requesting a heath check on the application itself.

func (*TaskMaster) Initialize

func (tm *TaskMaster) Initialize() *TaskMaster

Initialize is non-blocking and will perform application startup tasks such as: *Parsing and handling flags *Parsing and validating the config file *Setting config defaults

Note that start will handle application closure if there was an error during startup or a flag option was provided that asked the application to show the version, for example. So, if start is able to finish by returning, the user knows it is safe to move on.

func (*TaskMaster) Log

func (tm *TaskMaster) Log(format string, v ...interface{})

Log is a wrapper around the application logger Printf method.

func (*TaskMaster) Logger

func (tm *TaskMaster) Logger() *log.Logger

Logger returns a reference to the application logger.

func (*TaskMaster) MySQLDB

func (tm *TaskMaster) MySQLDB() *sql.DB

MySQLDB returns the MySQL sql.DB application connection. Will be nil if called before Start() or MySQLOpts() was not called.

func (*TaskMaster) MySQLOpts

func (tm *TaskMaster) MySQLOpts() *TaskMaster

MySQLOpts will parse mysql db connection options from the config toml file.

If using mysql options then a mysql db connection is made during startup. The mysql db connection is available through the MySQL() method.

MySQLOpts needs to be called before Start() to be effective.

If the user needs more than one db connection then those connection options need to be made available with the WorkerApp initialization. Note that the DBOptions struct is available to use in this way.

func (*TaskMaster) NewConsumer

func (tm *TaskMaster) NewConsumer() bus.Consumer

NewConsumer is a convenience method that will use the bus config information to create a new consumer instance. Can optionally provide a topic and channel on which to consume. All other bus options are the same.

func (*TaskMaster) NewProducer

func (tm *TaskMaster) NewProducer() bus.Producer

NewProducer will use the bus config information to create a new producer instance.

func (*TaskMaster) PostgresDB

func (tm *TaskMaster) PostgresDB() *sql.DB

PostgresDB returns the Postgres sql.DB application connection. Will be nil if called before Start() or PostgresOpts() was not called.

func (*TaskMaster) PostgresOpts

func (tm *TaskMaster) PostgresOpts() *TaskMaster

PostgresOpts will parse postgres db connection options from the config toml file.

If using postgres options then a postgres db connection is made during startup. The postgres db connection is available through the Postgres() method.

PostgresOpts needs to be called before Start() to be effective.

If the user needs more than one db connection then those connection options need to be made available with the WorkerApp initialization. Note that the DBOptions struct is available to use in this way.

func (*TaskMaster) Run

func (tm *TaskMaster) Run()

Run until the application is complete and then exit.

func (*TaskMaster) SetHandler

func (tm *TaskMaster) SetHandler(fn func(http.ResponseWriter, *http.Request))

SetHandler will overwrite the current HandleRequest function on root requests

func (*TaskMaster) SetLogger

func (tm *TaskMaster) SetLogger(lgr *log.Logger) *TaskMaster

SetLogger allows the user to override the default application logger (stdout) with a custom one.

If the provided logger is nil the logger output is discarded.

SetLogger should be called before initializing the application.

func (*TaskMaster) Version

func (tm *TaskMaster) Version(version string) *TaskMaster

Version sets the application version. The version is what is shown if the '-version' flag is specified when running the WorkerApp.

type Utility

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

func NewUtility

func NewUtility(name string, config interface{}) *Utility

func (*Utility) AddInfo

func (u *Utility) AddInfo(info func() interface{}, port int) *Utility

func (*Utility) Description

func (u *Utility) Description(description string) *Utility

func (*Utility) Initialize

func (u *Utility) Initialize()

func (*Utility) Version

func (u *Utility) Version(version string) *Utility

type Validator

type Validator interface {
	Validate() error
}

Validator provides a standard method for running underlying validation for underlying object values.

type Worker

type Worker struct {
	Info // info stats on various worker types
	// contains filtered or unexported fields
}

func NewWorkerApp

func NewWorkerApp(tskType string, newWkr task.NewWorker, options Validator) *Worker

NewWorkerApp will create a new worker bootstrap application. *tskType: defines the worker type; the type of tasks the worker is expecting. Also acts as a name for identification (required) *mkr: MakeWorker function that the launcher will call to create a new worker. *options: a struct pointer to additional specific application config options. Note that

the bootstrapped Worker already provides bus and launcher config options and the user
can request to add postgres and mysql config options.

func (*Worker) Description

func (w *Worker) Description(description string) *Worker

Description allows the user to set a description of the worker that will be shown with the help screen.

The description should also include information about what the worker expects from the NewWorker 'info' string.

func (*Worker) FileOpts

func (w *Worker) FileOpts() *Worker

FileOpts provides file options such as aws connection info.

func (*Worker) GetFileOpts

func (w *Worker) GetFileOpts() *file.Options

func (*Worker) HandleRequest

func (w *Worker) HandleRequest(wr http.ResponseWriter, r *http.Request)

HandleRequest is a simple http handler function that takes the compiled status functions that are called and the results marshaled to return as the body of the response

func (*Worker) HttpPort

func (w *Worker) HttpPort() int

HttpPort gets the application http port for requesting a heath check on the application itself. If the port is not provided The port should alwasy be provided

func (*Worker) InfoStats

func (w *Worker) InfoStats() Info

InfoStats for the Worker app

func (*Worker) Initialize

func (w *Worker) Initialize() *Worker

Initialize is non-blocking and will perform application startup tasks such as: *Parsing and handling flags *Parsing and validating the config file *Setting config defaults

Note that Initialize will handle application closure if there was an error during startup or a flag option was provided that asked the application to show the version, for example. So, if Initialize is able to finish by returning, the user knows it is safe to move on.

func (*Worker) Log

func (w *Worker) Log(format string, v ...interface{})

Log is a wrapper around the application logger Printf method.

func (*Worker) Logger

func (w *Worker) Logger() *log.Logger

Logger returns a reference to the application logger.

func (*Worker) MySQLDB

func (w *Worker) MySQLDB() *sql.DB

MySQLDB returns the MySQL sql.DB application connection. Will be nil if called before Start() or MySQLOpts() was not called.

func (*Worker) MySQLOpts

func (w *Worker) MySQLOpts() *Worker

MySQLOpts will parse mysql db connection options from the config toml file.

If using mysql options then a mysql db connection is made during startup. The mysql db connection is available through the MySQL() method.

MySQLOpts needs to be called before Start() to be effective.

If the user needs more than one db connection then those connection options need to be made available with the Worker initialization. Note that the DBOptions struct is available to use in this way.

func (*Worker) NewConsumer

func (w *Worker) NewConsumer(topic, channel string) bus.Consumer

NewConsumer is a convenience method that will use the bus config information to create a new consumer instance. Can optionally provide a topic and channel on which to consume. All other bus options are the same.

func (*Worker) NewProducer

func (w *Worker) NewProducer() bus.Producer

NewProducer will use the bus config information to create a new producer instance.

func (*Worker) PostgresDB

func (w *Worker) PostgresDB() *sql.DB

PostgresDB returns the Postgres sql.DB application connection. Will be nil if called before Start() or PostgresOpts() was not called.

func (*Worker) PostgresOpts

func (w *Worker) PostgresOpts() *Worker

PostgresOpts will parse postgres db connection options from the config toml file.

If using postgres options then a postgres db connection is made during startup. The postgres db connection is available through the Postgres() method.

PostgresOpts needs to be called before Start() to be effective.

If the user needs more than one db connection then those connection options need to be made available with the Worker initialization. Note that the DBOptions struct is available to use in this way.

func (*Worker) Run

func (w *Worker) Run()

Run will run until the application is complete and then exit.

func (*Worker) SetLogger

func (w *Worker) SetLogger(lgr *log.Logger) *Worker

SetLogger allows the user to override the default application logger (stdout) with a custom one.

If the provided logger is nil the logger output is discarded.

SetLogger should be called before initializing the application.

func (*Worker) TaskType

func (w *Worker) TaskType() string

TaskType returns the TaskType initialized with the Worker.

func (*Worker) Version

func (w *Worker) Version(version string) *Worker

Version sets the application version. The version is what is shown if the '-version' flag is specified when running the Worker.