puppeteer

package
v0.120.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 26, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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

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

Config descriptors.

Functions

func FilterSuites added in v0.52.0

func FilterSuites(p *Project, suiteName string) error

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

func SetDefaults added in v0.52.0

func SetDefaults(p *Project)

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

func Validate added in v0.52.0

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                   `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"`
	// 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"`
	Notifications config.Notifications `yaml:"notifications,omitempty" json:"-"`
}

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"`
	Groups      []string          `yaml:"groups,omitempty" json:"groups"`
}

Suite represents the puppeteer test suite configuration.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL