selenium-webdriver 3.142.7 → 4.16.0

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

@@ -30,6 +30,7 @@ module Selenium
 
     class Driver
       include SearchContext
+      include TakesScreenshot
 
       class << self
         #
@@ -43,19 +44,17 @@ module Selenium
         def for(browser, opts = {})
           case browser
           when :chrome
-            Chrome::Driver.new(opts)
+            Chrome::Driver.new(**opts)
           when :internet_explorer, :ie
-            IE::Driver.new(opts)
+            IE::Driver.new(**opts)
           when :safari
-            Safari::Driver.new(opts)
-          when :phantomjs
-            PhantomJS::Driver.new(opts)
+            Safari::Driver.new(**opts)
           when :firefox, :ff
-            Firefox::Driver.new(opts)
-          when :edge
-            Edge::Driver.new(opts)
+            Firefox::Driver.new(**opts)
+          when :edge, :microsoftedge, :msedge
+            Edge::Driver.new(**opts)
           when :remote
-            Remote::Driver.new(opts)
+            Remote::Driver.new(**opts)
           else
             raise ArgumentError, "unknown driver: #{browser.inspect}"
           end
@@ -69,13 +68,27 @@ module Selenium
       # @api private
       #
 
-      def initialize(bridge, listener: nil)
-        @bridge = bridge
-        @bridge = Support::EventFiringBridge.new(bridge, listener) if listener
+      def initialize(bridge: nil, listener: nil, **opts)
+        @devtools = nil
+        @bidi = nil
+        bridge ||= create_bridge(**opts)
+        add_extensions(bridge.browser)
+        @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
       end
 
       def inspect
-        format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2, browser: bridge.browser.inspect
+        format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2,
+                                                              browser: bridge.browser.inspect
+      end
+
+      #
+      # information about whether a remote end is in a state in which it can create new sessions,
+      # and may include additional meta information.
+      #
+      # @return [Hash]
+      #
+      def status
+        @bridge.status
       end
 
       #
@@ -106,20 +119,12 @@ module Selenium
       end
 
       #
-      # @return [ActionBuilder, W3CActionBuilder]
-      # @see ActionBuilder, W3CActionBuilder
+      # @return [ActionBuilder]
+      # @see ActionBuilder
       #
 
-      def action
-        bridge.action
-      end
-
-      def mouse
-        bridge.mouse
-      end
-
-      def keyboard
-        bridge.keyboard
+      def action(**opts)
+        bridge.action(**opts)
       end
 
       #
@@ -166,6 +171,10 @@ module Selenium
 
       def quit
         bridge.quit
+      ensure
+        @service_manager&.stop
+        @devtools&.close
+        @bidi&.close
       end
 
       #
@@ -173,7 +182,10 @@ module Selenium
       #
 
       def close
-        bridge.close
+        # If no top-level browsing contexts are open after calling close,
+        # it indicates that the WebDriver session is closed.
+        # If the WebDriver session is closed, the BiDi session also needs to be closed.
+        bridge.close.tap { |handles| @bidi&.close if handles&.empty? }
       end
 
       #
@@ -232,25 +244,34 @@ module Selenium
         bridge.execute_async_script(script, *args)
       end
 
+      #
+      # @return [VirtualAuthenticator]
+      # @see VirtualAuthenticator
+      #
+
+      def add_virtual_authenticator(options)
+        bridge.add_virtual_authenticator(options)
+      end
+
       #-------------------------------- sugar  --------------------------------
 
       #
       #   driver.first(id: 'foo')
       #
 
-      alias_method :first, :find_element
+      alias first find_element
 
       #
       #   driver.all(class: 'bar') #=> [#<WebDriver::Element:0x1011c3b88, ...]
       #
 
-      alias_method :all, :find_elements
+      alias all find_elements
 
       #
       #   driver.script('function() { ... };')
       #
 
-      alias_method :script, :execute_script
+      alias script execute_script
 
       # Get the first element matching the given selector. If given a
       # String or Symbol, it will be used as the id of the element.
@@ -271,7 +292,7 @@ module Selenium
       end
 
       def browser
-        bridge.browser
+        bridge&.browser
       end
 
       def capabilities
@@ -283,25 +304,43 @@ module Selenium
       # @see SearchContext
       #
 
-      def ref; end
+      def ref
+        [:driver, nil]
+      end
 
       private
 
       attr_reader :bridge
 
-      def service_url(opts)
-        @service = opts.delete(:service)
-        %i[driver_opts driver_path port].each do |key|
-          next unless opts.key? key
-
-          WebDriver.logger.deprecate(":#{key}", ':service with an instance of Selenium::WebDriver::Service')
+      def create_bridge(caps:, url:, http_client: nil)
+        Remote::Bridge.new(http_client: http_client, url: url).tap do |bridge|
+          bridge.create_session(caps)
         end
