selenium-webdriver 3.142.7 → 4.3.0

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

@@ -17,6 +17,8 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chrome/driver'
+
 module Selenium
   module WebDriver
     module Edge
@@ -26,40 +28,16 @@ module Selenium
       # @api private
       #
 
-      class Driver < WebDriver::Driver
-        include DriverExtensions::TakesScreenshot
-
-        def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::Capabilities.edge
-
-          opts[:url] ||= service_url(opts)
-
-          listener = opts.delete(:listener)
-
-          # Edge is mostly using W3C dialect, but a request to
-          # create session responds with OSS-like body,
-          # so we need to force W3C implementation.
-          desired_capabilities = opts.delete(:desired_capabilities)
-          bridge = Remote::Bridge.new(opts)
-          capabilities = bridge.create_session(desired_capabilities)
-
-          WebDriver.logger.info 'Forcing W3C dialect.'
-          @bridge = Remote::W3C::Bridge.new(capabilities, bridge.session_id, **opts)
-          @bridge.extend Edge::Bridge
-
-          super(@bridge, listener: listener)
-        end
-
+      class Driver < Selenium::WebDriver::Chrome::Driver
         def browser
           :edge
         end
 
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
+        private
 
+        def devtools_address
+          "http://#{capabilities['ms:edgeOptions']['debuggerAddress']}"
+        end
       end # Driver
     end # Edge
   end # WebDriver

data/lib/selenium/webdriver/edge/features.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.
+
+require 'selenium/webdriver/chrome/features'
+
+module Selenium
+  module WebDriver
+    module Edge
+      module Features
+
+        include WebDriver::Chrome::Features
+
+        EDGE_COMMANDS = {
+          get_cast_sinks: [:get, 'session/:session_id/ms/cast/get_sinks'],
+          set_cast_sink_to_use: [:post, 'session/:session_id/ms/cast/set_sink_to_use'],
+          start_cast_tab_mirroring: [:post, 'session/:session_id/ms/cast/start_tab_mirroring'],
+          start_cast_desktop_mirroring: [:post, 'session/:session_id/ms/cast/start_desktop_mirroring'],
+          get_cast_issue_message: [:get, 'session/:session_id/ms/cast/get_issue_message'],
+          stop_casting: [:post, 'session/:session_id/ms/cast/stop_casting'],
+          send_command: [:post, 'session/:session_id/ms/cdp/execute']
+        }.freeze
+
+        def commands(command)
+          EDGE_COMMANDS[command] || Chrome::Features::CHROME_COMMANDS[command] || self.class::COMMANDS[command]
+        end
+      end # Bridge
+    end # Edge
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/edge/options.rb

@@ -17,62 +17,25 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chrome/options'
+
 module Selenium
   module WebDriver
     module Edge
-      class Options
-        attr_accessor :in_private, :start_page
-        attr_reader :extension_paths
+      class Options < Selenium::WebDriver::Chrome::Options
+        KEY = 'ms:edgeOptions'
+        BROWSER = 'MicrosoftEdge'
 
-        #
-        # Create a new Options instance for Edge.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Edge::Options.new(in_private: true)
-        #   driver = Selenium::WebDriver.for :edge, options: options
-        #
-        # @param [Hash] opts the pre-defined options to create the Edge::Options with
-        # @option opts [Boolean] :in_private Start in private mode. Default is false
-        # @option opts [Array<String>] :extension_paths A list of full paths to extensions to install on startup
-        # @option opts [String] :start_page Default page to start with
-        #
-        # @see https://docs.microsoft.com/en-us/microsoft-edge/webdriver
-        #
+        protected
 
-        def initialize(**opts)
-          @in_private = opts.delete(:in_private) || false
-          @extension_paths = opts.delete(:extension_paths) || []
-          @start_page = opts.delete(:start_page)
+        def enable_logging(browser_options)
+          browser_options['ms:loggingPrefs'] = @logging_prefs
         end
 
