execute

Documentation

Index

• Variables
• type AnalyticsReporter
• type BindingsStorage
• type CommandCombinedOutputRunner
• type CommandFlags
  • func (flag CommandFlags) String() string
• type CommandRunner
• type CommandSeparateOutputRunner
• type ConfigPersistenceManager
• type Conversation
• type DefaultExecutor
  • func (e *DefaultExecutor) Execute() interactive.Message
• type DefaultExecutorFactory
  • func NewExecutorFactory(params DefaultExecutorFactoryParams) *DefaultExecutorFactory
  • func (f *DefaultExecutorFactory) NewDefault(cfg NewDefaultInput) Executor
• type DefaultExecutorFactoryParams
• type EditExecutor
  • func NewEditExecutor(log logrus.FieldLogger, analyticsReporter AnalyticsReporter, ...) *EditExecutor
  • func (e *EditExecutor) Do(args []string, commGroupName string, platform config.CommPlatformIntegration, ...) (interactive.Message, error)
• type EditResource
  • func (e EditResource) Key() string
• type Executor
• type FiltersAction
  • func (action FiltersAction) String() string
• type Kubectl
  • func NewKubectl(log logrus.FieldLogger, cfg config.Config, merger *kubectl.Merger, ...) *Kubectl
  • func (e *Kubectl) CanHandle(bindings []string, args []string) bool
  • func (e *Kubectl) Execute(bindings []string, command string, isAuthChannel bool) (string, error)
  • func (e *Kubectl) GetCommandPrefix(args []string) string
  • func (e *Kubectl) GetVerb(args []string) string
• type NewDefaultInput
• type NotifierAction
  • func (action NotifierAction) String() string
• type NotifierExecutor
  • func NewNotifierExecutor(log logrus.FieldLogger, cfg config.Config, cfgManager ConfigPersistenceManager, ...) *NotifierExecutor
  • func (e *NotifierExecutor) Do(ctx context.Context, args []string, commGroupName string, ...) (string, error)
• type NotifierHandler
• type OSCommand
  • func (*OSCommand) RunCombinedOutput(command string, args []string) (string, error)
  • func (*OSCommand) RunSeparateOutput(command string, args []string) (string, string, error)

Variables

var (
	// ErrNotificationsNotConfigured describes an error when user wants to toggle on/off the notifications for not configured channel.
	ErrNotificationsNotConfigured = errors.New("notifications not configured for this channel")
)

Types

type AnalyticsReporter

type AnalyticsReporter interface {
	// ReportCommand reports a new executed command. The command should be anonymized before using this method.
	ReportCommand(platform config.CommPlatformIntegration, command string, isButtonClickOrigin bool) error
}

AnalyticsReporter defines a reporter that collects analytics data.

type BindingsStorage

type BindingsStorage interface {
	PersistSourceBindings(ctx context.Context, commGroupName string, platform config.CommPlatformIntegration, channelAlias string, sourceBindings []string) error
}

BindingsStorage provides functionality to persist source binding for a given channel.

type CommandCombinedOutputRunner

type CommandCombinedOutputRunner interface {
	RunCombinedOutput(command string, args []string) (string, error)
}

CommandCombinedOutputRunner provides functionality to run arbitrary commands.

type CommandFlags

type CommandFlags string

CommandFlags creates custom type for flags in botkube

const (
	ClusterFlag    CommandFlags = "--cluster-name"
	FollowFlag     CommandFlags = "--follow"
	AbbrFollowFlag CommandFlags = "-f"
	WatchFlag      CommandFlags = "--watch"
	AbbrWatchFlag  CommandFlags = "-w"
)

Defines botkube flags

func (CommandFlags) String

func (flag CommandFlags) String() string

type CommandRunner

type CommandRunner interface {
	CommandCombinedOutputRunner
	CommandSeparateOutputRunner
}

CommandRunner provides functionality to run arbitrary commands.

type CommandSeparateOutputRunner

type CommandSeparateOutputRunner interface {
	RunSeparateOutput(command string, args []string) (string, string, error)
}

CommandSeparateOutputRunner provides functionality to run arbitrary commands.

type ConfigPersistenceManager

type ConfigPersistenceManager interface {
	PersistSourceBindings(ctx context.Context, commGroupName string, platform config.CommPlatformIntegration, channelAlias string, sourceBindings []string) error
	PersistNotificationsEnabled(ctx context.Context, commGroupName string, platform config.CommPlatformIntegration, channelAlias string, enabled bool) error
	PersistFilterEnabled(ctx context.Context, name string, enabled bool) error
}

ConfigPersistenceManager manages persistence of the configuration.

type Conversation

type Conversation struct {
	Alias               string
	ID                  string
	ExecutorBindings    []string
	IsAuthenticated     bool
	IsButtonClickOrigin bool
}

Conversation contains details about the conversation.

type DefaultExecutor

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

DefaultExecutor is a default implementations of Executor

func (*DefaultExecutor) Execute

func (e *DefaultExecutor) Execute() interactive.Message

Execute executes commands and returns output

type DefaultExecutorFactory

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

DefaultExecutorFactory facilitates creation of the Executor instances.

func NewExecutorFactory

func NewExecutorFactory(params DefaultExecutorFactoryParams) *DefaultExecutorFactory

NewExecutorFactory creates new DefaultExecutorFactory.

func (*DefaultExecutorFactory) NewDefault

