plugin

Documentation

Index

• Variables
• func Register(r *Registration)
• type InitContext
  • func NewContext(r *Registration, path string) *InitContext
• type Registration
  • func ForType(t Type) []*Registration
  • func Get(t Type, id string) *Registration
  • func (r *Registration) Init(ic *InitContext) (interface{}, error)
  • func (r *Registration) URI() string
• type Type
  • func (t Type) String() string

Variables

var (
	// ErrNoType is returned when no type is specified
	ErrNoType = errors.New("plugin: no type")
	// ErrNoPluginID is returned when no id is specified
	ErrNoPluginID = errors.New("plugin: no id")
)

Functions

func Register

func Register(r *Registration)

Register allows plugins to register

Types

type InitContext

type InitContext struct {
	Config interface{}
	Path   string
	Root   string
}

InitContext is used for plugin inititalization

func NewContext

func NewContext(r *Registration, path string) *InitContext

type Registration

type Registration struct {
	// Type of the plugin
	Type Type
	// ID of the plugin
	ID string
	// Config specific to the plugin
	Config interface{}

	// InitFn is called when initializing a plugin.
	InitFn func(*InitContext) (interface{}, error)
}

Registration contains information for registering a plugin

func ForType

func ForType(t Type) []*Registration

func Get

func Get(t Type, id string) *Registration

func (*Registration) Init

func (r *Registration) Init(ic *InitContext) (interface{}, error)

Init the registered plugin

func (*Registration) URI

func (r *Registration) URI() string

URI returns the full plugin URI

type Type

type Type string

Type is the type of the plugin

const (
	// TestSuitePlugin implements a test suite
	TestSuitePlugin Type = "aragorn.testsuite.v1"
	// NotifierPlugin implements a notifier
	NotifierPlugin Type = "aragorn.notifier.v1"
)

func (Type) String

func (t Type) String() string