selenium-webdriver 2.45.0 → 3.142.7

data/lib/selenium/webdriver/chrome/service.rb

@@ -1,75 +1,59 @@
+# 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 Chrome
-
       #
       # @api private
       #
 
-      class Service
-        START_TIMEOUT = 20
-        STOP_TIMEOUT  = 5
-        DEFAULT_PORT  = 9515
-        MISSING_TEXT  = "Unable to find the chromedriver executable. Please download the server from http://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH. More info at http://code.google.com/p/selenium/wiki/ChromeDriver."
-
-        attr_reader :uri
-
-        def self.executable_path
-          @executable_path ||= (
-            path = Platform.find_binary "chromedriver"
-            path or raise Error::WebDriverError, MISSING_TEXT
-            Platform.assert_executable path
-
-            path
-          )
+      class Service < WebDriver::Service
+        @default_port = 9515
+        @executable = 'chromedriver'
+        @missing_text = <<~ERROR
+          Unable to find chromedriver. Please download the server from
+          https://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH.
+          More info at https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver.
+        ERROR
+        @shutdown_supported = true
+
+        def self.driver_path=(path)
+          Platform.assert_executable path if path.is_a?(String)
+          @driver_path = path
         end
 
-        def self.executable_path=(path)
-          Platform.assert_executable path
-          @executable_path = path
-        end
-
-        def self.default_service(*extra_args)
-          new executable_path, PortProber.above(DEFAULT_PORT), *extra_args
-        end
-
-        def initialize(executable_path, port, *extra_args)
-          @uri           = URI.parse "http://#{Platform.localhost}:#{port}"
-          server_command = [executable_path, "--port=#{port}", *extra_args]
-
-          @process       = ChildProcess.build(*server_command)
-          @socket_poller = SocketPoller.new Platform.localhost, port, START_TIMEOUT
-
-          @process.io.inherit! if $DEBUG == true
-        end
-
-        def start
-          @process.start
-
-          unless @socket_poller.connected?
-            raise Error::WebDriverError, "unable to connect to chromedriver #{@uri}"
-          end
-
-          Platform.exit_hook { stop } # make sure we don't leave the server running
-        end
-
-        def stop
-          return if @process.nil? || @process.exited?
-
-          Net::HTTP.start(uri.host, uri.port) do |http|
-            http.open_timeout = STOP_TIMEOUT / 2
-            http.read_timeout = STOP_TIMEOUT / 2
-
-            http.head("/shutdown")
-          end
-
-          @process.poll_for_exit STOP_TIMEOUT
-        rescue ChildProcess::TimeoutError
-          # ok, force quit
-          @process.stop STOP_TIMEOUT
+        private
+
+        # Note: This processing is deprecated
+        def extract_service_args(driver_opts)
+          driver_args = super
+          driver_opts = driver_opts.dup
+          driver_args << "--log-path=#{driver_opts.delete(:log_path)}" if driver_opts.key?(:log_path)
+          driver_args << "--url-base=#{driver_opts.delete(:url_base)}" if driver_opts.key?(:url_base)
+          driver_args << "--port-server=#{driver_opts.delete(:port_server)}" if driver_opts.key?(:port_server)
+          driver_args << "--whitelisted-ips=#{driver_opts.delete(:whitelisted_ips)}" if driver_opts.key?(:whitelisted_ips)
+          driver_args << "--verbose" if driver_opts.key?(:verbose)
+          driver_args << "--silent" if driver_opts.key?(:silent)
+          driver_args
         end
       end # Service
-
     end # Chrome
   end # WebDriver
-end # Service
+end # Selenium

data/lib/selenium/webdriver/chrome.rb

@@ -1,15 +1,42 @@
+# 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 'net/http'
 
-require 'selenium/webdriver/chrome/service'
 require 'selenium/webdriver/chrome/bridge'
+require 'selenium/webdriver/chrome/driver'
 require 'selenium/webdriver/chrome/profile'