-        @service ||= Service.send(browser,
-                                  args: opts.delete(:driver_opts),
-                                  path: opts.delete(:driver_path),
-                                  port: opts.delete(:port))
-        @service.start
-        @service.uri
+      end
+
+      def service_url(service)
+        @service_manager = service.launch
+        @service_manager.uri
+      end
+
+      def screenshot
+        bridge.screenshot
+      end
+
+      def add_extensions(browser)
+        extensions = case browser
+                     when :chrome, :msedge
+                       Chromium::Driver::EXTENSIONS
+                     when :firefox
+                       Firefox::Driver::EXTENSIONS
+                     when :safari, :safari_technology_preview
+                       Safari::Driver::EXTENSIONS
+                     when :ie, :internet_explorer
+                       IE::Driver::EXTENSIONS
+                     else
+                       []
+                     end
+        extensions.each { |extension| extend extension }
       end
     end # Driver
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/downloads_files.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module DownloadsFiles
-
         #
         # Sets download path for Chromium.
         #
@@ -38,7 +37,6 @@ module Selenium
           }
           @bridge.send_command(params)
         end
-
       end # DownloadsFiles
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/{has_location.rb → full_page_screenshot.rb}

@@ -20,21 +20,23 @@
 module Selenium
   module WebDriver
     module DriverExtensions
-      module HasLocation
-        def location
-          @bridge.location
-        end
-
-        def location=(loc)
-          raise TypeError, "expected #{Location}, got #{loc.inspect}:#{loc.class}" unless loc.is_a?(Location)
+      module FullPageScreenshot
+        #
+        # Save a PNG screenshot of the full page to the given path
+        #
+        # @api public
+        #
 
-          @bridge.set_location loc.latitude, loc.longitude, loc.altitude
+        def save_full_page_screenshot(path)
+          save_screenshot(path, full_page: true)
         end
 
-        def set_location(lat, lon, alt)
-          self.location = Location.new(Float(lat), Float(lon), Float(alt))
+        private
+
+        def full_screenshot
+          @bridge.full_screenshot
         end
-      end # HasLocation
+      end # FullPageScreenshot
     end # DriverExtensions
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_addons.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasAddons
-
         #
         # Installs addon.
         #
@@ -43,7 +42,6 @@ module Selenium
         def uninstall_addon(id)
           @bridge.uninstall_addon(id)
         end
-
       end # HasAddons
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_apple_permissions.rb

@@ -0,0 +1,49 @@
+# 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 DriverExtensions
+      module HasApplePermissions
+        #
+        # Returns permissions.
+        #
+        # @return [Hash]
+        #
+
+        def permissions
+          @bridge.permissions
+        end
+
+        #
+        # Sets permissions.
+        #
+        # @example
+        #   driver.permissions = {'getUserMedia' => true}
+        #
+        # @param [Hash<Symbol, Boolean>] permissions
+        #
+
+        def permissions=(permissions)
+          @bridge.permissions = permissions
+        end
+      end # HasPermissions
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_authentication.rb

