Categorygithub.com/bunsenapp/go-selenium
modulepackage
0.1.0
Repository: https://github.com/bunsenapp/go-selenium.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
9
Dependents
8
Files
2k SLOC

# README

go-selenium

Build Status GoDoc

Introduction

Yes, yet another Selenium Web Driver library has been brought to the table. This one, however, is slightly different.

  • Easy to understand.
  • Full test coverage by unit tests and integration tests.
  • Excellent support; we use this in our main project so if you find an issue - it'll likely impact us!
  • Idiomatic, structured code with no gimmicks.
  • Simple errors that describe what has happened and why.

Installation

As with all Go libraries, go-selenium is easy to install. Simply run the below command:

go get github.com/bunsenapp/go-selenium

and then import the library in your project:

import "github.com/bunsenapp/go-selenium"

Getting started

Please see the examples/getting-started/main.go file.

Examples

Further examples, including tests of HackerNews (c), are available within the examples directory.

Documentation

All documentation is available on the godoc.org website: https://godoc.org/github.com/bunsenapp/go-selenium.

Version

This project is currently in an alpha state. This means it is fairly new and hasn't been used all that much in the big wide world. Fortunately, this doesn't mean it's not stable. The project been developed in such a way that any changes will not leave you having to re-write your code.

# Packages

No description provided by the author
No description provided by the author

# Functions

AndroidBrowser returns an Android browser object.
ByCSSSelector accepts a CSS selector (i.e.
ByIndex accepts an integer that represents what the index of an element is and returns the appropriate By implementation.
ByLinkText is used to find an anchor element by its innerText.
ByPartialLinkText works the same way as ByLinkText but performs a search where the link text contains the string passed in instead of a full match.
ByXPath utilises the xpath to find elements (see http://www.guru99.com/xpath-selenium.html).
ChromeBrowser returns a Chrome browser object.
FirefoxBrowser returns a Firefox browser object.
HTMLUnitBrowser returns a HTMLUnit browser object.
InternetExplorerBrowser returns an IE browser object.
IPadBrowser returns an IPad browser object.
IPhoneBrowser returns an IPhone browser object.
IsCommunicationError checks whether an error is a selenium communication error.
IsInvalidURLError checks whether an error is due to the URL being incorrectly formatted.
IsMarshallingError checks whether an error is a marshalling error.
IsSessionIDError checks whether an error is due to a session ID not being set.
IsUnmarshallingError checks whether an error is a selenium unmarshalling error.
NewSeleniumWebDriver creates a new instance of a Selenium web driver with a service URL (usually http://domain:port/wd/hub) and a Capabilities object.
OperaBrowser returns an Opera browser object.
SafariBrowser returns a Safari browser object.
SessionImplicitWaitTimeout creates an appropriate timeout implementation for the session implicit wait timeout.
SessionPageLoadTimeout creates an appropriate Timeout implementation for the page load timeout.
SessionScriptTimeout creates an appropriate Timeout implementation for the script timeout.
UntilElementPresent attempts to locate an element on the page.
UntilURLIs checks whether or not the page's URL has changed.

# Constants

Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Error codes that are returned from Selenium.
Keyboard keys converted from the ASCII code.

# Variables

WaitTimeoutError is returned when a Wait call has timed out.

# Structs

AcceptAlertResponse is the response returned from calling the AcceptAlert method.
AddCookieResponse is the result returned from calling the AddCookie method.
AlertTextResponse is the response returned from calling the AlertText method.
AllCookiesResponse is the response returned from the AllCookies method.
BackResponse is the response returned from the Back call.
Capabilities represents the capabilities defined in the W3C specification.
CloseWindowResponse is the response returned from the CloseWindow() method.
CommunicationError is the result of a communication failure between this library and the WebDriver API.
Cookie represents a browser cookie.
CookieResponse is the response returned from the Cookie method.
CreateSessionCapabilities is a summarisation of the capabilities returned from the CreateSession method.
CreateSessionResponse is the response returned from the API when the CreateSession() method does not throw an error.
CurrentURLResponse is the response returned from the GET Url call.
DeleteCookieResponse is the result returned from calling the DeleteCookie method.
DeleteSessionResponse is the response returned from the API when the DeleteSession() method does not thrown an error.
Dimensions is a type that is both returned and accept by functions.
DismissAlertResponse is the response returned from calling the DismissAlert method.
ElementAttributeResponse is the response returned from the Attribute call.
ElementClearResponse is the response returned from calling the Clear method.
ElementClickResponse is the response returned from calling the Click method.
ElementCSSValueResponse is the response returned when the CSSValue method is called on an Element implementation.
ElementEnabledResponse is the response returned from calling the Enabled method.
ElementRectangleResponse is the response returned from calling the Rectangle method.
ElementSelectedResponse is the response returned from the Selected() call.
ElementSendKeysResponse is the response returned from calling the SendKeys method.
ElementTagNameResponse is the response returned from calling the TagName method.
ElementTextResponse is the response returned from calling the Text method.
ErrorResponse is what is returned from the Selenium API when an error occurs.
ExecuteScriptResponse is the response returned from calling the ExecuteScript method.
ForwardResponse is the response returned from the Forward call.
GoResponse is the response returned from the selenium web driver when calling the Go() call.
MarshallingError is an error that is returned when a json.Marshal error occurs.
MaximizeWindowResponse is the response that is returned from increasing the browser to match the viewport.
PageSourceResponse is the response returned from calling the PageSource method.
Rectangle repsents an elements size and position on the page.
RefreshResponse is the response returned from the Refresh call.
ScreenshotResponse is the response returned from the Screenshot and ScreenshotElement methods.
SendAlertTextResponse is the response returned from calling the SendAlertText method.
SessionStatusResponse is the response returned from the API when the SessionStatus() method is called.
SetSessionTimeoutResponse is the response returned from the API when the SetSessionTimeoutResponse() method is called.
SetWindowSizeResponse is the response that is returned from setting the window size of the current top level browsing context.
SwitchToFrameResponse is the response returned from the SwitchToFrame() method.
SwitchToParentFrameResponse represents the response from attempting to switch the top level browsing context to the parent of the current top level browsing context.
SwitchToWindowResponse is the response returned from the SwitchToWindow() method.
TitleResponse is the response returned from the Title call.
UnmarshallingError is the result of an unmarshalling failure of a JSON string.
WindowHandleResponse is the response returned from the WindowHandle() method.
WindowHandlesResponse is the response returned from the WindowHandles() method.
WindowSizeResponse is the response returned from calling the WindowSize method.

# Interfaces

Browser defines a supported selenium enabled browser.
By is an interface that defines what all 'ByX' methods must return.
Element is an interface which specifies what all WebDriver elements must do.
Timeout is an interface which specifies what all timeout requests must follow.
WebDriver is an interface which adheres to the W3C specification for WebDrivers (https://w3c.github.io/webdriver/webdriver-spec.html).

# Type aliases

InvalidURLError is an error that is returned whenever a URL is not correctly formatted.
SessionIDError is an error that is returned when the session id is invalid.
Until represents a function that will be continuously repeated until it succeeds or a timeout is reached.