selenium-webdriver 4.0.0.beta2 → 4.0.0.rc2

data/lib/selenium/webdriver/remote/capabilities.rb

@@ -39,23 +39,17 @@ module Selenium
           :timeouts,
           :unhandled_prompt_behavior,
           :strict_file_interactability,
+          :web_socket_url,
 
-          # remote-specific
-          :remote_session_id,
-
-          # TODO: (AR) deprecate compatibility with OSS-capabilities
-          :implicit_timeout,
-          :page_load_timeout,
-          :script_timeout
+          # remote-specific (webdriver.remote.sessionid)
+          :remote_session_id
         ].freeze
 
-        KNOWN.each do |key|
+        (KNOWN - %i[proxy timeouts]).each do |key|
           define_method key do
-            @capabilities.fetch(key)
+            @capabilities[key]
           end
 
-          next if key == :proxy
-
           define_method "#{key}=" do |value|
             @capabilities[key] = value
           end
@@ -89,16 +83,10 @@ module Selenium
           alias_method :microsoftedge, :edge
 
           def firefox(opts = {})
-            opts[:browser_version] = opts.delete(:version) if opts.key?(:version)
-            opts[:platform_name] = opts.delete(:platform) if opts.key?(:platform)
-            opts[:timeouts] = {}
-            opts[:timeouts]['implicit'] = opts.delete(:implicit_timeout) if opts.key?(:implicit_timeout)
-            opts[:timeouts]['pageLoad'] = opts.delete(:page_load_timeout) if opts.key?(:page_load_timeout)
-            opts[:timeouts]['script'] = opts.delete(:script_timeout) if opts.key?(:script_timeout)
-            opts.delete(:timeouts) if opts[:timeouts].empty?
-            new({browser_name: 'firefox'}.merge(opts))
+            new({
+              browser_name: 'firefox'
+            }.merge(opts))
           end
-
           alias_method :ff, :firefox
 
           def safari(opts = {})
@@ -121,18 +109,21 @@ module Selenium
           end
           alias_method :ie, :internet_explorer
 
+          def always_match(capabilities)
+            new(always_match: capabilities)
+          end
+
+          def first_match(*capabilities)
+            new(first_match: capabilities)
+          end
+
           #
           # @api private
           #
 
           def json_create(data)
             data = data.dup
-
             caps = new
-            (KNOWN - %i[timeouts proxy]).each do |cap|
-              data_value = camel_case(cap)
-              caps[cap] = data.delete(data_value) if data.key?(data_value)
-            end
 
             process_timeouts(caps, data.delete('timeouts'))
 
@@ -146,6 +137,11 @@ module Selenium
               caps[:remote_session_id] = data.delete('webdriver.remote.sessionid')
             end
 
+            KNOWN.each do |cap|
+              data_value = camel_case(cap)
+              caps[cap] = data.delete(data_value) if data.key?(data_value)
+            end
+
             # any remaining pairs will be added as is, with no conversion
             caps.merge!(data)
 
@@ -179,8 +175,9 @@ module Selenium
         #
 
         def initialize(opts = {})
-          @capabilities = opts
-          self.proxy = opts.delete(:proxy)
+          @capabilities = {}
+          self.proxy = opts.delete(:proxy) if opts[:proxy]
+          @capabilities.merge!(opts)
         end
 
         #
@@ -205,6 +202,10 @@ module Selenium
           end
         end
 
+        def proxy
+          @capabilities[:proxy]
+        end
+
         def proxy=(proxy)
           case proxy
           when Hash
@@ -216,33 +217,46 @@ module Selenium
           end
         end
 
+        def timeouts
+          @capabilities[:timeouts] ||= {}
+        end
+
+        def timeouts=(timeouts)
+          @capabilities[:timeouts] = timeouts
+        end
+
+        def implicit_timeout
+          timeouts[:implicit]
+        end
+
+        def implicit_timeout=(timeout)
+          timeouts[:implicit] = timeout
+        end
+
+        def page_load_timeout
+          timeouts[:page_load] || timeouts[:pageLoad]
+        end
+
+        def page_load_timeout=(timeout)
+          timeouts[:page_load] = timeout
+        end
+
+        def script_timeout
+          timeouts[:script]
+        end
+
+        def script_timeout=(timeout)
+          timeouts[:script] = timeout
+        end
+
         #
         # @api private
         #
 
         def as_json(*)
