cli

Documentation

Index

• Variables
• func New(opts clients.CommonOpts) (pipeline.Client, error)
• type Client
  • func (c *Client) Done(ctx context.Context, w pipeline.Walker) error
  • func (c *Client) HandleEvents(events []pipeline.Event) error
  • func (c *Client) PipelineWalkFunc(ctx context.Context, pipelines ...pipeline.Pipeline) error
  • func (c *Client) Validate(step pipeline.Step) error
• type StateWrapper
  • func NewStateWrapper(r state.Reader, w state.Writer) *StateWrapper
  • func (w *StateWrapper) Exists(arg state.Argument) (bool, error)
  • func (w *StateWrapper) GetBool(arg state.Argument) (bool, error)
  • func (w *StateWrapper) GetDirectory(arg state.Argument) (fs.FS, error)
  • func (w *StateWrapper) GetDirectoryString(arg state.Argument) (string, error)
  • func (w *StateWrapper) GetFile(arg state.Argument) (*os.File, error)
  • func (w *StateWrapper) GetFloat64(arg state.Argument) (float64, error)
  • func (w *StateWrapper) GetInt64(arg state.Argument) (int64, error)
  • func (w *StateWrapper) GetString(arg state.Argument) (string, error)
  • func (w *StateWrapper) SetBool(key state.Argument, val bool) error
  • func (w *StateWrapper) SetDirectory(key state.Argument, val string) error
  • func (w *StateWrapper) SetFile(key state.Argument, val string) error
  • func (w *StateWrapper) SetFileReader(key state.Argument, r io.Reader) (string, error)
  • func (w *StateWrapper) SetFloat64(key state.Argument, val float64) error
  • func (w *StateWrapper) SetInt64(key state.Argument, val int64) error
  • func (w *StateWrapper) SetString(key state.Argument, val string) error

Variables

var KnownValues = map[state.Argument]func(state.Writer) error{
	pipeline.ArgumentRemoteURL:  setCurrentRemote,
	pipeline.ArgumentCommitRef:  setCurrentCommit,
	pipeline.ArgumentBranch:     setCurrentBranch,
	pipeline.ArgumentWorkingDir: setWorkingDir,
	pipeline.ArgumentSourceFS:   setSourceFS,
	pipeline.ArgumentBuildID:    setBuildID,
}

KnownValues are URL values that we know how to retrieve using the command line.

Functions

func New

func New(opts clients.CommonOpts) (pipeline.Client, error)

Types

type Client

type Client struct {
	Opts  clients.CommonOpts
	Log   *logrus.Logger
	State *StateWrapper
}

The Client is used when interacting with a scribe pipeline using the scribe CLI. It is used to run only one step. The CLI client simply runs the anonymous function defined in the step.

func (*Client) Done

func (c *Client) Done(ctx context.Context, w pipeline.Walker) error

func (*Client) HandleEvents

func (c *Client) HandleEvents(events []pipeline.Event) error

func (*Client) PipelineWalkFunc

func (c *Client) PipelineWalkFunc(ctx context.Context, pipelines ...pipeline.Pipeline) error

PipelineWalkFunc walks through the pipelines that the collection provides. Each pipeline is a pipeline of steps, so each will walk through the list of steps using the StepWalkFunc.

func (*Client) Validate

func (c *Client) Validate(step pipeline.Step) error

type StateWrapper

type StateWrapper struct {
	state.Reader
	state.Writer
	// contains filtered or unexported fields
}

func NewStateWrapper

func NewStateWrapper(r state.Reader, w state.Writer) *StateWrapper

func (*StateWrapper) Exists

func (w *StateWrapper) Exists(arg state.Argument) (bool, error)

func (*StateWrapper) GetBool

func (w *StateWrapper) GetBool(arg state.Argument) (bool, error)

func (*StateWrapper) GetDirectory

func (w *StateWrapper) GetDirectory(arg state.Argument) (fs.FS, error)

func (*StateWrapper) GetDirectoryString

func (w *StateWrapper) GetDirectoryString(arg state.Argument) (string, error)

func (*StateWrapper) GetFile

func (w *StateWrapper) GetFile(arg state.Argument) (*os.File, error)

func (*StateWrapper) GetFloat64

func (w *StateWrapper) GetFloat64(arg state.Argument) (float64, error)

func (*StateWrapper) GetInt64

func (w *StateWrapper) GetInt64(arg state.Argument) (int64, error)

func (*StateWrapper) GetString

func (w *StateWrapper) GetString(arg state.Argument) (string, error)

func (*StateWrapper) SetBool

func (w *StateWrapper) SetBool(key state.Argument, val bool) error

func (*StateWrapper) SetDirectory

func (w *StateWrapper) SetDirectory(key state.Argument, val string) error

func (*StateWrapper) SetFile

func (w *StateWrapper) SetFile(key state.Argument, val string) error

func (*StateWrapper) SetFileReader

func (w *StateWrapper) SetFileReader(key state.Argument, r io.Reader) (string, error)

func (*StateWrapper) SetFloat64

func (w *StateWrapper) SetFloat64(key state.Argument, val float64) error

func (*StateWrapper) SetInt64

func (w *StateWrapper) SetInt64(key state.Argument, val int64) error

func (*StateWrapper) SetString

func (w *StateWrapper) SetString(key state.Argument, val string) error