agouti

package
v0.0.0-...-f16a5c3 Latest Latest
Warning

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

 Go to latest Published: Jul 1, 2015 License: MIT, MIT Imports: 11 Imported by: 0

README

Agouti

Build Status GoDoc

Acceptance/integration testing for Golang with support for Ginkgo and Gomega! See agouti.org for more complete documentation. Have questions? Check out the Agouti mailing list.

Want to dive right in? Our integration test is a great place to see everything in action.

Documentation

Overview

Package agouti is a universal WebDriver client for Go. It extends the agouti/api package to provide a feature-rich interface for controlling a Web Browser.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Capabilities 

type Capabilities map[string]interface{}

A Capabilities instance defines the desired capabilities the WebDriver should use to configure a Page.

For example, to open Firefox with JavaScript disabled: 

capabilities := agouti.NewCapabilities().Browser("firefox").Without("javascriptEnabled")
driver.NewPage(agouti.Desired(capabilities))

See: https://code.google.com/p/selenium/wiki/DesiredCapabilities

All methods called on this instance will modify the original instance.

func NewCapabilities 

func NewCapabilities(features ...string) Capabilities

NewCapabilities returns a Capabilities instance with any provided features enabled.

func (Capabilities) Browser 

func (c Capabilities) Browser(name string) Capabilities

Browser sets the desired browser name. Possible values: 

{android|chrome|firefox|htmlunit|internet explorer|iPhone|iPad|opera|safari}

func (Capabilities) JSON 

func (c Capabilities) JSON() (string, error)

JSON returns a JSON string representing the desired capabilities.

func (Capabilities) Platform 

func (c Capabilities) Platform(platform string) Capabilities

Platform sets the desired browser platform. Possible values: 

{WINDOWS|XP|VISTA|MAC|LINUX|UNIX|ANDROID|ANY}.

func (Capabilities) Version 

func (c Capabilities) Version(version string) Capabilities

Version sets the desired browser version (ex. "3.6").

func (Capabilities) With 

func (c Capabilities) With(feature string) Capabilities

With enables the provided feature (ex. "trustAllSSLCertificates").

func (Capabilities) Without 

func (c Capabilities) Without(feature string) Capabilities

Without disables the provided feature (ex. "javascriptEnabled"). 

type Cookie map[string]interface{}

Cookie defines a cookie for use with *Page#SetCookie()

func NewCookie 

func NewCookie(name string, value string) Cookie

NewCookie returns a Cookie instance with the provided name and value. All methods called on this instance will modify the original instance.

func (Cookie) Domain 

func (c Cookie) Domain(domain string) Cookie

Domain sets the domain that the cookie is visible to.

func (Cookie) Expiry 

func (c Cookie) Expiry(expiry int64) Cookie

Expiry sets when the cookie expires in Unix time.

func (Cookie) JSON 

func (c Cookie) JSON() (string, error)

JSON returns a JSON string representing the cookie.

func (Cookie) Path 

func (c Cookie) Path(path string) Cookie

Path sets the cookie path - defaults to "/".

func (Cookie) SetHTTPOnly 

func (c Cookie) SetHTTPOnly() Cookie

SetHTTPOnly marks the cookie as HTTP-only

func (Cookie) SetSecure 

func (c Cookie) SetSecure() Cookie

SetSecure marks the cookie as a secure cookie

type Log 

type Log struct {
	// Message is the text of the log message.
	Message string

	// Location is the code location of the log message, if present
	Location string

	// Level is the log level ("DEBUG", "INFO", "WARNING", or "SEVERE").
	Level string

	// Time is the time the message was logged.
	Time time.Time
}

A Log represents a single log message

type MultiSelection 

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

A MultiSelection is a Selection that may be indexed using the At() method. All Selection methods are available on a MultiSelection.

A Selection returned by At() may still refer to multiple elements if any parent of the MultiSelection refers to multiple elements.

Examples: 

selection.All("section").All("form").At(1).Submit()

