webfriend

README

   “Your friendly friend in modern web automation and testing.”

ALPHA ALERT

This software is under heavy development and should not be considered production-ready. Much of it works, but much is still yet to be implemented. It is a ground-up rewrite of my Python version of this project. Documentation and examples are missing and incomplete at this time, but I am working on it as I am able.

I welcome polite feedback, comments, and suggestions.

Overview

Webfriend is a Golang library and command-line utility that integrates with the Chrome DevTools Protocol to control a Google Chrome or Chromium browser instance. There is also a purpose-built scripting language (called Friendscript) that is designed to be an easy-to-learn environment for writing simple or complex browser automation scripts.

Some of the things that you can use Webfriend for:

• Take full-page screenshots of web pages.

• Automate tedious or repetitive tasks on web pages that otherwise would require extensive user input with a keyboard, mouse, or touchscreen device.

• Execute pre-defined tests against web pages and serve as an automated testing framework for verifying frontend functionality.

• Automatically login to websites with complex authentication flows.

• Extract (i.e. scrape) information from web pages and present it in a structured way that other languages and scripts can use as input.

• Inject Javascript code into the browser, evaluate it, then return the results for output or further processing.

Operation and Usage

Webfriend by default operates using Headless Chrome mode, but can also just as easily run Chrome in the foreground in a graphical environment. Importantly, headless operation allows you to run Webfriend on servers without running Xfvb or X11. In this sense, it operates as a potentially-faster alternative to phantomjs or Selenium while also providing almost all of the capabilities of the complete Google Chrome/Chromium browser.

Using Friendscript, straightforward and composable scripts can be written and combined together to create fast, modular, and flexible processes that can be used to solve real problems.

Installation

go install github.com/ghetzel/go-webfriend/webfriend

Documentation

• Friendscript (Web Automation Scripting Language)

  • Beginner's Guide

  • Language Overview

  • Command Reference

Documentation

Index

• Constants
• Variables
• type CallDoc
• type CallDocSet
• type DocItem
• type Environment
  • func NewEnvironment(browser *browser.Browser) *Environment
  • func (self *Environment) Browser() *browser.Browser
  • func (self *Environment) Documentation() []*ModuleDoc
  • func (self *Environment) MustModule(name string) friendscript.Module
• type ModuleDoc
  • func (self *ModuleDoc) AddCommand(name string, doc *CallDoc)

Constants

const Slogan = `Your friendly friend in web browser automation.`

const Version = `0.10.4`

Variables

var MaxReaderWait = time.Duration(5) * time.Second

Types

type CallDoc

type CallDoc struct {
	Name        string     `json:"name"`
	Description string     `json:"description,omitempty"`
	Argument    *DocItem   `json:"argument,omitempty"`
	Options     []*DocItem `json:"options,omitempty"`
	Return      *DocItem   `json:"return,omitempty"`
}

type CallDocSet

type CallDocSet []*CallDoc

type DocItem

type DocItem struct {
	Name         string      `json:"name,omitempty"`
	Type         string      `json:"types"`
	Required     bool        `json:"required,omitempty"`
	Description  string      `json:"description,omitempty"`
	DefaultValue interface{} `json:"default,omitempty"`
	Examples     []string    `json:"examples,omitempty"`
	Parameters   []*DocItem  `json:"parameters,omitempty"`
}

type Environment

type Environment struct {
	*friendscript.Environment
	Cookies *cookies.Commands
	Core    *core.Commands
	Page    *page.Commands
	File    *file.Commands
	// contains filtered or unexported fields
}

func NewEnvironment

func NewEnvironment(browser *browser.Browser) *Environment

func (*Environment) Browser

func (self *Environment) Browser() *browser.Browser

func (*Environment) Documentation

func (self *Environment) Documentation() []*ModuleDoc

func (*Environment) MustModule

func (self *Environment) MustModule(name string) friendscript.Module

type ModuleDoc

type ModuleDoc struct {
	DisplayName string     `json:"display_name"`
	Name        string     `json:"name"`
	Summary     string     `json:"summary,omitempty"`
	Description string     `json:"description,omitempty"`
	Commands    CallDocSet `json:"commands"`
	// contains filtered or unexported fields
}

func (*ModuleDoc) AddCommand

func (self *ModuleDoc) AddCommand(name string, doc *CallDoc)