plugins

package
v0.1.143 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 10, 2023 License: MIT Imports: 30 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultPluginSourceFmt = "https://github.com/outblocks/cli-plugin-%s"
	DefaultAuthor          = "outblocks"
)
View Source 
const DefaultPriority = 1000

Variables

View Source 
var (
	ErrPluginNotFound               = errors.New("plugin not found")
	ErrPluginNoMatchingVersionFound = errors.New("no matching version for plugin not found")
)
View Source 
var (
	CommandValueTypes = []string{"str", "string", "bool", "boolean", "int", "integer", "strings", "stringarray"}
	CommandInputTypes = []string{"app_states", "dependency_states", "plugin_state"}
)
View Source 
var GitHubRegex = regexp.MustCompile(`^https://github\.com/(?P<owner>[^/]+)/(?P<name>[^/]+)/?$`)

Functions

func ComputePluginID added in v0.1.54 

func ComputePluginID(name string) string

func CurrentArch 

func CurrentArch() string

Types

type Action 

type Action int
const (
	ActionDeploy Action = iota
	ActionRun
	ActionDNS
	ActionLock
	ActionState
	ActionDeployHook
	ActionSecrets
	ActionMonitoring
)

type AppOverrides added in v0.1.132 

type AppOverrides struct {
	Function struct {
		Archive *bool `json:"archive"`
	} `json:"function"`
}

type CommandInputType added in v0.1.56 

type CommandInputType int
const (
	CommandInputTypeAppStates CommandInputType = iota + 1
	CommandInputTypeDependencyStates
	CommandInputTypePluginState
)

type CommandValueType added in v0.1.56 

type CommandValueType int
const (
	CommandValueTypeBool CommandValueType = iota + 1
	CommandValueTypeString
	CommandValueTypeInt
	CommandValueTypeStringArray
)

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 added in v0.1.2 

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 added in v0.1.2 

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"`
	Short          string                            `json:"short"`
	Author         string                            `json:"author"`
	Usage          string                            `json:"usage"`
	Description    string                            `json:"description"`
	Cmd            map[string]*command.StringCommand `json:"cmd"`
	Actions        []string                          `json:"actions"`
	Priorities     map[string][]int                  `json:"priorities"`
	Hooks          []*PluginHooks                    `json:"hooks"`
	Supports       []string                          `json:"supports"`
	StateTypes     []string                          `json:"state_types"`
	SecretsTypes   []string                          `json:"secrets_types"`
	SupportedTypes []*PluginType                     `json:"supported_types"`
	Commands       map[string]*PluginCommand         `json:"commands"`
	SecretsRepr    yaml.MapSlice                     `json:"secrets"`
	AppOverrides   AppOverrides                      `json:"app_overrides"`

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

func (*Plugin) Client 

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

func (*Plugin) CommandArgs added in v0.1.13 

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

func (*Plugin) HasAction 

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

func (*Plugin) ID added in v0.1.54 

func (p *Plugin) ID() string

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, hostAddr string, props map[string]interface{}, yamlPrefix string, yamlData []byte) error

func (*Plugin) PriorityFor added in v0.1.107 

func (p *Plugin) PriorityFor(cmd string) []int

func (*Plugin) Secrets added in v0.1.109 

func (p *Plugin) Secrets() []*PluginSecret

func (*Plugin) ShortName added in v0.1.111 

func (p *Plugin) ShortName() string

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 added in v0.1.13 

type PluginCommand struct {
	Short string               `json:"short"`
	Long  string               `json:"long"`
	Input []string             `json:"input"`
	Flags []*PluginCommandFlag `json:"flags"`
	// contains filtered or unexported fields
}

func (*PluginCommand) InputTypes added in v0.1.56 

func (p *PluginCommand) InputTypes() []CommandInputType

func (*PluginCommand) Proto added in v0.1.56 

func (p *PluginCommand) Proto(args []string) *apiv1.CommandArgs

func (*PluginCommand) Validate added in v0.1.13 

func (p *PluginCommand) Validate() error

type PluginCommandFlag added in v0.1.56 

type PluginCommandFlag struct {
	Name     string      `json:"name"`
	Short    string      `json:"short"`
	Usage    string      `json:"usage"`
	Type     string      `json:"type"`
	Default  interface{} `json:"default"`
	Required bool        `json:"required"`
	Value    interface{} `json:"-"`
	// contains filtered or unexported fields
}

func (*PluginCommandFlag) Val added in v0.1.56 

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

func (*PluginCommandFlag) Validate added in v0.1.56 

func (p *PluginCommandFlag) Validate() error

func (*PluginCommandFlag) ValueType added in v0.1.56 

func (p *PluginCommandFlag) ValueType() CommandValueType

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 PluginSecret added in v0.1.109 

type PluginSecret struct {
	Key         string `json:"-"`
	Description string `json:"description"`
}

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 added in v0.1.2 

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

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.