API

WebDriver

A binding for the WebDriver and JSON Wire Protocol for the Julia programing language compatible with the Selenium WebDriver.

Repository

Example

julia> using WebDriver

Capabilities(browserName::AbstractString;
             browserVersion::AbstractString = "",
             platformName::AbstractString = "",
             acceptInsecureCerts::Union{Nothing, Bool} = nothing,
             pageLoadStrategy::AbstractString = "",
             proxy::Union{Nothing, Proxy} = nothing,
             setWindowRect::Union{Nothing, Bool} = nothing,
             timeouts::Timeouts = Timeouts(),
             strictFileInteractability::Union{Nothing, Bool} = nothing,
             unhandledPromptBehavior::AbstractString = "dismiss and notify"
             )::Capabilities

According to W3C.

Example

julia> capabilities = Capabilities("chrome")
Remote WebDriver Capabilities
browserName: chrome

Cookie(obj)::Cookie
Cookie(name::AbstractString, value;
       path::AbstractString = "/",
       domain::Union{Nothing, AbstractString} = nothing,
       secure::Bool = false,
       httpOnly::Bool = false,
       expiry::Union{Nothing, Integer, DateTime} = nothing)::Cookie

A cookie per W3C.

Element(session::Session, location_strategy::AbstractString, value::AbstractString)::Element
Element(element::Element, location_strategy::AbstractString, value::AbstractString)::Element

The Find Element command is used to find an element in the current browsing context that can be used as the web element context for future element-centric commands.

May use a location strategy from "css selector", "link text", "partial link text", "tag name" or "xpath".

julia> capabilities = Capabilities("chrome")
Remote WebDriver Capabilities
browserName: chrome
julia> wd = RemoteWebDriver(capabilities, host = ENV["WEBDRIVER_HOST"], port = parse(Int, ENV["WEBDRIVER_PORT"]))
Remote WebDriver
julia> session = Session(wd)
Session
julia> isa(session, Session)
true
julia> delete!(session);

Proxy(proxyType::AbstractString;
      proxyAutoconfigUrl::Union{Nothing, AbstractString} = nothing,
      ftpProxy::Union{Nothing, AbstractString} = nothing,
      httpProxy::Union{Nothing, AbstractString} = nothing,
      noProxy::Union{Nothing, AbstractVector{<:AbstractString}} = nothing,
      sslProxy::Union{Nothing, AbstractString} = nothing,
      socksProxy::Union{Nothing, AbstractString} = nothing,
      socksVersion::Union{Nothing, Integer} = nothing)::Proxy

The proxy configuration capability is a JSON Object nested within the primary capabilities. According to the W3C.

RemoteWebDriver(capabilities::Capabilities;
                host::AbstractString = "localhost",
                port::Integer = 4444,
                path::AbstractString = "/wd/hub",
				kwargs...)::RemoteWebDriver

Specifies a remote web driver according to W3C.

julia> capabilities = Capabilities("chrome")
Remote WebDriver Capabilities
browserName: chrome
julia> wd = RemoteWebDriver(capabilities, host = ENV["WEBDRIVER_HOST"], port = parse(Int, ENV["WEBDRIVER_PORT"]))
Remote WebDriver
julia> status(wd) # Ready to accept new sessions?
true

Session

This is a web session.

julia> capabilities = Capabilities("chrome")
Remote WebDriver Capabilities
browserName: chrome
julia> wd = RemoteWebDriver(capabilities, host = ENV["WEBDRIVER_HOST"], port = parse(Int, ENV["WEBDRIVER_PORT"]))
Remote WebDriver
julia> session = Session(wd)
Session
julia> isa(session, Session)
true
julia> delete!(session);

Timeouts

According to the W3C.

julia> Timeouts(script = 50_000, pageLoad = 100_000, implicit = 5)
Session Timeouts -- script: 50000, pageLoad: 100000, implicit: 5

WDError <: Exception

A Web Driver Exception.

delete!(session::Session, cookie::AbstractString)::Nothing

If cookie = "", delete all cookies. Otherwise, delete cookie matching the "cookie" name.

delete!(session::Session)

Deletes the session from the Remote Driver.

Elements(element::Element, location_strategy::AbstractString, value::AbstractString)::Vector{Element}

Find Elements

See also: Element

Elements(session::Session, location_strategy::AbstractString, value::AbstractString)::Vector{Element}

Find Elements

See also: Element

accept(session::Session)::Nothing

Accepts the currently displayed alert dialog.

active_element(session::Session)::Element

Get Active Element

alert_text!(session::Session, text::AbstractString)::Nothing

Sends keystrokes to a JavaScript prompt() dialog.

alert_text(session::Session)::String

Gets the text of the currently displayed JavaScript alert(), confirm(), or prompt() dialog.

back!(session::Session)

This command causes the browser to traverse one step backward in the joint session history of the current top-level browsing context. This is equivalent to pressing the back button in the browser chrome or invoking window.history.back.

clear!(element::Element)::Nothing

Element Clear

click!(element::Element)::Nothing

The Element Click command scrolls into view the element if it is not already pointer-interactable, and clicks its in-view center point. If the element’s center point is obscured by another element, an element click intercepted error is returned. If the element is outside the viewport, an element not interactable error is returned.

