harness

Documentation

Index

• func BuildSDKClientOptions(config ClientConfig) sdkclient.Options
• func DefaultClientFactory(config ClientConfig) (sdkclient.Client, error)
• func Run(app App) error
• type App
• type ClientConfig
• type ClientFactory
• type ProjectExecuteContext
• type ProjectExecuteHandler
• type ProjectHandlers
• type ProjectInitContext
• type ProjectInitHandler
• type ProjectRunMetadata
• type WorkerContext
• type WorkerFactory

Functions

func BuildSDKClientOptions

func BuildSDKClientOptions(config ClientConfig) sdkclient.Options

BuildSDKClientOptions converts the harness client config into Go SDK client options.

func DefaultClientFactory

func DefaultClientFactory(config ClientConfig) (sdkclient.Client, error)

func Run

func Run(app App) error

Types

type App

type App struct {
	Worker        WorkerFactory
	ClientFactory ClientFactory
	Project       *ProjectHandlers
}

type ClientConfig

type ClientConfig struct {
	TargetHost string
	Namespace  string
	APIKey     string
	TLS        *tls.Config
	Logger     *zap.SugaredLogger
	Metrics    *metrics.Metrics
}

type ClientFactory

type ClientFactory func(ClientConfig) (sdkclient.Client, error)

type ProjectExecuteContext

type ProjectExecuteContext struct {
	Logger    *zap.SugaredLogger
	Run       ProjectRunMetadata
	TaskQueue string
	Iteration int64
	Payload   []byte
}

type ProjectExecuteHandler

type ProjectExecuteHandler func(sdkclient.Client, ProjectExecuteContext) error

type ProjectHandlers

type ProjectHandlers struct {
	Execute ProjectExecuteHandler
	Init    ProjectInitHandler
}

type ProjectInitContext

type ProjectInitContext struct {
	Logger     *zap.SugaredLogger
	Run        ProjectRunMetadata
	TaskQueue  string
	ConfigJSON []byte
}

type ProjectInitHandler

type ProjectInitHandler func(sdkclient.Client, ProjectInitContext) error

type ProjectRunMetadata

type ProjectRunMetadata struct {
	RunID       string
	ExecutionID string
}

type WorkerContext

type WorkerContext struct {
	Logger             *zap.SugaredLogger
	TaskQueue          string
	ErrOnUnimplemented bool
	WorkerOptions      sdkworker.Options
}

type WorkerFactory

type WorkerFactory func(sdkclient.Client, WorkerContext) sdkworker.Worker