once

Documentation

Index

• Constants
• Variables
• func CheckSQLiteSchemaVersion(version string) error
• func HashAttemptToken(token string) string
• func NewAttemptToken() (string, error)
• func RejectSharedWritableParent(path string) error
• func RejectSymlinkPath(path string) error
• func RestrictLocalFile(path string) error
• func ValidateAttemptToken(token string) error
• func ValidateKey(key string) error
• func ValidateSQLitePath(path string) error
• type ListOptions
• type PruneOptions
• type PruneResult
• type Record
• type SQLiteStore
  • func OpenSQLite(path string) (*SQLiteStore, error)
  • func (s *SQLiteStore) AdminForget(key string, force bool) (bool, error)
  • func (s *SQLiteStore) Close() error
  • func (s *SQLiteStore) Commit(key, attempt string, state State, exitCode int, stdout, stderr []byte, ...) (Record, error)
  • func (s *SQLiteStore) Forget(key string, force bool, attempt string) (bool, error)
  • func (s *SQLiteStore) Get(key string) (Record, error)
  • func (s *SQLiteStore) List(opts ListOptions) ([]Record, error)
  • func (s *SQLiteStore) Prune(opts PruneOptions) (PruneResult, error)
  • func (s *SQLiteStore) Reserve(key string, command []string) (Record, bool, error)
• type State
• type Store

Constants

const MaxKeyLen = 256

Variables

var (
	ErrConflict = errors.New("record conflicts with existing key")
	ErrNotFound = errors.New("record not found")
	ErrRunning  = errors.New("record is still running")
)

Functions

func CheckSQLiteSchemaVersion

func CheckSQLiteSchemaVersion(version string) error

CheckSQLiteSchemaVersion rejects stores that need a different once binary.

func HashAttemptToken

func HashAttemptToken(token string) string

func NewAttemptToken

func NewAttemptToken() (string, error)

func RejectSharedWritableParent

func RejectSharedWritableParent(path string) error

func RejectSymlinkPath

func RejectSymlinkPath(path string) error

func RestrictLocalFile

func RestrictLocalFile(path string) error

func ValidateAttemptToken

func ValidateAttemptToken(token string) error

func ValidateKey

func ValidateKey(key string) error

func ValidateSQLitePath

func ValidateSQLitePath(path string) error

ValidateSQLitePath rejects SQLite DSN forms. once stores must be local filesystem paths so SQLite options cannot bypass local file checks.

Types

type ListOptions

type ListOptions struct {
	State         State
	Limit         int
	IncludeOutput bool
	UpdatedBefore time.Time
}

type PruneOptions

type PruneOptions struct {
	State  State
	Cutoff time.Time
	Force  bool
}

type PruneResult

type PruneResult struct {
	Records []Record
	Deleted int
}

type Record

type Record struct {
	Key        string
	Attempt    string
	State      State
	ExitCode   int
	Stdout     []byte
	Stderr     []byte
	Error      string
	Command    []string
	StartedAt  time.Time
	FinishedAt *time.Time
	UpdatedAt  time.Time
}

type SQLiteStore

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

func OpenSQLite

func OpenSQLite(path string) (*SQLiteStore, error)

func (*SQLiteStore) AdminForget

func (s *SQLiteStore) AdminForget(key string, force bool) (bool, error)

func (*SQLiteStore) Close

func (s *SQLiteStore) Close() error

func (*SQLiteStore) Commit

func (s *SQLiteStore) Commit(key, attempt string, state State, exitCode int, stdout, stderr []byte, runErr string) (Record, error)

func (*SQLiteStore) Forget

func (s *SQLiteStore) Forget(key string, force bool, attempt string) (bool, error)

func (*SQLiteStore) Get

func (s *SQLiteStore) Get(key string) (Record, error)

func (*SQLiteStore) List

func (s *SQLiteStore) List(opts ListOptions) ([]Record, error)

func (*SQLiteStore) Prune

func (s *SQLiteStore) Prune(opts PruneOptions) (PruneResult, error)

func (*SQLiteStore) Reserve

func (s *SQLiteStore) Reserve(key string, command []string) (Record, bool, error)

type State

type State string

const (
	Running   State = "running"
	Succeeded State = "succeeded"
	Failed    State = "failed"
)

type Store

type Store interface {
	Close() error
	Reserve(key string, command []string) (Record, bool, error)
	Commit(key, attempt string, state State, exitCode int, stdout, stderr []byte, runErr string) (Record, error)
	Get(key string) (Record, error)
	Forget(key string, force bool, attempt string) (bool, error)
}