chromatic

package

v0.0.0-...-88ee3f8 Latest Latest Go to latest Published: May 15, 2021 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	ErrorTimeoutExceeded = errors.New("timeout exceeded")
)

func Match(actual Page, targetTitle string, targetURL string, targetCookie cookieConfig) bool

func Report(result Page) (string, error)

func Run(filename string) error

func RunWithConfig(config *Config) error

type Browser struct {
	// contains filtered or unexported fields
}

Browser represents a single Chrome instance that can be started, stopped, and waited on.

func NewBrowser(ctx context.Context, url string, args ...string) (*Browser, error)

NewBrowser creates a Browser object that can start Chrome with optional args, and will initially load the given url.

func (b *Browser) Address() string

Address returns the Chrome Debugging Protocol address.

func (b *Browser) Start() error

Start creates a Chrome process, and will make a browser window appear.

func (b *Browser) Stop() error

Stop terminates the Chrome process.

func (b *Browser) Wait() error

Wait returns when the Chrome process eventually terminates.

type Client struct {
	// contains filtered or unexported fields
}

Client represents a single connection to the Chrome Debugging Protocol.

func NewClient(ctx context.Context, url string) *Client

NewClient creates Client object that can be used to connect to and receive events from the Chrome Debugging Protocol.

func (c *Client) Connect() error

Connect to the Chrome Debugging Protocol endpoint.

func (c *Client) Events() (<-chan Page, <-chan error, error)

Events listens for page load events and returns any errors on a channel.

type Config struct {
	Browser browserConfig `yaml:"browser"`
	Start   startConfig   `yaml:"start"`
	End     endConfig     `yaml:"end"`
}

func Load(filename string) (*Config, error)

func LoadBytes(body []byte) (*Config, error)

type Page struct {
	Title   string
	URL     string
	Cookies []network.Cookie
	Body    string
}