-          hash = {}
-
-          @capabilities.each do |key, value|
-            case key
-            when :platform
-              hash['platform'] = value.to_s.upcase
-            when :proxy
-              next unless value
-
-              process_proxy(hash, value)
-            when :unhandled_prompt_behavior
-              hash['unhandledPromptBehavior'] = value.is_a?(Symbol) ? value.to_s.tr('_', ' ') : value
-            when String
-              hash[key.to_s] = value
-            when Symbol
-              hash[self.class.camel_case(key)] = value
-            else
-              raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class} / #{value.inspect}"
-            end
+          @capabilities.each_with_object({}) do |(key, value), hash|
+            hash[convert_key(key)] = process_capabilities(key, value, hash)
           end
-
-          hash
         end
 
         def to_json(*)
@@ -263,13 +277,43 @@ module Selenium
 
         private
 
-        def process_proxy(hash, value)
-          hash['proxy'] = value.as_json
-          hash['proxy']['proxyType'] &&= hash['proxy']['proxyType'].downcase
+        def process_capabilities(key, value, hash)
+          case value
+          when Array
+            value.map { |v| process_capabilities(key, v, hash) }
+          when Hash
+            value.each_with_object({}) do |(k, v), h|
+              h[convert_key(k)] = process_capabilities(k, v, h)
+            end
+          when Capabilities, Options
+            value.as_json
+          else
+            convert_value(key, value)
+          end
+        end
 
-          return unless hash['proxy']['noProxy'].is_a?(String)
+        def convert_key(key)
+          case key
+          when String
+            key.to_s
+          when Symbol
+            self.class.camel_case(key)
+          else
+            raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
+          end
+        end
 
-          hash['proxy']['noProxy'] = hash['proxy']['noProxy'].split(', ')
+        def convert_value(key, value)
+          case key
+          when :platform
+            value.to_s.upcase
+          when :proxy
+            value&.as_json
+          when :unhandled_prompt_behavior
+            value.is_a?(Symbol) ? value.to_s.tr('_', ' ') : value
+          else
+            value
+          end
         end
       end # Capabilities
     end # Remote

data/lib/selenium/webdriver/remote/commands.rb

@@ -77,11 +77,16 @@ module Selenium
           find_elements: [:post, 'session/:session_id/elements'],
           find_child_element: [:post, 'session/:session_id/element/:id/element'],
           find_child_elements: [:post, 'session/:session_id/element/:id/elements'],
+          find_shadow_child_element: [:post, 'session/:session_id/shadow/:id/element'],
+          find_shadow_child_elements: [:post, 'session/:session_id/shadow/:id/elements'],
           get_active_element: [:get, 'session/:session_id/element/active'],
+          get_element_shadow_root: [:get, 'session/:session_id/element/:id/shadow'],
           is_element_selected: [:get, 'session/:session_id/element/:id/selected'],
           get_element_attribute: [:get, 'session/:session_id/element/:id/attribute/:name'],
           get_element_property: [:get, 'session/:session_id/element/:id/property/:name'],
           get_element_css_value: [:get, 'session/:session_id/element/:id/css/:property_name'],
+          get_element_aria_role: [:get, 'session/:session_id/element/:id/computedrole'],
+          get_element_aria_label: [:get, 'session/:session_id/element/:id/computedlabel'],
           get_element_text: [:get, 'session/:session_id/element/:id/text'],
           get_element_tag_name: [:get, 'session/:session_id/element/:id/name'],
           get_element_rect: [:get, 'session/:session_id/element/:id/rect'],

data/lib/selenium/webdriver/remote/driver.rb

@@ -42,19 +42,19 @@ module Selenium
           end
           opts[:url] ||= "http://#{Platform.localhost}:4444/wd/hub"
           super
-        end
-
-        def print_page(**options)
-          options[:page_ranges] &&= Array(options[:page_ranges])
-
-          @bridge.print_page(options)
+          @bridge.file_detector = ->((filename, *)) { File.exist?(filename) && filename.to_s }
         end
 
         private
 
-        def devtools_address
+        def devtools_url
           capabilities['se:cdp']
         end
+
+        def devtools_version
+          capabilities['se:cdpVersion']&.split('.')&.first ||
+            raise(Error::WebDriverError, "DevTools is not supported by the Remote Server")
+        end
       end # Driver
     end # Remote
   end # WebDriver

data/lib/selenium/webdriver/remote.rb

@@ -18,6 +18,7 @@
 # under the License.
 
 require 'uri'
+require 'selenium/webdriver/remote/server_error'
 
 module Selenium
   module WebDriver
@@ -25,7 +26,6 @@ module Selenium
       autoload :Bridge, 'selenium/webdriver/remote/bridge'
       autoload :Driver, 'selenium/webdriver/remote/driver'
       autoload :Response, 'selenium/webdriver/remote/response'
-      autoload :ServerError, 'selenium/webdriver/remote/server_error'
       autoload :Capabilities, 'selenium/webdriver/remote/capabilities'
       autoload :COMMANDS, 'selenium/webdriver/remote/commands'
       module Http