Submits the second form in each section. 

selection.All("div").Find("h1").Click()

Clicks one h1 in each div, failing if any div does not contain exactly one h1.

func (*MultiSelection) At 

func (s *MultiSelection) At(index int) *Selection

At finds an element at the provided index. It only applies to the immediate selection, meaning that the returned selection may still refer to multiple elements if any parent of the immediate selection is also a *MultiSelection.

type Option 

type Option func(*config)

func Desired 

func Desired(capabilities Capabilities) Option

Desired provides an option for specifying desired WebDriver capabilities.

func Timeout 

func Timeout(seconds int) Option

Timeout provides an option for specifying a timeout in seconds.

type Page 

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

A Page represents an open browser session. Pages may be created using the *WebDriver#Page() method or by calling the NewPage or SauceLabs functions.

func NewPage 

func NewPage(url string, options ...Option) (*Page, error)

NewPage opens a Page using the provided WebDriver URL.

func SauceLabs 

func SauceLabs(name, platform, browser, version, username, accessKey string) (*Page, error)

SauceLabs opens a Sauce Labs session and returns a *Page. Does not support Sauce Connect.

func (*Page) All 

func (s *Page) All(selector string) *MultiSelection

All finds zero or more elements by CSS selector.

func (*Page) AllByButton 

func (s *Page) AllByButton(text string) *MultiSelection

AllByButton finds zero or more button elements with the provided text. Supports <button>, <input type="button">, and <input type="submit">.

func (*Page) AllByLabel 

func (s *Page) AllByLabel(text string) *MultiSelection

AllByLabel finds zero or more elements by associated label text. 

func (s *Page) AllByLink(text string) *MultiSelection

AllByLink finds zero or more anchor elements by their text content.

func (*Page) AllByXPath 

func (s *Page) AllByXPath(selector string) *MultiSelection

AllByXPath finds zero or more elements by XPath selector.

func (*Page) Back 

func (p *Page) Back() error

Back navigates backwards in history.

func (*Page) CancelPopup 

func (p *Page) CancelPopup() error

CancelPopup cancels an alert, confirm, or prompt popup.

func (*Page) ClearCookies 

func (p *Page) ClearCookies() error

ClearCookies deletes all cookies on the page.

func (*Page) CloseWindow 

func (p *Page) CloseWindow() error

CloseWindow closes the active window.

func (*Page) ConfirmPopup 

func (p *Page) ConfirmPopup() error

ConfirmPopup confirms an alert, confirm, or prompt popup.

func (*Page) DeleteCookie 

func (p *Page) DeleteCookie(name string) error

DeleteCookie deletes a cookie on the page by name.

func (*Page) Destroy 

func (p *Page) Destroy() error

Destroy closes the session and any open browsers processes.

func (*Page) EnterPopupText 

func (p *Page) EnterPopupText(text string) error

EnterPopupText enters text into an open prompt popup.

func (*Page) Find 

func (s *Page) Find(selector string) *Selection

Find finds exactly one element by CSS selector.

func (*Page) FindByButton 

func (s *Page) FindByButton(text string) *Selection

FindByButton finds exactly one button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.

func (*Page) FindByLabel 

func (s *Page) FindByLabel(text string) *Selection

FindByLabel finds exactly one element by associated label text. 

func (s *Page) FindByLink(text string) *Selection

FindByLink finds exactly one anchor element by its text content.

func (*Page) FindByXPath 

func (s *Page) FindByXPath(selector string) *Selection

FindByXPath finds exactly one element by XPath selector.

func (*Page) First 

func (s *Page) First(selector string) *Selection

First finds the first element by CSS selector.

func (*Page) FirstByButton 

func (s *Page) FirstByButton(text string) *Selection

FirstByButton finds the first button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.

func (*Page) FirstByLabel 

func (s *Page) FirstByLabel(text string) *Selection

FirstByLabel finds the first element by associated label text. 

func (s *Page) FirstByLink(text string) *Selection

