selenium-webdriver 3.142.6 → 4.1.0

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

@@ -0,0 +1,43 @@
+# 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 FullPageScreenshot
+        #
+        # Save a PNG screenshot of the full page to the given path
+        #
+        # @api public
+        #
+
+        def save_full_page_screenshot(path)
+          save_screenshot(path, full_page: true)
+        end
+
+        private
+
+        def full_screenshot
+          @bridge.full_screenshot
+        end
+
+      end # FullPageScreenshot
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,51 @@
+# 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,89 @@
+# 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_casting.rb

@@ -0,0 +1,77 @@
+# 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
+
+        #
+        # 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_touch_screen.rb → has_cdp.rb}

@@ -20,17 +20,19 @@
 module Selenium
   module WebDriver
     module DriverExtensions
-      module HasTouchScreen
-        def touch
-          TouchActionBuilder.new Mouse.new(@bridge), Keyboard.new(@bridge), touch_screen
-        end
+      module HasCDP
 
-        private
+        #
+        # Returns network conditions.
+        #
+        # @return [Hash]
+        #
 
-        def touch_screen
-          TouchScreen.new @bridge
+        def execute_cdp(cmd, **params)
+          @bridge.send_command(cmd: cmd, params: params)
         end
-      end # HasTouchScreen
+
+      end # HasCDP
     end # DriverExtensions
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_context.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
+    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] name which permission to set
+        # @param [String] value what to set the permission to
+        #
+
+        def context=(value)
+          @bridge.context = value
+        end
+
+        def context
+          @bridge.context
+        end
+
+      end # HasContext
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/{firefox/util.rb → common/driver_extensions/has_devtools.rb}

@@ -19,28 +19,25 @@
 
 module Selenium
   module WebDriver
-    module Firefox
-      # @api private
-      module Util
-        module_function
+    module DriverExtensions
+      module HasDevTools
 
-        def app_data_path
-          case Platform.os
-          when :windows
-            "#{ENV['APPDATA']}\\Mozilla\\Firefox"
-          when :macosx
-            "#{Platform.home}/Library/Application Support/Firefox"
-          when :unix, :linux
-            "#{Platform.home}/.mozilla/firefox"
-          else
-            raise "Unknown os: #{Platform.os}"
+        #
+        # 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
 
-        def stringified?(str)
-          str =~ /^".*"$/
-        end
-      end # Util
-    end # Firefox
+      end # HasDevTools
+    end # DriverExtensions
   end # WebDriver
 end # Selenium

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

@@ -0,0 +1,38 @@
+# 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 HasLaunching
+
+        #
+        # Launches Chromium app specified by id.
+        #
+        # @param [String] id
+        #
+
+        def launch_app(id)
+          @bridge.launch_app(id)
+        end
+
+      end # HasLaunching
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

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

@@ -17,23 +17,20 @@
 # specific language governing permissions and limitations
 # under the License.
 
+# TODO: Deprecated; Delete after 4.0 release
 module Selenium
   module WebDriver
     module DriverExtensions
       module HasLocation
         def location
-          @bridge.location
+          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support getting location'
         end
 
-        def location=(loc)
-          raise TypeError, "expected #{Location}, got #{loc.inspect}:#{loc.class}" unless loc.is_a?(Location)
-
-          @bridge.set_location loc.latitude, loc.longitude, loc.altitude
+        def location=(*)
+          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support setting location'
         end
+        alias_method :set_location, :location
 
-        def set_location(lat, lon, alt)
-          self.location = Location.new(Float(lat), Float(lon), Float(alt))
-        end
       end # HasLocation
     end # DriverExtensions
   end # WebDriver

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

