config

Documentation

Index

• type ImageDefinition
• type Metadata
  • func (m *Metadata) ExpandEnv()
• type Project
  • func NewJobConfiguration(cfgFilePath string) (Project, error)
  • func (p *Project) SyncCapabilities()
• type Run
• type RunnerConfiguration
  • func NewRunnerConfiguration(cfgFilePath string) (RunnerConfiguration, error)
• type SauceConfig
• type Settings
• type Suite
• type Timeouts

Examples

• Metadata.ExpandEnv

Types

type ImageDefinition

type ImageDefinition struct {
	Base    string                 `yaml:"base"`
	Version string                 `yaml:"version"`
	Exec    string                 `yaml:"exec"`
	Options map[string]interface{} `yaml:"options"`
}

ImageDefinition describe configuration to the testrunner image

type Metadata

type Metadata struct {
	Name  string   `yaml:"name"`
	Tags  []string `yaml:"tags"`
	Build string   `yaml:"build"`
}

Metadata describes job metadata

func (*Metadata) ExpandEnv

func (m *Metadata) ExpandEnv()

ExpandEnv expands environment variables inside metadata fields.

Example

os.Setenv("tname", "Envy")
os.Setenv("ttag", "xp1")
os.Setenv("tbuild", "Bob")

m := Metadata{
	Name:  "Test $tname",
	Tags:  []string{"$ttag"},
	Build: "Build $tbuild",
}

m.ExpandEnv()

fmt.Println(m)

Output:

{Test Envy [xp1] Build Bob}

type Project

type Project struct {
	APIVersion string            `yaml:"apiVersion"`
	Kind       string            `yaml:"kind"`
	Metadata   Metadata          `yaml:"metadata"`
	Suites     []Suite           `yaml:"suites"`
	Files      []string          `yaml:"files"`
	Image      ImageDefinition   `yaml:"image"`
	BeforeExec []string          `yaml:"beforeExec"`
	Timeout    int               `yaml:"timeout"`
	Sauce      SauceConfig       `yaml:"sauce"`
	Env        map[string]string `yaml:"env"`
	Parallel   bool              `yaml:"parallel"`
}

Project represents the project configuration.

func NewJobConfiguration

func NewJobConfiguration(cfgFilePath string) (Project, error)

NewJobConfiguration creates a new job configuration based on a config file

func (*Project) SyncCapabilities

func (p *Project) SyncCapabilities()

SyncCapabilities uses the project capabilities if no settings have been defined in the suites.

type Run

type Run struct {
	Match       []string `yaml:"match"`
	ProjectPath string   `yaml:"projectPath"`
}

Run represents the configuration for a particular test run. This information is communicated to the test framework.

type RunnerConfiguration

type RunnerConfiguration struct {
	RootDir     string   `yaml:"rootDir"`
	TargetDir   string   `yaml:"targetDir"`
	ExecCommand []string `yaml:"execCommand"`
}

RunnerConfiguration describes configurations for the testrunner

func NewRunnerConfiguration

func NewRunnerConfiguration(cfgFilePath string) (RunnerConfiguration, error)

NewRunnerConfiguration reads yaml file for runner configurations

type SauceConfig

type SauceConfig struct {
	Region string `yaml:"region"`
}

SauceConfig represents sauce labs related settings.

type Settings

type Settings struct {
	BrowserName               string   `yaml:"browserName"`
	BrowserVersion            string   `yaml:"browserVersion"`
	PlatformName              string   `yaml:"platformName"`
	AcceptInsecureCerts       bool     `yaml:"acceptInsecureCerts"`
	PageLoadStrategy          bool     `yaml:"pageLoadStrategy"`
	SetWindowRect             bool     `yaml:"setWindowRect"`
	Timeouts                  Timeouts `yaml:"timeouts"`
	StrictFileInteractability bool     `yaml:"strictFileInteractability"`
	UnhandledPromptBehavior   string   `yaml:"unhandledPromptBehavior"`
}

Settings describes job settings

type Suite

type Suite struct {
	Name         string   `yaml:"name"`
	Capabilities Settings `yaml:"capabilities"`
	Settings     Settings `yaml:"settings"`
	Match        string   `yaml:"match"`
}

Suite represents the test suite configuration.

type Timeouts

type Timeouts struct {
	Script   int `yaml:"script"`
	PageLoad int `yaml:"pageLoad"`
	Implicit int `yaml:"implicit"`
}

Timeouts describes WebDriver timeouts