genericclioptions

Documentation

Index

• Constants
• func AddContextFlag(cmd *cobra.Command, setValueTo *string)
• func AddNowFlag(cmd *cobra.Command, setValueTo *bool)
• func ApplyIgnore(ignores *[]string, sourcePath string) (err error)
• func CheckMachineReadableOutputCommand(cmd *cobra.Command)
• func Client(command *cobra.Command) *occlient.Client
• func ClientWithConnectionCheck(command *cobra.Command, skipConnectionCheck bool) *occlient.Client
• func FlagValueIfSet(cmd *cobra.Command, flagName string) string
• func GenericRun(o Runnable, cmd *cobra.Command, args []string)
• type Context
  • func NewConfigContext(command *cobra.Command) *Context
  • func NewContext(command *cobra.Command, ignoreMissingConfiguration ...bool) *Context
  • func NewContextCompletion(command *cobra.Command) *Context
  • func NewContextCreatingAppIfNeeded(command *cobra.Command) *Context
  • func NewDevfileContext(command *cobra.Command, ignoreMissingConfiguration ...bool) *Context
  • func NewFakeContext(project, application, component string, client *occlient.Client) *Context
  • func UpdatedContext(context *Context) (*Context, *config.LocalConfigInfo, error)
  • func (o *Context) Component(optionalComponent ...string) string
  • func (o *Context) ComponentAllowingEmpty(allowEmpty bool, optionalComponent ...string) string
• type Runnable

Constants

const (
	// ProjectFlagName is the name of the flag allowing a user to specify which project to operate on
	ProjectFlagName = "project"
	// ApplicationFlagName is the name of the flag allowing a user to specify which application to operate on
	ApplicationFlagName = "app"
	// ComponentFlagName is the name of the flag allowing a user to specify which component to operate on
	ComponentFlagName = "component"
	// OutputFlag is the name of the flag allowing use to specify output format
	OutputFlagName = "output"
	// ContextFlagName is the name of the flag allowing a user to specify the location of the component settings
	ContextFlagName = "context"
)

const DefaultAppName = "app"

DefaultAppName is the default name of the application when an application name is not provided

Functions

func AddContextFlag

func AddContextFlag(cmd *cobra.Command, setValueTo *string)

AddContextFlag adds `context` flag to given cobra command

func AddNowFlag

func AddNowFlag(cmd *cobra.Command, setValueTo *bool)

AddNowFlag adds `now` flag to given cobra command

func ApplyIgnore

func ApplyIgnore(ignores *[]string, sourcePath string) (err error)

ApplyIgnore will take the current ignores []string and either ignore it (if .odoignore is used) or find the .gitignore file in the directory and use that instead.

func CheckMachineReadableOutputCommand

func CheckMachineReadableOutputCommand(cmd *cobra.Command)

CheckMachineReadableOutputCommand performs machine-readable output functions required to have it work correctly

func Client

func Client(command *cobra.Command) *occlient.Client

Client returns an oc client configured for this command's options

func ClientWithConnectionCheck

func ClientWithConnectionCheck(command *cobra.Command, skipConnectionCheck bool) *occlient.Client

ClientWithConnectionCheck returns an oc client configured for this command's options but forcing the connection check status to the value of the provided bool, skipping it if true, checking the connection otherwise

func FlagValueIfSet

func FlagValueIfSet(cmd *cobra.Command, flagName string) string

FlagValueIfSet retrieves the value of the specified flag if it is set for the given command

func GenericRun

func GenericRun(o Runnable, cmd *cobra.Command, args []string)

Types

type Context

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

Context holds contextual information useful to commands such as correctly configured client, target project and application (based on specified flag values) and provides for a way to retrieve a given component given this context

func NewConfigContext

func NewConfigContext(command *cobra.Command) *Context

NewConfigContext is a special kind of context which only contains local configuration, other information is not retrived

from the cluster. This is useful for commands which don't want to connect to cluster.

func NewContext

func NewContext(command *cobra.Command, ignoreMissingConfiguration ...bool) *Context

NewContext creates a new Context struct populated with the current state based on flags specified for the provided command

func NewContextCompletion

func NewContextCompletion(command *cobra.Command) *Context

NewContextCompletion disables checking for a local configuration since when we use autocompletion on the command line, we couldn't care less if there was a configuriation. We only need to check the parameters.

func NewContextCreatingAppIfNeeded

func NewContextCreatingAppIfNeeded(command *cobra.Command) *Context

NewContextCreatingAppIfNeeded creates a new Context struct populated with the current state based on flags specified for the provided command, creating the application if none already exists

func NewDevfileContext

func NewDevfileContext(command *cobra.Command, ignoreMissingConfiguration ...bool) *Context

NewDevfileContext creates a new Context struct populated with the current state based on flags specified for the provided command

func NewFakeContext

func NewFakeContext(project, application, component string, client *occlient.Client) *Context

func UpdatedContext

func UpdatedContext(context *Context) (*Context, *config.LocalConfigInfo, error)

UpdatedContext returns a new context updated from config file

func (*Context) Component

func (o *Context) Component(optionalComponent ...string) string

Component retrieves the optionally specified component or the current one if it is set. If no component is set, exit with an error

func (*Context) ComponentAllowingEmpty

func (o *Context) ComponentAllowingEmpty(allowEmpty bool, optionalComponent ...string) string

ComponentAllowingEmpty retrieves the optionally specified component or the current one if it is set, allowing empty components (instead of exiting with an error) if so specified

type Runnable

type Runnable interface {
	Complete(name string, cmd *cobra.Command, args []string) error
	Validate() error
	Run() error
}