import "github.com/sclevine/agouti"
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.
agouti.go capabilities.go multiselection.go options.go page.go selectable.go selection.go selection_actions.go selection_frames.go selection_properties.go types.go webdriver.go
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://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
All methods called on this instance will modify the original instance.
func NewCapabilities(features ...string) Capabilities
NewCapabilities returns a Capabilities instance with any provided features enabled.
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 (c Capabilities) JSON() (string, error)
JSON returns a JSON string representing the desired capabilities.
func (c Capabilities) Platform(platform string) Capabilities
Platform sets the desired browser platform. Possible values:
{WINDOWS|XP|VISTA|MAC|LINUX|UNIX|ANDROID|ANY}.
func (c Capabilities) Proxy(p ProxyConfig) Capabilities
Proxy sets the desired proxy configuration.
func (c Capabilities) Version(version string) Capabilities
Version sets the desired browser version (ex. "3.6").
func (c Capabilities) With(feature string) Capabilities
With enables the provided feature (ex. "trustAllSSLCertificates").
func (c Capabilities) Without(feature string) Capabilities
Without disables the provided feature (ex. "javascriptEnabled").
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
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 (s *MultiSelection) All(selector string) *MultiSelection
All finds zero or more elements by CSS selector.
func (s *MultiSelection) 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 (s *MultiSelection) AllByClass(text string) *MultiSelection
AllByClass finds zero or more elements with a given CSS class.
func (s *MultiSelection) AllByID(text string) *MultiSelection
AllByID finds zero or more elements with a given ID.
func (s *MultiSelection) AllByLabel(text string) *MultiSelection
AllByLabel finds zero or more elements by associated label text.
func (s *MultiSelection) AllByLink(text string) *MultiSelection
AllByLink finds zero or more anchor elements by their text content.
func (s *MultiSelection) AllByName(name string) *MultiSelection
AllByName finds zero or more elements with the provided name attribute.
func (s *MultiSelection) AllByXPath(selector string) *MultiSelection
AllByXPath finds zero or more elements by XPath selector.
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.
Find finds exactly one element by CSS selector.
FindByButton finds exactly one button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.
FindByClass finds exactly one element with a given CSS class.
FindByID finds exactly one element that has the given ID.
FindByLabel finds exactly one element by associated label text.
FindByLink finds exactly one anchor element by its text content.
FindByName finds exactly element with the provided name attribute.
FindByXPath finds exactly one element by XPath selector.
FirstByClass finds the first element with a given CSS class.
First finds the first element by CSS selector.
FirstByButton finds the first button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.
FirstByClass finds the first element with a given CSS class.
FirstByLabel finds the first element by associated label text.
FirstByLink finds the first anchor element by its text content.
FirstByName finds the first element with the provided name attribute.
FirstByXPath finds the first element by XPath selector.
type Option func(*config)
An Option specifies configuration for a new WebDriver or Page.
Debug is an Option that connects the running WebDriver to stdout and stdin.
RejectInvalidSSL is an Option specifying that the WebDriver should reject invalid SSL certificates. All WebDrivers should accept invalid SSL certificates by default. See: http://www.w3.org/TR/webdriver/#invalid-ssl-certificates
Browser provides an Option for specifying a browser.
ChromeOptions is used to pass additional options to Chrome via ChromeDriver.
func Desired(capabilities Capabilities) Option
Desired provides an Option for specifying desired WebDriver Capabilities.
HTTPClient provides an Option for specifying a *http.Client
Timeout provides an Option for specifying a timeout in seconds.
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.
JoinPage creates a Page using existing session URL. This method takes Options but respects only the HTTPClient Option if provided.
NewPage opens a Page using the provided WebDriver URL. This method takes the same Options as *WebDriver.NewPage. Unlike *WebDriver.NewPage, this method will respect the HTTPClient Option if provided.
func SauceLabs(name, platform, browser, version, username, accessKey string, options ...Option) (*Page, error)
SauceLabs opens a Sauce Labs session and returns a *Page. Does not support Sauce Connect.
This method takes the same Options as NewPage. Passing the Desired Option will completely override the provided name, platform, browser, and version.
func (s *Page) All(selector string) *MultiSelection
All finds zero or more elements by CSS selector.
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 (s *Page) AllByClass(text string) *MultiSelection
AllByClass finds zero or more elements with a given CSS class.
func (s *Page) AllByID(text string) *MultiSelection
AllByID finds zero or more elements with a given ID.
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 (s *Page) AllByName(name string) *MultiSelection
AllByName finds zero or more elements with the provided name attribute.
func (s *Page) AllByXPath(selector string) *MultiSelection
AllByXPath finds zero or more elements by XPath selector.
Back navigates backwards in history.
CancelPopup cancels an alert, confirm, or prompt popup.
ClearCookies deletes all cookies on the page.
Click performs the provided Click event using the provided Button at the current mouse position.
CloseWindow closes the active window.
ConfirmPopup confirms an alert, confirm, or prompt popup.
DeleteCookie deletes a cookie on the page by name.
Destroy closes any open browsers by ending the session.
DoubleClick double clicks the left mouse button at the current mouse position.
EnterPopupText enters text into an open prompt popup.
Find finds exactly one element by CSS selector.
FindByButton finds exactly one button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.
FindByClass finds exactly one element with a given CSS class.
FindByID finds exactly one element that has the given ID.
FindByLabel finds exactly one element by associated label text.
FindByLink finds exactly one anchor element by its text content.
FindByName finds exactly element with the provided name attribute.
FindByXPath finds exactly one element by XPath selector.
FirstByClass finds the first element with a given CSS class.
First finds the first element by CSS selector.
FirstByButton finds the first button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.
FirstByClass finds the first element with a given CSS class.
FirstByLabel finds the first element by associated label text.
FirstByLink finds the first anchor element by its text content.
FirstByName finds the first element with the provided name attribute.
FirstByXPath finds the first element by XPath selector.
Forward navigates forward in history.
GetCookies returns all cookies on the page.
HTML returns the current contents of the DOM for the entire page.
LogTypes returns all of the valid log types that may be used with a LogReader.
MoveMouseBy moves the mouse by the provided offset.
Navigate navigates to the provided URL.
NextWindow switches to the next available window.
PopupText returns the current alert, confirm, or prompt popup text.
ReadAllLogs returns all log messages of the provided log type. For example, page.ReadAllLogs("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.
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.
Refresh refreshes the page.
Reset deletes all cookies set for the current domain and navigates to a blank page. Unlike Destroy, Reset will permit the page to be re-used after it is called. Reset is faster than Destroy, but any cookies from domains outside the current domain will remain after a page is reset.
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
Screenshot takes a screenshot and saves it to the provided filename. The provided filename may be an absolute or relative path.
Session returns a *api.Session that can be used to send direct commands to the WebDriver. See: https://code.google.com/p/selenium/wiki/JsonWireProtocol
SetCookie sets a cookie on the page.
SetImplicitWait sets the implicit wait timeout (in ms)
SetPageLoad sets the page load timeout (in ms)
SetScriptTimeout sets the script timeout (in ms)
Size sets the current page size in pixels.
String returns a string representation of the Page. Currently: "page"
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.
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.
SwitchToWindow switches to the first available window with the provided name (JavaScript `window.name` attribute).
Title returns the page title.
URL returns the current page URL.
WindowCount returns the number of available windows.
type ProxyConfig struct {
ProxyType string `json:"proxyType"`
ProxyAutoconfigURL string `json:"proxyAutoconfigUrl,omitempty"`
FTPProxy string `json:"ftpProxy,omitempty"`
HTTPProxy string `json:"httpProxy,omitempty"`
SSLProxy string `json:"sslProxy,omitempty"`
SOCKSProxy string `json:"socksProxy,omitempty"`
SOCKSUsername string `json:"socksUsername,omitempty"`
SOCKSPassword string `json:"socksPassword,omitempty"`
NoProxy string `json:"noProxy,omitempty"`
}A ProxyConfig instance defines the desired proxy configuration the WebDriver should use to proxy a Page.
ProxyType is required and defines the type of proxy being used
Possible Values:
{direct|manual|pac|autodetect|system}
See: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities#proxy-json-object
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.
Active returns true if the single element that the selection refers to is active.
func (s *Selection) All(selector string) *MultiSelection
All finds zero or more elements by CSS selector.
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 (s *Selection) AllByClass(text string) *MultiSelection
AllByClass finds zero or more elements with a given CSS class.
func (s *Selection) AllByID(text string) *MultiSelection
AllByID finds zero or more elements with a given ID.
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 (s *Selection) AllByName(name string) *MultiSelection
AllByName finds zero or more elements with the provided name attribute.
func (s *Selection) AllByXPath(selector string) *MultiSelection
AllByXPath finds zero or more elements by XPath selector.
Attribute returns an attribute value for exactly one element.
CSS returns a CSS style property value for exactly one element.
Check checks all of the unchecked checkboxes that the selection refers to.
Clear clears all fields the selection refers to.
Click clicks on all of the elements that the selection refers to.
Count returns the number of elements that the selection refers to.
DoubleClick double-clicks on all of the elements that the selection refers to.
Elements returns a []*api.Element that can be used to send direct commands to WebDriver elements. See: https://code.google.com/p/selenium/wiki/JsonWireProtocol
Enabled returns true if all of the elements that the selection refers to are enabled.
EqualsElement returns whether or not two selections of exactly one element refer to the same element.
Fill fills all of the fields the selection refers to with the provided text.
Find finds exactly one element by CSS selector.
FindByButton finds exactly one button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.
FindByClass finds exactly one element with a given CSS class.
FindByID finds exactly one element that has the given ID.
FindByLabel finds exactly one element by associated label text.
FindByLink finds exactly one anchor element by its text content.
FindByName finds exactly element with the provided name attribute.
FindByXPath finds exactly one element by XPath selector.
FirstByClass finds the first element with a given CSS class.
First finds the first element by CSS selector.
FirstByButton finds the first button element with the provided text. Supports <button>, <input type="button">, and <input type="submit">.
FirstByClass finds the first element with a given CSS class.
FirstByLabel finds the first element by associated label text.
FirstByLink finds the first anchor element by its text content.
FirstByName finds the first element with the provided name attribute.
FirstByXPath finds the first element by XPath selector.
FlickFinger performs a flick touch action by the provided offset and at the provided speed on exactly one element.
MouseToElement moves the mouse over exactly one element in the selection.
ScrollFinger performs a scroll touch action by the provided offset on exactly one element.
Select may be called on a selection of any number of <select> elements to select any <option> elements under those <select> elements that match the provided text.
Selected returns true if all of the elements that the selection refers to are selected.
String returns a string representation of the selection, ex.
selection 'CSS: .some-class | XPath: //table [3] | Link "click me" [single]'
Submit submits all selected forms. The selection may refer to a form itself or any input element contained within a form.
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.
Tap performs the provided Tap event on each element in the selection.
Text returns the entirety of the text content for exactly one element.
Touch performs the provided Touch event at the location of each element in the selection.
Uncheck unchecks all of the checked checkboxes that the selection refers to.
UploadFile uploads the provided file to all selected <input type="file" />. The provided filename may be a relative or absolute path. Returns an error if elements of any other type are in the selection.
Visible returns true if all of the elements that the selection refers to are visible.
A WebDriver controls a WebDriver process. This struct embeds api.WebDriver, which provides Start and Stop methods for starting and stopping the process.
ChromeDriver returns an instance of a ChromeDriver WebDriver.
Provided Options will apply as default arguments for new pages. New pages will accept invalid SSL certificates by default. This may be disabled using the RejectInvalidSSL Option.
EdgeDriver returns an instance of a EdgeDriver WebDriver.
Provided Options will apply as default arguments for new pages. New pages will accept invalid SSL certificates by default. This may be disabled using the RejectInvalidSSL Option.
GeckoDriver returns an instance of a geckodriver WebDriver which supports gecko based brwoser like Firefox.
Provided Options will apply as default arguments for new pages.
See https://github.com/mozilla/geckodriver for geckodriver details.
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 (each of which are templated).
The Timeout Option specifies how many seconds to wait for the web service to become available. The default timeout is 5 seconds.
The HTTPClient Option specifies a *http.Client to use for all WebDriver communications. The default client is http.DefaultClient.
Any other provided Options are treated as default Options for new pages.
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)
PhantomJS returns an instance of a PhantomJS WebDriver.
Provided Options will apply as default arguments for new pages. New pages will accept invalid SSL certificates by default. This may be disabled using the RejectInvalidSSL Option.
The RejectInvalidSSL Option must be provided to the PhantomJS function (and not the NewPage method) for this Option to take effect on any PhantomJS page.
Selendroid returns an instance of a Selendroid WebDriver.
Provided Options will apply as default arguments for new pages. New pages will accept invalid SSL certificates by default. This may be disabled using the RejectInvalidSSL Option.
The jarFile is a relative or absolute path to Selendroid JAR file. Selendroid will return nil if an invalid path is provided.
Selenium returns an instance of a Selenium WebDriver.
Provided Options will apply as default arguments for new pages. New pages will accept invalid SSL certificates by default. This may be disabled using the RejectInvalidSSL Option.
NewPage returns a *Page that corresponds to a new WebDriver session. Provided Options configure the page. For instance, to disable JavaScript:
capabilities := agouti.NewCapabilities().Without("javascriptEnabled")
driver.NewPage(agouti.Desired(capabilities))
For Selenium, a Browser Option (or a Desired Option with Capabilities that specify a Browser) must be provided. For instance:
seleniumDriver.NewPage(agouti.Browser("safari"))
Specific Options (such as Browser) have precedence over Capabilities specified by the Desired Option.
The HTTPClient Option will be ignored if passed to this function. New pages will always use the *http.Client provided to their WebDriver, or http.DefaultClient if none was provided.
| Path | Synopsis |
|---|---|
| api | Package api provides a generic, low-level WebDriver API client for Go. |
| api/internal/bus | |
| api/internal/mocks | |
| api/internal/service | |
| api/mobile | |
| appium | |
| internal/element | |
| internal/integration | |
| internal/matchers | |
| internal/mocks | |
| internal/target | |
| matchers | Package matchers provides a set of Gomega-compatible matchers for use with the agouti package. |
| matchers/internal | |
| matchers/internal/colorparser | |
| matchers/internal/mocks |
Package agouti imports 14 packages (graph) and is imported by 50 packages. Updated 2018-08-26. Refresh now. Tools for package owners.