selenium-webdriver 2.45.0 → 3.142.7

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

@@ -0,0 +1,82 @@
+# 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
+    #
+    # @api private
+    #
+
+    class SocketLock
+      def initialize(port, timeout)
+        @port    = port
+        @timeout = timeout
+      end
+
+      #
+      # Attempt to acquire a lock on the given port. Control is yielded to an
+      # execution block if the lock could be successfully obtained.
+      #
+
+      def locked
+        lock
+
+        begin
+          yield
+        ensure
+          release
+        end
+      end
+
+      private
+
+      def lock
+        max_time = current_time + @timeout
+
+        sleep 0.1 until can_lock? || current_time >= max_time
+
+        return if did_lock?
+
+        raise Error::WebDriverError, "unable to bind to locking port #{@port} within #{@timeout} seconds"
+      end
+
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
+      def release
+        @server&.close
+      end
+
+      def can_lock?
+        @server = TCPServer.new(Platform.localhost, @port)
+        ChildProcess.close_on_exec @server
+
+        true
+      rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => ex
+        WebDriver.logger.debug("#{self}: #{ex.message}")
+        false
+      end
+
+      def did_lock?
+        !@server.nil?
+      end
+    end # SocketLock
+  end # WebDriver
+end # Selenium

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

@@ -1,10 +1,28 @@
+# 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 'selenium/webdriver/common/platform'
 require 'socket'
 
 module Selenium
   module WebDriver
     class SocketPoller
-
       def initialize(host, port, timeout = 0, interval = 0.25)
         @host     = host
         @port     = Integer(port)
@@ -31,18 +49,21 @@ module Selenium
       #
 
       def closed?
-        with_timeout { not listening? }
+        with_timeout { !listening? }
       end
 
       private
 
       CONNECT_TIMEOUT = 5
 
-      NOT_CONNECTED_ERRORS = [Errno::ECONNREFUSED, Errno::ENOTCONN, SocketError]
-      NOT_CONNECTED_ERRORS << Errno::EPERM if Platform.cygwin?
+      NOT_CONNECTED_ERRORS = [Errno::ECONNREFUSED, Errno::ENOTCONN, SocketError].tap { |arr|
+        arr << Errno::EPERM if Platform.cygwin?
+      }.freeze
 
-      CONNECTED_ERRORS = [Errno::EISCONN]
-      CONNECTED_ERRORS << Errno::EINVAL if Platform.windows?
+      CONNECTED_ERRORS = [Errno::EISCONN].tap { |arr|
+        arr << Errno::EINVAL if Platform.windows?
+        arr << Errno::EALREADY if Platform.wsl?
+      }.freeze
 
       if Platform.jruby?
         # we use a plain TCPSocket here since JRuby has issues select()ing on a connecting socket
@@ -62,11 +83,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 socket_writable?(sock) && conn_completed?(sock)
+            raise Errno::ECONNREFUSED
           rescue *CONNECTED_ERRORS
             # yay!
           end
@@ -74,32 +92,35 @@ module Selenium
           sock.close
           true
         rescue *NOT_CONNECTED_ERRORS
-          sock.close if sock
-          $stderr.puts [@host, @port].inspect if $DEBUG
+          sock&.close
+          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
           false
         end
       end
 
-      def with_timeout(&blk)
-        max_time = time_now + @timeout
+      def socket_writable?(sock)
+        IO.select(nil, [sock], nil, CONNECT_TIMEOUT)
+      end
+
+      def conn_completed?(sock)
+        sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_ERROR).int.zero?
+      end
+
+      def with_timeout
+        max_time = current_time + @timeout
 
-        (
+        until current_time > max_time
           return true if yield
-          wait
-        ) until time_now > max_time
 
-        false
-      end
+          sleep @interval
+        end
 
-      def wait
-        sleep @interval
+        false
       end
 
