selenium-webdriver 4.0.0.alpha3 → 4.0.0.beta1

data/lib/selenium/webdriver/{edge_chrome → edge}/service.rb

@@ -21,11 +21,7 @@ require 'selenium/webdriver/chrome/service'
 
 module Selenium
   module WebDriver
-    module EdgeChrome
-      #
-      # @api private
-      #
-
+    module Edge
       class Service < Selenium::WebDriver::Chrome::Service
         DEFAULT_PORT = 9515
         EXECUTABLE = 'msedgedriver'
@@ -35,6 +31,6 @@ module Selenium
         ERROR
         SHUTDOWN_SUPPORTED = true
       end # Service
-    end # EdgeChrome
+    end # Edge
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/firefox.rb

@@ -25,7 +25,6 @@ module Selenium
   module WebDriver
     module Firefox
       autoload :Extension, 'selenium/webdriver/firefox/extension'
-      autoload :Binary, 'selenium/webdriver/firefox/binary'
       autoload :ProfilesIni, 'selenium/webdriver/firefox/profiles_ini'
       autoload :Profile, 'selenium/webdriver/firefox/profile'
       autoload :Bridge, 'selenium/webdriver/firefox/bridge'
@@ -41,18 +40,25 @@ module Selenium
 
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path=',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path='
+                                   'Selenium::WebDriver::Firefox::Service#driver_path=',
+                                   id: :driver_path
         Selenium::WebDriver::Firefox::Service.driver_path = path
       end
 
       def self.driver_path
         WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path'
+                                   'Selenium::WebDriver::Firefox::Service#driver_path',
+                                   id: :driver_path
         Selenium::WebDriver::Firefox::Service.driver_path
       end
 
       def self.path=(path)
-        Binary.path = path
+        Platform.assert_executable path
+        @path = path
+      end
+
+      def self.path
+        @path ||= nil
       end
     end # Firefox
   end # WebDriver

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

@@ -20,7 +20,7 @@
 module Selenium
   module WebDriver
     module Firefox
-      module Bridge
+      class Bridge < WebDriver::Remote::Bridge
 
         COMMANDS = {
           install_addon: [:post, 'session/:session_id/moz/addon/install'],

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

@@ -28,27 +28,27 @@ module Selenium
 
       class Driver < WebDriver::Driver
         include DriverExtensions::HasAddons
+        include DriverExtensions::HasDevTools
+        include DriverExtensions::HasLogEvents
         include DriverExtensions::HasWebStorage
-        include DriverExtensions::TakesScreenshot
+        include DriverExtensions::PrintsPage
 
-        def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::Capabilities.firefox
-
-          opts[:url] ||= service_url(opts)
+        def browser
+          :firefox
+        end
 
-          listener = opts.delete(:listener)
-          desired_capabilities = opts.delete(:desired_capabilities)
-          options = opts.delete(:options)
+        def bridge_class
+          Bridge
+        end
 
-          @bridge = Remote::Bridge.new(opts)
-          @bridge.extend Bridge
-          @bridge.create_session(desired_capabilities, options)
+        private
 
-          super(@bridge, listener: listener)
+        def devtools_version
+          85
         end
 
-        def browser
-          :firefox
+        def debugger_address
+          capabilities['moz:debuggerAddress']
         end
       end # Driver
     end # Firefox

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

@@ -0,0 +1,47 @@
+# 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 = {
+          install_addon: [:post, 'session/:session_id/moz/addon/install'],
+          uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall']
+        }.freeze
+
+        def commands(command)
+          FIREFOX_COMMANDS[command] || self.class::COMMANDS[command]
+        end
+
+        def install_addon(path, temporary)
+          payload = {path: path}
+          payload[:temporary] = temporary unless temporary.nil?
+          execute :install_addon, {}, payload
+        end
+
+        def uninstall_addon(id)
+          execute :uninstall_addon, {}, {id: id}
+        end
+
+      end # Bridge
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -21,24 +21,19 @@ module Selenium
   module WebDriver
     module Firefox
       class Options < WebDriver::Options
+        attr_accessor :debugger_address
+
         KEY = 'moz:firefoxOptions'
 
         # see: https://firefox-source-docs.mozilla.org/testing/geckodriver/Capabilities.html
         CAPABILITIES = {binary: 'binary',
                         args: 'args',
-                        profile: 'profile',
                         log: 'log',
                         prefs: 'prefs'}.freeze