func (f *DefaultExecutorFactory) NewDefault(cfg NewDefaultInput) Executor

NewDefault creates new Default Executor.

type DefaultExecutorFactoryParams

type DefaultExecutorFactoryParams struct {
	Log               logrus.FieldLogger
	CmdRunner         CommandRunner
	Cfg               config.Config
	FilterEngine      filterengine.FilterEngine
	KcChecker         *kubectl.Checker
	Merger            *kubectl.Merger
	CfgManager        ConfigPersistenceManager
	AnalyticsReporter AnalyticsReporter
}

DefaultExecutorFactoryParams contains input parameters for DefaultExecutorFactory.

type EditExecutor

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

EditExecutor provides functionality to run all BotKube edit related commands.

func NewEditExecutor

func NewEditExecutor(log logrus.FieldLogger, analyticsReporter AnalyticsReporter, cfgManager BindingsStorage, cfg config.Config) *EditExecutor

NewEditExecutor returns a new EditExecutor instance.

func (*EditExecutor) Do

func (e *EditExecutor) Do(args []string, commGroupName string, platform config.CommPlatformIntegration, conversation Conversation, userID, botName string) (interactive.Message, error)

Do executes a given edit command based on args.

type EditResource

type EditResource string

EditResource defines the name of editable resource

const (
	// SourceBindings define name of source binding resource
	SourceBindings EditResource = "SourceBindings"
)

func (EditResource) Key

func (e EditResource) Key() string

Key returns normalized edit resource name.

type Executor

type Executor interface {
	Execute() interactive.Message
}

Executor is an interface for processes to execute commands

type FiltersAction

type FiltersAction string

FiltersAction for options in filter commands

const (
	FilterList    FiltersAction = "list"
	FilterEnable  FiltersAction = "enable"
	FilterDisable FiltersAction = "disable"
)

Filter command options

func (FiltersAction) String

func (action FiltersAction) String() string

type Kubectl

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

Kubectl executes kubectl commands using local binary.

func NewKubectl

func NewKubectl(log logrus.FieldLogger, cfg config.Config, merger *kubectl.Merger, kcChecker *kubectl.Checker, fn CommandCombinedOutputRunner) *Kubectl

NewKubectl creates a new instance of Kubectl.

func (*Kubectl) CanHandle

func (e *Kubectl) CanHandle(bindings []string, args []string) bool

CanHandle returns true if it's allowed kubectl command that can be handled by this executor.

TODO: we should just introduce a command name explicitly. In this case `@BotKube kubectl get po` instead of `@BotKube get po` As a result, we are able to detect kubectl command but say that you're simply not authorized to use it instead of "Command not supported. (..)"

func (*Kubectl) Execute

func (e *Kubectl) Execute(bindings []string, command string, isAuthChannel bool) (string, error)

Execute executes kubectl command based on a given args.

This method should be called ONLY if: - we are a target cluster, - and Kubectl.CanHandle returned true.

func (*Kubectl) GetCommandPrefix

func (e *Kubectl) GetCommandPrefix(args []string) string

GetCommandPrefix gets verb command with k8s alias prefix.

func (*Kubectl) GetVerb

func (e *Kubectl) GetVerb(args []string) string

GetVerb gets verb command for k8s ignoring k8s alias prefix.

type NewDefaultInput

type NewDefaultInput struct {
	CommGroupName   string
	Platform        config.CommPlatformIntegration
	NotifierHandler NotifierHandler
	Conversation    Conversation
	Message         string
	User            string
}

NewDefaultInput an input for NewDefault

type NotifierAction

type NotifierAction string

NotifierAction creates custom type for notifier actions

const (
	Start      NotifierAction = "start"
	Stop       NotifierAction = "stop"
	Status     NotifierAction = "status"
	ShowConfig NotifierAction = "showconfig"
)

Defines constants for notifier actions

func (NotifierAction) String

func (action NotifierAction) String() string

type NotifierExecutor

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

NotifierExecutor executes all commands that are related to notifications.

func NewNotifierExecutor

func NewNotifierExecutor(log logrus.FieldLogger, cfg config.Config, cfgManager ConfigPersistenceManager, analyticsReporter AnalyticsReporter) *NotifierExecutor

NewNotifierExecutor creates a new instance of NotifierExecutor.

func (*NotifierExecutor) Do

func (e *NotifierExecutor) Do(ctx context.Context, args []string, commGroupName string, platform config.CommPlatformIntegration, conversation Conversation, clusterName string, handler NotifierHandler) (string, error)

Do executes a given Notifier command based on args.

type NotifierHandler

type NotifierHandler interface {
	// NotificationsEnabled returns current notification status for a given conversation ID.
	NotificationsEnabled(conversationID string) bool

	// SetNotificationsEnabled sets a new notification status for a given conversation ID.
	SetNotificationsEnabled(conversationID string, enabled bool) error

	BotName() string
}

NotifierHandler handles disabling and enabling notifications for a given communication platform.

type OSCommand

type OSCommand struct{}

OSCommand provides syntax sugar for working with exec.Command

func (*OSCommand) RunCombinedOutput

func (*OSCommand) RunCombinedOutput(command string, args []string) (string, error)

RunCombinedOutput runs a given command and returns its combined standard output and standard error.

func (*OSCommand) RunSeparateOutput

func (*OSCommand) RunSeparateOutput(command string, args []string) (string, string, error)

RunSeparateOutput runs a given command and returns separately its standard output and standard error.