selector

Documentation

Overview

Package selector provides functionality for users to select an application, environment, or service name.

Package selector provides functionality for users to select an application, environment, or service name.

Index

• Constants
• Variables
• type AppEnvLister
• type ConfigLister
• type ConfigSelect
  • func NewConfigSelect(prompt Prompter, store ConfigLister) *ConfigSelect
  • func (s *ConfigSelect) Service(prompt, help, app string) (string, error)
• type ConfigWorkloadLister
• type CredsSelect
  • func (s *CredsSelect) Creds(prompt, help string) (*session.Session, error)
• type DeploySelect
  • func NewDeploySelect(prompt Prompter, configStore ConfigLister, deployStore DeployStoreClient) *DeploySelect
  • func (s *DeploySelect) DeployedService(prompt, help string, app string, opts ...GetDeployedServiceOpts) (*DeployedService, error)
• type DeployStoreClient
• type DeployedService
  • func (s *DeployedService) String() string
• type EC2Select
  • func NewEC2Select(prompt Prompter, ec2Client VPCSubnetLister) *EC2Select
  • func (s *EC2Select) PrivateSubnets(prompt, help, vpcID string) ([]string, error)
  • func (s *EC2Select) PublicSubnets(prompt, help, vpcID string) ([]string, error)
  • func (s *EC2Select) VPC(prompt, help string) (string, error)
• type GetDeployedServiceOpts
  • func WithEnv(env string) GetDeployedServiceOpts
  • func WithSvc(svc string) GetDeployedServiceOpts
• type Names
• type Prompter
• type Select
  • func NewSelect(prompt Prompter, store ConfigLister) *Select
  • func (s *Select) Application(prompt, help string, additionalOpts ...string) (string, error)
  • func (s *Select) Environment(prompt, help, app string, additionalOpts ...string) (string, error)
• type SessionProvider
• type VPCSubnetLister
• type WorkspaceRetriever
• type WorkspaceSelect
  • func NewWorkspaceSelect(prompt Prompter, store ConfigLister, ws WorkspaceRetriever) *WorkspaceSelect
  • func (s *WorkspaceSelect) Dockerfile(selPrompt, notFoundPrompt, selHelp, notFoundHelp string, ...) (string, error)
  • func (s *WorkspaceSelect) Job(msg, help string) (string, error)
  • func (s *WorkspaceSelect) Schedule(scheduleTypePrompt, scheduleTypeHelp string, ...) (string, error)
  • func (s *WorkspaceSelect) Service(msg, help string) (string, error)
  • func (s *WorkspaceSelect) Workload(msg, help string) (wl string, err error)
• type WsWorkloadLister

Constants

const (

	// DockerfilePromptUseImage is the option for using existing image instead of Dockerfile.
	DockerfilePromptUseImage = "Use an existing image instead"
)

Variables

var (
	// ErrVPCNotFound is returned when no existing VPCs are found.
	ErrVPCNotFound = errors.New("no existing VPCs found")
	// ErrSubnetsNotFound is returned when no existing subnets are found.
	ErrSubnetsNotFound = errors.New("no existing subnets found")
)

Types

type AppEnvLister

type AppEnvLister interface {
	ListEnvironments(appName string) ([]*config.Environment, error)
	ListApplications() ([]*config.Application, error)
}

AppEnvLister wraps methods to list apps and envs in config store.

type ConfigLister

type ConfigLister interface {
	AppEnvLister
	ConfigWorkloadLister
}

ConfigLister wraps config store listing methods.

type ConfigSelect

type ConfigSelect struct {
	*Select
	// contains filtered or unexported fields
}

ConfigSelect is an application and environment selector, but can also choose a service from the config store.

func NewConfigSelect

func NewConfigSelect(prompt Prompter, store ConfigLister) *ConfigSelect

NewConfigSelect returns a new selector that chooses applications, environments, or services from the config store.

func (*ConfigSelect) Service

func (s *ConfigSelect) Service(prompt, help, app string) (string, error)

Service fetches all services in an app and prompts the user to select one.

type ConfigWorkloadLister

type ConfigWorkloadLister interface {
	ListServices(appName string) ([]*config.Workload, error)
	ListJobs(appName string) ([]*config.Workload, error)
	ListWorkloads(appName string) ([]*config.Workload, error)
}

ConfigWorkloadLister wraps the method to list workloads in config store.

type CredsSelect

type CredsSelect struct {
	Prompt  Prompter
	Profile Names
	Session SessionProvider
}

CredsSelect prompts users for credentials.

func (*CredsSelect) Creds

func (s *CredsSelect) Creds(prompt, help string) (*session.Session, error)

Creds prompts users to choose either use temporary credentials or choose from one of their existing AWS named profiles.

type DeploySelect

type DeploySelect struct {
	*Select
	// contains filtered or unexported fields
}

DeploySelect is a service and environment selector from the deploy store.

func NewDeploySelect

func NewDeploySelect(prompt Prompter, configStore ConfigLister, deployStore DeployStoreClient) *DeploySelect

NewDeploySelect returns a new selector that chooses services and environments from the deploy store.

func (*DeploySelect) DeployedService

func (s *DeploySelect) DeployedService(prompt, help string, app string, opts ...GetDeployedServiceOpts) (*DeployedService, error)

DeployedService has the user select a deployed service. Callers can provide either a particular environment, a particular service to filter on, or both.

type DeployStoreClient

type DeployStoreClient interface {
	ListDeployedServices(appName string, envName string) ([]string, error)
	IsServiceDeployed(appName string, envName string, svcName string) (bool, error)
}

