plugins

Documentation

Index

• Constants
• Variables
• func CurrentArch() string
• type Action
• type DownloadedPlugin
• type Downloader
• type GitHubDownloader
  • func NewGitHubDownloader() *GitHubDownloader
  • func (d *GitHubDownloader) Download(ctx context.Context, pi *pluginInfo) (*DownloadedPlugin, error)
  • func (d *GitHubDownloader) MatchingVersion(ctx context.Context, pi *pluginInfo) (matching, latest *semver.Version, err error)
• type Loader
  • func NewLoader(baseDir, pluginsCacheDir string) *Loader
  • func (l *Loader) DownloadPlugin(ctx context.Context, name string, verConstr *semver.Constraints, src string, ...) (*Plugin, error)
  • func (l *Loader) LoadPlugin(ctx context.Context, name, src string, verConstr *semver.Constraints, ...) (*Plugin, error)
  • func (l *Loader) MatchingVersion(ctx context.Context, name, src string, verConstr *semver.Constraints) (matching, latest *semver.Version, err error)
• type Plugin
  • func (p *Plugin) Client() *client.Client
  • func (p *Plugin) CommandArgs(cmd string) map[string]interface{}
  • func (p *Plugin) HasAction(a Action) bool
  • func (p *Plugin) Locked() *lockfile.Plugin
  • func (p *Plugin) Normalize() error
  • func (p *Plugin) Prepare(ctx context.Context, log logger.Logger, ...) error
  • func (p *Plugin) Stop() error
  • func (p *Plugin) SupportsApp(app string) bool
  • func (p *Plugin) SupportsType(typ, dep string, other map[string]interface{}) bool
  • func (p *Plugin) Validate() error
• type PluginCommand
  • func (p *PluginCommand) Validate() error
• type PluginCommandArg
  • func (p *PluginCommandArg) Val() interface{}
  • func (p *PluginCommandArg) Validate() error
• type PluginHooks
  • func (p *PluginHooks) Validate() error
• type PluginMatch
• type PluginType
  • func (p *PluginType) Validate() error
• type VCSDownloader
  • func NewVCSDownloader() *VCSDownloader
  • func (d *VCSDownloader) Download(ctx context.Context, pi *pluginInfo) (*DownloadedPlugin, error)
  • func (d *VCSDownloader) MatchingVersion(ctx context.Context, pi *pluginInfo) (matching, latest *semver.Version, err error)

Constants

const (
	DefaultPluginSourceFmt = "https://github.com/outblocks/cli-plugin-%s"
	DefaultAuthor          = "outblocks"
	A                      = runtime.GOOS + "_" + runtime.GOARCH
)

const (
	CommandTypeBool   = "bool"
	CommandTypeString = "string"
	CommandTypeInt    = "int"
)

Variables

var (
	ErrPluginNotFound               = errors.New("plugin not found")
	ErrPluginNoMatchingVersionFound = errors.New("no matching version for plugin not found")
)

var (
	CommandTypes = []string{CommandTypeBool, CommandTypeString, CommandTypeInt}
)

var GitHubRegex = regexp.MustCompile(`^https://github\.com/(?P<owner>[^/]+)/(?P<name>[^/]+)/?$`)

Functions

func CurrentArch

func CurrentArch() string

Types

type Action

type Action int

const (
	ActionDeploy Action = iota
	ActionRun
	ActionDNS
)

type DownloadedPlugin

type DownloadedPlugin struct {
	Dir     string
	TempDir bool
	Version *semver.Version
}

type Downloader

type Downloader interface {
	Download(ctx context.Context, pi *pluginInfo) (*DownloadedPlugin, error)
	MatchingVersion(ctx context.Context, pi *pluginInfo) (matching, latest *semver.Version, err error)
}

type GitHubDownloader

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

func NewGitHubDownloader

func NewGitHubDownloader() *GitHubDownloader

func (*GitHubDownloader) Download

func (d *GitHubDownloader) Download(ctx context.Context, pi *pluginInfo) (*DownloadedPlugin, error)

func (*GitHubDownloader) MatchingVersion