@@ -0,0 +1,144 @@
+# 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 HasLogEvents
+        include Atoms
+
+        KINDS = %i[console exception mutation].freeze
+
+        #
+        # Registers listener to be called whenever browser receives
+        # a new Console API message such as console.log() or an unhandled
+        # exception.
+        #
+        # This currently relies on DevTools so is only supported in
+        # Chromium browsers.
+        #
+        # @example Collect console messages
+        #   logs = []
+        #   driver.on_log_event(:console) do |event|
+        #     logs.push(event)
+        #   end
+        #
+        # @example Collect JavaScript exceptions
+        #   exceptions = []
+        #   driver.on_log_event(:exception) do |event|
+        #     exceptions.push(event)
+        #   end
+        #
+        # @example Collect DOM mutations
+        #   mutations = []
+        #   driver.on_log_event(:mutation) do |event|
+        #     mutations.push(event)
+        #   end
+        #
+        # @param [Symbol] kind :console, :exception or :mutation
+        # @param [#call] block which is called when event happens
+        # @yieldparam [DevTools::ConsoleEvent, DevTools::ExceptionEvent, DevTools::MutationEvent]
+        #
+
+        def on_log_event(kind, &block)
+          raise Error::WebDriverError, "Don't know how to handle #{kind} events" unless KINDS.include?(kind)
+
+          enabled = log_listeners[kind].any?
+          log_listeners[kind] << block
+          return if enabled
+
+          devtools.runtime.enable
+          __send__("log_#{kind}_events")
+        end
+
+        private
+
+        def log_listeners
+          @log_listeners ||= Hash.new { |listeners, kind| listeners[kind] = [] }
+        end
+
+        def log_console_events
+          devtools.runtime.on(:console_api_called) do |params|
+            event = DevTools::ConsoleEvent.new(
+              type: params['type'],
+              timestamp: params['timestamp'],
+              args: params['args']
+            )
+
+            log_listeners[:console].each do |listener|
+              listener.call(event)
+            end
+          end
+        end
+
+        def log_exception_events
+          devtools.runtime.on(:exception_thrown) do |params|
+            description = if params.dig('exceptionDetails', 'exception')
+                            params.dig('exceptionDetails', 'exception', 'description')
+                          else
+                            params.dig('exceptionDetails', 'text')
+                          end
+
+            event = DevTools::ExceptionEvent.new(
+              description: description,
+              timestamp: params['timestamp'],
+              stacktrace: params.dig('exceptionDetails', 'stackTrace', 'callFrames')
+            )
+
+            log_listeners[:exception].each do |listener|
+              listener.call(event)
+            end
+          end
+        end
+
+        def log_mutation_events
+          devtools.page.enable
+
+          devtools.runtime.add_binding(name: '__webdriver_attribute')
+          execute_script(mutation_listener)
+          devtools.page.add_script_to_evaluate_on_new_document(source: mutation_listener)
+
+          devtools.runtime.on(:binding_called, &method(:log_mutation_event))
+        end
+
+        def log_mutation_event(params)
+          payload = JSON.parse(params['payload'])
+          elements = find_elements(css: "*[data-__webdriver_id='#{payload['target']}']")
+          return if elements.empty?
+
+          event = DevTools::MutationEvent.new(
+            element: elements.first,
+            attribute_name: payload['name'],
+            current_value: payload['value'],
+            old_value: payload['oldValue']
+          )
+
+          log_listeners[:mutation].each do |log_listener|
+            log_listener.call(event)
+          end
+        end
+
+        def mutation_listener
+          @mutation_listener ||= read_atom(:mutationListener)
+        end
+
+      end # HasLogEvents
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,30 @@
+# 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 HasLogs
+        def logs
+          @logs ||= Logs.new(@bridge)
+        end
+      end # HasLogs
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

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

@@ -38,13 +38,30 @@ module Selenium
         # @param [Hash] conditions
         # @option conditions [Integer] :latency
         # @option conditions [Integer] :throughput
+        # @option conditions [Integer] :upload_throughput
+        # @option conditions [Integer] :download_throughput
         # @option conditions [Boolean] :offline
         #
 
         def network_conditions=(conditions)
+          conditions[:latency] ||= 0
+          unless conditions.key?(:throughput)
+            conditions[:download_throughput] ||= -1
+            conditions[:upload_throughput] ||= -1
+          end
+          conditions[:offline] = false unless conditions.key?(:offline)
+
           @bridge.network_conditions = conditions
         end
 
+        #
+        # Resets Chromium network emulation settings.
+        #
+
+        def delete_network_conditions
+          @bridge.delete_network_conditions
+        end
+
       end # HasNetworkConditions
     end # DriverExtensions
   end # WebDriver