config

Documentation

Index

• Constants
• func StandardizeVersionFormat(version string) string
• type ArtifactDownload
• type Artifacts
• type Defaults
• type Device
• type DeviceOptions
• type Docker
• type DockerFileMode
• type Emulator
• type Metadata
  • func (m *Metadata) ExpandEnv()
• type Npm
• type SauceConfig
• type Tunnel
• type TypeDef
  • func Describe(cfgPath string) (TypeDef, error)

Examples

• Metadata.ExpandEnv

Constants

const (
	WhenFail   when = "fail"
	WhenPass   when = "pass"
	WhenNever  when = "never"
	WhenAlways when = "always"
)

These conditions indicate when artifacts are to be downloaded.

const (
	KindCypress    = "cypress"
	KindPuppeteer  = "puppeteer"
	KindPlaywright = "playwright"
	KindTestcafe   = "testcafe"
	KindEspresso   = "espresso"
	KindXcuitest   = "xcuitest"
)

Kind* contains referenced config kinds

const (
	VersionV1Alpha = "v1alpha"
)

Version* contains referenced config version

Functions

func StandardizeVersionFormat

func StandardizeVersionFormat(version string) string

StandardizeVersionFormat remove the leading v in version to ensure reliable comparisons.

Types

type ArtifactDownload

type ArtifactDownload struct {
	Match     []string `yaml:"match,omitempty" json:"match"`
	When      when     `yaml:"when,omitempty" json:"when"`
	Directory string   `yaml:"directory,omitempty" json:"directory"`
}

ArtifactDownload represents the test artifacts configuration.

type Artifacts

type Artifacts struct {
	Download ArtifactDownload `yaml:"download,omitempty" json:"download"`
}

Artifacts represents the test artifacts configuration.

type Defaults

type Defaults struct {
	Mode string `yaml:"mode,omitempty" json:"mode"`
}

Defaults represents default suite settings.

type Device

type Device struct {
	ID              string        `yaml:"id,omitempty" json:"id"`
	Name            string        `yaml:"name,omitempty" json:"name"`
	PlatformName    string        `yaml:"platformName,omitempty" json:"platformName"`
	PlatformVersion string        `yaml:"platformVersion,omitempty" json:"platformVersion"`
	Options         DeviceOptions `yaml:"options,omitempty" json:"options,omitempty"`
}

Device represents the RDC device configuration.

type DeviceOptions

type DeviceOptions struct {
	CarrierConnectivity bool   `yaml:"carrierConnectivity,omitempty" json:"carrierConnectivity"`
	DeviceType          string `yaml:"deviceType,omitempty" json:"deviceType,omitempty"`
	Private             bool   `yaml:"private,omitempty" json:"private,omitempty"`
}

DeviceOptions represents the devices capabilities required from a real device.

type Docker

type Docker struct {
	FileTransfer DockerFileMode `yaml:"fileTransfer,omitempty" json:"fileTransfer"`
	Image        string         `yaml:"image,omitempty" json:"image"`
}

Docker represents docker settings.

type DockerFileMode

type DockerFileMode string

DockerFileMode represent the file providing method

const (
	DockerFileMount DockerFileMode = "mount"
	DockerFileCopy  DockerFileMode = "copy"
)

DockerFile* represent the different modes

type Emulator

type Emulator struct {
	Name             string   `yaml:"name,omitempty" json:"name,omitempty"`
	PlatformName     string   `yaml:"platformName,omitempty" json:"platformName"`
	Orientation      string   `yaml:"orientation,omitempty" json:"orientation,omitempty"`
	PlatformVersions []string `yaml:"platformVersions,omitempty" json:"platformVersions,omitempty"`
}

Emulator represents the emulator configuration.

type Metadata

type Metadata struct {
	Name  string   `yaml:"name" json:"name"`
	Tags  []string `yaml:"tags" json:"tags,omitempty"`
	Build string   `yaml:"build" json:"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 Npm

type Npm struct {
	Registry  string            `yaml:"registry,omitempty" json:"registry,omitempty"`
	Packages  map[string]string `yaml:"packages,omitempty" json:"packages"`
	StrictSSL *bool             `yaml:"strictSSL,omitempty" json:"strictSSL"`
}

Npm represents the npm settings

type SauceConfig

type SauceConfig struct {
	Region      string            `yaml:"region,omitempty" json:"region"`
	Metadata    Metadata          `yaml:"metadata,omitempty" json:"metadata"`
	Tunnel      Tunnel            `yaml:"tunnel,omitempty" json:"tunnel,omitempty"`
	Concurrency int               `yaml:"concurrency,omitempty" json:"concurrency,omitempty"`
	Sauceignore string            `yaml:"sauceignore,omitempty" json:"sauceignore,omitempty"`
	Experiments map[string]string `yaml:"experiments,omitempty" json:"experiments,omitempty"`
}

SauceConfig represents sauce labs related settings.

type Tunnel

type Tunnel struct {
	ID     string `yaml:"id,omitempty" json:"id"`
	Parent string `yaml:"parent,omitempty" json:"parent,omitempty"`
}

Tunnel represents a sauce labs tunnel.

type TypeDef

type TypeDef struct {
	APIVersion string `yaml:"apiVersion,omitempty"`
	Kind       string `yaml:"kind,omitempty"`
}

TypeDef represents the type definition of the config.

func Describe

func Describe(cfgPath string) (TypeDef, error)

Describe returns a description of the given config that is cfgPath.