1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
|
# frozen_string_literal: true
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module Selenium
module WebDriver
module Remote
class Bridge
autoload :COMMANDS, 'selenium/webdriver/remote/bridge/commands'
autoload :LocatorConverter, 'selenium/webdriver/remote/bridge/locator_converter'
include Atoms
PORT = 4444
attr_accessor :http, :file_detector
attr_reader :capabilities
class << self
attr_reader :extra_commands
attr_writer :element_class, :locator_converter
def add_command(name, verb, url, &block)
@extra_commands ||= {}
@extra_commands[name] = [verb, url]
define_method(name, &block)
end
def locator_converter
@locator_converter ||= LocatorConverter.new
end
def element_class
@element_class ||= Element
end
end
#
# Initializes the bridge with the given server URL
# @param [String, URI] url url for the remote server
# @param [Object] http_client an HTTP client instance that implements the same protocol as Http::Default
# @api private
#
def initialize(url:, http_client: nil)
uri = url.is_a?(URI) ? url : URI.parse(url)
uri.path += '/' unless uri.path.end_with?('/')
@http = http_client || Http::Default.new
@http.server_url = uri
@file_detector = nil
@locator_converter = self.class.locator_converter
end
#
# Creates session.
#
def create_session(capabilities)
response = execute(:new_session, {}, prepare_capabilities_payload(capabilities))
@session_id = response['sessionId']
capabilities = response['capabilities']
raise Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
@capabilities = Capabilities.json_create(capabilities)
case @capabilities[:browser_name]
when 'chrome', 'chrome-headless-shell'
extend(WebDriver::Chrome::Features)
when 'firefox'
extend(WebDriver::Firefox::Features)
when 'msedge', 'MicrosoftEdge'
extend(WebDriver::Edge::Features)
when 'Safari', 'Safari Technology Preview'
extend(WebDriver::Safari::Features)
when 'internet explorer'
extend(WebDriver::IE::Features)
end
end
#
# Returns the current session ID.
#
def session_id
@session_id || raise(Error::WebDriverError, 'no current session exists')
end
def browser
@browser ||= begin
name = @capabilities.browser_name
name ? name.tr(' -', '_').downcase.to_sym : 'unknown'
end
end
def status
execute :status
end
def get(url)
execute :get, {}, {url: url}
end
#
# timeouts
#
def timeouts
execute :get_timeouts, {}
end
def timeouts=(timeouts)
execute :set_timeout, {}, timeouts
end
#
# alerts
#
def accept_alert
execute :accept_alert
end
def dismiss_alert
execute :dismiss_alert
end
def alert=(keys)
execute :send_alert_text, {}, {value: keys.chars, text: keys}
end
def alert_text
execute :get_alert_text
end
#
# navigation
#
def go_back
execute :back
end
def go_forward
execute :forward
end
def url
execute :get_current_url
end
def title
execute :get_title
end
def page_source
execute :get_page_source
end
#
# Create a new top-level browsing context
# https://w3c.github.io/webdriver/#new-window
# @param type [String] Supports two values: 'tab' and 'window'.
# Use 'tab' if you'd like the new window to share an OS-level window
# with the current browsing context.
# Use 'window' otherwise
# @return [Hash] Containing 'handle' with the value of the window handle
# and 'type' with the value of the created window type
#
def new_window(type)
execute :new_window, {}, {type: type}
end
def switch_to_window(name)
execute :switch_to_window, {}, {handle: name}
end
def switch_to_frame(id)
id = find_element_by('id', id) if id.is_a? String
execute :switch_to_frame, {}, {id: id}
end
def switch_to_parent_frame
execute :switch_to_parent_frame
end
def switch_to_default_content
switch_to_frame nil
end
QUIT_ERRORS = [IOError].freeze
def quit
execute :delete_session
http.close
rescue *QUIT_ERRORS
nil
end
def close
execute :close_window
end
def refresh
execute :refresh
end
#
# window handling
#
def window_handles
execute :get_window_handles
end
def window_handle
execute :get_window_handle
end
def resize_window(width, height, handle = :current)
raise Error::WebDriverError, 'Switch to desired window before changing its size' unless handle == :current
set_window_rect(width: width, height: height)
end
def window_size(handle = :current)
unless handle == :current
raise Error::UnsupportedOperationError,
'Switch to desired window before getting its size'
end
data = execute :get_window_rect
Dimension.new data['width'], data['height']
end
def minimize_window
execute :minimize_window
end
def maximize_window(handle = :current)
unless handle == :current
raise Error::UnsupportedOperationError,
'Switch to desired window before changing its size'
end
execute :maximize_window
end
def full_screen_window
execute :fullscreen_window
end
def reposition_window(x, y)
set_window_rect(x: x, y: y)
end
def window_position
data = execute :get_window_rect
Point.new data['x'], data['y']
end
def set_window_rect(x: nil, y: nil, width: nil, height: nil)
params = {x: x, y: y, width: width, height: height}
params.update(params) { |_k, v| Integer(v) unless v.nil? }
execute :set_window_rect, {}, params
end
def window_rect
data = execute :get_window_rect
Rectangle.new data['x'], data['y'], data['width'], data['height']
end
def screenshot
execute :take_screenshot
end
def element_screenshot(element)
execute :take_element_screenshot, id: element
end
#
# javascript execution
#
def execute_script(script, *args)
result = execute :execute_script, {}, {script: script, args: args}
unwrap_script_result result
end
def execute_async_script(script, *args)
result = execute :execute_async_script, {}, {script: script, args: args}
unwrap_script_result result
end
#
# cookies
#
def manage
@manage ||= WebDriver::Manager.new(self)
end
def add_cookie(cookie)
execute :add_cookie, {}, {cookie: cookie}
end
def delete_cookie(name)
raise ArgumentError, 'Cookie name cannot be null or empty' if name.nil? || name.to_s.strip.empty?
execute :delete_cookie, name: name
end
def cookie(name)
execute :get_cookie, name: name
end
def cookies
execute :get_all_cookies
end
def delete_all_cookies
execute :delete_all_cookies
end
#
# actions
#
def action(async: false, devices: [], duration: 250)
ActionBuilder.new self, async: async, devices: devices, duration: duration
end
alias actions action
def send_actions(data)
execute :actions, {}, {actions: data}
end
def release_actions
execute :release_actions
end
def print_page(options = {})
execute :print_page, {}, {options: options}
end
def click_element(element)
execute :element_click, id: element
end
def send_keys_to_element(element, keys)
keys = upload_if_necessary(keys) if @file_detector
text = keys.join
execute :element_send_keys, {id: element}, {value: text.chars, text: text}
end
def clear_element(element)
execute :element_clear, id: element
end
def submit_element(element)
script = "/* submitForm */ var form = arguments[0];\n" \
"while (form.nodeName != \"FORM\" && form.parentNode) {\n " \
"form = form.parentNode;\n" \
"}\n" \
"if (!form) { throw Error('Unable to find containing form element'); }\n" \
"if (!form.ownerDocument) { throw Error('Unable to find owning document'); }\n" \
"var e = form.ownerDocument.createEvent('Event');\n" \
"e.initEvent('submit', true, true);\n" \
"if (form.dispatchEvent(e)) { HTMLFormElement.prototype.submit.call(form) }\n"
execute_script(script, Bridge.element_class::ELEMENT_KEY => element)
rescue Error::JavascriptError
raise Error::UnsupportedOperationError, 'To submit an element, it must be nested inside a form element'
end
#
# element properties
#
def element_tag_name(element)
execute :get_element_tag_name, id: element
end
def element_attribute(element, name)
WebDriver.logger.debug "Using script for :getAttribute of #{name}", id: :script
execute_atom :getAttribute, element, name
end
def element_dom_attribute(element, name)
execute :get_element_attribute, id: element, name: name
end
def element_property(element, name)
execute :get_element_property, id: element, name: name
end
def element_aria_role(element)
execute :get_element_aria_role, id: element
end
def element_aria_label(element)
execute :get_element_aria_label, id: element
end
def element_value(element)
element_property element, 'value'
end
def element_text(element)
execute :get_element_text, id: element
end
def element_location(element)
data = execute :get_element_rect, id: element
Point.new data['x'], data['y']
end
def element_rect(element)
data = execute :get_element_rect, id: element
Rectangle.new data['x'], data['y'], data['width'], data['height']
end
def element_location_once_scrolled_into_view(element)
send_keys_to_element(element, [''])
element_location(element)
end
def element_size(element)
data = execute :get_element_rect, id: element
Dimension.new data['width'], data['height']
end
def element_enabled?(element)
execute :is_element_enabled, id: element
end
def element_selected?(element)
execute :is_element_selected, id: element
end
def element_displayed?(element)
WebDriver.logger.debug 'Using script for :isDisplayed', id: :script
execute_atom :isDisplayed, element
end
def element_value_of_css_property(element, prop)
execute :get_element_css_value, id: element, property_name: prop
end
#
# finding elements
#
def active_element
Bridge.element_class.new self, element_id_from(execute(:get_active_element))
end
alias switch_to_active_element active_element
def find_element_by(how, what, parent_ref = [])
how, what = @locator_converter.convert(how, what)
return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'
parent_type, parent_id = parent_ref
id = case parent_type
when :element
execute :find_child_element, {id: parent_id}, {using: how, value: what.to_s}
when :shadow_root
execute :find_shadow_child_element, {id: parent_id}, {using: how, value: what.to_s}
else
execute :find_element, {}, {using: how, value: what.to_s}
end
Bridge.element_class.new self, element_id_from(id)
end
def find_elements_by(how, what, parent_ref = [])
how, what = @locator_converter.convert(how, what)
return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'
parent_type, parent_id = parent_ref
ids = case parent_type
when :element
execute :find_child_elements, {id: parent_id}, {using: how, value: what.to_s}
when :shadow_root
execute :find_shadow_child_elements, {id: parent_id}, {using: how, value: what.to_s}
else
execute :find_elements, {}, {using: how, value: what.to_s}
end
ids.map { |id| Bridge.element_class.new self, element_id_from(id) }
end
def shadow_root(element)
id = execute :get_element_shadow_root, id: element
ShadowRoot.new self, shadow_root_id_from(id)
end
#
# virtual-authenticator
#
def add_virtual_authenticator(options)
authenticator_id = execute :add_virtual_authenticator, {}, options.as_json
VirtualAuthenticator.new(self, authenticator_id, options)
end
def remove_virtual_authenticator(id)
execute :remove_virtual_authenticator, {authenticatorId: id}
end
def add_credential(credential, id)
execute :add_credential, {authenticatorId: id}, credential
end
def credentials(authenticator_id)
execute :get_credentials, {authenticatorId: authenticator_id}
end
def remove_credential(credential_id, authenticator_id)
execute :remove_credential, {credentialId: credential_id, authenticatorId: authenticator_id}
end
def remove_all_credentials(authenticator_id)
execute :remove_all_credentials, {authenticatorId: authenticator_id}
end
def user_verified(verified, authenticator_id)
execute :set_user_verified, {authenticatorId: authenticator_id}, {isUserVerified: verified}
end
#
# federated-credential management
#
def cancel_fedcm_dialog
execute :cancel_fedcm_dialog
end
def select_fedcm_account(index)
execute :select_fedcm_account, {}, {accountIndex: index}
end
def fedcm_dialog_type
execute :get_fedcm_dialog_type
end
def fedcm_title
execute(:get_fedcm_title).fetch('title')
end
def fedcm_subtitle
execute(:get_fedcm_title).fetch('subtitle', nil)
end
def fedcm_account_list
execute :get_fedcm_account_list
end
def fedcm_delay(enabled)
execute :set_fedcm_delay, {}, {enabled: enabled}
end
def reset_fedcm_cooldown
execute :reset_fedcm_cooldown
end
def click_fedcm_dialog_button
execute :click_fedcm_dialog_button, {}, {dialogButton: 'ConfirmIdpLoginContinue'}
end
def bidi
msg = 'BiDi must be enabled by setting #web_socket_url to true in options class'
raise(WebDriver::Error::WebDriverError, msg)
end
def command_list
COMMANDS
end
private
#
# executes a command on the remote server.
#
# @return [WebDriver::Remote::Response]
#
def execute(command, opts = {}, command_hash = nil)
verb, path = commands(command) || raise(ArgumentError, "unknown command: #{command.inspect}")
path = path.dup
path[':session_id'] = session_id if path.include?(':session_id')
begin
opts.each { |key, value| path[key.inspect] = escaper.escape(value.to_s) }
rescue IndexError
raise ArgumentError, "#{opts.inspect} invalid for #{command.inspect}"
end
WebDriver.logger.debug("-> #{verb.to_s.upcase} #{path}", id: :command)
http.call(verb, path, command_hash)['value']
end
def escaper
@escaper ||= defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
end
def commands(command)
command_list[command] || Bridge.extra_commands[command]
end
def unwrap_script_result(arg)
case arg
when Array
arg.map { |e| unwrap_script_result(e) }
when Hash
element_id = element_id_from(arg)
return Bridge.element_class.new(self, element_id) if element_id
shadow_root_id = shadow_root_id_from(arg)
return ShadowRoot.new self, shadow_root_id if shadow_root_id
arg.each { |k, v| arg[k] = unwrap_script_result(v) }
else
arg
end
end
def element_id_from(id)
id['ELEMENT'] || id[Bridge.element_class::ELEMENT_KEY]
end
def shadow_root_id_from(id)
id[ShadowRoot::ROOT_KEY]
end
def prepare_capabilities_payload(capabilities)
capabilities = {alwaysMatch: capabilities} if !capabilities['alwaysMatch'] && !capabilities['firstMatch']
{capabilities: capabilities}
end
end # Bridge
end # Remote
end # WebDriver
end # Selenium
|