FirstByLink finds the first anchor element by its text content.

func (*Page) FirstByXPath 

func (s *Page) FirstByXPath(selector string) *Selection

FirstByXPath finds the first element by XPath selector.

func (*Page) Forward 

func (p *Page) Forward() error

Forward navigates forward in history.

func (*Page) HTML 

func (p *Page) HTML() (string, error)

HTML returns the current contents of the DOM for the entire page.

func (*Page) LogTypes 

func (p *Page) LogTypes() ([]string, error)

LogTypes returns all of the valid log types that may be used with a LogReader.

func (*Page) Navigate 

func (p *Page) Navigate(url string) error

Navigate navigates to the provided URL.

func (*Page) NextWindow 

func (p *Page) NextWindow() error

NextWindow switches to the next available window.

func (*Page) PopupText 

func (p *Page) PopupText() (string, error)

PopupText returns the current alert, confirm, or prompt popup text.

func (*Page) ReadAllLogs 

func (p *Page) ReadAllLogs(logType string) ([]Log, error)

ReadAllLogs returns all log messages of the provided log type. For example, page.ReadLogs("browser") returns browser console logs, such as JavaScript logs and errors. All logs since the session was created are returned. Valid log types may be obtained using the LogTypes method.

func (*Page) ReadNewLogs 

func (p *Page) ReadNewLogs(logType string) ([]Log, error)

ReadNewLogs returns new log messages of the provided log type. For example, page.ReadNewLogs("browser") returns browser console logs, such as JavaScript logs and errors. Only logs since the last call to ReadNewLogs are returned. Valid log types may be obtained using the LogTypes method.

func (*Page) Refresh 

func (p *Page) Refresh() error

Refresh refreshes the page.

func (*Page) RunScript 

func (p *Page) RunScript(body string, arguments map[string]interface{}, result interface{}) error

RunScript runs the JavaScript provided in the body. Any keys present in the arguments map will be available as variables in the body. Values provided in arguments are converted into javascript objects. If the body returns a value, it will be unmarshalled into the result argument. Simple example: 

var number int
page.RunScript("return test;", map[string]interface{}{"test": 100}, &number)
fmt.Println(number)

-> 100

func (*Page) Screenshot 

func (p *Page) Screenshot(filename string) error

Screenshot takes a screenshot and saves it to the provided filename.

func (*Page) SetCookie 

func (p *Page) SetCookie(cookie Cookie) error

SetCookie sets a cookie on the page.

func (*Page) Size 

func (p *Page) Size(width, height int) error

Size sets the current page size in pixels.

func (*Page) SwitchToParentFrame 

func (p *Page) SwitchToParentFrame() error

SwitchToParentFrame focuses on the immediate parent frame of a frame selected by Selection#Frame. After switching, all new and existing selections will refer to the parent frame. All further Page methods will apply to this frame as well.

This method is not supported by PhantomJS. Please use SwitchToRootFrame instead.

func (*Page) SwitchToRootFrame 

func (p *Page) SwitchToRootFrame() error

SwitchToRootFrame focuses on the original, default page frame before any calls to Selection#Frame were made. After switching, all new and existing selections will refer to the root frame. All further Page methods will apply to this frame as well.

func (*Page) SwitchToWindow 

func (p *Page) SwitchToWindow(name string) error

SwitchToWindow switches to the first available window with the provided name (JavaScript `window.name` attribute).

func (*Page) Title 

func (p *Page) Title() (string, error)

Title returns the page title.

func (*Page) URL 

func (p *Page) URL() (string, error)

URL returns the current page URL.

func (*Page) WindowCount 

func (p *Page) WindowCount() (int, error)

WindowCount returns the number of available windows.

type Selection 

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

Selection instances refer to a selection of elements. All Selection methods are also MultiSelection methods.

Methods that take selectors apply their selectors to each element in the selection they are called on. If the selection they are called on refers to multiple elements, the resulting selection will refer to at least that many elements.