-        #
-        # Add an extension by local path.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Edge::Options.new
-        #   options.add_extension_path('C:\path\to\extension')
-        #
-        # @param [String] path The local path to the extension folder
-        #
-
-        def add_extension_path(path)
-          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path)
-
-          @extension_paths << path
-        end
-
-        #
-        # @api private
-        #
-
-        def as_json(*)
-          opts = {}
-
-          opts['ms:inPrivate'] = true if @in_private
-          opts['ms:extensionPaths'] = @extension_paths if @extension_paths.any?
-          opts['ms:startPage'] = @start_page if @start_page
+        private
 
-          opts
+        def binary_path
+          Edge.path
         end
       end # Options
     end # Edge

data/lib/selenium/webdriver/edge/profile.rb

@@ -0,0 +1,33 @@
+# 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/chrome/profile'
+
+module Selenium
+  module WebDriver
+    module Edge
+      #
+      # @private
+      #
+
+      class Profile < Selenium::WebDriver::Chrome::Profile
+      end # Profile
+    end # Edge
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/edge/service.rb

@@ -17,36 +17,20 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chrome/service'
+
 module Selenium
   module WebDriver
     module Edge
-      #
-      # @api private
-      #
-
-      class Service < WebDriver::Service
-        @default_port = 17556
-        @executable = 'MicrosoftWebDriver'
-        @missing_text = <<~ERROR
-          Unable to find MicrosoftWebDriver. Please download the server from
-          https://www.microsoft.com/en-us/download/details.aspx?id=48212 and place it somewhere on your PATH.
-          More info at https://github.com/SeleniumHQ/selenium/wiki/MicrosoftWebDriver.
+      class Service < Selenium::WebDriver::Chrome::Service
+        DEFAULT_PORT = 9515
+        EXECUTABLE = 'msedgedriver'
+        MISSING_TEXT = <<~ERROR
+          Unable to find msedgedriver. Please download the server from
+          https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ and place it somewhere on your PATH.
         ERROR
-        @shutdown_supported = true
-
-        private
-
-        # Note: This processing is deprecated
-        def extract_service_args(driver_opts)
-          driver_args = super
-          driver_opts = driver_opts.dup
-          driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key? :host
-          driver_args << "--package=#{driver_opts[:package]}" if driver_opts.key? :package
-          driver_args << "--silent" if driver_opts[:silent] == true
-          driver_args << "--verbose" if driver_opts[:verbose] == true
-          driver_args
-        end
+        SHUTDOWN_SUPPORTED = true
       end # Service
     end # Edge
   end # WebDriver
-end # Service
+end # Selenium

data/lib/selenium/webdriver/edge.rb

@@ -19,26 +19,23 @@
 
 require 'net/http'
 
-require 'selenium/webdriver/edge/bridge'
-require 'selenium/webdriver/edge/driver'
-require 'selenium/webdriver/edge/options'
-
 module Selenium
   module WebDriver
     module Edge
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path=',
-                                   'Selenium::WebDriver::Edge::Service#driver_path='
-        Selenium::WebDriver::Edge::Service.driver_path = path
+      autoload :Features, 'selenium/webdriver/edge/features'
+      autoload :Driver, 'selenium/webdriver/edge/driver'
+      autoload :Profile, 'selenium/webdriver/edge/profile'
+      autoload :Options, 'selenium/webdriver/edge/options'
+      autoload :Service, 'selenium/webdriver/edge/service'
+
+      def self.path=(path)
+        Platform.assert_executable path
+        @path = path
       end
 
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path',
-                                   'Selenium::WebDriver::Edge::Service#driver_path'
-        Selenium::WebDriver::Edge::Service.driver_path
+      def self.path
+        @path ||= nil
       end
     end # Edge
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/edge/service'

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

@@ -20,30 +20,43 @@
 module Selenium
   module WebDriver
     module Firefox
-      module Driver
-        class << self
-
-          #
-          # Instantiates correct Firefox driver implementation
-          # @return [Marionette::Driver, Legacy::Driver]
-          #
-
-          def new(**opts)
-            if marionette?(opts)
-              Firefox::Marionette::Driver.new(opts)
-            else
-              Firefox::Legacy::Driver.new(opts)
-            end
-          end
 
