run

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(ctx context.Context, socketPath string) (Client, error)
  • func NewDefaultClient(ctx context.Context) (Client, error)
• type Option
  • func WithLogger(logger *slog.Logger) Option
• type RunCommand
  • func (rc *RunCommand) IsShutdown() bool
• type RunServer
  • func NewServerWithDefaultSocketPath(rb *savvy_client.Runbook, opts ...Option) (*RunServer, error)
  • func NewServerWithSocketPath(socketPath string, rb *savvy_client.Runbook, opts ...Option) (*RunServer, error)
  • func (rs *RunServer) Close() error
  • func (rs *RunServer) Commands() []*RunCommand
  • func (rs *RunServer) ListenAndServe()
  • func (rs *RunServer) SocketPath() string
• type State
  • func (s *State) CommandWithSetParams() string

Constants

const DefaultRunSocketPath = "/tmp/savvy-run.sock"

Variables

var ErrAbortRun = errors.New("abort running runbook")

var ErrStartingRunSession = errors.New("failed to start run session")

Types

type Client

type Client interface {
	server.ShutdownSender
	NextCommand() error
	PreviousCommand() error
	CurrentState() (*State, error)
	SetParams(params map[string]string) error
}

func NewClient

func NewClient(ctx context.Context, socketPath string) (Client, error)

func NewDefaultClient

func NewDefaultClient(ctx context.Context) (Client, error)

type Option

type Option func(s *RunServer)

func WithLogger

func WithLogger(logger *slog.Logger) Option

type RunCommand

type RunCommand struct {
	Command string            `json:"command,omitempty"`
	Params  map[string]string `json:"params,omitempty"`
}

func (*RunCommand) IsShutdown

func (rc *RunCommand) IsShutdown() bool

type RunServer

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

func NewServerWithDefaultSocketPath

func NewServerWithDefaultSocketPath(rb *savvy_client.Runbook, opts ...Option) (*RunServer, error)

func NewServerWithSocketPath

func NewServerWithSocketPath(socketPath string, rb *savvy_client.Runbook, opts ...Option) (*RunServer, error)

func (*RunServer) Close

func (rs *RunServer) Close() error

func (*RunServer) Commands

func (rs *RunServer) Commands() []*RunCommand

func (*RunServer) ListenAndServe

func (rs *RunServer) ListenAndServe()

func (*RunServer) SocketPath

func (rs *RunServer) SocketPath() string

type State

type State struct {
	Command string            `json:"command"`
	Index   int               `json:"index"`
	Params  map[string]string `json:"params"`
}

func (*State) CommandWithSetParams

func (s *State) CommandWithSetParams() string