xcuitest

Documentation

Index

• Variables
• func SetDefaults(p *Project)
• func Validate(p Project) error
• type Project
  • func FromFile(cfgPath string) (Project, error)
• type Suite
• type TestOptions
• type Xcuitest

Variables

var (
	// Kind represents the type definition of this config.
	Kind = "xcuitest"

	// APIVersion represents the supported config version.
	APIVersion = "v1alpha"
)

Config descriptors.

Functions

func SetDefaults

func SetDefaults(p *Project)

SetDefaults applies config defaults in case the user has left them blank.

func Validate

func Validate(p Project) error

Validate validates basic configuration of the project and returns an error if any of the settings contain illegal values. This is not an exhaustive operation and further validation should be performed both in the client and/or server side depending on the workflow that is executed.

Types

type Project

type Project struct {
	config.TypeDef `yaml:",inline"`
	ConfigFilePath string             `yaml:"-" json:"-"`
	DryRun         bool               `yaml:"-" json:"-"`
	Sauce          config.SauceConfig `yaml:"sauce,omitempty" json:"sauce"`
	Xcuitest       Xcuitest           `yaml:"xcuitest,omitempty" json:"xcuitest"`
	Suites         []Suite            `yaml:"suites,omitempty" json:"suites"`
	Artifacts      config.Artifacts   `yaml:"artifacts,omitempty" json:"artifacts"`
}

Project represents the xcuitest project configuration.

func FromFile

func FromFile(cfgPath string) (Project, error)

FromFile creates a new xcuitest Project based on the filepath cfgPath.

type Suite

type Suite struct {
	Name        string          `yaml:"name,omitempty" json:"name"`
	Devices     []config.Device `yaml:"devices,omitempty" json:"devices"`
	TestOptions TestOptions     `yaml:"testOptions,omitempty" json:"testOptions"`
}

Suite represents the xcuitest test suite configuration.

type TestOptions

type TestOptions struct {
	Class []string `yaml:"class,omitempty" json:"class"`
}

TestOptions represents the xcuitest test filter options configuration.

type Xcuitest

type Xcuitest struct {
	App     string `yaml:"app,omitempty" json:"app"`
	TestApp string `yaml:"testApp,omitempty" json:"testApp"`
}

Xcuitest represents xcuitest apps configuration.