cli

Documentation

Index

• Variables
• func AGPL() []*cobra.Command
• func Core() []*cobra.Command
• func CreateClient(cmd *cobra.Command) (*codersdk.Client, error)
• func CurrentOrganization(cmd *cobra.Command, client *codersdk.Client) (codersdk.Organization, error)
• func EnsureExperimental(cmd *cobra.Command, name string) error
• func ExperimentalEnabled(cmd *cobra.Command) bool
• func FormatCobraError(err error, cmd *cobra.Command) string
• func Root(subcommands []*cobra.Command) *cobra.Command
• func Server(vip *viper.Viper, ...) *cobra.Command
• type LoadTest
  • func (t LoadTest) NewRunner(client *codersdk.Client) (harness.Runnable, error)
  • func (t *LoadTest) Validate() error
• type LoadTestConfig
  • func (c *LoadTestConfig) Validate() error
• type LoadTestStrategy
  • func (s LoadTestStrategy) ExecutionStrategy() harness.ExecutionStrategy
  • func (s *LoadTestStrategy) Validate() error
• type LoadTestStrategyType
• type LoadTestType

Variables

var (
	Caret = cliui.Styles.Prompt.String()
)

Functions

func AGPL

func AGPL() []*cobra.Command

func Core

func Core() []*cobra.Command

func CreateClient

func CreateClient(cmd *cobra.Command) (*codersdk.Client, error)

CreateClient returns a new client from the command context. It reads from global configuration files if flags are not set.

func CurrentOrganization

func CurrentOrganization(cmd *cobra.Command, client *codersdk.Client) (codersdk.Organization, error)

CurrentOrganization returns the currently active organization for the authenticated user.

func EnsureExperimental

func EnsureExperimental(cmd *cobra.Command, name string) error

EnsureExperimental will ensure that the experimental feature flag is set if the given flag is set.

func ExperimentalEnabled

func ExperimentalEnabled(cmd *cobra.Command) bool

ExperimentalEnabled returns if the experimental feature flag is enabled.

func FormatCobraError

func FormatCobraError(err error, cmd *cobra.Command) string

FormatCobraError colorizes and adds "--help" docs to cobra commands.

func Root

func Root(subcommands []*cobra.Command) *cobra.Command

func Server

func Server(vip *viper.Viper, newAPI func(context.Context, *coderd.Options) (*coderd.API, io.Closer, error)) *cobra.Command

nolint:gocyclo

Types

type LoadTest

type LoadTest struct {
	// Type is the type of load test to run.
	Type LoadTestType `json:"type"`
	// Count is the number of test runs to execute with this configuration. If
	// the count is 0 or negative, defaults to 1.
	Count int `json:"count"`

	// Placebo must be set if type == "placebo".
	Placebo *placebo.Config `json:"placebo,omitempty"`
	// WorkspaceBuild must be set if type == "workspacebuild".
	WorkspaceBuild *workspacebuild.Config `json:"workspacebuild,omitempty"`
}

func (LoadTest) NewRunner

func (t LoadTest) NewRunner(client *codersdk.Client) (harness.Runnable, error)

func (*LoadTest) Validate

func (t *LoadTest) Validate() error

type LoadTestConfig

type LoadTestConfig struct {
	Strategy LoadTestStrategy `json:"strategy"`
	Tests    []LoadTest       `json:"tests"`
	// Timeout sets a timeout for the entire test run, to control the timeout
	// for each individual run use strategy.timeout.
	Timeout httpapi.Duration `json:"timeout"`
}

LoadTestConfig is the overall configuration for a call to `coder loadtest`.

func (*LoadTestConfig) Validate

func (c *LoadTestConfig) Validate() error

type LoadTestStrategy

type LoadTestStrategy struct {
	// Type is the type of load test strategy to use. Strategies determine how
	// to run tests concurrently.
	Type LoadTestStrategyType `json:"type"`

	// ConcurrencyLimit is the maximum number of concurrent runs. This only
	// applies if type == "concurrent". Negative values disable the concurrency
	// limit and attempts to perform all runs concurrently. The default value is
	// 100.
	ConcurrencyLimit int `json:"concurrency_limit"`

	// Shuffle determines whether or not to shuffle the test runs before
	// executing them.
	Shuffle bool `json:"shuffle"`
	// Timeout is the maximum amount of time to run each test for. This is
	// independent of the timeout specified in the test run. A timeout of 0
	// disables the timeout.
	Timeout httpapi.Duration `json:"timeout"`
}

func (LoadTestStrategy) ExecutionStrategy

func (s LoadTestStrategy) ExecutionStrategy() harness.ExecutionStrategy

func (*LoadTestStrategy) Validate

func (s *LoadTestStrategy) Validate() error

type LoadTestStrategyType

type LoadTestStrategyType string

const (
	LoadTestStrategyTypeLinear     LoadTestStrategyType = "linear"
	LoadTestStrategyTypeConcurrent LoadTestStrategyType = "concurrent"
)

type LoadTestType

type LoadTestType string

const (
	LoadTestTypePlacebo        LoadTestType = "placebo"
	LoadTestTypeWorkspaceBuild LoadTestType = "workspacebuild"
)