+        BROWSER = 'firefox'
 
-        CAPABILITIES.each_key do |key|
-          define_method key do
-            @options[key]
-          end
-
-          define_method "#{key}=" do |value|
-            @options[key] = value
-          end
-        end
+        # 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.
@@ -57,10 +52,15 @@ module Selenium
         #
 
         def initialize(log_level: nil, **opts)
-          super(opts)
+          @debugger_address = opts.delete(:debugger_address)
+
+          super(**opts)
 
+          @options[:args] ||= []
+          @options[:prefs] ||= {}
           @options[:log] ||= {level: log_level} if log_level
-          process_profile(@options[:profile]) if @options.key?(:profile)
+
+          process_profile(@options.delete(:profile))
         end
 
         #
@@ -74,7 +74,6 @@ module Selenium
         #
 
         def add_argument(arg)
-          @options[:args] ||= []
           @options[:args] << arg
         end
 
@@ -90,7 +89,6 @@ module Selenium
         #
 
         def add_preference(name, value)
-          @options[:prefs] ||= {}
           @options[:prefs][name] = value
         end
 
@@ -121,7 +119,6 @@ module Selenium
         # @param [Profile, String] profile Profile to be used
         #
 
-        undef profile=
         def profile=(profile)
           process_profile(profile)
         end
@@ -134,24 +131,24 @@ module Selenium
           @options[:log] = {level: level}
         end
 
-        #
-        # @api private
-        #
+        private
 
-        def as_json(*)
-          {KEY => generate_as_json(super)}
+        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
 
-        private
-
         def process_profile(profile)
-          @options[:profile] = if profile.nil?
-                                 nil
-                               elsif profile.is_a? Profile
-                                 profile
-                               else
-                                 Profile.from_name(profile)
-                               end
+          @profile = case profile
+                     when nil
+                       nil
+                     when Profile
+                       profile
+                     else
+                       Profile.from_name(profile)
+                     end
         end
       end # Options
     end # Firefox

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

@@ -23,18 +23,18 @@ module Selenium
       class Profile
         include ProfileHelper
 
-        VALID_PREFERENCE_TYPES   = [TrueClass, FalseClass, Integer, Float, String].freeze
-        WEBDRIVER_EXTENSION_PATH = File.expand_path("#{WebDriver.root}/selenium/webdriver/firefox/extension/webdriver.xpi")
-        WEBDRIVER_PREFS          = {
-          native_events: 'webdriver_enable_native_events',
-          untrusted_certs: 'webdriver_accept_untrusted_certs',
-          untrusted_issuer: 'webdriver_assume_untrusted_issuer',
-          port: 'webdriver_firefox_port',
-          log_file: 'webdriver.log.file'
+        VALID_PREFERENCE_TYPES = [TrueClass, FalseClass, Integer, Float, String].freeze
+
+        DEFAULT_PREFERENCES = {
+          "browser.newtabpage.enabled" => false,
+          "browser.startup.homepage" => "about:blank",
+          "browser.usedOnWindows10.introURL" => "about:blank",
+          "network.captive-portal-service.enabled" => false,
+          "security.csp.enable" => false
         }.freeze
 
         attr_reader   :name, :log_file
-        attr_writer   :secure_ssl, :native_events, :load_no_focus_lib
+        attr_writer   :secure_ssl, :load_no_focus_lib
 
         class << self
           def ini
@@ -48,12 +48,6 @@ module Selenium
             raise Error::WebDriverError, "unable to find profile named: #{name.inspect}"
           end
 
-          def default_preferences
-            @default_preferences ||= JSON.parse(
-              File.read(File.expand_path("#{WebDriver.root}/selenium/webdriver/firefox/extension/prefs.json"))
-            ).freeze
-          end
-
           def decoded(json)
             JSON.parse(json)
           end
@@ -74,14 +68,7 @@ module Selenium
         def initialize(model = nil)
           @model = verify_model(model)
 
-          model_prefs = read_model_prefs
-
-          if model_prefs.empty?
-            assign_default_preferences
-          else
-            assign_updated_preferences(model_prefs)
-          end
-
+          @additional_prefs = read_model_prefs
           @extensions = {}
         end
 
@@ -125,12 +112,6 @@ module Selenium
           self[WEBDRIVER_PREFS[:log_file]] = file
         end
 
-        def add_webdriver_extension
-          return if @extensions.key?(:webdriver)
-
-          add_extension(WEBDRIVER_EXTENSION_PATH, :webdriver)
-        end
-
         #
         # Add the extension (directory, .zip or .xpi) at the given path to the profile.
         #
@@ -139,26 +120,6 @@ module Selenium
           @extensions[name] = Extension.new(path)
         end
 
-        def native_events?
-          @native_events == true
-        end
-
-        def load_no_focus_lib?
-          @load_no_focus_lib == true
-        end
-
-        def secure_ssl?
-          @secure_ssl == true
-        end
-
-        def assume_untrusted_certificate_issuer?
-          @untrusted_issuer == true
-        end
-
-        def assume_untrusted_certificate_issuer=(bool)
-          @untrusted_issuer = bool
-        end
-
         def proxy=(proxy)
           raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}" unless proxy.is_a? Proxy
 
