task

Documentation

Index

• Variables
• type CreatedBy
• type DatedState
• type Outcome
• type Queue
  • func NewQueue(ts *Storage, max int, converter func([]byte) (*Task, error)) (*Queue, error)
  • func (q *Queue) Pop() (*Task, error)
  • func (q *Queue) Push(tsk *Task) error
  • func (q *Queue) PushUniqueByBranch(tsk *Task) error
• type State
• type Storage
  • func NewMemoryTaskStorage() (*Storage, error)
  • func NewTaskStorage(path string) (*Storage, error)
  • func (s *Storage) ArchiveTask(tsk *Task) error
  • func (s *Storage) Delete(id string) error
  • func (s *Storage) Filter(state State, start time.Time, end time.Time) (tasks []*Task, err error)
  • func (s *Storage) Get(id string) (*Task, error)
  • func (s *Storage) PersistProcessing(tsk *Task) error
  • func (s *Storage) PersistScheduled(tsk *Task) error
  • func (s *Storage) ProcessTask(tsk *Task) error
• type Task
  • func (t *Task) Created() time.Time
  • func (t *Task) CreatedByCI() bool
  • func (t *Task) IsCanceled() bool
  • func (t *Task) Name() string
  • func (t *Task) RenderCreatedBy() string
  • func (t *Task) State() DatedState
  • func (t *Task) Took() time.Duration
• type Type

Variables

var (
	ErrQueueEmpty = errors.New("queue empty")
	ErrQueueFull  = errors.New("queue full")
)

var (
	ErrNotFound = errors.New("task not found")
)

Types

type CreatedBy

type CreatedBy struct {
	User   string `json:"user,omitempty"`
	Repo   string `json:"repo,omitempty"`
	Branch string `json:"branch,omitempty"`
	Commit string `json:"commit,omitempty"`
}

type DatedState

type DatedState struct {
	Created time.Time `json:"created"`
	State   State     `json:"state"`
}

DatedState (kind: struct) is a State with a timestamp.

type Outcome

type Outcome string

const (
	OutcomeUnknown  Outcome = "unknown"
	OutcomeSuccess  Outcome = "success"
	OutcomeFailure  Outcome = "failure"
	OutcomeCanceled Outcome = "canceled"
)

type Queue

type Queue struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Queue is a priority queue for tasks.

func NewQueue

func NewQueue(ts *Storage, max int, converter func([]byte) (*Task, error)) (*Queue, error)

func (*Queue) Pop

func (q *Queue) Pop() (*Task, error)

get the next item from the priority queue Pop the task off of the queue The task remains in the database, but is no longer in the heap. As the state of the task changes

func (*Queue) Push

func (q *Queue) Push(tsk *Task) error

Add an item to the priority queue 1. Check if we have too many items enqueued already. 2. Persist task to the database. 3. Push the task into the in-memory heap.

func (*Queue) PushUniqueByBranch

func (q *Queue) PushUniqueByBranch(tsk *Task) error

Pushes a task to the queue, and removes any tasks with matching repo/branch from the queue

type State

type State string

State (kind: string) represents the last known state of a task. A task can be in one of three states StateScheduled: this is the initial state of the task when it enters the queue. StateProcessing: once work begins on the task, it is put into this state. StateComplete: work is no longer being done on this task. client should check task result.

const (
	StateScheduled  State = "scheduled"
	StateProcessing State = "processing"
	StateComplete   State = "complete"
	StateCanceled   State = "canceled"
)

type Storage

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

Tasks stored in leveldb

func NewMemoryTaskStorage

func NewMemoryTaskStorage() (*Storage, error)

func NewTaskStorage

func NewTaskStorage(path string) (*Storage, error)

func (*Storage) ArchiveTask

func (s *Storage) ArchiveTask(tsk *Task) error

func (*Storage) Delete

func (s *Storage) Delete(id string) error

func (*Storage) Filter

func (s *Storage) Filter(state State, start time.Time, end time.Time) (tasks []*Task, err error)

func (*Storage) Get

func (s *Storage) Get(id string) (*Task, error)

func (*Storage) PersistProcessing

func (s *Storage) PersistProcessing(tsk *Task) error

func (*Storage) PersistScheduled

func (s *Storage) PersistScheduled(tsk *Task) error

func (*Storage) ProcessTask

func (s *Storage) ProcessTask(tsk *Task) error

type Task

type Task struct {
	Version     int          `json:"version"`     // Schema version
	Priority    int          `json:"priority"`    // Scheduling priority
	ID          string       `json:"id"`          // Unique identifier for this task
	Runner      string       `json:"runner"`      // Runner that ran this task
	Plan        string       `json:"plan"`        // Test plan
	Case        string       `json:"case"`        // Test case
	States      []DatedState `json:"states"`      // State of the task
	Type        Type         `json:"type"`        // Type of the task
	Composition interface{}  `json:"composition"` // Composition used for the task
	Input       interface{}  `json:"input"`       // The input data for this task
	Result      interface{}  `json:"result"`      // Result of the task, when terminal.
	Error       string       `json:"error"`       // Error from Testground
	CreatedBy   CreatedBy    `json:"created_by"`  // Who created the task
}

Task (kind: struct) contains metadata about a testground task. This schema is used to store metadata in our task storage database as well as the wire format returned when clients get the state of a running or scheduled task.

func (*Task) Created

func (t *Task) Created() time.Time

func (*Task) CreatedByCI

func (t *Task) CreatedByCI() bool

func (*Task) IsCanceled

func (t *Task) IsCanceled() bool

func (*Task) Name

func (t *Task) Name() string

func (*Task) RenderCreatedBy

func (t *Task) RenderCreatedBy() string

func (*Task) State

func (t *Task) State() DatedState

func (*Task) Took

func (t *Task) Took() time.Duration

type Type

type Type string

Type (kind: string) represents the kind of activity the daemon asked to perform. In alignment with the testground command-line we have two kinds of tasks TypeBuild -- which functions similarly to `testground build`. The result of this task will contain a build ID which can be used in a subsequent run. TypeRun -- which functions similarly to `testground run`

const (
	TypeBuild Type = "build"
	TypeRun   Type = "run"
)