data/lib/selenium/webdriver/safari/driver.rb

@@ -28,7 +28,7 @@ module Selenium
 
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasDebugger,
-                      DriverExtensions::HasPermissions,
+                      DriverExtensions::HasApplePermissions,
                       DriverExtensions::HasWebStorage].freeze
 
         def browser

data/lib/selenium/webdriver/safari/options.rb

@@ -28,6 +28,13 @@ module Selenium
                         automatic_profiling: 'safari:automaticProfiling'}.freeze
         BROWSER = 'safari'
 
+        def add_option(name, value = nil)
+          key = name.is_a?(Hash) ? name.keys.first : name
+          raise ArgumentError, 'Safari does not support options that are not namespaced' unless key.to_s.include?(':')
+
+          super
+        end
+
       end # Options
     end # Safari
   end # WebDriver

data/lib/selenium/webdriver/support/cdp/domain.rb.erb

@@ -0,0 +1,63 @@
+# 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.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module DevTools
+    module <%= version %>
+      class <%= domain[:domain] %>
+        <% if domain[:events] %>
+        EVENTS = {
+          <% domain[:events].each do |event| %>
+          <%= h.snake_case(event[:name]) %>: '<%= event[:name] %>',
+          <% end %>
+        }.freeze
+        <% end %>
+
+        def initialize(devtools)
+          @devtools = devtools
+        end
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @devtools.callbacks["<%= domain[:domain] %>.#{event}"] << block
+        end
+
+        <% domain[:commands].each do |command| %>
+        <% if command[:parameters] %>
+        def <%= h.snake_case(command[:name]) %>(<%= h.kwargs(command[:parameters]) %>)
+        <% else %>
+        def <%= h.snake_case(command[:name]) %>
+        <% end %>
+          <% if command[:parameters] %>
+          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>',
+            <% until command[:parameters].empty? %>
+              <% parameter = command[:parameters].shift %>
+                             <%= parameter[:name] %>: <%= h.snake_case(parameter[:name]) %><%= command[:parameters].empty? ? ')' : ',' %>
+            <% end %>
+          <% else %>
+          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>')
+          <% end %>
+        end
+
+        <% end %>
+      end # <%= domain[:domain] %>
+    end # <%= version %>
+  end # DevTools
+end # Selenium

data/lib/selenium/webdriver/support/cdp_client_generator.rb

@@ -0,0 +1,108 @@
+# 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.
+
+require 'erb'
+require 'fileutils'
+require 'json'
+
+module Selenium
+  module WebDriver
+    module Support
+      class CDPClientGenerator
+        # Input JSON files are generated from PDL tasks.
+        TEMPLATE_PATH = File.expand_path('cdp/domain.rb.erb', __dir__)
+
+        RESERVED_KEYWORDS = %w[end].freeze
+
+        def call(output_dir:, version:, browser_protocol_path: nil, js_protocol_path: nil, loader_path: nil, **)
+          @template = ERB.new(File.read(TEMPLATE_PATH))
+          @output_dir = output_dir
+          @loader_path = loader_path || "#{@output_dir}.rb"
+          @version = version
+
+          browser_protocol_path ||= File.expand_path('cdp/browser_protocol.json', __dir__)
+          js_protocol_path ||= File.expand_path('cdp/js_protocol.json', __dir__)
+
+          browser_protocol = JSON.parse(File.read(browser_protocol_path), symbolize_names: true)
+          js_protocol = JSON.parse(File.read(js_protocol_path), symbolize_names: true)
+
+          FileUtils.mkdir_p(@output_dir)
+
+          browser_protocol[:domains].each(&method(:process_domain))
+          js_protocol[:domains].each(&method(:process_domain))
+          require_file
+        end
+
+        def process_domain(domain)
+          result = @template.result_with_hash(domain: domain, version: @version.upcase, h: self)
+          filename = File.join(@output_dir, "#{snake_case(domain[:domain])}.rb")
+          File.write(filename, remove_empty_lines(result))
+        end
+
+        def snake_case(string)
+          name = string.gsub('JavaScript', 'Javascript')
+                       .gsub(/([A-Z]+)([A-Z][a-z]{2,})/, '\1_\2')
+                       .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                       .downcase
+          # Certain CDP parameters conflict with Ruby keywords
+          # so we prefix the name with underscore.
+          name = "_#{name}" if RESERVED_KEYWORDS.include?(name)
+
+          name
+        end
+
+        def kwargs(parameters)
+          parameters = parameters.map do |parameter|
+            if parameter[:optional]
+              "#{snake_case(parameter[:name])}: nil"
+            else
+              "#{snake_case(parameter[:name])}:"
+            end
+          end
+          parameters.join(', ')
+        end
+
+        def remove_empty_lines(string)
+          string.split("\n").reject { |l| l =~ /^\s+$/ }.join("\n")
+        end
+
+        def require_file
+          # rubocop:disable Lint/InterpolationCheck
+          dynamic_location = '#{File.dirname(File.absolute_path(__FILE__))}'
+          # rubocop:enable Lint/InterpolationCheck
+
+          require_all = "Dir.glob(\"#{dynamic_location}/#{@version}/*\", &method(:require))"
+          File.open(@loader_path, 'w') { |file| file.write(require_all) }
+        end
+      end
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  browser_protocol_path, js_protocol_path, output_dir, loader_path, version = *ARGV
+
+  Selenium::WebDriver::Support::CDPClientGenerator.new.call(
+    browser_protocol_path: browser_protocol_path,
+    js_protocol_path: js_protocol_path,
+    output_dir: output_dir,
+    loader_path: loader_path,
+    version: version
+  )
+end

data/lib/selenium/webdriver/support/event_firing_bridge.rb

@@ -76,7 +76,7 @@ module Selenium
             @delegate.find_element_by how, what, parent
           end
 
-          Element.new self, e.ref
+          Element.new self, e.ref.last
         end
 
         def find_elements_by(how, what, parent = nil)
@@ -84,7 +84,7 @@ module Selenium
             @delegate.find_elements_by(how, what, parent)
           end
 
-          es.map { |e| Element.new self, e.ref }
+          es.map { |e| Element.new self, e.ref.last }
         end
 
         def execute_script(script, *args)

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.0.0.beta2'
+    VERSION = '4.0.0.rc2'
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver.rb

@@ -23,7 +23,7 @@ require 'fileutils'
 require 'date'
 require 'json'
 require 'set'
-require 'websocket'
+require 'uri'
 
 require 'selenium/webdriver/atoms'
 require 'selenium/webdriver/common'

data/selenium-webdriver.gemspec

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+root = File.expand_path(File.dirname(__FILE__))
+raise "cwd must be #{root} when reading gemspec" if root != Dir.pwd
+
+$LOAD_PATH.push(File.expand_path('lib', root))
+require 'selenium/webdriver/version'
+
+Gem::Specification.new do |s|
+  s.name = 'selenium-webdriver'
+  s.version = Selenium::WebDriver::VERSION
+
+  s.authors = ['Alex Rodionov', 'Titus Fortner', 'Thomas Walpole']
+  s.email = %w[p0deje@gmail.com titusfortner@gmail.com twalpole@gmail.com]
+
+  s.summary = 'Selenium is a browser automation tool for automated testing of webapps and more'
+  s.description = <<-DESCRIPTION
+    Selenium implements the W3C WebDriver protocol to automate popular browsers.
+    It aims to mimic the behaviour of a real user as it interacts with the application's HTML.
+    It's primarily intended for web application testing, but any web-based task can automated.
+  DESCRIPTION
+
+  s.license = 'Apache-2.0'
+  s.homepage = 'https://selenium.dev'
+  s.metadata = {
+    'changelog_uri' => 'https://github.com/SeleniumHQ/selenium/blob/trunk/rb/CHANGES',
+    'source_code_uri' => 'https://github.com/SeleniumHQ/selenium/tree/trunk/rb'
+  }
+
+  s.required_rubygems_version = Gem::Requirement.new('> 1.3.1') if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = Gem::Requirement.new('>= 2.5')
+
+  s.files = [
+    'CHANGES',
+    'LICENSE',
+    'NOTICE',
+    'Gemfile',
+    'README.md',
+    'selenium-webdriver.gemspec',
+    'lib/selenium-webdriver.rb',
+    'lib/selenium/server.rb',
+    'lib/selenium/webdriver.rb'
+  ] + Dir['lib/selenium/webdriver/**/*']
+
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'childprocess', ['>= 0.5', '< 5.0']
+  s.add_runtime_dependency 'rexml', ['~> 3.2']
+  s.add_runtime_dependency 'rubyzip', ['>= 1.2.2']
+
+  # childprocess requires ffi on windows but doesn't declare it in its dependencies
+  s.add_development_dependency 'ffi'
+  s.add_development_dependency 'pry', ['~> 0.14']
+  s.add_development_dependency 'rack', ['~> 2.0']
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', ['~> 3.0']
+  s.add_development_dependency 'rubocop', ['~> 1.8.0']
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'webmock', ['~> 3.5']
+  s.add_development_dependency 'webrick', ['~> 1.7']
+  s.add_development_dependency 'yard', ['~> 0.9.11']
+end