-          private
+      #
+      # Driver implementation for Firefox using GeckoDriver.
+      # @api private
+      #
+
+      class Driver < WebDriver::Driver
+        EXTENSIONS = [DriverExtensions::HasAddons,
+                      DriverExtensions::FullPageScreenshot,
+                      DriverExtensions::HasContext,
+                      DriverExtensions::HasBiDi,
+                      DriverExtensions::HasDevTools,
+                      DriverExtensions::HasLogEvents,
+                      DriverExtensions::HasNetworkInterception,
+                      DriverExtensions::HasWebStorage,
+                      DriverExtensions::PrintsPage].freeze
+
+        def browser
+          :firefox
+        end
+
+        private
 
-          def marionette?(opts)
-            opts.delete(:marionette) != false &&
-              (!opts[:desired_capabilities] || opts[:desired_capabilities][:marionette] != false)
+        def devtools_url
+          if capabilities['moz:debuggerAddress'].nil?
+            raise(Error::WebDriverError, "DevTools is not supported by this version of Firefox; use v85 or higher")
           end
+
+          uri = URI("http://#{capabilities['moz:debuggerAddress']}")
+          response = Net::HTTP.get(uri.hostname, '/json/version', uri.port)
+
+          JSON.parse(response)['webSocketDebuggerUrl']
         end
 
+        def devtools_version
+          Firefox::DEVTOOLS_VERSION
+        end
       end # Driver
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/extension.rb

@@ -87,6 +87,14 @@ module Selenium
           return unless File.exist?(manifest_path)
 
           manifest = JSON.parse(File.read(manifest_path))
+          applications_gecko_id(manifest) || name_and_version(manifest)
+        end
+
+        def applications_gecko_id(manifest)
+          manifest.dig('applications', 'gecko', 'id')&.strip
+        end
+
+        def name_and_version(manifest)
           [manifest['name'].delete(' '), manifest['version']].join('@')
         end
       end # Extension

data/lib/selenium/webdriver/firefox/features.rb

