app

Documentation

Index

• Constants
• func ClearCleanup(thread *starlark.Thread, key string)
• func CreatePluginApi(f StarlarkFunction, opType PluginFunctionType) plugin.PluginFunc
• func CreatePluginApiName(...) plugin.PluginFunc
• func CreatePluginConstant(name string, value starlark.Value) plugin.PluginFunc
• func DeferCleanup(thread *starlark.Thread, key string, deferFunc DeferFunc, strict bool)
• func FetchPluginState(thread *starlark.Thread, key string) any
• func GetContext(thread *starlark.Thread) context.Context
• func RegisterPlugin(name string, builder plugin.NewPluginFunc, funcs []plugin.PluginFunc)
• func SavePluginState(thread *starlark.Thread, key string, value any)
• type App
  • func NewApp(sourceFS *appfs.SourceFs, workFS *appfs.WorkFs, logger *types.Logger, ...) *App
  • func (a *App) Audit() (*types.ApproveResult, error)
  • func (a *App) Close() error
  • func (a *App) Initialize(dryRun DryRun) error
  • func (a *App) Reload(force, immediate bool, dryRun DryRun) (bool, error)
  • func (a *App) ResetFS()
  • func (a *App) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type AppPlugins
  • func NewAppPlugins(app *App, pluginConfig map[string]types.PluginSettings, ...) *AppPlugins
  • func (p *AppPlugins) GetPlugin(pluginInfo *plugin.PluginInfo, accountName string) (any, error)
• type DeferEntry
• type DeferFunc
• type DryRun
• type PluginFunctionType
• type PluginResponse
  • func NewErrorCodeResponse(errorCode int, err error, value any) *PluginResponse
  • func NewErrorResponse(err error, errorCallable starlark.Callable, thread *starlark.Thread) *PluginResponse
  • func NewResponse(value any) *PluginResponse
  • func (r *PluginResponse) Attr(name string) (starlark.Value, error)
  • func (r *PluginResponse) AttrNames() []string
  • func (r *PluginResponse) Freeze()
  • func (r *PluginResponse) Hash() (uint32, error)
  • func (r *PluginResponse) String() string
  • func (r *PluginResponse) Truth() starlark.Bool
  • func (r *PluginResponse) Type() string
  • func (r *PluginResponse) UnmarshalStarlarkType() (any, error)
• type SSEMessage
• type StarlarkFunction

Constants

const (
	CONTAINERFILE = "Containerfile"
	DOCKERFILE    = "Dockerfile"
)

Functions

func ClearCleanup

func ClearCleanup(thread *starlark.Thread, key string)

ClearCleanup clears a defer function from the thread local

func CreatePluginApi

func CreatePluginApi(f StarlarkFunction, opType PluginFunctionType) plugin.PluginFunc

func CreatePluginApiName

func CreatePluginApiName(
	f func(thread *starlark.Thread, fn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error),
	opType PluginFunctionType,
	name string) plugin.PluginFunc

CreatePluginApiName creates a Clace plugin function

func CreatePluginConstant

func CreatePluginConstant(name string, value starlark.Value) plugin.PluginFunc

func DeferCleanup

func DeferCleanup(thread *starlark.Thread, key string, deferFunc DeferFunc, strict bool)

DeferCleanup defers a close function to call when the API handler is done

func FetchPluginState

func FetchPluginState(thread *starlark.Thread, key string) any

FetchPluginState fetches a value from the thread local for the plugin

func GetContext

func GetContext(thread *starlark.Thread) context.Context

func RegisterPlugin

func RegisterPlugin(name string, builder plugin.NewPluginFunc, funcs []plugin.PluginFunc)

RegisterPlugin registers a plugin with Clace

func SavePluginState

func SavePluginState(thread *starlark.Thread, key string, value any)

SavePluginState saves a value in the thread local for the plugin

Types

type App

type App struct {
	*types.Logger
	*types.AppEntry
	Name         string
	CustomLayout bool

	Config *apptype.AppConfig
	// contains filtered or unexported fields
}

App is the main object that represents a Clace app. It is created when the app is loaded

func NewApp

func NewApp(sourceFS *appfs.SourceFs, workFS *appfs.WorkFs, logger *types.Logger,
	appEntry *types.AppEntry, systemConfig *types.SystemConfig,
	plugins map[string]types.PluginSettings) *App

func (*App) Audit

func (a *App) Audit() (*types.ApproveResult, error)

func (*App) Close

func (a *App) Close() error

func (*App) Initialize

func (a *App) Initialize(dryRun DryRun) error

func (*App) Reload

func (a *App) Reload(force, immediate bool, dryRun DryRun) (bool, error)

func (*App) ResetFS

func (a *App) ResetFS()

func (*App) ServeHTTP

func (a *App) ServeHTTP(w http.ResponseWriter, r *http.Request)

type AppPlugins

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

func NewAppPlugins

func NewAppPlugins(app *App, pluginConfig map[string]types.PluginSettings, appAccounts []types.AccountLink) *AppPlugins

func (*AppPlugins) GetPlugin

func (p *AppPlugins) GetPlugin(pluginInfo *plugin.PluginInfo, accountName string) (any, error)

type DeferEntry

type DeferEntry struct {
	Func   DeferFunc
	Strict bool
}

type DeferFunc

type DeferFunc func() error

type DryRun

type DryRun bool

const (
	DryRunTrue  DryRun = true
	DryRunFalse DryRun = false
)

type PluginFunctionType

type PluginFunctionType int

const (
	READ PluginFunctionType = iota
	WRITE
	READ_WRITE
)

type PluginResponse

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

PluginResponse is a starlark.Value that represents the response to a plugin request

func NewErrorCodeResponse

func NewErrorCodeResponse(errorCode int, err error, value any) *PluginResponse

func NewErrorResponse

func NewErrorResponse(err error, errorCallable starlark.Callable, thread *starlark.Thread) *PluginResponse

func NewResponse

func NewResponse(value any) *PluginResponse

func (*PluginResponse) Attr

func (r *PluginResponse) Attr(name string) (starlark.Value, error)

func (*PluginResponse) AttrNames

func (r *PluginResponse) AttrNames() []string

func (*PluginResponse) Freeze

func (r *PluginResponse) Freeze()

func (*PluginResponse) Hash

func (r *PluginResponse) Hash() (uint32, error)

func (*PluginResponse) String

func (r *PluginResponse) String() string

func (*PluginResponse) Truth

func (r *PluginResponse) Truth() starlark.Bool

func (*PluginResponse) Type

func (r *PluginResponse) Type() string

func (*PluginResponse) UnmarshalStarlarkType

func (r *PluginResponse) UnmarshalStarlarkType() (any, error)

type SSEMessage

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

type StarlarkFunction

type StarlarkFunction func(thread *starlark.Thread, fn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)