selector

Documentation

Overview

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

Index

• type AppEnvLister
• type ConfigLister
• type ConfigSelect
  • func NewConfigSelect(prompt Prompter, store ConfigLister) *ConfigSelect
  • func (s *ConfigSelect) Service(prompt, help, app string) (string, error)
• type ConfigSvcLister
• type DeploySelect
  • func NewDeploySelect(prompt Prompter, configStore AppEnvLister, 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 GetDeployedServiceOpts
  • func WithEnv(env string) GetDeployedServiceOpts
  • func WithSvc(svc string) GetDeployedServiceOpts
• type Prompter
• type Select
  • func NewSelect(prompt Prompter, store AppEnvLister) *Select
  • func (s *Select) Application(prompt, help string) (string, error)
  • func (s *Select) Environment(prompt, help, app string) (string, error)
  • func (s *Select) EnvironmentWithNone(prompt, help, app string) (string, error)
• type WorkspaceSelect
  • func NewWorkspaceSelect(prompt Prompter, store AppEnvLister, ws WsSvcLister) *WorkspaceSelect
  • func (s *WorkspaceSelect) Service(prompt, help string) (string, error)
• type WsSvcLister

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
	ConfigSvcLister
}

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 ConfigSvcLister

type ConfigSvcLister interface {
	ListServices(appName string) ([]*config.Service, error)
}

ConfigSvcLister wraps the method to list svcs in config store.

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 AppEnvLister, 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 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 Prompter

type Prompter interface {
	SelectOne(message, help string, options []string, promptOpts ...prompt.Option) (string, error)
}

Prompter wraps the method to select an option from a list of options.

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 AppEnvLister) *Select

NewSelect returns a selector that chooses applications or environments.

func (*Select) Application

func (s *Select) Application(prompt, help 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) (string, error)

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

func (*Select) EnvironmentWithNone

func (s *Select) EnvironmentWithNone(prompt, help, app string) (string, error)

EnvironmentWithNone fetches all the environments in an app and prompts the user to select one of the environments or None.

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 AppEnvLister, ws WsSvcLister) *WorkspaceSelect

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

func (*WorkspaceSelect) Service

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

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

type WsSvcLister

type WsSvcLister interface {
	ServiceNames() ([]string, error)
}

WsSvcLister wraps the method to get svcs in current workspace.