selenium-webdriver 2.45.0 → 3.142.7

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

@@ -0,0 +1,212 @@
+# 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 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

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

@@ -0,0 +1,45 @@
+# 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 W3CManager < Manager
+
+      #
+      # Get the cookie with the given name
+      #
+      # @param [String] name the name of the cookie
+      # @return [Hash, nil] the cookie, or nil if it wasn't found.
+      #
+
+      def cookie_named(name)
+        convert_cookie(@bridge.cookie(name))
+      end
+
+      #
+      # Delete all cookies
+      #
+
+      def delete_all_cookies
+        @bridge.delete_all_cookies
+      end
+
+    end # WC3Options
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/wait.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 Wait
-
       DEFAULT_TIMEOUT  = 5
       DEFAULT_INTERVAL = 0.2
 
@@ -22,19 +40,18 @@ module Selenium
         @ignored  = Array(opts[:ignore] || Error::NoSuchElementError)
       end
 
-
       #
       # Wait until the given block returns a true value.
       #
-      # @raise [Error::TimeOutError]
+      # @raise [Error::TimeoutError]
       # @return [Object] the result of the block
       #
 
-      def until(&blk)
-        end_time = Time.now + @timeout
+      def until
+        end_time = current_time + @timeout
         last_error = nil
 
-        until Time.now > end_time
+        until current_time > end_time
           begin
             result = yield
             return result if result
@@ -45,19 +62,22 @@ module Selenium
           sleep @interval
         end
 
-
-        if @message
-          msg = @message.dup
-        else
-          msg = "timed out after #{@timeout} seconds"
-        end
+        msg = if @message
+                @message.dup
+              else
+                +"timed out after #{@timeout} seconds"
+              end
 
         msg << " (#{last_error.message})" if last_error
 
-        raise Error::TimeOutError, msg
+        raise Error::TimeoutError, msg
       end
 
+      private
+
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
     end # Wait
   end # WebDriver
 end # Selenium
-

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

@@ -1,12 +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
-
     #
     # @api beta This API may be changed or removed in a future release.
     #
 
     class Window
-
       #
       # @api private
       #
@@ -23,11 +40,11 @@ module Selenium
 
       def size=(dimension)
         unless dimension.respond_to?(:width) && dimension.respond_to?(:height)
-          raise ArgumentError, "expected #{dimension.inspect}:#{dimension.class}" +
-                                " to respond to #width and #height"
+          raise ArgumentError, "expected #{dimension.inspect}:#{dimension.class}" \
+                               ' to respond to #width and #height'
         end
 
-        @bridge.setWindowSize dimension.width, dimension.height
+        @bridge.resize_window dimension.width, dimension.height
       end
 
       #
@@ -37,7 +54,7 @@ module Selenium
       #
 
       def size
-        @bridge.getWindowSize
+        @bridge.window_size
       end
 
       #
@@ -48,11 +65,11 @@ module Selenium
 
       def position=(point)
         unless point.respond_to?(:x) && point.respond_to?(:y)
-          raise ArgumentError, "expected #{point.inspect}:#{point.class}" +
-                                " to respond to #x and #y"
+          raise ArgumentError, "expected #{point.inspect}:#{point.class}" \
+                               ' to respond to #x and #y'
         end
 
-        @bridge.setWindowPosition point.x, point.y
+        @bridge.reposition_window point.x, point.y
       end
 
       #
@@ -62,7 +79,35 @@ module Selenium
       #
 
       def position
-        @bridge.getWindowPosition
+        @bridge.window_position
+      end
+
+      #
+      # Sets the current window rect to the given point and position.
+      #
+      # @param [Selenium::WebDriver::Rectangle, #x, #y, #width, #height] rectangle The new rect.
+      #
+
+      def rect=(rectangle)
+        unless %w[x y width height].all? { |val| rectangle.respond_to? val }
+          raise ArgumentError, "expected #{rectangle.inspect}:#{rectangle.class}" \
+                               ' to respond to #x, #y, #width, and #height'
+        end
+
+        @bridge.set_window_rect(x: rectangle.x,
+                                y: rectangle.y,
+                                width: rectangle.width,
+                                height: rectangle.height)
+      end
+
+      #
+      # Get the rect of the current window.
+      #
+      # @return [Selenium::WebDriver::Rectangle] The rectangle.
+      #
+
+      def rect
+        @bridge.window_rect
       end
 
       #
@@ -75,7 +120,7 @@ module Selenium
       #
 
       def resize_to(width, height)
-        @bridge.setWindowSize Integer(width), Integer(height)
+        @bridge.resize_window Integer(width), Integer(height)
       end
 
       #
@@ -87,7 +132,7 @@ module Selenium
       #
 
       def move_to(x, y)
-        @bridge.setWindowPosition Integer(x), Integer(y)
+        @bridge.reposition_window Integer(x), Integer(y)
       end
 
       #
@@ -95,10 +140,24 @@ module Selenium
       #
 
       def maximize
-        @bridge.maximizeWindow
+        @bridge.maximize_window
+      end
+
+      #
+      # Minimize the current window
+      #
+
+      def minimize
+        @bridge.minimize_window
       end
 
+      #
+      # Make current window full screen
+      #
 
-    end
-  end
-end
+      def full_screen
+        @bridge.full_screen_window
+      end
+    end # Window
+  end # WebDriver
+end # Selenium

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

@@ -1,6 +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.
+
 require 'zip'
 require 'tempfile'
 require 'find'
+require 'base64'
 
 module Selenium
   module WebDriver
@@ -9,13 +29,11 @@ module Selenium
     #
 
     module Zipper