@@ -0,0 +1,87 @@
+# 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 DriverExtensions
+      module HasAuthentication
+        #
+        # Registers basic authentication handler which is automatically
+        # used whenever browser gets an authentication required response.
+        # This currently relies on DevTools so is only supported in
+        # Chromium browsers.
+        #
+        # @example Authenticate any request
+        #   driver.register(username: 'admin', password: '123456')
+        #
+        # @example Authenticate based on URL
+        #   driver.register(username: 'admin1', password: '123456', uri: /mysite1\.com/)
+        #   driver.register(username: 'admin2', password: '123456', uri: /mysite2\.com/)
+        #
+        # @param [String] username
+        # @param [String] password
+        # @param [Regexp] uri to associate the credentials with
+        #
+
+        def register(username:, password:, uri: //)
+          auth_handlers << {username: username, password: password, uri: uri}
+
+          devtools.network.set_cache_disabled(cache_disabled: true)
+          devtools.fetch.on(:auth_required) do |params|
+            authenticate(params['requestId'], params.dig('request', 'url'))
+          end
+          devtools.fetch.on(:request_paused) do |params|
+            devtools.fetch.continue_request(request_id: params['requestId'])
+          end
+          devtools.fetch.enable(handle_auth_requests: true)
+        end
+
+        private
+
+        def auth_handlers
+          @auth_handlers ||= []
+        end
+
+        def authenticate(request_id, url)
+          credentials = auth_handlers.find do |handler|
+            url.match?(handler[:uri])
+          end
+
+          if credentials
+            devtools.fetch.continue_with_auth(
+              request_id: request_id,
+              auth_challenge_response: {
+                response: 'ProvideCredentials',
+                username: credentials[:username],
+                password: credentials[:password]
+              }
+            )
+          else
+            devtools.fetch.continue_with_auth(
+              request_id: request_id,
+              auth_challenge_response: {
+                response: 'CancelAuth'
+              }
+            )
+          end
+        end
+      end # HasAuthentication
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/{has_touch_screen.rb → has_bidi.rb}

@@ -20,17 +20,17 @@
 module Selenium
   module WebDriver
     module DriverExtensions
-      module HasTouchScreen
-        def touch
-          TouchActionBuilder.new Mouse.new(@bridge), Keyboard.new(@bridge), touch_screen
-        end
-
-        private
+      module HasBiDi
+        #
+        # Retrieves WebDriver BiDi connection.
+        #
+        # @return [BiDi]
+        #
 
-        def touch_screen
-          TouchScreen.new @bridge
+        def bidi
+          @bidi ||= Selenium::WebDriver::BiDi.new(url: capabilities[:web_socket_url])
         end
-      end # HasTouchScreen
+      end # HasBiDi
     end # DriverExtensions
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_casting.rb

@@ -0,0 +1,86 @@
+# 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 DriverExtensions
+      module HasCasting
+        #
+        # What devices ("sinks") are available to be cast to.
+        #
+        # @return [Array] list of sinks available for casting with id and name values
+        #
+
+        def cast_sinks
+          @bridge.cast_sinks
+        end
+
+        #
+        # Sets a specific sink, using its name, as a Cast session receiver target.
+        #
+        # @param [String] name the sink to use as the target
+        #
+
+        def cast_sink_to_use=(name)
+          @bridge.cast_sink_to_use = name
+        end
+
+        #
+        # Starts a tab mirroring session on a specific receiver target.
+        #
+        # @param [String] name the sink to use as the target
+        #
+
+        def start_cast_tab_mirroring(name)
+          @bridge.start_cast_tab_mirroring(name)
+        end
+
+        #
+        # Starts a tab mirroring session on a specific receiver target.
+        #
+        # @param [String] name the sink to use as the target
+        #
+
+        def start_cast_desktop_mirroring(name)
+          @bridge.start_cast_desktop_mirroring(name)
+        end
+
+        #
+        # Gets error messages when there is any issue in a Cast session.
+        #
+        # @return [String] the error message
+        #
+
+        def cast_issue_message
+          @bridge.cast_issue_message
+        end
+
+        #
+        # Stops the existing Cast session on a specific receiver target.
+        #
+        # @param [String] name the sink to stop the Cast session
+        #
+
+        def stop_casting(name)
+          @bridge.stop_casting(name)
+        end
+      end # HasCasting
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_cdp.rb

@@ -0,0 +1,36 @@
+# 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 DriverExtensions
+      module HasCDP
+        #
+        # Returns network conditions.
+        #
+        # @return [Hash]
+        #
+
+        def execute_cdp(cmd, **params)
+          @bridge.send_command(cmd: cmd, params: params)
+        end
+      end # HasCDP
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_context.rb

@@ -0,0 +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.
+
+module Selenium
+  module WebDriver
+    module DriverExtensions
+      module HasContext
+        #
+        # Sets the context that Selenium commands are running in using
+        #         a `with` statement. The state of the context on the server is
+        #         saved before entering the block, and restored upon exiting it.
+        #
+        # @param [String] value which context gets set (either 'chrome' or 'content')
+        #
+
+        def context=(value)
+          @bridge.context = value
+        end
+
+        def context
+          @bridge.context
+        end
+      end # HasContext
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_debugger.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasDebugger
-
         #
         # Attaches debugger to session.
         #
@@ -35,7 +34,6 @@ module Selenium
         def attach_debugger
           @bridge.attach_debugger
         end
-
       end # HasDebugger
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_devtools.rb

@@ -0,0 +1,41 @@
+# 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 DriverExtensions
+      module HasDevTools
+        #
+        # Retrieves connection to DevTools.
+        #
+        # @return [DevTools]
+        #
+
+        def devtools
+          @devtools ||= begin
+            require 'selenium/devtools'
+            Selenium::DevTools.version ||= devtools_version
+            Selenium::DevTools.load_version
+            Selenium::WebDriver::DevTools.new(url: devtools_url)
+          end
+        end
+      end # HasDevTools
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium