job

Documentation

Index

• Variables
• func Get(params martini.Params, req *http.Request) (int, string)
• func GetAll(params martini.Params) (int, string)
• func Logger(l *logrus.Logger)
• func TailN(params martini.Params, req *http.Request) (int, string)
• type Config
• type Job
  • func NewJob(cfg *Config, spec *Spec) *Job
  • func (job *Job) Process() error
• type Spec
  • func NewSpec(args ...interface{}) (*Spec, error)
  • func (spec *Spec) Validate() error

Variables

var TestMode bool

TestMode monkeys with certain things for tests so bad things don't happen

Functions

func Get

func Get(params martini.Params, req *http.Request) (int, string)

Get gets the requested job as JSON.

func GetAll

func GetAll(params martini.Params) (int, string)

GetAll gets all of the jobs as JSON.

func Logger

func Logger(l *logrus.Logger)

Logger sets the (global) logger for the server package

func TailN

func TailN(params martini.Params, req *http.Request) (int, string)

TailN is the handler function for the job log tailing route.

Types

type Config

type Config struct {
	Workdir        string
	Logger         *logrus.Logger
	GitHubAPIToken string
}

Config contains global configuration options for jobs

type Job

type Job struct {
	Account        string         `json:"account,omitempty"`
	Completed      time.Time      `json:"completed,omitempty"`
	Created        time.Time      `json:"created"`
	Error          error          `json:"error,omitempty"`
	GitCloneDepth  string         `json:"clone_depth,omitempty"`
	GitHubAPIToken string         `json:"-"`
	ID             string         `json:"id,omitempty"`
	LogRoute       string         `json:"log_route,omitempty"`
	Logger         *logrus.Logger `json:"-"`
	Ref            string         `json:"ref,omitempty"`
	Repo           string         `json:"repo,omitempty"`
	Status         string         `json:"status"`
	Workdir        string         `json:"-"`
	// contains filtered or unexported fields
}

Job is the struct representation of a build job. Intended to be created with NewJob, but exported so it can be used for tests.

func NewJob

func NewJob(cfg *Config, spec *Spec) *Job

NewJob creates a new job from the config as well as a job spec. After creating the job, calling job.Process() will actually perform the work.

func (*Job) Process

func (job *Job) Process() error

Process does the actual job processing work, including:

1. clone the repo
2. build from the Bobfile at the top level
3. clean up the cloned repo

type Spec

type Spec struct {
	RepoOwner      string `json:"account"`
	RepoName       string `json:"repo"`
	GitRef         string `json:"ref"`
	GitHubAPIToken string `json:"api_token"`
	Depth          string `json:"depth"`
	Sync           bool   `json:"sync"`
}

Spec contains the specs for a job, retrieved from parsed JSON

func NewSpec

func NewSpec(args ...interface{}) (*Spec, error)

NewSpec creates a new job spec based on the arguments that would be passed along from the job goworker picks up from Redis.

func (*Spec) Validate

func (spec *Spec) Validate() error

Validate checks that required fields are present in the spec.