cookie!(session::Session, cookie::Cookie)::Nothing

Add Cookie.

cookie(session::Session, cookie::AbstractString)::Cookie

Get Named Cookie.

cookies(session::Session)::Vector{Cookie}

The Get Page Source command returns a string serialization of the DOM of the current browsing context active document.

current_url(session::Session)::String

Get Current URL.

dismiss(session::Session)::Nothing

Dismisses the currently displayed alert dialog.

document_title(session::Session)::String

This command returns the document title of the current top-level browsing context, equivalent to calling document.title.

element_attr(element::Element, attribute::AbstractString)

Get Element Attribute.

element_css(element::Element, value::AbstractString)

Get Element CSS Value

clear!(element::Element)::Nothing

The Element Send Keys command scrolls into view the form control element and then sends the provided keys to the element. In case the element is not keyboard-interactable, an element not interactable error is returned.

element_property(element::Element, property::AbstractString)

Get Element Property.

element_tag(element::Element)::String

Get Element Tag Name.

element_text(element::Element)::String

The Get Element Text command intends to return an element’s text "as rendered". An element's rendered text is also used for locating a elements by their link text and partial link text.

forward!(session::Session)

This command causes the browser to traverse one step forwards in the joint session history of the current top-level browsing context.

frame!(frame::Element)::Nothing

The Switch To Frame command is used to select the current top-level browsing context or a child browsing context of the current browsing context to use as the current browsing context for subsequent commands.

isenabled(element::Element)::Bool

Is Element Enabled.

isselected(element::Element)::Bool

The Is Element Selected command determines if the referenced element is selected or not. This operation only makes sense on input elements of the Checkbox and Radio Button states, or on option elements.

maximize!(session::Session; window::AbstractString = "current")::Dict{String,Int}

The Maximize Window command invokes the window manager-specific "maximize" operation, if any, on the window containing the current top-level browsing context. This typically increases the window to the maximum available size without going full-screen.

minimize!(session::Session; window::AbstractString = "current")::NamedTuple{(:width, :height, :x, :y),NTuple{4,Int64}}

The Minimize Window command invokes the window manager-specific "minimize" operation, if any, on the window containing the current top-level browsing context. This typically hides the window in the system tray.

moveto!(session::Session; x::Integer = 0, y::Integer = 0)
moveto!(element::Element; x::Integer = 0, y::Integer = 0)

Move the mouse by an offset of the specificed element.

navigate!(session::Session, url::AbstractString)

The command causes the user agent to navigate the current top-level browsing context to a new location.

parent_frame!(session::Session)::Nothing

The Switch to Parent Frame command sets the current browsing context for future commands to the parent of the current browsing context.

rect(session::Session; window::AbstractString = "current")::NamedTuple{(:width, :height, :x, :y),NTuple{4,Int64}}

The Get Window Rect command returns the size and position on the screen of the operating system window corresponding to the current top-level browsing context.

rect!(session::Session;
      window::AbstractString = "current",
      width::Union{Nothing, Real} = nothing,
      height::Union{Nothing, Real} = nothing
     )::NamedTuple{(:width, :height, :x, :y),NTuple{4,Int64}}

The Set Window Rect command alters the size and the position of the operating system window corresponding to the current top-level browsing context.

rect(element::Element)::NamedTuple{(:width, :height, :x, :y),NTuple{4,Int64}}

The Get Element Rect command returns the dimensions and coordinates of the given web element. The returned value is a dictionary with the following members:

• x: X axis position of the top-left corner of the web element relative to the current browsing context’s document element in CSS pixels.
• y: Y axis position of the top-left corner of the web element relative to the current browsing context’s document element in CSS pixels.
• height: Height of the web element’s bounding rectangle in CSS pixels.
• width: Width of the web element’s bounding rectangle in CSS pixels.

refresh!(session::Session)

This command causes the browser to reload the page in the current top-level browsing context.

screenshot(session::Session)::String
screenshot(element::Element)::String
screenshot(source::Union{Session, Element}, sink::Union{AbstractString, IO})

Take Screenshot and optionally saves it.

script!(session::Session, script::AbstractString, args...; async::Bool = false)

Executes JavaScript (sync / async)

sessions(wd::RemoteWebDriver)

Returns a list of the currently active sessions.

source(session::Session)::String

The Get Page Source command returns a string serialization of the DOM of the current browsing context active document.

status(wd::WebDriver)::Bool

Returns true if the server is running and ready to accept new sessions.

timeouts!(session::Session, timeouts::Timeouts)::Nothing

Sets the timeouts.

timeouts(session::Session)

Get the timeouts according to webdriver2. Currently not supported by Selenium.

window!(session::Session, handle::AbstractString)

The window handle associated with the current top-level browsing context.

window!(session::Session)

Create a new top-level browsing context.

window_close!(session::Session)::Nothing

The window handle associated with the current top-level browsing context.

window_handle(session::Session)::String

The window handle associated with the current top-level browsing context.

window_handles(session::Session)::Vector{String}

Switching window will select the current top-level browsing context used as the target for all subsequent commands. In a tabbed browser, this will typically make the tab containing the browsing context the selected tab.