puppeteer

Documentation

Index

• 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 Puppeteer
• type Suite

Variables

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

	// 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"`
	ShowConsoleLog bool
	DryRun         bool                   `yaml:"-" json:"-"`
	ConfigFilePath string                 `yaml:"-" json:"-"`
	CLIFlags       map[string]interface{} `yaml:"-" json:"-"`
	Sauce          config.SauceConfig     `yaml:"sauce,omitempty" json:"sauce"`
	// 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"`
	BeforeExec []string          `yaml:"beforeExec,omitempty" json:"beforeExec"`
	Docker     config.Docker     `yaml:"docker,omitempty" json:"docker"`
	Puppeteer  Puppeteer         `yaml:"puppeteer,omitempty" json:"puppeteer"`
	Npm        config.Npm        `yaml:"npm,omitempty" json:"npm"`
	RootDir    string            `yaml:"rootDir,omitempty" json:"rootDir"`
	Artifacts  config.Artifacts  `yaml:"artifacts,omitempty" json:"artifacts"`
	Reporters  config.Reporters  `yaml:"reporters,omitempty" json:"-"`
	Env        map[string]string `yaml:"env,omitempty" json:"env"`
}

Project represents the puppeteer project configuration.

func FromFile

func FromFile(cfgPath string) (Project, error)

FromFile creates a new puppeteer project based on the filepath.

type Puppeteer

type Puppeteer struct {
	// Version represents the puppeteer framework version.
	Version string `yaml:"version,omitempty" json:"version"`
}

Puppeteer represents the configuration for puppeteer.

type Suite

type Suite struct {
	Name        string            `yaml:"name,omitempty" json:"name"`
	Browser     string            `yaml:"browser,omitempty" json:"browser"`
	TestMatch   []string          `yaml:"testMatch,omitempty" json:"testMatch"`
	Env         map[string]string `yaml:"env,omitempty" json:"env"`
	BrowserArgs []string          `yaml:"browserArgs,omitempty" json:"browserArgs"`
	Timeout     time.Duration     `yaml:"timeout,omitempty" json:"timeout"`
}

Suite represents the puppeteer test suite configuration.