-      # for testability
-      def time_now
-        Time.now
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
-
     end # SocketPoller
   end # WebDriver
 end # Selenium

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

@@ -1,7 +1,25 @@
+# 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 TargetLocator
-
       #
       # @api private
       #
@@ -15,7 +33,7 @@ module Selenium
       #
 
       def frame(id)
-        @bridge.switchToFrame id
+        @bridge.switch_to_frame id
       end
 
       #
@@ -23,7 +41,7 @@ module Selenium
       #
 
       def parent_frame
-        @bridge.switchToParentFrame
+        @bridge.switch_to_parent_frame
       end
 
       #
@@ -39,23 +57,27 @@ module Selenium
       def window(id)
         if block_given?
           original = begin
-            @bridge.getCurrentWindowHandle
-          rescue Error::NoSuchWindowError
-            nil
+                       @bridge.window_handle
+                     rescue Error::NoSuchWindowError
+                       nil
+                     end
+
+          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
 
@@ -66,7 +88,7 @@ module Selenium
       #
 
       def active_element
-        @bridge.switchToActiveElement
+        @bridge.switch_to_active_element
       end
 
       #
@@ -74,7 +96,7 @@ module Selenium
       #
 
       def default_content
-        @bridge.switchToDefaultContent
+        @bridge.switch_to_default_content
       end
 
       #
@@ -84,7 +106,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,7 +1,25 @@
+# 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 Timeouts
-
       def initialize(bridge)
         @bridge = bridge
       end
@@ -11,7 +29,7 @@ module Selenium
       #
 
       def implicit_wait=(seconds)
-        @bridge.setImplicitWaitTimeout Integer(seconds * 1000)
+        @bridge.implicit_wait_timeout = Integer(seconds * 1000)
       end
 
       #
@@ -21,7 +39,7 @@ module Selenium
       #
 
       def script_timeout=(seconds)
-        @bridge.setScriptTimeout Integer(seconds * 1000)
+        @bridge.script_timeout = Integer(seconds * 1000)
       end
 
       #
@@ -30,9 +48,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,29 +1,44 @@
+# 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 TouchActionBuilder < ActionBuilder
-
       #
       # @api private
       #
 
       def initialize(mouse, keyboard, touch_screen)
+        WebDriver.logger.deprecate(self.class.name)
         super(mouse, keyboard)
         @devices[:touch_screen] = touch_screen
       end
 
       def scroll(*args)
-        unless [2,3].include? args.size
-          raise ArgumentError, "wrong number of arguments, expected 2..3, got #{args.size}"
-        end
+        raise ArgumentError, "wrong number of arguments, expected 2..3, got #{args.size}" unless [2, 3].include? args.size
 
         @actions << [:touch_screen, :scroll, args]
         self
       end
 
       def flick(*args)
-        unless [2,4].include? args.size
-          raise ArgumentError, "wrong number of arguments, expected 2 or 4, got #{args.size}"
-        end
+        raise ArgumentError, "wrong number of arguments, expected 2 or 4, got #{args.size}" unless [2, 4].include? args.size
 
         @actions << [:touch_screen, :flick, args]
         self
@@ -58,7 +73,6 @@ module Selenium
         @actions << [:touch_screen, :move, [x, y]]
         self
       end
-
-    end
-  end
-end
+    end # TouchActionBuilder
+  end # WebDriver
+end # Selenium

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

@@ -1,8 +1,26 @@
+# 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 TouchScreen
-      FLICK_SPEED = { :normal => 0, :fast => 1}
-
+      FLICK_SPEED = {normal: 0, fast: 1}.freeze
 
       #
       # @api private
@@ -14,43 +32,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
@@ -60,22 +78,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.key?(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
@@ -88,18 +106,18 @@ 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
-      end
+        return if element.is_a? Element
 
-    end
-  end
-end
+        raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
+      end
+    end # TouchScreen
+  end # WebDriver
+end # Selenium