hook

Documentation

Index

• func Logs(id, name, base string) (*os.File, error)
• func ResolveScript(dir, name, defaultExt string) (string, error)
• type Job
  • func NewHookJob(request *Request) (*Job, error)
  • func (job *Job) Close()
  • func (job *Job) Err() error
  • func (job *Job) ID() uint64
  • func (job *Job) IsTerminated() bool
  • func (job *Job) Logs(prefixFilter string) string
  • func (job *Job) Meta() []string
  • func (job *Job) Name() string
  • func (job *Job) Run() error
  • func (job *Job) SendMessage(message string)
  • func (job *Job) Status() Status
  • func (job *Job) StatusLabel() string
  • func (job *Job) Terminate(err error) error
• type Request
• type Status

Functions

func Logs

func Logs(id, name, base string) (*os.File, error)

Logs get hook log with its name and id

func ResolveScript

func ResolveScript(dir, name, defaultExt string) (string, error)

ResolveScript is resolving the target script.

Types

type Job

type Job struct {
	MessageChan chan []byte
	// contains filtered or unexported fields
}

Job a hook job

func NewHookJob

func NewHookJob(request *Request) (*Job, error)

NewHookJob creates new hook job

func (*Job) Close

func (job *Job) Close()

Close job message chan

func (*Job) Err

func (job *Job) Err() error

Err returns job error

func (*Job) ID

func (job *Job) ID() uint64

ID returns job ID

func (*Job) IsTerminated

func (job *Job) IsTerminated() bool

IsTerminated ask if the job is terminated

func (*Job) Logs

func (job *Job) Logs(prefixFilter string) string

Logs returns job logs filtered with the prefix

func (*Job) Meta

func (job *Job) Meta() []string

Meta returns job meta

func (*Job) Name

func (job *Job) Name() string

Name returns job name

func (*Job) Run

func (job *Job) Run() error

Run hook job

func (*Job) SendMessage

func (job *Job) SendMessage(message string)

SendMessage send message to the message channel

func (*Job) Status

func (job *Job) Status() Status

Status get job status

func (*Job) StatusLabel

func (job *Job) StatusLabel() string

StatusLabel return job status as string

func (*Job) Terminate

func (job *Job) Terminate(err error) error

Terminate set job as terminated

type Request

type Request struct {
	Name      string
	Script    string
	Method    string
	Payload   string
	Args      []string
	Timeout   int
	OutputDir string
}

Request is a hook request

type Status

type Status int

Status is the status of a hook

const (
	// Idle means that the hook is not yet started
	Idle Status = iota
	// Running means that the hook is running
	Running
	// Success means that the hook over
	Success
	// Error means that the hook is over but in error
	Error
)