selenium-webdriver 2.53.4 → 3.8.0

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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
@@ -19,13 +17,11 @@
 
 module Selenium
   module WebDriver
-
     #
     # @api private
     #
 
     class SocketLock
-
       def initialize(port, timeout)
         @port    = port
         @timeout = timeout
@@ -36,7 +32,7 @@ module Selenium
       # execution block if the lock could be successfully obtained.
       #
 
-      def locked(&blk)
+      def locked
         lock
 
         begin
@@ -51,13 +47,10 @@ module Selenium
       def lock
         max_time = Time.now + @timeout
 
-        until can_lock? || Time.now >= max_time
-          sleep 0.1
-        end
+        sleep 0.1 until can_lock? || Time.now >= max_time
 
-        unless did_lock?
-          raise Error::WebDriverError, "unable to bind to locking port #{@port} within #{@timeout} seconds"
-        end
+        return if did_lock?
+        raise Error::WebDriverError, "unable to bind to locking port #{@port} within #{@timeout} seconds"
       end
 
       def release
@@ -70,14 +63,13 @@ module Selenium
 
         true
       rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => ex
-        $stderr.puts "#{self}: #{ex.message}" if $DEBUG
+        WebDriver.logger.debug("#{self}: #{ex.message}")
         false
       end
 
       def did_lock?
-        !!@server
+        !@server.nil?
       end
-
     end # SocketLock
   end # WebDriver
 end # Selenium

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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
@@ -23,7 +21,6 @@ require 'socket'
 module Selenium
   module WebDriver
     class SocketPoller
-
       def initialize(host, port, timeout = 0, interval = 0.25)
         @host     = host
         @port     = Integer(port)
@@ -50,7 +47,7 @@ module Selenium
       #
 
       def closed?
-        with_timeout { not listening? }
+        with_timeout { !listening? }
       end
 
       private
@@ -81,11 +78,8 @@ module Selenium
           begin
             sock.connect_nonblock sockaddr
           rescue Errno::EINPROGRESS
-            if IO.select(nil, [sock], nil, CONNECT_TIMEOUT)
-              retry
-            else
-              raise Errno::ECONNREFUSED
-            end
+            retry if IO.select(nil, [sock], nil, CONNECT_TIMEOUT)
+            raise Errno::ECONNREFUSED
           rescue *CONNECTED_ERRORS
             # yay!
           end
@@ -94,12 +88,12 @@ module Selenium
           true
         rescue *NOT_CONNECTED_ERRORS
           sock.close if sock
-          $stderr.puts [@host, @port].inspect if $DEBUG
+          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
           false
         end
       end
 