Examples: 

selection.Find("table").All("tr").At(2).First("td input[type=checkbox]").Check()

Checks the first checkbox in the third row of the only table. 

selection.Find("table").All("tr").Find("td").All("input[type=checkbox]").Check()

Checks all checkboxes in the first-and-only cell of each row in the only table.

func (*Selection) Active 

func (s *Selection) Active() (bool, error)

Active returns true if the single element that the selection refers to is active.

func (*Selection) All 

func (s *Selection) All(selector string) *MultiSelection

All finds zero or more elements by CSS selector.

func (*Selection) AllByButton 

func (s *Selection) AllByButton(text string) *MultiSelection

AllByButton finds zero or more button elements with the provided text. Supports <button>, <input type="button">, and <input type="submit">.

func (*Selection) AllByLabel 

func (s *Selection) AllByLabel(text string) *MultiSelection

AllByLabel finds zero or more elements by associated label text. 

func (s *Selection) AllByLink(text string) *MultiSelection

AllByLink finds zero or more anchor elements by their text content.

func (*Selection) AllByXPath 

func (s *Selection) AllByXPath(selector string) *MultiSelection

AllByXPath finds zero or more elements by XPath selector.

func (*Selection) Attribute 

func (s *Selection) Attribute(attribute string) (string, error)

Attribute returns an attribute value for exactly one element.

func (*Selection) CSS 

func (s *Selection) CSS(property string) (string, error)

CSS returns a CSS style property value for exactly one element.

func (*Selection) Check 

func (s *Selection) Check() error

Check checks all of the unchecked checkboxes that the selection refers to.

func (*Selection) Click 

func (s *Selection) Click() error

Click clicks on all of the elements that the selection refers to.

func (*Selection) Count 

func (s *Selection) Count() (int, error)

Count returns the number of elements that the selection refers to.

func (*Selection) DoubleClick 

func (s *Selection) DoubleClick() error

DoubleClick double-clicks on all of the elements that the selection refers to.

func (*Selection) Enabled 

func (s *Selection) Enabled() (bool, error)

Enabled returns true if all of the elements that the selection refers to are enabled.

func (*Selection) EqualsElement 

func (s *Selection) EqualsElement(other interface{}) (bool, error)

EqualsElement returns whether or not two selections of exactly one element each refer to the same element.

func (*Selection) Fill 

func (s *Selection) Fill(text string) error

Fill fills all of the fields the selection refers to with the provided text.

func (*Selection) Find 

func (s *Selection) Find(selector string) *Selection

Find finds exactly one element by CSS selector.

func (*Selection) FindByButton 

func (s *Selection) FindByButton(text string) *Selection

FindByButton finds exactly one button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.

func (*Selection) FindByLabel 

func (s *Selection) FindByLabel(text string) *Selection

FindByLabel finds exactly one element by associated label text. 

func (s *Selection) FindByLink(text string) *Selection

FindByLink finds exactly one anchor element by its text content.

func (*Selection) FindByXPath 

func (s *Selection) FindByXPath(selector string) *Selection

FindByXPath finds exactly one element by XPath selector.

func (*Selection) First 

func (s *Selection) First(selector string) *Selection

First finds the first element by CSS selector.

func (*Selection) FirstByButton 

func (s *Selection) FirstByButton(text string) *Selection

FirstByButton finds the first button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.

func (*Selection) FirstByLabel 

func (s *Selection) FirstByLabel(text string) *Selection

FirstByLabel finds the first element by associated label text. 

func (s *Selection) FirstByLink(text string) *Selection

FirstByLink finds the first anchor element by its text content.

func (*Selection) FirstByXPath 

func (s *Selection) FirstByXPath(selector string) *Selection

FirstByXPath finds the first element by XPath selector.

func (*Selection) Select 

func (s *Selection) Select(text string) error

Select, when called on some number of <select> elements, will select all <option> elements under those <select> elements that match the provided text.

