plugin

Documentation

Index

• func GenerateDoc(pluginName string, specDirs []string, port int)
• func GetInstallDir(pluginName, version string) (string, error)
• func GetLanguageJSONFilePath(language string) (string, error)
• func GetPluginDescriptor(pluginID, pluginVersion string) (*pluginDescriptor, error)
• func GetPluginDescriptorFromJSON(pluginJSON string) (*pluginDescriptor, error)
• func IsLanguagePlugin(plugin string) bool
• func IsPluginAdded(manifest *manifest.Manifest, descriptor *pluginDescriptor) bool
• func IsPluginInstalled(pluginName, pluginVersion string) bool
• func QueryParams() string
• func SetEnvForPlugin(action string, pd *pluginDescriptor, manifest *manifest.Manifest, ...) error
• func StartPlugin(pd *pluginDescriptor, action string) (*plugin, error)
• type GaugePlugins
  • func (gp *GaugePlugins) GracefullyKillPlugins()
  • func (gp *GaugePlugins) NotifyPlugins(message *gauge_messages.Message)
• type Handler
  • func StartPlugins(manifest *manifest.Manifest) Handler
• type PluginInfo
  • func GetAllInstalledPluginsWithVersion() ([]PluginInfo, error)
  • func GetPluginsInfo() []PluginInfo
  • func PluginsWithoutScope() (infos []PluginInfo)

Functions

func GenerateDoc

func GenerateDoc(pluginName string, specDirs []string, port int)

func GetInstallDir

func GetInstallDir(pluginName, version string) (string, error)

GetInstallDir returns the install directory of given plugin and a given version.

func GetLanguageJSONFilePath

func GetLanguageJSONFilePath(language string) (string, error)

func GetPluginDescriptor

func GetPluginDescriptor(pluginID, pluginVersion string) (*pluginDescriptor, error)

func GetPluginDescriptorFromJSON

func GetPluginDescriptorFromJSON(pluginJSON string) (*pluginDescriptor, error)

func IsLanguagePlugin

func IsLanguagePlugin(plugin string) bool

func IsPluginAdded

func IsPluginAdded(manifest *manifest.Manifest, descriptor *pluginDescriptor) bool

func IsPluginInstalled

func IsPluginInstalled(pluginName, pluginVersion string) bool

func QueryParams

func QueryParams() string

func SetEnvForPlugin

func SetEnvForPlugin(action string, pd *pluginDescriptor, manifest *manifest.Manifest, pluginEnvVars map[string]string) error

func StartPlugin

func StartPlugin(pd *pluginDescriptor, action string) (*plugin, error)

Types

type GaugePlugins

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

func (*GaugePlugins) GracefullyKillPlugins

func (gp *GaugePlugins) GracefullyKillPlugins()

func (*GaugePlugins) NotifyPlugins

func (gp *GaugePlugins) NotifyPlugins(message *gauge_messages.Message)

type Handler

type Handler interface {
	NotifyPlugins(*gauge_messages.Message)
	GracefullyKillPlugins()
}

func StartPlugins

func StartPlugins(manifest *manifest.Manifest) Handler

type PluginInfo

type PluginInfo struct {
	Name    string
	Version *version.Version
	Path    string
}

func GetAllInstalledPluginsWithVersion

func GetAllInstalledPluginsWithVersion() ([]PluginInfo, error)

func GetPluginsInfo

func GetPluginsInfo() []PluginInfo

func PluginsWithoutScope

func PluginsWithoutScope() (infos []PluginInfo)