DeployStoreClient wraps methods of deploy store.

type DeployedService

type DeployedService struct {
	Svc string
	Env string
}

DeployedService contains the service name and environment name of the deployed service.

func (*DeployedService) String

func (s *DeployedService) String() string

type EC2Select

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

EC2Select is a selector for Ec2 resources.

func NewEC2Select

func NewEC2Select(prompt Prompter, ec2Client VPCSubnetLister) *EC2Select

NewEC2Select returns a new selector that chooses Ec2 resources.

func (*EC2Select) PrivateSubnets

func (s *EC2Select) PrivateSubnets(prompt, help, vpcID string) ([]string, error)

PrivateSubnets has the user multiselect private subnets given the VPC ID.

func (*EC2Select) PublicSubnets

func (s *EC2Select) PublicSubnets(prompt, help, vpcID string) ([]string, error)

PublicSubnets has the user multiselect public subnets given the VPC ID.

func (*EC2Select) VPC

func (s *EC2Select) VPC(prompt, help string) (string, error)

VPC has the user select an available VPC.

type GetDeployedServiceOpts

type GetDeployedServiceOpts func(*DeploySelect)

GetDeployedServiceOpts sets up optional parameters for GetDeployedServiceOpts function.

func WithEnv

func WithEnv(env string) GetDeployedServiceOpts

WithEnv sets up the env name for DeploySelect.

func WithSvc

func WithSvc(svc string) GetDeployedServiceOpts

WithSvc sets up the svc name for DeploySelect.

type Names

type Names interface {
	Names() []string
}

Names wraps the method that returns a list of names.

type Prompter

type Prompter interface {
	Get(message, help string, validator prompt.ValidatorFunc, promptOpts ...prompt.Option) (string, error)
	SelectOne(message, help string, options []string, promptOpts ...prompt.Option) (string, error)
	MultiSelect(message, help string, options []string, promptOpts ...prompt.Option) ([]string, error)
	Confirm(message, help string, promptOpts ...prompt.Option) (bool, error)
}

Prompter wraps the methods to ask for inputs from the terminal.

type Select

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

Select prompts users to select the name of an application or environment.

func NewSelect

func NewSelect(prompt Prompter, store ConfigLister) *Select

NewSelect returns a selector that chooses applications or environments.

func (*Select) Application

func (s *Select) Application(prompt, help string, additionalOpts ...string) (string, error)

Application fetches all the apps in an account/region and prompts the user to select one.

func (*Select) Environment

func (s *Select) Environment(prompt, help, app string, additionalOpts ...string) (string, error)

Environment fetches all the environments in an app and prompts the user to select one.

type SessionProvider

type SessionProvider interface {
	Default() (*session.Session, error)
	FromProfile(name string) (*session.Session, error)
	FromStaticCreds(accessKeyID, secretAccessKey, sessionToken string) (*session.Session, error)
}

SessionProvider wraps the methods to create AWS sessions.

type VPCSubnetLister

type VPCSubnetLister interface {
	ListVPCs() ([]ec2.VPC, error)
	ListVPCSubnets(vpcID string, opts ...ec2.ListVPCSubnetsOpts) ([]string, error)
}

VPCSubnetLister list VPCs and subnets.

type WorkspaceRetriever

type WorkspaceRetriever interface {
	WsWorkloadLister
	Summary() (*workspace.Summary, error)
	ListDockerfiles() ([]string, error)
}

WorkspaceRetriever wraps methods to get workload names, app names, and Dockerfiles from the workspace.

type WorkspaceSelect

type WorkspaceSelect struct {
	*Select
	// contains filtered or unexported fields
}

WorkspaceSelect is an application and environment selector, but can also choose a service from the workspace.

func NewWorkspaceSelect

func NewWorkspaceSelect(prompt Prompter, store ConfigLister, ws WorkspaceRetriever) *WorkspaceSelect

NewWorkspaceSelect returns a new selector that chooses applications and environments from the config store, but services from the local workspace.

func (*WorkspaceSelect) Dockerfile

func (s *WorkspaceSelect) Dockerfile(selPrompt, notFoundPrompt, selHelp, notFoundHelp string, pathValidator prompt.ValidatorFunc) (string, error)

Dockerfile asks the user to select from a list of Dockerfiles in the current directory or one level down. If no dockerfiles are found, it asks for a custom path.

func (*WorkspaceSelect) Job

func (s *WorkspaceSelect) Job(msg, help string) (string, error)

Job fetches all jobs in the workspace and then prompts the user to select one.

func (*WorkspaceSelect) Schedule

func (s *WorkspaceSelect) Schedule(scheduleTypePrompt, scheduleTypeHelp string, scheduleValidator, rateValidator prompt.ValidatorFunc) (string, error)

Schedule asks the user to select either a rate, preset cron, or custom cron.

func (*WorkspaceSelect) Service

func (s *WorkspaceSelect) Service(msg, help string) (string, error)

Service fetches all services in the workspace and then prompts the user to select one.

func (*WorkspaceSelect) Workload

func (s *WorkspaceSelect) Workload(msg, help string) (wl string, err error)

Workload fetches all jobs and services in an app and prompts the user to select one.

type WsWorkloadLister

type WsWorkloadLister interface {
	ServiceNames() ([]string, error)
	JobNames() ([]string, error)
	WorkloadNames() ([]string, error)
}

WsWorkloadLister wraps the method to get workloads in current workspace.