x

package

v1.2.0 Latest Latest Go to latest Published: Jul 17, 2023 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubeshop/botkube

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GetPluginDependencies() map[string]api.Dependency
func RunInstalledCommand(ctx context.Context, tmp plugin.TmpDir, in string, envs map[string]string) (string, error)
type Command
- func Parse(cmd string) Command
type Config
type Render
type Renderer
- func NewRenderer() *Renderer
type Runner
- func NewRunner(log logrus.FieldLogger, renderer *Renderer) *Runner
- func (i *Runner) Run(ctx context.Context, cfg Config, state *state.Container, cmd Command, ...) (executor.ExecuteOutput, error)

Constants ¶

View Source

const (
	RawOutputIndicator   = "@raw"
	SelectIndexIndicator = "@idx:"
	PageIndexIndicator   = "@page:"
)

Variables ¶

This section is empty.

Functions ¶

func GetPluginDependencies ¶

func GetPluginDependencies() map[string]api.Dependency

GetPluginDependencies returns exec plugin dependencies.

func RunInstalledCommand ¶

func RunInstalledCommand(ctx context.Context, tmp plugin.TmpDir, in string, envs map[string]string) (string, error)

RunInstalledCommand runs a given user command for already installed CLIs.

Types ¶

type Command ¶

type Command struct {
	ToExecute     string
	IsRawRequired bool
	PageIndex     int
}

Command holds command details.

func Parse ¶

func Parse(cmd string) Command

Parse returns parsed command string.

type Config ¶

type Config struct {
	Templates []getter.Source `yaml:"templates"`
	TmpDir    plugin.TmpDir   `yaml:"tmpDir"`
	Logger    config.Logger
}

Config holds exec plugin configuration.

type Render ¶

type Render interface {
	// RenderMessage receives command output and a template and produce a final message.
	RenderMessage(cmd, output string, state *state.Container, msgCtx *template.Template) (api.Message, error)
}

Render is an interface that knows how to render a given command output.

type Renderer ¶

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

Renderer provides functionality to render command output in requested format.

func NewRenderer ¶

func NewRenderer() *Renderer

NewRenderer returns a new Renderer instance.

func (*Renderer) Get ¶

func (r *Renderer) Get(output string) (Render, error)

Get return renderer for a given output

func (*Renderer) Register ¶

func (r *Renderer) Register(name string, render Render) error

func (*Renderer) RegisterAll ¶

func (r *Renderer) RegisterAll(in map[string]Render) error

type Runner ¶

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

Runner runs command and parse its output if needed.

func NewRunner ¶

func NewRunner(log logrus.FieldLogger, renderer *Renderer) *Runner

NewRunner returns a new Runner instance.

func (*Runner) Run ¶

func (i *Runner) Run(ctx context.Context, cfg Config, state *state.Container, cmd Command, runFn func() (string, error)) (executor.ExecuteOutput, error)

Run runs a given command and parse its output if needed.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
getter Package getter.	Package getter.
mathx
output
parser
state
template

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL