plugin

Documentation

Index

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

Functions

func GenerateDoc

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

func GetInstallDir

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

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

func GetLanguageJSONFilePath

func GetLanguageJSONFilePath(language string) (string, error)

func IsLanguagePlugin

func IsLanguagePlugin(plugin string) bool

func IsPluginAdded

func IsPluginAdded(m *manifest.Manifest, descriptor *PluginDescriptor) bool

func IsPluginInstalled

func IsPluginInstalled(pluginName, pluginVersion string) bool

IsPluginInstalled checks if given plugin with specific version is installed or not.

func PluginsWithoutScope

func PluginsWithoutScope() (infos []pluginInfo.PluginInfo)

func QueryParams

func QueryParams() string

func SetEnvForPlugin

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

Types

type GaugePlugins

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

GaugePlugins holds a reference to all plugins launched. The plugins are listed in project manifest

func (*GaugePlugins) GracefullyKillPlugins

func (gp *GaugePlugins) GracefullyKillPlugins()

GracefullyKillPlugins tells the plugins to stop, letting them cleanup whatever they need to

func (*GaugePlugins) NotifyPlugins

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

NotifyPlugins passes a message to all plugins listed in the manifest

type Handler

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

Handler manages plugins listed in project manifest.

func StartPlugins

func StartPlugins(m *manifest.Manifest) Handler

type PluginDescriptor

type PluginDescriptor struct {
	ID          string
	Version     string
	Name        string
	Description string
	Command     struct {
		Windows []string
		Linux   []string
		Darwin  []string
	}
	Scope               []string
	GaugeVersionSupport version.VersionSupport

	Capabilities []string
	// contains filtered or unexported fields
}

func GetPluginDescriptor

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

GetPluginDescriptor return the information about the plugin including name, id, commands to start etc.

func GetPluginDescriptorFromJSON

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