command

Documentation

Index

• Constants
• func CreateEnv(key, value string) string
• func EnvSliceToString(env []string) string
• func IsShellLanguage(languageID string) bool
• func IsShellProgram(programName string) bool
• func SetEnvDumpCommand(cmd string)
• func SetWinsize(cmd Command, winsize *Winsize) (err error)
• type Command
• type CommandOptions
• type EnvDecryptor
  • func NewEnvDecryptor(key []byte, nonce []byte, source io.Reader) (*EnvDecryptor, error)
  • func (d *EnvDecryptor) Read(p []byte) (n int, err error)
• type EnvEncryptor
  • func NewEnvEncryptor(key []byte, nonce []byte, source io.Reader) (*EnvEncryptor, error)
  • func (e *EnvEncryptor) Read(p []byte) (n int, err error)
• type EnvProducer
  • func NewEnvProducerFromEnv() (*EnvProducer, error)
  • func (p *EnvProducer) Read(b []byte) (n int, err error)
• type Factory
  • func NewFactory(opts ...FactoryOption) Factory
• type FactoryOption
  • func WithDebug() FactoryOption
  • func WithDocker(docker *dockerexec.Docker) FactoryOption
  • func WithLogger(logger *zap.Logger) FactoryOption
  • func WithProject(proj *project.Project) FactoryOption
  • func WithRuntime(r Runtime) FactoryOption
• type ProgramConfig
  • func NewProgramConfigFromCodeBlock(block *document.CodeBlock) (*ProgramConfig, error)
• type ProgramResolver
  • func NewProgramResolver(mode ProgramResolverMode, sensitiveEnvNames []string, ...) *ProgramResolver
  • func (r *ProgramResolver) IsEnvSensitive(name string) bool
  • func (r *ProgramResolver) Resolve(reader io.Reader, writer io.Writer) (*ProgramResolverResult, error)
• type ProgramResolverMode
• type ProgramResolverResult
• type ProgramResolverSource
  • func ProgramResolverSourceFunc(env []string) ProgramResolverSource
• type ProgramResolverStatus
• type ProgramResolverVarResult
• type Runtime
• type Winsize

Constants

const StoreStdoutEnvName = "__"

Functions

func CreateEnv

func CreateEnv(key, value string) string

func EnvSliceToString

func EnvSliceToString(env []string) string

func IsShellLanguage

func IsShellLanguage(languageID string) bool

TODO(adamb): this function is used for two quite different inputs: program name and language ID.

func IsShellProgram

func IsShellProgram(programName string) bool

func SetEnvDumpCommand

func SetEnvDumpCommand(cmd string)

func SetWinsize

func SetWinsize(cmd Command, winsize *Winsize) (err error)

Types

type Command

type Command interface {
	Interactive() bool
	Pid() int
	Running() bool
	Start(context.Context) error
	Signal(os.Signal) error
	Wait(context.Context) error
}

type CommandOptions

type CommandOptions struct {
	// EnableEcho enables the echo when typing in the terminal.
	// It's respected only by interactive commands, i.e. composed
	// with [virtualCommand].
	EnableEcho bool

	// Session is used to share the state between commands.
	// If none is provided, an empty one will be used.
	Session *session.Session

	// StdinWriter is used by [terminalCommand].
	StdinWriter io.Writer
	Stdin       io.Reader
	Stdout      io.Writer
	Stderr      io.Writer
}

type EnvDecryptor

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

func NewEnvDecryptor

func NewEnvDecryptor(key []byte, nonce []byte, source io.Reader) (*EnvDecryptor, error)

func (*EnvDecryptor) Read

func (d *EnvDecryptor) Read(p []byte) (n int, err error)

type EnvEncryptor

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

func NewEnvEncryptor

func NewEnvEncryptor(key []byte, nonce []byte, source io.Reader) (*EnvEncryptor, error)

func (*EnvEncryptor) Read

func (e *EnvEncryptor) Read(p []byte) (n int, err error)

type EnvProducer

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

func NewEnvProducerFromEnv

func NewEnvProducerFromEnv() (*EnvProducer, error)

func (*EnvProducer) Read

func (p *EnvProducer) Read(b []byte) (n int, err error)

type Factory

