plugins

type CLIPluginV1 ¶

type CLIPluginV1 struct {
	// Impl Injection
	Impl Dispatcher
}

CLIPluginV1 is the implementation of plugin.Plugin so we can serve/consume this

This has two methods: Server must return an RPC server for this plugin type. We construct a DispatcherRPCServer for this.

Client must return an implementation of our interface that communicates over an RPC client. We return a PluginClient for this.

Ignore MuxBroker. That is used to create more multiplexed streams on a plugin connection and is a more advanced use case.

func (CLIPluginV1) Client(b *hcplugin.MuxBroker, c *rpc.Client) (interface{}, error)

func (p *CLIPluginV1) Server(*hcplugin.MuxBroker) (interface{}, error)

type Dispatcher ¶

type Dispatcher interface {
	RunCommand(args []string) (string, error)
}

Dispatcher is the interface that we're exposing as a plugin. It is named so because it is able to dispatch a command from the main CLI to the plugin

type DispatcherRPCServer ¶

type DispatcherRPCServer struct {
	// This is the real implementation
	Impl Dispatcher
}

DispatcherRPCServer is the RPC server that a plugin talks to, conforming to the requirements of net/rpc

func (s *DispatcherRPCServer) RunCommand(args []string, resp *string) error

type Plugin ¶

type Plugin struct {
	Shortname        string
	Binary           string
	Releases         []Release `toml:"Release"`
	MagicCookieValue string
}

Plugin contains the plugin properties

func LookUpPlugin(ctx context.Context, config config.IConfig, fs afero.Fs, pluginName string) (Plugin, error)

func (p *Plugin) Install(ctx context.Context, config config.IConfig, fs afero.Fs, version string, baseURL string) error

func (p *Plugin) LookUpLatestVersion() string

func (p *Plugin) Run(ctx context.Context, config *config.Config, fs afero.Fs, args []string) error

type PluginClient ¶

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

PluginClient is an implementation that talks over RPC

func (g *PluginClient) RunCommand(args []string) (string, error)

type PluginList ¶

type PluginList struct {
	Plugins []Plugin `toml:"Plugin"`
}

PluginList contains a list of plugins

func GetPluginList(ctx context.Context, config config.IConfig, fs afero.Fs) (PluginList, error)

type Release ¶

type Release struct {
	Arch    string
	OS      string
	Version string
	Sum     string
}

Release is the type that holds release data for a specific build of a plugin

type TestConfig ¶

type TestConfig struct{}

TestConfig Implementation out the GetConfigFolder function

func (c *TestConfig) EditConfig() error

func (c *TestConfig) GetConfigFolder(xdgPath string) string

func (c *TestConfig) GetProfile() *config.Profile

func (c *TestConfig) InitConfig()

func (c *TestConfig) PrintConfig() error

func (c *TestConfig) RemoveAllProfiles() error

func (c *TestConfig) RemoveProfile(profileName string) error

type TestServers ¶

type TestServers struct {
	ArtifactoryServer *httptest.Server
	StripeServer      *httptest.Server
}

TestServers is a struct containing test servers that will be useful for unit testing plugin logic

func (ts *TestServers) CloseAll()