@@ -186,24 +147,6 @@ module Selenium
 
         private
 
-        def assign_default_preferences
-          @native_events     = DEFAULT_ENABLE_NATIVE_EVENTS
-          @secure_ssl        = DEFAULT_SECURE_SSL
-          @untrusted_issuer  = DEFAULT_ASSUME_UNTRUSTED_ISSUER
-          @load_no_focus_lib = DEFAULT_LOAD_NO_FOCUS_LIB
-
-          @additional_prefs  = {}
-        end
-
-        def assign_updated_preferences(model_prefs)
-          @native_events     = model_prefs.delete(WEBDRIVER_PREFS[:native_events]) == 'true'
-          @secure_ssl        = model_prefs.delete(WEBDRIVER_PREFS[:untrusted_certs]) != 'true'
-          @untrusted_issuer  = model_prefs.delete(WEBDRIVER_PREFS[:untrusted_issuer]) == 'true'
-          # not stored in profile atm, so will always be false.
-          @load_no_focus_lib = model_prefs.delete(WEBDRIVER_PREFS[:load_no_focus_lib]) == 'true'
-          @additional_prefs  = model_prefs
-        end
-
         def set_manual_proxy_preference(key, value)
           return unless value
 
@@ -245,17 +188,11 @@ module Selenium
         def update_user_prefs_in(directory)
           path = File.join(directory, 'user.js')
           prefs = read_user_prefs(path)
-
-          prefs.merge! self.class.default_preferences.fetch 'mutable'
-          prefs.merge! @additional_prefs
-          prefs.merge! self.class.default_preferences.fetch 'frozen'
-
-          prefs[WEBDRIVER_PREFS[:untrusted_certs]]  = !secure_ssl?
-          prefs[WEBDRIVER_PREFS[:native_events]]    = native_events?
-          prefs[WEBDRIVER_PREFS[:untrusted_issuer]] = assume_untrusted_certificate_issuer?
+          prefs.merge! self.class::DEFAULT_PREFERENCES
+          prefs.merge!(@additional_prefs)
 
           # If the user sets the home page, we should also start up there
-          prefs['startup.homepage_welcome_url'] = prefs['browser.startup.homepage']
+          prefs['startup.homepage_welcome_url'] ||= prefs['browser.startup.homepage']
 
           write_prefs prefs, path
         end

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

@@ -20,10 +20,6 @@
 module Selenium
   module WebDriver
     module Firefox
-      #
-      # @api private
-      #
-
       class Service < WebDriver::Service
         DEFAULT_PORT = 4444
         EXECUTABLE = 'geckodriver'
@@ -36,7 +32,7 @@ module Selenium
 
         private
 
-        # Note: This processing is deprecated
+        # NOTE: This processing is deprecated
         def extract_service_args(driver_opts)
           driver_args = super
           driver_opts = driver_opts.dup

data/lib/selenium/webdriver/ie.rb

@@ -26,13 +26,15 @@ module Selenium
 
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path=',
-                                   'Selenium::WebDriver::IE::Service#driver_path='
+                                   'Selenium::WebDriver::IE::Service#driver_path=',
+                                   id: :driver_path
         Selenium::WebDriver::IE::Service.driver_path = path
       end
 
       def self.driver_path
         WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path',
-                                   'Selenium::WebDriver::IE::Service#driver_path'
+                                   'Selenium::WebDriver::IE::Service#driver_path',
+                                   id: :driver_path
         Selenium::WebDriver::IE::Service.driver_path
       end
     end # IE