runscript

Documentation

Overview

Package runscript implements the RunScript plugin. RunPowerShellScript contains implementation of the plugin that runs powershell scripts on linux or windows

Package runscript implements the runscript plugin.

Package runscript implements the RunScript plugin. RunShellScript contains implementation of the plugin that runs shell scripts on linux

Index

• func NewRunPowerShellPlugin(pluginConfig pluginutil.PluginConfig) (*runPowerShellPlugin, error)
• func NewRunShellPlugin(log log.T, pluginConfig pluginutil.PluginConfig) (*runShellPlugin, error)
• type Plugin
  • func (p *Plugin) AssignPluginConfigs(pluginConfig pluginutil.PluginConfig)
  • func (p *Plugin) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag, ...) (res contracts.PluginResult)
• type RunScriptPluginInput

Functions

func NewRunPowerShellPlugin

func NewRunPowerShellPlugin(pluginConfig pluginutil.PluginConfig) (*runPowerShellPlugin, error)

NewRunPowerShellPlugin returns a new instance of the PSPlugin.

func NewRunShellPlugin

func NewRunShellPlugin(log log.T, pluginConfig pluginutil.PluginConfig) (*runShellPlugin, error)

NewRunShellPlugin returns a new instance of the SHPlugin.

Types

type Plugin

type Plugin struct {
	pluginutil.DefaultPlugin

	// Name is the plugin name (PowerShellScript or ShellScript)
	Name           string
	ScriptName     string
	ShellCommand   string
	ShellArguments []string
	ByteOrderMark  fileutil.ByteOrderMark
	// contains filtered or unexported fields
}

Plugin is the type for the runscript plugin.

func (*Plugin) AssignPluginConfigs

func (p *Plugin) AssignPluginConfigs(pluginConfig pluginutil.PluginConfig)

func (*Plugin) Execute

func (p *Plugin) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag, subDocumentRunner runpluginutil.PluginRunner) (res contracts.PluginResult)

Execute runs multiple sets of commands and returns their outputs. res.Output will contain a slice of RunScriptPluginOutput.

type RunScriptPluginInput

type RunScriptPluginInput struct {
	contracts.PluginInput
	RunCommand       []string
	ID               string
	WorkingDirectory string
	TimeoutSeconds   interface{}
}

RunScriptPluginInput represents one set of commands executed by the RunScript plugin.