commands

Documentation

Overview

package commands provides the interfaces and structures to trigger and run shell commands.

Index

• Variables
• type Action
  • func New(config *common.Config, commands []*Command) *Action
  • func (a *Action) Create()
  • func (a *Action) GetByHash(hash string) *Command
  • func (a *Action) List() []*cmdconfig.Config
• type Command
  • func (c *Command) Run(input *common.ActionInput)
  • func (c *Command) RunNow(ctx context.Context, input *common.ActionInput) (string, error)
  • func (c *Command) Setup(logger mnd.Logger, website *website.Server)
  • func (c *Command) SetupRegexpArgs() error
  • func (c *Command) Stats() Stats
• type Stats

Variables

var (
	ErrArgCount = fmt.Errorf("wrong count of args provided")
	ErrArgValue = fmt.Errorf("provided argument value invalid")
)

Errors produced by this file.

var ErrDisabled = fmt.Errorf("the command is disabled due to an error")

var (
	ErrNoCmd = fmt.Errorf("cmd provided without a command configured; fix it")
)

Errors produced by this file.

Types

type Action

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

Action contains the exported methods for this package.

func New

func New(config *common.Config, commands []*Command) *Action

New configures the library.

func (*Action) Create

func (a *Action) Create()

Create initializes the library.

func (*Action) GetByHash

func (a *Action) GetByHash(hash string) *Command

GetByHash returns a command by the hash ID.

func (*Action) List

func (a *Action) List() []*cmdconfig.Config

List returns a list of active triggers that can be executed.

type Command

type Command struct {
	cmdconfig.Config
	// contains filtered or unexported fields
}

Command contains the input data for a defined command. It also contains some saved data about the command being run.

func (*Command) Run

func (c *Command) Run(input *common.ActionInput)

Run fires a custom command.

func (*Command) RunNow

func (c *Command) RunNow(ctx context.Context, input *common.ActionInput) (string, error)

RunNow runs the command immediately, waits for and returns the output.

func (*Command) Setup

func (c *Command) Setup(logger mnd.Logger, website *website.Server)

Setup must run in the creation routine.

func (*Command) SetupRegexpArgs

func (c *Command) SetupRegexpArgs() error

func (*Command) Stats

func (c *Command) Stats() Stats

Stats returns statistics about a command.

type Stats

type Stats struct {
	Args       []*regexp.Regexp `json:"-"`
	Command    string           `json:"-"`
	Runs       int              `json:"runs"`
	Fails      int              `json:"fails"`
	LastOutput string           `json:"output"`
	LastRun    string           `json:"last"`
	LastArgs   []string         `json:"lastArgs"`
}

Stats for a command's invocations.