replay

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 Suite
  • func ShardSuites(suites []Suite) ([]Suite, error)

Variables

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

	// 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"`
	ConfigFilePath string             `yaml:"-" json:"-"`
	DryRun         bool               `yaml:"-" json:"-"`
	ShowConsoleLog bool               `yaml:"showConsoleLog" json:"-"`
	Defaults       config.Defaults    `yaml:"defaults,omitempty" json:"defaults"`
	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"`
	Artifacts     config.Artifacts     `yaml:"artifacts,omitempty" json:"artifacts"`
	Reporters     config.Reporters     `yaml:"reporters,omitempty" json:"-"`
	Notifications config.Notifications `yaml:"notifications,omitempty" json:"-"`
	RunnerVersion string               `yaml:"runnerVersion,omitempty" json:"runnerVersion"`
}

Project represents the replay project configuration.

func FromFile

func FromFile(cfgPath string) (Project, error)

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

type Suite

type Suite struct {
	Name           string        `yaml:"name,omitempty" json:"name"`
	Timeout        time.Duration `yaml:"timeout,omitempty" json:"timeout"`
	Recording      string        `yaml:"recording,omitempty" json:"recording,omitempty"`
	BrowserName    string        `yaml:"browserName,omitempty" json:"browserName,omitempty"`
	BrowserVersion string        `yaml:"browserVersion,omitempty" json:"browserVersion,omitempty"`
	Platform       string        `yaml:"platform,omitempty" json:"platform,omitempty"`

	Recordings []string `yaml:"recordings,omitempty" json:"-"`
}

Suite represents the playwright test suite configuration.

func ShardSuites

func ShardSuites(suites []Suite) ([]Suite, error)

ShardSuites automatically shards the suites for each recording.