func (d *GitHubDownloader) MatchingVersion(ctx context.Context, pi *pluginInfo) (matching, latest *semver.Version, err error)

type Loader

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

func NewLoader

func NewLoader(baseDir, pluginsCacheDir string) *Loader

func (*Loader) DownloadPlugin

func (l *Loader) DownloadPlugin(ctx context.Context, name string, verConstr *semver.Constraints, src string, lock *lockfile.Plugin) (*Plugin, error)

func (*Loader) LoadPlugin

func (l *Loader) LoadPlugin(ctx context.Context, name, src string, verConstr *semver.Constraints, lock *lockfile.Plugin) (*Plugin, error)

func (*Loader) MatchingVersion

func (l *Loader) MatchingVersion(ctx context.Context, name, src string, verConstr *semver.Constraints) (matching, latest *semver.Version, err error)

type Plugin

type Plugin struct {
	Name           string                    `json:"name"`
	Author         string                    `json:"author"`
	Usage          string                    `json:"usage"`
	Description    string                    `json:"description"`
	Cmd            map[string]string         `json:"cmd"`
	Actions        []string                  `json:"actions"`
	Hooks          []*PluginHooks            `json:"hooks"`
	Supports       []string                  `json:"supports"`
	StateTypes     []string                  `json:"state_types"`
	SupportedTypes []*PluginType             `json:"supported_types"`
	Commands       map[string]*PluginCommand `json:"commands"`

	Dir     string          `json:"-"`
	Version *semver.Version `json:"-"`
	// contains filtered or unexported fields
}

func (*Plugin) Client

func (p *Plugin) Client() *client.Client

func (*Plugin) CommandArgs

func (p *Plugin) CommandArgs(cmd string) map[string]interface{}

func (*Plugin) HasAction

func (p *Plugin) HasAction(a Action) bool

func (*Plugin) Locked

func (p *Plugin) Locked() *lockfile.Plugin

func (*Plugin) Normalize

func (p *Plugin) Normalize() error

func (*Plugin) Prepare

func (p *Plugin) Prepare(ctx context.Context, log logger.Logger, env, projectID, projectName, projectDir string, props map[string]interface{}, yamlPrefix string, yamlData []byte) error

func (*Plugin) Stop

func (p *Plugin) Stop() error

func (*Plugin) SupportsApp

func (p *Plugin) SupportsApp(app string) bool

func (*Plugin) SupportsType

func (p *Plugin) SupportsType(typ, dep string, other map[string]interface{}) bool

func (*Plugin) Validate

func (p *Plugin) Validate() error

type PluginCommand

type PluginCommand struct {
	Args []*PluginCommandArg `json:"args"`
}

func (*PluginCommand) Validate

func (p *PluginCommand) Validate() error

type PluginCommandArg

type PluginCommandArg struct {
	Name    string      `json:"name"`
	Usage   string      `json:"usage"`
	Type    string      `json:"type"`
	Default interface{} `json:"default"`
	Value   interface{} `json:"-"`
}

func (*PluginCommandArg) Val

func (p *PluginCommandArg) Val() interface{}

func (*PluginCommandArg) Validate

func (p *PluginCommandArg) Validate() error

type PluginHooks

type PluginHooks struct {
	Type string `json:"type"`
	Name string `json:"name"`
}

func (*PluginHooks) Validate

func (p *PluginHooks) Validate() error

type PluginMatch

type PluginMatch struct {
	Deploy string                 `json:"deploy"`
	Other  map[string]interface{} `yaml:"-,remain"`
}

type PluginType

type PluginType struct {
	Type  string       `json:"type"`
	Match *PluginMatch `json:"match"`
}

func (*PluginType) Validate

func (p *PluginType) Validate() error

type VCSDownloader

type VCSDownloader struct {
}

func NewVCSDownloader

func NewVCSDownloader() *VCSDownloader

func (*VCSDownloader) Download

func (d *VCSDownloader) Download(ctx context.Context, pi *pluginInfo) (*DownloadedPlugin, error)

func (*VCSDownloader) MatchingVersion

func (d *VCSDownloader) MatchingVersion(ctx context.Context, pi *pluginInfo) (matching, latest *semver.Version, err error)