+require 'selenium/webdriver/chrome/options'
 
 module Selenium
   module WebDriver
-
     module Chrome
       def self.driver_path=(path)
-        Service.executable_path = path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path=',
+                                   'Selenium::WebDriver::Chrome::Service#driver_path='
+        Selenium::WebDriver::Chrome::Service.driver_path = path
+      end
+
+      def self.driver_path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path',
+                                   'Selenium::WebDriver::Chrome::Service#driver_path'
+        Selenium::WebDriver::Chrome::Service.driver_path
       end
 
       def self.path=(path)
@@ -20,7 +47,8 @@ module Selenium
       def self.path
         @path ||= nil
       end
+    end # Chrome
+  end # WebDriver
+end # Selenium
 
-    end
-  end
-end
+require 'selenium/webdriver/chrome/service'

data/lib/selenium/webdriver/common/action_builder.rb

@@ -1,13 +1,29 @@
+# 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
-
     #
     # The ActionBuilder provides the user a way to set up and perform
     # complex user interactions.
     #
-    # This class should not be instantiated directly, but is created by
-    # Selenium::WebDriver::DriverExtensions::HasInputDevices#action, which
-    # is available on Driver instances that support the user interaction API.
+    # This class should not be instantiated directly, but is created by Driver#action
     #
     # @example
     #
@@ -20,18 +36,17 @@ module Selenium
     #
 
     class ActionBuilder
-
       #
       # @api private
       #
 
       def initialize(mouse, keyboard)
