xcuitest

Documentation

Index

• Constants
• Variables
• func FilterSuites(p *Project, suiteName string) error
• func SetDefaults(p *Project)
• func Validate(p Project) error
• type Project
  • func FromFile(cfgPath string) (Project, error)
• type Suite
  • func SortByHistory(suites []Suite, history insights.JobHistory) []Suite
• type TestOptions
• type Xcuitest

Constants

const IOS = "iOS"

IOS constant

Variables

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

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

Config descriptors.

Functions

func FilterSuites

func FilterSuites(p *Project, suiteName string) error

FilterSuites filters out suites in the project that don't match the given suite name.

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" mapstructure:",squash"`
	Defaults       config.Defaults        `yaml:"defaults,omitempty" json:"defaults"`
	ConfigFilePath string                 `yaml:"-" json:"-"`
	ShowConsoleLog bool                   `yaml:"showConsoleLog" json:"-"`
	DryRun         bool                   `yaml:"-" json:"-"`
	CLIFlags       map[string]interface{} `yaml:"-" json:"-"`
	Sauce          config.SauceConfig     `yaml:"sauce,omitempty" json:"sauce"`
	Xcuitest       Xcuitest               `yaml:"xcuitest,omitempty" json:"xcuitest"`
	// Suite is only used as a workaround to parse adhoc suites that are created via CLI args.
	Suite         Suite                `yaml:"suite,omitempty" json:"-"`
	Suites        []Suite              `yaml:"suites,omitempty" json:"suites"`
	Artifacts     config.Artifacts     `yaml:"artifacts,omitempty" json:"artifacts"`
	Reporters     config.Reporters     `yaml:"reporters,omitempty" json:"-"`
	Notifications config.Notifications `yaml:"notifications,omitempty" json:"-"`
}

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"`
	TestApp            string             `yaml:"testApp,omitempty" json:"testApp"`
	TestAppDescription string             `yaml:"testAppDescription,omitempty" json:"testAppDescription"`
	Timeout            time.Duration      `yaml:"timeout,omitempty" json:"timeout"`
	Devices            []config.Device    `yaml:"devices,omitempty" json:"devices"`
	TestOptions        TestOptions        `yaml:"testOptions,omitempty" json:"testOptions"`
	AppSettings        config.AppSettings `yaml:"appSettings,omitempty" json:"appSettings"`
	PassThreshold      int                `yaml:"passThreshold,omitempty" json:"-"`
	SmartRetry         config.SmartRetry  `yaml:"smartRetry,omitempty" json:"-"`
}

Suite represents the xcuitest test suite configuration.

func SortByHistory

func SortByHistory(suites []Suite, history insights.JobHistory) []Suite

SortByHistory sorts the suites in the order of job history

type TestOptions

type TestOptions struct {
	NotClass []string `yaml:"notClass,omitempty" json:"notClass"`
	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"`
	AppDescription     string   `yaml:"appDescription,omitempty" json:"appDescription"`
	TestApp            string   `yaml:"testApp,omitempty" json:"testApp"`
	TestAppDescription string   `yaml:"testAppDescription,omitempty" json:"testAppDescription"`
	OtherApps          []string `yaml:"otherApps,omitempty" json:"otherApps"`
}

Xcuitest represents xcuitest apps configuration.