type Factory interface {
	Build(*ProgramConfig, CommandOptions) (Command, error)
}

func NewFactory

func NewFactory(opts ...FactoryOption) Factory

type FactoryOption

type FactoryOption func(*commandFactory)

func WithDebug

func WithDebug() FactoryOption

WithDebug enables additional debug information. For example, for shell commands it prints out commands before execution.

func WithDocker

func WithDocker(docker *dockerexec.Docker) FactoryOption

WithDocker provides a docker client for docker commands.

func WithLogger

func WithLogger(logger *zap.Logger) FactoryOption

func WithProject

func WithProject(proj *project.Project) FactoryOption

func WithRuntime

func WithRuntime(r Runtime) FactoryOption

type ProgramConfig

type ProgramConfig = runnerv2.ProgramConfig

ProgramConfig contains a serializable configuration for a command. It's agnostic to the runtime or particular execution settings.

func NewProgramConfigFromCodeBlock

func NewProgramConfigFromCodeBlock(block *document.CodeBlock) (*ProgramConfig, error)

type ProgramResolver

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

ProgramResolver uses a list of ProgramResolverSource to resolve environment variables found in a shell program.

func NewProgramResolver

func NewProgramResolver(mode ProgramResolverMode, sensitiveEnvNames []string, sources ...ProgramResolverSource) *ProgramResolver

func (*ProgramResolver) IsEnvSensitive

func (r *ProgramResolver) IsEnvSensitive(name string) bool

func (*ProgramResolver) Resolve

func (r *ProgramResolver) Resolve(reader io.Reader, writer io.Writer) (*ProgramResolverResult, error)

Resolve resolves the environment variables found in a shell program. It might modify the program and write it provided writer.

type ProgramResolverMode

type ProgramResolverMode uint8

const (
	// ProgramResolverModeAuto is a default which prompts for all unresolved variables.
	ProgramResolverModeAuto ProgramResolverMode = iota
	// ProgramResolverModePromptAll always prompts even if variables are resolved.
	ProgramResolverModePromptAll
	// ProgramResolverModeSkipAll does not prompt even if variables are unresolved.
	// All variables will be marked as resolved.
	ProgramResolverModeSkipAll
)

type ProgramResolverResult

type ProgramResolverResult struct {
	Variables       []ProgramResolverVarResult
	ModifiedProgram bool
}

type ProgramResolverSource

type ProgramResolverSource func() []string

func ProgramResolverSourceFunc

func ProgramResolverSourceFunc(env []string) ProgramResolverSource

type ProgramResolverStatus

type ProgramResolverStatus uint8

const (
	// ProgramResolverStatusUnresolved indicates a variable is unresolved.
	ProgramResolverStatusUnresolved ProgramResolverStatus = iota
	// ProgramResolverStatusUnresolvedWithMessage indicates a variable is unresolved but it has a message.
	// It typically means that the variable is of form `export FOO=this is a message`.
	ProgramResolverStatusUnresolvedWithMessage
	// ProgramResolverStatusUnresolvedWithPlaceholder indicates a variable is unresolved but it has a placeholder.
	// It typically means that the variable is of form `export FOO="this is a placeholder"`.
	ProgramResolverStatusUnresolvedWithPlaceholder
	// ProgramResolverStatusUnresolvedWithSecret indicates a variable is unresolved and needs to be treated with sensitivity.
	// It typically means that the variable is a password, certificate, or access key.
	ProgramResolverStatusUnresolvedWithSecret
	// ProgramResolverStatusResolved indicates a variable is resolved.
	ProgramResolverStatusResolved
)

type ProgramResolverVarResult

type ProgramResolverVarResult struct {
	// Status indicates the status of the result.
	Status ProgramResolverStatus

	// Name is the name of the variable.
	// It is set always.
	Name string

	// OriginalValue is the original value of the variable.
	// It's either a placeholder (`export FOO="this is a placeholder"`) or
	// a message (`export FOO=this is a message`).
	OriginalValue string

	// Value is the resolved value of the variable.
	// It is set only if Status is ProgramResolverStatusResolved.
	Value string
}

type Runtime

type Runtime interface {
	Environ() []string
	LookPathUsingPathEnv(file, pathEnv string) (string, error)
}

type Winsize

type Winsize pty.Winsize