-        @devices    = {
-          :mouse    => mouse,
-          :keyboard => keyboard
+        @devices = {
+          mouse: mouse,
+          keyboard: keyboard
         }
 
-        @actions  = []
+        @actions = []
       end
 
       #
@@ -51,19 +66,19 @@ module Selenium
       #
       # @example Press a key on an element
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    el = driver.find_element(id: "some_id")
       #    driver.action.key_down(el, :shift).perform
       #
-      # @param [:shift, :alt, :control, :command, :meta] The key to press.
-      # @param [Selenium::WebDriver::Element] element An optional element
+      # @overload key_down(key)
+      #   @param [:shift, :alt, :control, :command, :meta] key The modifier key to press
+      # @overload key_down(element, key)
+      #   @param [Element] element An optional element to move to first
+      #   @param [:shift, :alt, :control, :command, :meta] key The modifier key to press
       # @raise [ArgumentError] if the given key is not a modifier
-      # @return [ActionBuilder] A self reference.
-      #
+      # @return [ActionBuilder] A self reference
 
       def key_down(*args)
-        if args.first.kind_of? Element
-          @actions << [:mouse, :click, [args.shift]]
-        end
+        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
         @actions << [:keyboard, :press, args]
         self
@@ -79,19 +94,20 @@ module Selenium
       #
       # @example Release a key from an element
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.key_up(el, :alt).perform
       #
-      # @param [:shift, :alt, :control, :command, :meta] The modifier key to release.
-      # @param [Selenium::WebDriver::Element] element An optional element
-      # @raise [ArgumentError] if the given key is not a modifier key
-      # @return [ActionBuilder] A self reference.
+      # @overload key_up(key)
+      #   @param [:shift, :alt, :control, :command, :meta] key The modifier key to release
+      # @overload key_up(element, key)
+      #   @param [Element] element An optional element to move to first
+      #   @param [:shift, :alt, :control, :command, :meta] key The modifier key to release
+      # @raise [ArgumentError] if the given key is not a modifier
+      # @return [ActionBuilder] A self reference
       #
 
       def key_up(*args)
-        if args.first.kind_of? Element
-          @actions << [:mouse, :click, [args.shift]]
-        end
+        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
         @actions << [:keyboard, :release, args]
         self
@@ -106,22 +122,23 @@ module Selenium
       #
       # @example Send the text "help" to an element
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.send_keys(el, "help").perform
       #
       # @example Send the text "help" to the currently focused element
       #
       #   driver.action.send_keys("help").perform
       #
-      # @param [Selenium::WebDriver::Element] element An optional element
-      # @param [String] keys The keys to be sent.
-      # @return [ActionBuilder] A self reference.
+      # @overload send_keys(keys)
+      #   @param [Array, Symbol, String] keys The key(s) to press and release
+      # @overload send_keys(element, keys)
+      #   @param [Element] element An optional element to move to first
+      #   @param [Array, Symbol, String] keys The key(s) to press and release
+      # @return [ActionBuilder] A self reference
       #
 
       def send_keys(*args)
-        if args.first.kind_of? Element
-          @actions << [:mouse, :click, [args.shift]]
-        end
+        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
         @actions << [:keyboard, :send_keys, args]
         self
@@ -135,10 +152,10 @@ module Selenium
       #
       # @example Clicking and holding on some element
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    el = driver.find_element(id: "some_id")
       #    driver.action.click_and_hold(el).perform
       #
-      # @param [Selenium::WebDriver::Element] element the element to move to and click.
+      # @param [Element] element the element to move to and click.
       # @return [ActionBuilder] A self reference.
       #
 
@@ -152,7 +169,7 @@ module Selenium
       #
       # @example Releasing an element after clicking and holding it
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    el = driver.find_element(id: "some_id")
       #    driver.action.click_and_hold(el).release.perform
       #
       # @return [ActionBuilder] A self reference.
@@ -172,7 +189,7 @@ module Selenium
       #
       # @example Clicking on an element
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    el = driver.find_element(id: "some_id")
       #    driver.action.click(el).perform
       #
       # @example Clicking at the current mouse position
@@ -195,7 +212,7 @@ module Selenium
       #
       # @example Double click an element
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    el = driver.find_element(id: "some_id")
       #    driver.action.double_click(el).perform
       #
       # @param [Selenium::WebDriver::Element] element An optional element to move to.
@@ -216,12 +233,12 @@ module Selenium
       #
       # @example Scroll element into view and move the mouse to it
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.move_to(el).perform
       #
       # @example
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.move_to(el, 100, 100).perform
       #
       # @param [Selenium::WebDriver::Element] element to move to.
@@ -233,11 +250,11 @@ module Selenium
       #
 
       def move_to(element, right_by = nil, down_by = nil)
-        if right_by && down_by
-          @actions << [:mouse, :move_to, [element, right_by, down_by]]
-        else
-          @actions << [:mouse, :move_to, [element]]
-        end
+        @actions << if right_by && down_by
+                      [:mouse, :move_to, [element, Integer(right_by), Integer(down_by)]]
+                    else
+                      [:mouse, :move_to, [element]]
+                    end
 
         self
       end
@@ -262,7 +279,7 @@ module Selenium
       #
 
       def move_by(right_by, down_by)
-        @actions << [:mouse, :move_by, [right_by, down_by]]
+        @actions << [:mouse, :move_by, [Integer(right_by), Integer(down_by)]]
         self
       end
 
@@ -272,7 +289,7 @@ module Selenium
       #
       # @example Context-click at middle of given element
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.context_click(el).perform
       #
       # @param [Selenium::WebDriver::Element] element An element to context click.
@@ -291,8 +308,8 @@ module Selenium
       #
       # @example Drag and drop one element onto another
       #
-      #   el1 = driver.find_element(:id, "some_id1")
-      #   el2 = driver.find_element(:id, "some_id2")
+      #   el1 = driver.find_element(id: "some_id1")
+      #   el2 = driver.find_element(id: "some_id2")
       #   driver.action.drag_and_drop(el1, el2).perform
       #
       # @param [Selenium::WebDriver::Element] source element to emulate button down at.
@@ -304,7 +321,7 @@ module Selenium
       def drag_and_drop(source, target)
         click_and_hold source
         move_to        target
-        release        target
+        release
 
         self
       end
@@ -315,14 +332,12 @@ module Selenium
       #
       # @example Drag and drop an element by offset
       #
-      #   el = driver.find_element(:id, "some_id1")
+      #   el = driver.find_element(id: "some_id1")
       #   driver.action.drag_and_drop_by(el, 100, 100).perform
       #
       # @param [Selenium::WebDriver::Element] source Element to emulate button down at.
       # @param [Integer] right_by horizontal move offset.
       # @param [Integer] down_by vertical move offset.
-      # @param [Selenium::WebDriver::Element] target Element to move to and release the
-      #   mouse at.
       # @return [ActionBuilder] A self reference.
       #
 
@@ -334,19 +349,17 @@ module Selenium
         self
       end
 
-
       #
       # Executes the actions added to the builder.
       #
 
       def perform
-        @actions.each { |receiver, method, args|
+        @actions.each do |receiver, method, args|
           @devices.fetch(receiver).__send__(method, *args)
-        }
+        end
 
         nil
       end
-
     end # ActionBuilder
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/alert.rb

@@ -1,30 +1,47 @@
+# 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
     class Alert
-
       def initialize(bridge)
         @bridge = bridge
 
         # fail fast if the alert doesn't exist
-        bridge.getAlertText
+        bridge.alert_text
       end
 
       def accept
-        @bridge.acceptAlert
+        @bridge.accept_alert
       end
 
       def dismiss
-        @bridge.dismissAlert
+        @bridge.dismiss_alert
       end
 
       def send_keys(keys)
-        @bridge.setAlertValue keys
+        @bridge.alert = keys
       end
 
       def text
-        @bridge.getAlertText
+        @bridge.alert_text
       end
-
     end # Alert
   end # WebDriver
-end # Selenium
+end # Selenium

data/lib/selenium/webdriver/common/bridge_helper.rb

@@ -1,6 +1,24 @@
+# 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
-
     #
     # Shared across bridges
     #
@@ -8,52 +26,50 @@ module Selenium
     #
 
     module BridgeHelper
-
       def unwrap_script_result(arg)
         case arg
         when Array
           arg.map { |e| unwrap_script_result(e) }
         when Hash
-          if id = element_id_from(arg)
-            Element.new self, id
-          else
-            arg.each { |k, v| arg[k] = unwrap_script_result(v) }
-          end
+          element_id = element_id_from(arg)
+          return Element.new(self, element_id) if element_id
+
+          arg.each { |k, v| arg[k] = unwrap_script_result(v) }
         else
           arg
         end
       end
 
       def element_id_from(id)
-        id['ELEMENT']
+        id['ELEMENT'] || id['element-6066-11e4-a52e-4f735466cecf']
       end
 
       def parse_cookie_string(str)
         result = {
-          'name'    => '',
-          'value'   => '',
-          'domain'  => '',
-          'path'    => '',
+          'name' => '',
+          'value' => '',
+          'domain' => '',
+          'path' => '',
           'expires' => '',
-          'secure'  => false
+          'secure' => false
         }
 
-        str.split(";").each do |attribute|
-          if attribute.include? "="
-            key, value = attribute.strip.split("=", 2)
+        str.split(';').each do |attribute|
+          if attribute.include? '='
+            key, value = attribute.strip.split('=', 2)
             if result['name'].empty?
               result['name']  = key
               result['value'] = value
             elsif key == 'domain' && value.strip =~ /^\.(.+)/
-              result['domain'] = $1
+              result['domain'] = Regexp.last_match(1)
             elsif key && value
               result[key] = value
             end
-          elsif attribute == "secure"
+          elsif attribute == 'secure'
             result['secure'] = true
           end
 
-          unless [nil, "", "0"].include?(result['expires'])
+          unless [nil, '', '0'].include?(result['expires'])
             # firefox stores expiry as number of seconds
             result['expires'] = Time.at(result['expires'].to_i)
           end
@@ -61,7 +77,6 @@ module Selenium
 
         result
       end
-
     end # BridgeHelper
   end # WebDriver
 end # Selenium