config

Documentation

Index

• type Config
  • func ParseConfig() (*Config, error)
  • func (c *Config) GetKubeConfig() string
  • func (c *Config) GetSSHKeyPath() string
  • func (c *Config) IsKubernetes() bool
  • func (c *Config) ReadPublicSSHKey() (string, error)
  • func (c *Config) SetEnvVars() error
  • func (c *Config) SetKubeConfig()
  • func (c *Config) SetRandomRegion()
  • func (c *Config) SetSSHKeyPermissions() error

Types

type Config

type Config struct {
	SkipTest            bool          `envconfig:"SKIP_TEST" default:"false"`
	SkipLogsCollection  bool          `envconfig:"SKIP_LOGS_COLLECTION" default:"false"`
	Orchestrator        string        `envconfig:"ORCHESTRATOR" default:"kubernetes"`
	Name                string        `envconfig:"NAME"`                                                                  // Name allows you to set the name of a cluster already created
	Location            string        `envconfig:"LOCATION"`                                                              // Location where you want to create the cluster
	Regions             []string      `envconfig:"REGIONS"`                                                               // A whitelist of availableregions
	ClusterDefinition   string        `envconfig:"CLUSTER_DEFINITION" required:"true" default:"examples/kubernetes.json"` // ClusterDefinition is the path on disk to the json template these are normally located in examples/
	CleanUpOnExit       bool          `envconfig:"CLEANUP_ON_EXIT" default:"false"`                                       // if true the tests will clean up rgs when tests finish
	CleanUpIfFail       bool          `envconfig:"CLEANUP_IF_FAIL" default:"true"`
	RetainSSH           bool          `envconfig:"RETAIN_SSH" default:"true"`
	StabilityIterations int           `envconfig:"STABILITY_ITERATIONS"`
	Timeout             time.Duration `envconfig:"TIMEOUT" default:"10m"`
	CurrentWorkingDir   string
	SoakClusterName     string `envconfig:"SOAK_CLUSTER_NAME"`
	ForceDeploy         bool   `envconfig:"FORCE_DEPLOY"`
	UseDeployCommand    bool   `envconfig:"USE_DEPLOY_COMMAND"`
	GinkgoFocus         string `envconfig:"GINKGO_FOCUS"`
	GinkgoSkip          string `envconfig:"GINKGO_SKIP"`
}

Config holds global test configuration

func ParseConfig

func ParseConfig() (*Config, error)

ParseConfig will parse needed environment variables for running the tests

func (*Config) GetKubeConfig

func (c *Config) GetKubeConfig() string

GetKubeConfig returns the absolute path to the kubeconfig for c.Location

func (*Config) GetSSHKeyPath

func (c *Config) GetSSHKeyPath() string

GetSSHKeyPath will return the absolute path to the ssh private key

func (*Config) IsKubernetes

func (c *Config) IsKubernetes() bool

IsKubernetes will return true if the ORCHESTRATOR env var is set to kubernetes or not set at all

func (*Config) ReadPublicSSHKey

func (c *Config) ReadPublicSSHKey() (string, error)

ReadPublicSSHKey will read the contents of the public ssh key on disk into a string

func (*Config) SetEnvVars

func (c *Config) SetEnvVars() error

SetEnvVars will determine if we need to

func (*Config) SetKubeConfig

func (c *Config) SetKubeConfig()

SetKubeConfig will set the KUBECONIFG env var

func (*Config) SetRandomRegion

func (c *Config) SetRandomRegion()

SetRandomRegion sets Location to a random region

func (*Config) SetSSHKeyPermissions

func (c *Config) SetSSHKeyPermissions() error

SetSSHKeyPermissions will change the ssh file permission to 0600