func (*Selection) Selected 

func (s *Selection) Selected() (bool, error)

Selected returns true if all of the elements that the selection refers to are selected.

func (*Selection) String 

func (s *Selection) String() string

String returns a string representation of the selection, ex. 

CSS: .some-class | XPath: //table [3] | Link "click me" [single]

func (*Selection) Submit 

func (s *Selection) Submit() error

Submit submits all selected forms. The selection may refer to a form itself or any input element contained within a form.

func (*Selection) SwitchToFrame 

func (s *Selection) SwitchToFrame() error

SwitchToFrame focuses on the frame specified by the selection. All new and existing selections will refer to the new frame. All further Page methods will apply to this frame as well.

func (*Selection) Text 

func (s *Selection) Text() (string, error)

Text returns the entirety of the text content for exactly one element.

func (*Selection) Uncheck 

func (s *Selection) Uncheck() error

Uncheck unchecks all of the checked checkboxes that the selection refers to.

func (*Selection) Visible 

func (s *Selection) Visible() (bool, error)

Visible returns true if all of the elements that the selection refers to are visible.

type WebDriver 

type WebDriver struct {
	*api.WebDriver
}

A WebDriver controls a Selenium, PhantomJS, or ChromeDriver process. This struct embeds api.WebDriver, which provides Start and Stop methods for starting and stopping the process.

func ChromeDriver 

func ChromeDriver() *WebDriver

ChromeDriver returns an instance of a ChromeDriver WebDriver.

func NewWebDriver 

func NewWebDriver(url string, command []string, options ...Option) *WebDriver

NewWebDriver returns an instance of a WebDriver specified by a templated URL and command. The URL should be the location of the WebDriver Wire Protocol web service brought up by the command. The command should be provided as a list of arguments (which are each templated). The optional timeout specifies how long to wait for the web service to become available. Default timeout is 5 seconds.

Valid template parameters are: 

{{.Host}} - local address to bind to (usually 127.0.0.1)
{{.Port}} - arbitrary free port on the local address
{{.Address}} - {{.Host}}:{{.Port}}

Selenium JAR example: 

command := []string{"java", "-jar", "selenium-server.jar", "-port", "{{.Port}}"}
agouti.NewWebDriver("http://{{.Address}}/wd/hub", command)

func PhantomJS 

func PhantomJS() *WebDriver

PhantomJS returns an instance of a PhantomJS WebDriver. The return error is deprecated and will always be nil.

func Selenium 

func Selenium() *WebDriver

Selenium returns an instance of a Selenium WebDriver. The return error is deprecated and will always be nil.

func (*WebDriver) NewPage 

func (w *WebDriver) NewPage(options ...Option) (*Page, error)

NewPage returns a *Page that corresponds to a new WebDriver session. Any provided options configure the page. For instance: 

driver.NewPage(agouti.Desired(agouti.NewCapabilities().Without("javascriptEnabled")))

For Selenium, this argument must include a browser. For instance: 

seleniumDriver.NewPage(agouti.Desired(agouti.NewCapabilities().Browser("safari")))

Source Files

View all Source files

Directories

Path Synopsis
api
Package api provides a generic, low-level WebDriver API client for Go.
 Package api provides a generic, low-level WebDriver API client for Go.
internal/bus
internal/mocks
internal/service
Package core is DEPRECATED and will not receive future updates.
 Package core is DEPRECATED and will not receive future updates.
internal/integration
internal/mocks
internal/page
internal/selection
dsl
Package dsl uses Ginkgo to implement a Capybara-like DSL for writing acceptance tests.
 Package dsl uses Ginkgo to implement a Capybara-like DSL for writing acceptance tests.
internal/mocks
internal
element
integration
mocks
target
Package matchers provides a set of Gomega-compatible matchers for use with the agouti package.
 Package matchers provides a set of Gomega-compatible matchers for use with the agouti package.
internal/colorparser
internal/mocks
internal/page
internal/selection

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.