-
-      EXTENSIONS = %w[.zip .xpi]
+      EXTENSIONS = %w[.zip .xpi].freeze
 
       class << self
-
         def unzip(path)
-          destination = Dir.mktmpdir("webdriver-unzip")
+          destination = Dir.mktmpdir('webdriver-unzip')
           FileReaper << destination
 
           Zip::File.open(path) do |zip|
@@ -34,13 +52,11 @@ module Selenium
         def zip(path)
           with_tmp_zip do |zip|
             ::Find.find(path) do |file|
-              unless File.directory?(file)
-                add_zip_entry zip, file, file.sub("#{path}/", '')
-              end
+              add_zip_entry zip, file, file.sub("#{path}/", '') unless File.directory?(file)
             end
 
             zip.commit
-            File.open(zip.name, "rb") { |io| Base64.strict_encode64 io.read }
+            File.open(zip.name, 'rb') { |io| Base64.strict_encode64 io.read }
           end
         end
 
@@ -49,7 +65,7 @@ module Selenium
             add_zip_entry zip, path, File.basename(path)
 
             zip.commit
-            File.open(zip.name, "rb") { |io| Base64.strict_encode64 io.read }
+            File.open(zip.name, 'rb') { |io| Base64.strict_encode64 io.read }
           end
         end
 
@@ -59,7 +75,7 @@ module Selenium
           # can't use Tempfile here since it doesn't support File::BINARY mode on 1.8
           # can't use Dir.mktmpdir(&blk) because of http://jira.codehaus.org/browse/JRUBY-4082
           tmp_dir = Dir.mktmpdir
-          zip_path = File.join(tmp_dir, "webdriver-zip")
+          zip_path = File.join(tmp_dir, 'webdriver-zip')
 
           begin
             Zip::File.open(zip_path, Zip::File::CREATE, &blk)
@@ -75,7 +91,6 @@ module Selenium
 
           zip.add entry, file
         end
-
       end
     end # Zipper
   end # WebDriver

data/lib/selenium/webdriver/common.rb

@@ -1,11 +1,29 @@
-require 'selenium/webdriver/common/core_ext/dir'
-require 'selenium/webdriver/common/core_ext/string'
-require 'selenium/webdriver/common/core_ext/base64'
+# 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/error'
 require 'selenium/webdriver/common/platform'
 require 'selenium/webdriver/common/proxy'
 require 'selenium/webdriver/common/log_entry'
 require 'selenium/webdriver/common/file_reaper'
+require 'selenium/webdriver/common/service'
+require 'selenium/webdriver/common/socket_lock'
 require 'selenium/webdriver/common/socket_poller'
 require 'selenium/webdriver/common/port_prober'
 require 'selenium/webdriver/common/zipper'
@@ -18,27 +36,42 @@ require 'selenium/webdriver/common/target_locator'
 require 'selenium/webdriver/common/navigation'
 require 'selenium/webdriver/common/timeouts'
 require 'selenium/webdriver/common/window'
+require 'selenium/webdriver/common/logger'
 require 'selenium/webdriver/common/logs'
-require 'selenium/webdriver/common/options'
+require 'selenium/webdriver/common/manager'
+require 'selenium/webdriver/common/w3c_manager'
 require 'selenium/webdriver/common/search_context'
 require 'selenium/webdriver/common/action_builder'
+require 'selenium/webdriver/common/interactions/key_actions'
+require 'selenium/webdriver/common/interactions/pointer_actions'
+require 'selenium/webdriver/common/w3c_action_builder'
 require 'selenium/webdriver/common/touch_action_builder'
 require 'selenium/webdriver/common/html5/shared_web_storage'
 require 'selenium/webdriver/common/html5/local_storage'
 require 'selenium/webdriver/common/html5/session_storage'
 require 'selenium/webdriver/common/driver_extensions/takes_screenshot'
 require 'selenium/webdriver/common/driver_extensions/rotatable'
-require 'selenium/webdriver/common/driver_extensions/has_browser_connection'
-require 'selenium/webdriver/common/driver_extensions/has_input_devices'
 require 'selenium/webdriver/common/driver_extensions/has_web_storage'
+require 'selenium/webdriver/common/driver_extensions/downloads_files'
 require 'selenium/webdriver/common/driver_extensions/has_location'
 require 'selenium/webdriver/common/driver_extensions/has_session_id'
 require 'selenium/webdriver/common/driver_extensions/has_touch_screen'
 require 'selenium/webdriver/common/driver_extensions/has_remote_status'
+require 'selenium/webdriver/common/driver_extensions/has_network_conditions'
+require 'selenium/webdriver/common/driver_extensions/has_network_connection'
+require 'selenium/webdriver/common/driver_extensions/has_permissions'
+require 'selenium/webdriver/common/driver_extensions/has_debugger'
 require 'selenium/webdriver/common/driver_extensions/uploads_files'
+require 'selenium/webdriver/common/driver_extensions/has_addons'
+require 'selenium/webdriver/common/interactions/interactions'
+require 'selenium/webdriver/common/interactions/input_device'
+require 'selenium/webdriver/common/interactions/interaction'
+require 'selenium/webdriver/common/interactions/none_input'
+require 'selenium/webdriver/common/interactions/key_input'
+require 'selenium/webdriver/common/interactions/pointer_input'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/bridge_helper'
 require 'selenium/webdriver/common/profile_helper'
-require 'selenium/webdriver/common/json_helper'
+require 'selenium/webdriver/common/options'
 require 'selenium/webdriver/common/driver'
 require 'selenium/webdriver/common/element'