woodpecker/pipeline/rpc/peer.go

package rpc

import (
	"context"

	"github.com/woodpecker-ci/woodpecker/pipeline/backend"
)

// ErrCancelled signals the pipeine is cancelled.
// var ErrCancelled = errors.New("cancelled")

type (
	// Filter defines filters for fetching items from the queue.
	Filter struct {
		Labels map[string]string `json:"labels"`
		Expr   string            `json:"expr"`
	}

	// State defines the pipeline state.
	State struct {
		Proc     string `json:"proc"`
		Exited   bool   `json:"exited"`
		ExitCode int    `json:"exit_code"`
		Started  int64  `json:"started"`
		Finished int64  `json:"finished"`
		Error    string `json:"error"`
	}

	// Pipeline defines the pipeline execution details.
	Pipeline struct {
		ID      string          `json:"id"`
		Config  *backend.Config `json:"config"`
		Timeout int64           `json:"timeout"`
	}

	// File defines a pipeline artifact.
	File struct {
		Name string            `json:"name"`
		Proc string            `json:"proc"`
		Mime string            `json:"mime"`
		Time int64             `json:"time"`
		Size int               `json:"size"`
		Data []byte            `json:"data"`
		Meta map[string]string `json:"meta"`
	}
)

// NoFilter is an empty filter.
var NoFilter = Filter{}

// Peer defines a peer-to-peer connection.
type Peer interface {
	// Next returns the next pipeline in the queue.
	Next(c context.Context, f Filter) (*Pipeline, error)

	// Wait blocks until the pipeline is complete.
	Wait(c context.Context, id string) error

	// Init signals the pipeline is initialized.
	Init(c context.Context, id string, state State) error

	// Done signals the pipeline is complete.
	Done(c context.Context, id string, state State) error

	// Extend extends the pipeline deadline
	Extend(c context.Context, id string) error

	// Update updates the pipeline state.
	Update(c context.Context, id string, state State) error

	// Upload uploads the pipeline artifact.
	Upload(c context.Context, id string, file *File) error

	// Log writes the pipeline log entry.
	Log(c context.Context, id string, line *Line) error
}