install

Documentation

Index

• func AddPluginToProject(pluginName string) error
• func AllPlugins(silent bool)
• func HandleInstallResult(result InstallResult, pluginName string, exitIfFailure bool) bool
• func HandleUpdateResult(result InstallResult, pluginName string, exitIfFailure bool) bool
• func IsCompatiblePluginInstalled(pluginName string, isRunner bool) bool
• func PrintUpdateInfoWithDetails()
• func UninstallPlugin(pluginName string, uninstallVersion string)
• func UpdatePlugins(silent bool)
• type GaugePlugin
• type InstallResult
  • func InstallPluginFromZipFile(zipFile string, pluginName string) InstallResult
  • func Plugin(pluginName, version string, silent bool) InstallResult
• type UpdateFacade
  • func (u *UpdateFacade) BufferUpdateDetails()
  • func (u *UpdateFacade) PrintUpdateBuffer()
• type UpdateInfo

Functions

func AddPluginToProject

func AddPluginToProject(pluginName string) error

AddPluginToProject adds the given plugin to current Gauge project.

func AllPlugins

func AllPlugins(silent bool)

AllPlugins install the latest version of all plugins specified in Gauge project manifest file

func HandleInstallResult

func HandleInstallResult(result InstallResult, pluginName string, exitIfFailure bool) bool

HandleInstallResult handles the result of plugin Installation TODO: Merge both HandleInstallResult and HandleUpdateResult, eliminate boolean exitIfFailure

func HandleUpdateResult

func HandleUpdateResult(result InstallResult, pluginName string, exitIfFailure bool) bool

HandleUpdateResult handles the result of plugin Installation

func IsCompatiblePluginInstalled

func IsCompatiblePluginInstalled(pluginName string, isRunner bool) bool

IsCompatiblePluginInstalled checks if a plugin compatible to gauge is installed TODO: This always checks if latest installed version of a given plugin is compatible. This should also check for older versions.

func PrintUpdateInfoWithDetails

func PrintUpdateInfoWithDetails()

func UninstallPlugin

func UninstallPlugin(pluginName string, uninstallVersion string)

UninstallPlugin uninstall the given plugin of the given uninstallVersion If uninstallVersion is not specified, it uninstalls all the versions of given plugin

func UpdatePlugins

func UpdatePlugins(silent bool)

UpdatePlugins updates all the currently installed plugins to its latest version

Types

type GaugePlugin

type GaugePlugin struct {
	ID          string
	Version     string
	Description string
	PreInstall  struct {
		Windows []string
		Linux   []string
		Darwin  []string
	}
	PostInstall struct {
		Windows []string
		Linux   []string
		Darwin  []string
	}
	PreUnInstall struct {
		Windows []string
		Linux   []string
		Darwin  []string
	}
	PostUnInstall struct {
		Windows []string
		Linux   []string
		Darwin  []string
	}
	GaugeVersionSupport version.VersionSupport
}

GaugePlugin represents any plugin to Gauge. It can be an language runner or any other plugin.

type InstallResult

type InstallResult struct {
	Error   error
	Warning string
	Info    string
	Success bool
	Skipped bool
}

InstallResult represents the result of plugin installation

func InstallPluginFromZipFile

func InstallPluginFromZipFile(zipFile string, pluginName string) InstallResult

InstallPluginFromZipFile installs plugin from given zip file

func Plugin

func Plugin(pluginName, version string, silent bool) InstallResult

Plugin download and install the latest plugin(if version not specified) of given plugin name

type UpdateFacade

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

func (*UpdateFacade) BufferUpdateDetails

func (u *UpdateFacade) BufferUpdateDetails()

func (*UpdateFacade) PrintUpdateBuffer

func (u *UpdateFacade) PrintUpdateBuffer()

type UpdateInfo

type UpdateInfo struct {
	Name              string
	CompatibleVersion string
	Message           string
}