runner

Documentation

Index

• Constants
• type Client
  • func NewClient() Client
• type DeletionTimePayload
• type FakeClient
  • func NewFakeClient() *FakeClient
  • func (c *FakeClient) GetStatus(ctx context.Context, ip string) (*Status, error)
  • func (c *FakeClient) PutDeletionTime(ctx context.Context, ip string, tm time.Time) error
  • func (c *FakeClient) SetStatus(ip string, st *Status)
• type JobInfo
  • func GetJobInfo() (*JobInfo, error)
  • func GetJobInfoFromFile(file string) (*JobInfo, error)
  • func (info *JobInfo) BranchTagURL() string
  • func (info *JobInfo) PullRequestURL() string
  • func (info *JobInfo) RepositoryURL() string
  • func (info *JobInfo) WorkflowURL() string
• type Listener
  • func NewListener(runnerDir string) Listener
• type Option
• type Runner
  • func NewRunner(listener Listener, listenAddr, runnerDir, workDir, varDir string) (*Runner, error)
  • func (r *Runner) Run(ctx context.Context) error
• type Status

Constants

const (
	JobResultSuccess   = "success"
	JobResultFailure   = "failure"
	JobResultCancelled = "cancelled"
	JobResultUnknown   = "unknown"
)

Types

type Client

type Client interface {
	PutDeletionTime(ctx context.Context, ip string, tm time.Time) error
	GetStatus(ctx context.Context, ip string) (*Status, error)
}

func NewClient

func NewClient() Client

type DeletionTimePayload

type DeletionTimePayload struct {
	DeletionTime time.Time `json:"deletion_time"`
}

type FakeClient

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

FakeClient is a fake client

func NewFakeClient

func NewFakeClient() *FakeClient

func (*FakeClient) GetStatus

func (c *FakeClient) GetStatus(ctx context.Context, ip string) (*Status, error)

func (*FakeClient) PutDeletionTime

func (c *FakeClient) PutDeletionTime(ctx context.Context, ip string, tm time.Time) error

func (*FakeClient) SetStatus

func (c *FakeClient) SetStatus(ip string, st *Status)

type JobInfo

type JobInfo struct {
	Actor          string `json:"actor,omitempty"`
	GitRef         string `json:"git_ref,omitempty"`
	JobID          string `json:"job_id,omitempty"`
	PullRequestNum int    `json:"pull_request_number,omitempty"`
	Repository     string `json:"repository,omitempty"`
	RunID          int    `json:"run_id,omitempty"`
	RunNumber      int    `json:"run_number,omitempty"`
	WorkflowName   string `json:"workflow_name,omitempty"`
}

JobInfo represents information about a CI job.

func GetJobInfo

func GetJobInfo() (*JobInfo, error)

GetJobInfo reads environment variables and creates JobInfo.

func GetJobInfoFromFile

func GetJobInfoFromFile(file string) (*JobInfo, error)

func (*JobInfo) BranchTagURL

func (info *JobInfo) BranchTagURL() string

func (*JobInfo) PullRequestURL

func (info *JobInfo) PullRequestURL() string

func (*JobInfo) RepositoryURL

func (info *JobInfo) RepositoryURL() string

func (*JobInfo) WorkflowURL

func (info *JobInfo) WorkflowURL() string

type Listener

type Listener interface {
	// contains filtered or unexported methods
}

func NewListener

func NewListener(runnerDir string) Listener

type Option

type Option struct {
	SetupCommand []string `json:"setup_command,omitempty"`
}

Omittable options

type Runner

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

func NewRunner

func NewRunner(listener Listener, listenAddr, runnerDir, workDir, varDir string) (*Runner, error)

func (*Runner) Run

func (r *Runner) Run(ctx context.Context) error

type Status

type Status struct {
	State        string     `json:"state,omitempty"`
	Result       string     `json:"result,omitempty"`
	FinishedAt   *time.Time `json:"finished_at,omitempty"`
	DeletionTime *time.Time `json:"deletion_time,omitempty"`
	Extend       *bool      `json:"extend,omitempty"`
	JobInfo      *JobInfo   `json:"job_info,omitempty"`
	SlackChannel string     `json:"slack_channel,omitempty"`
}