@@ -0,0 +1,63 @@
+# 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 Firefox
+      module Features
+
+        FIREFOX_COMMANDS = {
+          get_context: [:get, 'session/:session_id/moz/context'],
+          set_context: [:post, 'session/:session_id/moz/context'],
+          install_addon: [:post, 'session/:session_id/moz/addon/install'],
+          uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall'],
+          full_page_screenshot: [:get, 'session/:session_id/moz/screenshot/full']
+        }.freeze
+
+        def commands(command)
+          FIREFOX_COMMANDS[command] || self.class::COMMANDS[command]
+        end
+
+        def install_addon(path, temporary)
+          addon = File.open(path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
+
+          payload = {addon: addon}
+          payload[:temporary] = temporary unless temporary.nil?
+          execute :install_addon, {}, payload
+        end
+
+        def uninstall_addon(id)
+          execute :uninstall_addon, {}, {id: id}
+        end
+
+        def full_screenshot
+          execute :full_page_screenshot
+        end
+
+        def context=(context)
+          execute :set_context, {}, {context: context}
+        end
+
+        def context
+          execute :get_context
+        end
+      end # Bridge
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/firefox/options.rb

@@ -20,18 +20,32 @@
 module Selenium
   module WebDriver
     module Firefox
-      class Options < WebDriver::Common::Options
-        attr_reader :args, :prefs, :options, :profile
-        attr_accessor :binary, :log_level
+      class Options < WebDriver::Options
+        attr_accessor :debugger_address
 
         KEY = 'moz:firefoxOptions'
 
+        # see: https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions
+        CAPABILITIES = {binary: 'binary',
+                        args: 'args',
+                        log: 'log',
+                        prefs: 'prefs',
+                        env: 'env',
+                        android_package: 'androidPackage',
+                        android_activity: 'androidActivity',
+                        android_device_serial: 'androidDeviceSerial',
+                        android_intent_arguments: 'androidIntentArguments'}.freeze
+        BROWSER = 'firefox'
+
+        # NOTE: special handling of 'profile' to validate when set instead of when used
+        attr_reader :profile
+
         #
         # Create a new Options instance, only for W3C-capable versions of Firefox.
         #
         # @example
         #   options = Selenium::WebDriver::Firefox::Options.new(args: ['--host=127.0.0.1'])
-        #   driver = Selenium::WebDriver.for :firefox, options: options
+        #   driver = Selenium::WebDriver.for :firefox, capabilities: options
         #
         # @param [Hash] opts the pre-defined options to create the Firefox::Options with
         # @option opts [String] :binary Path to the Firefox executable to use
@@ -42,13 +56,17 @@ module Selenium
         # @option opts [Hash] :options A hash for raw options
         #
 
-        def initialize(**opts)
-          @args = Set.new(opts.delete(:args) || [])
-          @binary = opts.delete(:binary)
-          @profile = process_profile(opts.delete(:profile))
-          @log_level = opts.delete(:log_level)
-          @prefs = opts.delete(:prefs) || {}
-          @options = opts.delete(:options) || {}
+        def initialize(log_level: nil, **opts)
+          @debugger_address = opts.delete(:debugger_address)
+
+          super(**opts)
+
+          @options[:args] ||= []
+          @options[:prefs] ||= {}
+          @options[:env] ||= {}
+          @options[:log] ||= {level: log_level} if log_level
+
+          process_profile(@options.delete(:profile))
         end
 
         #
@@ -62,22 +80,7 @@ module Selenium
         #
 
         def add_argument(arg)
-          @args << arg
-        end
-
-        #
-        # Add a new option not yet handled by these bindings.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Firefox::Options.new
-        #   options.add_option(:foo, 'bar')
-        #
-        # @param [String, Symbol] name Name of the option
-        # @param [Boolean, String, Integer] value Value of the option
-        #
-
-        def add_option(name, value)
-          @options[name] = value
+          @options[:args] << arg
         end
 
         #
@@ -92,7 +95,7 @@ module Selenium
         #
 
         def add_preference(name, value)
-          prefs[name] = value
+          @options[:prefs][name] = value
         end
 
         #
@@ -123,38 +126,58 @@ module Selenium
         #
 
         def profile=(profile)
-          @profile = process_profile(profile)
+          process_profile(profile)
         end
 
-        #
-        # @api private
-        #
+        def log_level
+          @options.dig(:log, :level)
+        end
 
-        def as_json(*)
-          opts = @options
+        def log_level=(level)
+          @options[:log] = {level: level}
+        end
 
-          opts[:profile] = @profile.encoded if @profile
-          opts[:args] = @args.to_a if @args.any?
-          opts[:binary] = @binary if @binary
-          opts[:prefs] = @prefs unless @prefs.empty?
-          opts[:log] = {level: @log_level} if @log_level
+        #
+        # Enables mobile browser use on Android.
+        #
+        # @see https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions#android
+        #
+        # @param [String] package The package name of the Chrome or WebView app.
+        # @param [String] serial_number The serial number of the device on which to launch the application.
+        #   If not specified and multiple devices are attached, an error will be returned.
+        # @param [String] activity The fully qualified class name of the activity to be launched.
+        # @param [Array] intent_arguments Arguments to launch the intent with.
+        #
 
-          {KEY => generate_as_json(opts)}
+        def enable_android(package: 'org.mozilla.firefox', serial_number: nil, activity: nil, intent_arguments: nil)
+          @options[:android_package] = package
+          @options[:android_activity] = activity unless activity.nil?
+          @options[:android_device_serial] = serial_number unless serial_number.nil?
+          @options[:android_intent_arguments] = intent_arguments unless intent_arguments.nil?
         end
 
         private
 
+        def process_browser_options(browser_options)
+          browser_options['moz:debuggerAddress'] = true if @debugger_address
+          options = browser_options[KEY]
+          options['binary'] ||= Firefox.path if Firefox.path
+          options['profile'] = @profile if @profile
+        end
+
         def process_profile(profile)
-          return unless profile
-
-          case profile
-          when Profile
-            profile
-          when String
-            Profile.from_name(profile)
-          else
-            raise Error::WebDriverError, "don't know how to handle profile: #{profile.inspect}"
-          end
+          @profile = case profile
+                     when nil
+                       nil
+                     when Profile
+                       profile
+                     else
+                       Profile.from_name(profile)
+                     end
+        end
+
+        def camelize?(key)
+          key != "prefs"
         end
       end # Options
     end # Firefox