-      def with_timeout(&blk)
+      def with_timeout
         max_time = time_now + @timeout
 
         (
@@ -118,7 +112,6 @@ module Selenium
       def time_now
         Time.now
       end
-
     end # SocketPoller
   end # WebDriver
 end # Selenium

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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
@@ -20,7 +18,6 @@
 module Selenium
   module WebDriver
     class TargetLocator
-
       #
       # @api private
       #
@@ -34,7 +31,7 @@ module Selenium
       #
 
       def frame(id)
-        @bridge.switchToFrame id
+        @bridge.switch_to_frame id
       end
 
       #
@@ -42,7 +39,7 @@ module Selenium
       #
 
       def parent_frame
-        @bridge.switchToParentFrame
+        @bridge.switch_to_parent_frame
       end
 
       #
@@ -58,27 +55,27 @@ module Selenium
       def window(id)
         if block_given?
           original = begin
-            @bridge.getCurrentWindowHandle
+            @bridge.window_handle
           rescue Error::NoSuchWindowError
             nil
           end
 
-          unless @bridge.getWindowHandles.include? id
+          unless @bridge.window_handles.include? id
             raise Error::NoSuchWindowError, "The specified identifier '#{id}' is not found in the window handle list"
           end
 
-          @bridge.switchToWindow id
+          @bridge.switch_to_window id
 
           begin
             returned = yield
           ensure
-            current_handles = @bridge.getWindowHandles
+            current_handles = @bridge.window_handles
             original = current_handles.first unless current_handles.include? original
-            @bridge.switchToWindow original
+            @bridge.switch_to_window original
             returned
           end
         else
-          @bridge.switchToWindow id
+          @bridge.switch_to_window id
         end
       end
 
@@ -89,7 +86,7 @@ module Selenium
       #
 
       def active_element
-        @bridge.switchToActiveElement
+        @bridge.switch_to_active_element
       end
 
       #
@@ -97,7 +94,7 @@ module Selenium
       #
 
       def default_content
-        @bridge.switchToDefaultContent
+        @bridge.switch_to_default_content
       end
 
       #
@@ -107,7 +104,6 @@ module Selenium
       def alert
         Alert.new(@bridge)
       end
-
     end # TargetLocator
   end # WebDriver
-end  # Selenium
+end # Selenium

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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
@@ -20,7 +18,6 @@
 module Selenium
   module WebDriver
     class Timeouts
-
       def initialize(bridge)
         @bridge = bridge
       end
@@ -30,7 +27,7 @@ module Selenium
       #
 
       def implicit_wait=(seconds)
-        @bridge.setImplicitWaitTimeout Integer(seconds * 1000)
+        @bridge.implicit_wait_timeout = Integer(seconds * 1000)
       end
 
       #
@@ -40,7 +37,7 @@ module Selenium
       #
 
       def script_timeout=(seconds)
-        @bridge.setScriptTimeout Integer(seconds * 1000)
+        @bridge.script_timeout = Integer(seconds * 1000)
       end
 
       #
@@ -49,9 +46,8 @@ module Selenium
       #
 
       def page_load=(seconds)
-        @bridge.setTimeout 'page load', Integer(seconds * 1000)
+        @bridge.timeout 'page load', Integer(seconds * 1000)
       end
-
     end # Timeouts
   end # WebDriver
-end # Selenium
+end # Selenium

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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
@@ -20,7 +18,6 @@
 module Selenium
   module WebDriver
     class TouchActionBuilder < ActionBuilder
-
       #
       # @api private
       #
@@ -31,7 +28,7 @@ module Selenium
       end
 
       def scroll(*args)
-        unless [2,3].include? args.size
+        unless [2, 3].include? args.size
           raise ArgumentError, "wrong number of arguments, expected 2..3, got #{args.size}"
         end
 
@@ -40,7 +37,7 @@ module Selenium
       end
 
       def flick(*args)
-        unless [2,4].include? args.size
+        unless [2, 4].include? args.size
           raise ArgumentError, "wrong number of arguments, expected 2 or 4, got #{args.size}"
         end
 
@@ -77,7 +74,6 @@ module Selenium
         @actions << [:touch_screen, :move, [x, y]]
         self
       end
-
     end # TouchActionBuilder
   end # WebDriver
 end # Selenium

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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
@@ -20,8 +18,7 @@
 module Selenium
   module WebDriver
     class TouchScreen
-      FLICK_SPEED = { :normal => 0, :fast => 1}
-
+      FLICK_SPEED = {normal: 0, fast: 1}.freeze
 
       #
       # @api private
@@ -33,43 +30,43 @@ module Selenium
 
       def single_tap(element)
         assert_element element
-        @bridge.touchSingleTap element.ref
+        @bridge.touch_single_tap element.ref
       end
 
       def double_tap(element)
         assert_element element
-        @bridge.touchDoubleTap element.ref
+        @bridge.touch_double_tap element.ref
       end
 
       def long_press(element)
         assert_element element
-        @bridge.touchLongPress element.ref
+        @bridge.touch_long_press element.ref
       end
 
       def down(x, y = nil)
         x, y = coords_from x, y
-        @bridge.touchDown x, y
+        @bridge.touch_down x, y
       end
 
       def up(x, y = nil)
         x, y = coords_from x, y
-        @bridge.touchUp x, y
+        @bridge.touch_up x, y
       end
 
       def move(x, y = nil)
         x, y = coords_from x, y
-        @bridge.touchMove x, y
+        @bridge.touch_move x, y
       end
 
       def scroll(*args)
         case args.size
         when 2
           x_offset, y_offset = args
-          @bridge.touchScroll nil, Integer(x_offset), Integer(y_offset)
+          @bridge.touch_scroll nil, Integer(x_offset), Integer(y_offset)
         when 3
           element, x_offset, y_offset = args
           assert_element element
-          @bridge.touchScroll element.ref, Integer(x_offset), Integer(y_offset)
+          @bridge.touch_scroll element.ref, Integer(x_offset), Integer(y_offset)
         else
           raise ArgumentError, "wrong number of arguments, expected 2..3, got #{args.size}"
         end
@@ -79,22 +76,22 @@ module Selenium
         case args.size
         when 2
           x_speed, y_speed = args
-          @bridge.touchFlick Integer(x_speed), Integer(y_speed)
+          @bridge.touch_flick Integer(x_speed), Integer(y_speed)
         when 4
           element, xoffset, yoffset, speed = args
 
           assert_element element
-          flick_speed = FLICK_SPEED[speed.to_sym]
 
-          unless flick_speed
-            raise ArgumentError, "expected one of #{FLICK_SPEED.keys.inspect}, got #{speed.inspect}"
+          if (speed.is_a?(String) || speed.is_a?(Symbol)) && FLICK_SPEED.keys.include?(speed.to_sym)
+            WebDriver.logger.deprecate "Passing #{speed.inspect} speed",
+                                       "Integer or Selenium::WebDriver::TouchScreen::FLICK_SPEED[:#{speed}]"
+            speed = FLICK_SPEED[speed.to_sym]
           end
 
-          @bridge.touchElementFlick element.ref, Integer(xoffset), Integer(yoffset), flick_speed
+          @bridge.touch_element_flick element.ref, Integer(xoffset), Integer(yoffset), Integer(speed)
         else
           raise ArgumentError, "wrong number of arguments, expected 2 or 4, got #{args.size}"
         end
-
       end
 
       private
@@ -107,18 +104,17 @@ module Selenium
             raise ArgumentError, "expected #{point.inspect} to respond to :x and :y"
           end
 
-          x, y = point.x, point.y
+          x = point.x
+          y = point.y
         end
 
         [Integer(x), Integer(y)]
       end
 
       def assert_element(element)
-        unless element.kind_of? Element
-          raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
-        end
+        return if element.is_a? Element
+        raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
       end
-
     end # TouchScreen
   end # WebDriver
 end # Selenium

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

@@ -0,0 +1,209 @@
+# 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 W3CActionBuilder
+      include KeyActions # Actions specific to key inputs
+      include PointerActions # Actions specific to pointer inputs
+      attr_reader :devices
+
+      #
+      # Initialize a W3C Action Builder. Differs from previous by requiring a bridge and allowing asynchronous actions.
+      # The W3C implementation allows asynchronous actions per device. e.g. A key can be pressed at the same time that
+      # the mouse is moving. Keep in mind that pauses must be added for other devices in order to line up the actions
+      # correctly when using asynchronous.
+      #
+      # @param [Selenium::WebDriver::Remote::W3CBridge] bridge the bridge for the current driver instance
+      # @param [Selenium::WebDriver::Interactions::PointerInput] mouse PointerInput for the mouse.
+      # @param [Selenium::WebDriver::Interactions::KeyInput] keyboard KeyInput for the keyboard.
+      # @param [Boolean] async Whether to perform the actions asynchronously per device. Defaults to false for
+      #   backwards compatibility.
+      # @return [W3CActionBuilder] A self reference.
+      #
+
+      def initialize(bridge, mouse, keyboard, async = false)
+        # For backwards compatibility, automatically include mouse & keyboard
+        @bridge = bridge
+        @devices = [mouse, keyboard]
+        @async = async
+      end
+
+      #
+      # Adds a PointerInput device of the given kind
+      #
+      # @example Add a touch pointer input device
+      #
+      #    builder = device.action
+      #    builder.add_pointer_input('touch', :touch)
+      #
+      # @param [String] name name for the device
+      # @param [Symbol] kind kind of pointer device to create
+      # @return [Interactions::PointerInput] The pointer input added
+      #
+      #
+
+      def add_pointer_input(kind, name)
+        new_input = Interactions.pointer(kind, name: name)
+        add_input(new_input)
+        new_input
+      end
+
+      #
+      # Adds a KeyInput device
+      #
+      # @example Add a key input device
+      #
+      #    builder = device.action
+      #    builder.add_key_input('keyboard2')
+      #
+      # @param [String] name name for the device
+      # @return [Interactions::KeyInput] The key input added
+      #
+
+      def add_key_input(name)
+        new_input = Interactions.key(name)
+        add_input(new_input)
+        new_input
+      end
+
+      #
+      # Retrieves the input device for the given name
+      #
+      # @param [String] name name of the input device
+      # @return [Selenium::WebDriver::Interactions::InputDevice] input device with given name
+      #
+
+      def get_device(name)
+        @devices.find { |device| device.name == name.to_s }
+      end
+
+      #
+      # Retrieves the current PointerInput devices
+      #
+      # @return [Array] array of current PointerInput devices
+      #
+
+      def pointer_inputs
+        @devices.select { |device| device.type == Interactions::POINTER }
+      end
+
+      #
+      # Retrieves the current KeyInput device
+      #
+      # @return [Selenium::WebDriver::Interactions::InputDevice] current KeyInput device
+      #
+
+      def key_inputs
+        @devices.select { |device| device.type == Interactions::KEY }
+      end
+
+      #
+      # Creates a pause for the given device of the given duration. If no duration is given, the pause will only wait
+      # for all actions to complete in that tick.
+      #
+      # @example Send keys to an element
+      #
+      #   action_builder = driver.action
+      #   keyboard = action_builder.key_input
+      #   el = driver.find_element(id: "some_id")
+      #   driver.action.click(el).pause(keyboard).pause(keyboard).pause(keyboard).send_keys('keys').perform
+      #
+      # @param [InputDevice] device Input device to pause
+      # @param [Float] duration Duration to pause
+      # @return [W3CActionBuilder] A self reference.
+      #
+
+      def pause(device, duration = nil)
+        device.create_pause(duration)
+        self
+      end
+
+      #
+      # Creates multiple pauses for the given device of the given duration.
+      #
+      # @example Send keys to an element
+      #
+      #   action_builder = driver.action
+      #   keyboard = action_builder.key_input
+      #   el = driver.find_element(id: "some_id")
+      #   driver.action.click(el).pauses(keyboard, 3).send_keys('keys').perform
+      #
+      # @param [InputDevice] device Input device to pause
+      # @param [Integer] number of pauses to add for the device
+      # @param [Float] duration Duration to pause
+      # @return [W3CActionBuilder] A self reference.
+      #
+
+      def pauses(device, number, duration = nil)
+        number.times { device.create_pause(duration) }
+        self
+      end
+
+      #
+      # Executes the actions added to the builder.
+      #
+
+      def perform
+        @bridge.send_actions @devices.map(&:encode).compact
+        clear_all_actions
+        nil
+      end
+
+      #
+      # Clears all actions from the builder.
+      #
+
+      def clear_all_actions
+        @devices.each(&:clear_actions)
+      end
+
+      #
+      # Releases all action states from the browser.
+      #
+
+      def release_actions
+        @bridge.release_actions
+      end
+
+      private
+
+      #
+      # Adds pauses for all devices but the given devices
+      #
+      # @param [Array[InputDevice]] action_devices Array of Input Devices performing an action in this tick.
+      #
+
+      def tick(*action_devices)
+        return if @async
+        @devices.each { |device| device.create_pause unless action_devices.include? device }
+      end
+
+      #
+      # Adds an InputDevice
+      #
+
+      def add_input(device)
+        unless @async
+          max_device = @devices.max { |a, b| a.actions.length <=> b.actions.length }
+          pauses(device, max_device.actions.length)
+        end
+        @devices << device
+      end
+    end # W3CActionBuilder
+  end # WebDriver
+end # Selenium