larker

Documentation

Index

• Variables
• type Context
  • func (context *Context) Freeze()
  • func (context *Context) Hash() (uint32, error)
  • func (context *Context) String() string
  • func (context *Context) Truth() starlark.Bool
  • func (context *Context) Type() string
• type ErrExecFailed
  • func (eee *ErrExecFailed) Error() string
  • func (eee *ErrExecFailed) Unwrap() error
• type ExtendedError
  • func (ee *ExtendedError) Error() string
  • func (ee *ExtendedError) Is(err error) bool
  • func (ee *ExtendedError) Logs() []byte
  • func (ee *ExtendedError) Unwrap() error
• type HookResult
• type Larker
  • func New(opts ...Option) *Larker
  • func (larker *Larker) Hook(ctx context.Context, source string, name string, arguments []interface{}) (*HookResult, error)
  • func (larker *Larker) Main(ctx context.Context, source string) (*MainResult, error)
  • func (larker *Larker) MainOptional(ctx context.Context, source string) (*MainResult, error)
• type MainResult
• type Option
  • func WithAffectedFiles(affectedFiles []string) Option
  • func WithEnvironment(env map[string]string) Option
  • func WithFileSystem(fs fs.FileSystem) Option
  • func WithTestMode() Option

Variables

var (
	ErrMalformedKeyValueTuple = errors.New("malformed key-value tuple")
	ErrNotADictOrTuple        = errors.New("main() should return a list of either dicts or tuples")
	ErrMixedList              = errors.New("main() should return a list of either dicts or tuples, " +
		"found both types in a single list")
)

var (
	ErrLoadFailed           = errors.New("load failed")
	ErrNotFound             = errors.New("entrypoint not found")
	ErrMainFailed           = errors.New("failed to call main")
	ErrHookFailed           = errors.New("failed to call hook")
	ErrMainUnexpectedResult = errors.New("main returned unexpected result")
	ErrSanity               = errors.New("sanity check failed")
)

var ErrStarlarkConversion = errors.New("failed to convert Starlark data type")

Types

type Context

type Context struct{}

func (*Context) Freeze

func (context *Context) Freeze()

func (*Context) Hash

func (context *Context) Hash() (uint32, error)

func (*Context) String

func (context *Context) String() string

func (*Context) Truth

func (context *Context) Truth() starlark.Bool

func (*Context) Type

func (context *Context) Type() string

type ErrExecFailed

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

func (*ErrExecFailed) Error

func (eee *ErrExecFailed) Error() string

func (*ErrExecFailed) Unwrap

func (eee *ErrExecFailed) Unwrap() error

type ExtendedError

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

func (*ExtendedError) Error

func (ee *ExtendedError) Error() string

func (*ExtendedError) Is

func (ee *ExtendedError) Is(err error) bool

func (*ExtendedError) Logs

func (ee *ExtendedError) Logs() []byte

func (*ExtendedError) Unwrap

func (ee *ExtendedError) Unwrap() error

type HookResult

type HookResult struct {
	ErrorMessage  string
	OutputLogs    []byte
	DurationNanos int64
	Result        interface{}
}

type Larker

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

func New

func New(opts ...Option) *Larker

func (*Larker) Hook

func (larker *Larker) Hook(
	ctx context.Context,
	source string,
	name string,
	arguments []interface{},
) (*HookResult, error)

func (*Larker) Main

func (larker *Larker) Main(ctx context.Context, source string) (*MainResult, error)

func (*Larker) MainOptional

func (larker *Larker) MainOptional(ctx context.Context, source string) (*MainResult, error)

type MainResult

type MainResult struct {
	OutputLogs []byte
	YAMLConfig string
}

type Option

type Option func(*Larker)

func WithAffectedFiles

func WithAffectedFiles(affectedFiles []string) Option

func WithEnvironment

func WithEnvironment(env map[string]string) Option

func WithFileSystem

func WithFileSystem(fs fs.FileSystem) Option

func WithTestMode

func WithTestMode() Option