espresso

Documentation

Index

• Constants
• Variables
• func FilterSuites(p *Project, suiteName string) error
• func GetShardTypes(suites []Suite) []string
• func SetDefaults(p *Project)
• func Validate(p Project) error
• type Espresso
• type Project
  • func FromFile(cfgPath string) (Project, error)
  • func (p *Project) IsSmartRetried() bool
• type ShardConfig
• type Suite
  • func SortByHistory(suites []Suite, history insights.JobHistory) []Suite
  • func (s *Suite) ShardConfig() ShardConfig

Constants

const Android = "Android"

Android constant

Variables

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

	// 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 GetShardTypes

func GetShardTypes(suites []Suite) []string

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 Espresso

type Espresso 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"`
}

Espresso represents espresso apps configuration.

type Project

type Project struct {
	config.TypeDef `yaml:",inline" mapstructure:",squash"`
	Defaults       config.Defaults        `yaml:"defaults" json:"defaults"`
	ShowConsoleLog bool                   `yaml:"showConsoleLog" json:"-"`
	DryRun         bool                   `yaml:"-" json:"-"`
	ConfigFilePath string                 `yaml:"-" json:"-"`
	CLIFlags       map[string]interface{} `yaml:"-" json:"-"`
	Sauce          config.SauceConfig     `yaml:"sauce,omitempty" json:"sauce"`
	Espresso       Espresso               `yaml:"espresso,omitempty" json:"espresso"`
	// 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:"-"`
}

Project represents the espresso project configuration.

func FromFile

func FromFile(cfgPath string) (Project, error)

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

func (*Project) IsSmartRetried

func (p *Project) IsSmartRetried() bool

IsSmartRetried checks if the suites contain a smartRetried suite

type ShardConfig

type ShardConfig struct {
	Shards int
	Index  int
}

ShardConfig represents the configuration for sharding. The config values come from Suite.TestOptions.

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"`
	Devices            []config.Device        `yaml:"devices,omitempty" json:"devices"`
	Emulators          []config.Emulator      `yaml:"emulators,omitempty" json:"emulators"`
	TestOptions        map[string]interface{} `yaml:"testOptions,omitempty" json:"testOptions"`
	Timeout            time.Duration          `yaml:"timeout,omitempty" json:"timeout"`
	AppSettings        config.AppSettings     `yaml:"appSettings,omitempty" json:"appSettings"`
	PassThreshold      int                    `yaml:"passThreshold,omitempty" json:"-"`
	SmartRetry         config.SmartRetry      `yaml:"smartRetry,omitempty" json:"-"`
}

Suite represents the espresso test suite configuration.

func SortByHistory

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

SortByHistory sorts the suites in the order of job history

func (*Suite) ShardConfig

func (s *Suite) ShardConfig() ShardConfig