plugin

Documentation

Index

• Constants
• Variables
• type Assets
• type Entrypoint
• type Evaluator
• type EvaluatorFactory
• type ParserType
• type PluginGetter
• type PluginService
  • func NewPluginService(logger log.Logger, pluginGetter PluginGetter, ...) (*PluginService, error)
  • func (s PluginService) ConstructDestinationURN(_ context.Context, taskName string, compiledConfig map[string]string) (resource.URN, error)
  • func (s PluginService) IdentifyUpstreams(ctx context.Context, taskName string, compiledConfig, assets map[string]string) ([]resource.URN, error)
  • func (s PluginService) Info(_ context.Context, taskName string) (*Spec, error)
• type Spec
  • func Load(pluginPath string) (*Spec, error)
  • func (s *Spec) GetEntrypoint(version string) (Entrypoint, error)
  • func (s *Spec) GetImage(version string) (string, error)
  • func (s *Spec) Validate() error
• type Store
  • func InitStore(pluginPaths []string, l log.Logger) (*Store, error)
  • func LoadPluginToStore(l log.Logger, location string) (*Store, error)
  • func NewPluginStore() *Store
  • func (s *Store) Add(pluginSpec *Spec) error
  • func (s *Store) All(yield func(spec *Spec) bool)
  • func (s *Store) GetByName(name string) (*Spec, error)
• type UpstreamIdentifierFactory
• type VersionDetails

Constants

const (
	Prefix     = "optimus-plugin-"
	Suffix     = ".yaml"
	PluginsDir = ".plugins"
)

Variables

var ErrNoSuchSpec = errors.New("spec not found")

var ErrUnsupportedPlugin = errors.New("unsupported plugin requested, make sure its correctly installed")

Types

type Assets

type Assets map[string]string

type Entrypoint

type Entrypoint struct {
	Shell string `yaml:"shell,omitempty"`
	// Setup  string `yaml:"setup,omitempty"`
	Script string `yaml:"script,omitempty"`
}

type Evaluator

type Evaluator struct {
	Env      string `yaml:"env,omitempty"`
	FilePath string `yaml:"filepath,omitempty"`
	Selector string `yaml:"selector,omitempty"`
}

type EvaluatorFactory

type EvaluatorFactory interface {
	GetFileEvaluator(filepath string) (evaluator.Evaluator, error)
	GetYamlPathEvaluator(filepath, selector string) (evaluator.Evaluator, error)
	GetEnvEvaluator(env string) (evaluator.Evaluator, error)
}

type ParserType

type ParserType string

const (
	BQParser         ParserType = "bq"
	MaxcomputeParser ParserType = "maxcompute"

	DefaultVersion = "default"
)

type PluginGetter

type PluginGetter interface {
	GetByName(name string) (*Spec, error)
}

type PluginService

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

func NewPluginService

func NewPluginService(logger log.Logger, pluginGetter PluginGetter, upstreamIdentifierFactory UpstreamIdentifierFactory, evaluatorFactory EvaluatorFactory) (*PluginService, error)

func (PluginService) ConstructDestinationURN

func (s PluginService) ConstructDestinationURN(_ context.Context, taskName string, compiledConfig map[string]string) (resource.URN, error)

func (PluginService) IdentifyUpstreams

func (s PluginService) IdentifyUpstreams(ctx context.Context, taskName string, compiledConfig, assets map[string]string) ([]resource.URN, error)

func (PluginService) Info

func (s PluginService) Info(_ context.Context, taskName string) (*Spec, error)

type Spec

type Spec struct {
	SpecVersion int    `yaml:"version"`
	Name        string `yaml:"name"`
	Description string `yaml:"description"`

	DestinationURNTemplate string `yaml:"destination_urn_template,omitempty"`

	AssetParsers  map[ParserType][]Evaluator `yaml:"asset_parsers,omitempty"`
	PluginVersion map[string]VersionDetails  `yaml:"plugin_versions,omitempty"`
	DefaultConfig map[string]string          `yaml:"default_config,omitempty"`
}

func Load

func Load(pluginPath string) (*Spec, error)

func (*Spec) GetEntrypoint

func (s *Spec) GetEntrypoint(version string) (Entrypoint, error)

func (*Spec) GetImage

func (s *Spec) GetImage(version string) (string, error)

func (*Spec) Validate

func (s *Spec) Validate() error

type Store

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

func InitStore

func InitStore(pluginPaths []string, l log.Logger) (*Store, error)

func LoadPluginToStore

func LoadPluginToStore(l log.Logger, location string) (*Store, error)

func NewPluginStore

func NewPluginStore() *Store

func (*Store) Add

func (s *Store) Add(pluginSpec *Spec) error

func (*Store) All

func (s *Store) All(yield func(spec *Spec) bool)

func (*Store) GetByName

func (s *Store) GetByName(name string) (*Spec, error)

type UpstreamIdentifierFactory

type UpstreamIdentifierFactory interface {
	GetBQUpstreamIdentifier(ctx context.Context, svcAcc string, evaluators ...evaluator.Evaluator) (upstreamidentifier.UpstreamIdentifier, error)
	GetMaxcomputeUpstreamIdentifier(ctx context.Context, svcAcc string, evaluators ...evaluator.Evaluator) (upstreamidentifier.UpstreamIdentifier, error)
}

type VersionDetails

type VersionDetails struct {
	Image      string     `yaml:"image,omitempty"`
	Tag        string     `yaml:"tag,omitempty"`
	Entrypoint Entrypoint `yaml:"entrypoint,omitempty"`
}