cli

Documentation

Index

• func PickLatestMajorVersion(versions api.LeafVersionsResult, leaf string, _ string) (string, error)
• func PickLatestMinorVersion(versions api.LeafVersionsResult, leaf string, major string) (string, error)
• type APIClient
• type Config
  • func (c Config) Validate() error
• type DebugTaskConfig
  • func (c DebugTaskConfig) Validate() error
• type InitiateRunConfig
  • func (c InitiateRunConfig) Validate() error
• type LintConfig
  • func NewLintConfig(filePaths []string, mintDir string, output io.Writer, formatString string) (LintConfig, error)
  • func (c LintConfig) Validate() error
• type LintOutputFormat
• type LoginConfig
  • func (c LoginConfig) Validate() error
• type SSHClient
• type Service
  • func NewService(cfg Config) (Service, error)
  • func (s Service) DebugTask(cfg DebugTaskConfig) error
  • func (s Service) InitiateRun(cfg InitiateRunConfig) (*api.InitiateRunResult, error)
  • func (s Service) Lint(cfg LintConfig) (*api.LintResult, error)
  • func (s Service) Login(cfg LoginConfig) error
  • func (s Service) SetSecretsInVault(cfg SetSecretsInVaultConfig) error
  • func (s Service) UpdateLeaves(cfg UpdateLeavesConfig) error
  • func (s Service) Whoami(cfg WhoamiConfig) error
• type SetSecretsInVaultConfig
  • func (c SetSecretsInVaultConfig) Validate() error
• type UpdateLeavesConfig
  • func (c UpdateLeavesConfig) Validate() error
• type WhoamiConfig
  • func (c WhoamiConfig) Validate() error

Functions

func PickLatestMajorVersion

func PickLatestMajorVersion(versions api.LeafVersionsResult, leaf string, _ string) (string, error)

func PickLatestMinorVersion

func PickLatestMinorVersion(versions api.LeafVersionsResult, leaf string, major string) (string, error)

Types

type APIClient

type APIClient interface {
	GetDebugConnectionInfo(debugKey string) (api.DebugConnectionInfo, error)
	InitiateRun(api.InitiateRunConfig) (*api.InitiateRunResult, error)
	ObtainAuthCode(api.ObtainAuthCodeConfig) (*api.ObtainAuthCodeResult, error)
	AcquireToken(tokenUrl string) (*api.AcquireTokenResult, error)
	Lint(api.LintConfig) (*api.LintResult, error)
	Whoami() (*api.WhoamiResult, error)
	SetSecretsInVault(api.SetSecretsInVaultConfig) (*api.SetSecretsInVaultResult, error)
	GetLeafVersions() (*api.LeafVersionsResult, error)
}

type Config

type Config struct {
	APIClient APIClient
	SSHClient SSHClient
}

func (Config) Validate

func (c Config) Validate() error

type DebugTaskConfig

type DebugTaskConfig struct {
	DebugKey string
}

func (DebugTaskConfig) Validate

func (c DebugTaskConfig) Validate() error

type InitiateRunConfig

type InitiateRunConfig struct {
	InitParameters map[string]string
	Json           bool
	MintDirectory  string
	MintFilePath   string
	NoCache        bool
	TargetedTasks  []string
	Title          string
}

func (InitiateRunConfig) Validate

func (c InitiateRunConfig) Validate() error

type LintConfig

type LintConfig struct {
	MintDirectory string
	MintFilePaths []string
	Output        io.Writer
	OutputFormat  LintOutputFormat
}

func NewLintConfig

func NewLintConfig(filePaths []string, mintDir string, output io.Writer, formatString string) (LintConfig, error)

func (LintConfig) Validate

func (c LintConfig) Validate() error

type LintOutputFormat

type LintOutputFormat int

const (
	LintOutputNone LintOutputFormat = iota
	LintOutputOneLine
	LintOutputMultiLine
)

type LoginConfig

type LoginConfig struct {
	DeviceName         string
	AccessTokenBackend accesstoken.Backend
	Stdout             io.Writer
	OpenUrl            func(url string) error
}

func (LoginConfig) Validate

func (c LoginConfig) Validate() error

type SSHClient

type SSHClient interface {
	Close() error
	Connect(addr string, cfg ssh.ClientConfig) error
	InteractiveSession() error
}

type Service

type Service struct {
	Config
}

Service holds the main business logic of the CLI.

func NewService

func NewService(cfg Config) (Service, error)

func (Service) DebugTask

func (s Service) DebugTask(cfg DebugTaskConfig) error

DebugRunConfig will connect to a running task over SSH. Key exchange is facilitated over the Cloud API.

func (Service) InitiateRun

func (s Service) InitiateRun(cfg InitiateRunConfig) (*api.InitiateRunResult, error)

InitiateRun will connect to the Cloud API and start a new run in Mint.

func (Service) Lint

func (s Service) Lint(cfg LintConfig) (*api.LintResult, error)

func (Service) Login

func (s Service) Login(cfg LoginConfig) error

InitiateRun will connect to the Cloud API and start a new run in Mint.

func (Service) SetSecretsInVault

func (s Service) SetSecretsInVault(cfg SetSecretsInVaultConfig) error

func (Service) UpdateLeaves

func (s Service) UpdateLeaves(cfg UpdateLeavesConfig) error

func (Service) Whoami

func (s Service) Whoami(cfg WhoamiConfig) error

type SetSecretsInVaultConfig

type SetSecretsInVaultConfig struct {
	Secrets []string
	Vault   string
	File    string
	Stdout  io.Writer
}

func (SetSecretsInVaultConfig) Validate

func (c SetSecretsInVaultConfig) Validate() error

type UpdateLeavesConfig

type UpdateLeavesConfig struct {
	DefaultDir               string
	Files                    []string
	ReplacementVersionPicker func(versions api.LeafVersionsResult, leaf string, major string) (string, error)
	Stdout                   io.Writer
	Stderr                   io.Writer
}

func (UpdateLeavesConfig) Validate

func (c UpdateLeavesConfig) Validate() error

type WhoamiConfig

type WhoamiConfig struct {
	Json   bool
	Stdout io.Writer
}

func (WhoamiConfig) Validate

func (c WhoamiConfig) Validate() error