selenium-webdriver 2.53.3 → 3.142.7

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

@@ -0,0 +1,83 @@
+# 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 Legacy
+
+        #
+        # Driver implementation for Firefox using legacy extension.
+        # @api private
+        #
+
+        class Driver < WebDriver::Driver
+          include DriverExtensions::TakesScreenshot
+
+          def initialize(opts = {}) # rubocop:disable Metrics/AbcSize
+            WebDriver.logger.deprecate 'Selenium support for legacy Firefox', 'Firefox via marionette'
+
+            opts[:desired_capabilities] ||= Remote::Capabilities.firefox_legacy
+
+            if opts.key? :proxy
+              WebDriver.logger.deprecate ':proxy', "Selenium::WebDriver::Remote::Capabilities.firefox(proxy: #{opts[:proxy]})"
+              opts[:desired_capabilities].proxy = opts.delete(:proxy)
+            end
+
+            unless opts.key?(:url)
+              port = opts.delete(:port) || DEFAULT_PORT
+              profile = opts.delete(:profile)
+
+              Binary.path = opts[:desired_capabilities][:firefox_binary] if opts[:desired_capabilities][:firefox_binary]
+              @launcher = Launcher.new Binary.new, port, profile
+              @launcher.launch
+              opts[:url] = @launcher.url
+            end
+
+            listener = opts.delete(:listener)
+            WebDriver.logger.info 'Skipping handshake as we know it is OSS.'
+            desired_capabilities = opts.delete(:desired_capabilities)
+            bridge = Remote::Bridge.new(opts)
+            capabilities = bridge.create_session(desired_capabilities)
+            @bridge = Remote::OSS::Bridge.new(capabilities, bridge.session_id, opts)
+
+            begin
+              super(@bridge, listener: listener)
+            rescue
+              @launcher&.quit
+              raise
+            end
+          end
+
+          def browser
+            :firefox
+          end
+
+          def quit
+            super
+            nil
+          ensure
+            @launcher.quit
+          end
+
+        end # Driver
+      end # Legacy
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/firefox/marionette/bridge.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 Firefox
+      module Marionette
+        module Bridge
+
+          COMMANDS = {
+            install_addon: [:post, 'session/:session_id/moz/addon/install'],
+            uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall']
+          }.freeze
+
+          def commands(command)
+            COMMANDS[command] || super
+          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 # Marionette
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,90 @@
+# 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 Marionette
+
+        #
+        # Driver implementation for Firefox using GeckoDriver.
+        # @api private
+        #
+
+        class Driver < WebDriver::Driver
+          include DriverExtensions::HasAddons
+          include DriverExtensions::HasWebStorage
+          include DriverExtensions::TakesScreenshot
+
+          def initialize(opts = {})
+            opts[:desired_capabilities] = create_capabilities(opts)
+
+            opts[:url] ||= service_url(opts)
+
+            listener = opts.delete(:listener)
+            WebDriver.logger.info 'Skipping handshake as we know it is W3C.'
+            desired_capabilities = opts.delete(:desired_capabilities)
+            bridge = Remote::Bridge.new(opts)
+            capabilities = bridge.create_session(desired_capabilities)
+            @bridge = Remote::W3C::Bridge.new(capabilities, bridge.session_id, **opts)
+            @bridge.extend Marionette::Bridge
+
+            super(@bridge, listener: listener)
+          end
+
+          def browser
+            :firefox
+          end
+
+          def quit
+            super
+          ensure
+            @service&.stop
+          end
+
+          private
+
+          def create_capabilities(opts)
+            caps = opts.delete(:desired_capabilities) { Remote::Capabilities.firefox }
+            options = opts.delete(:options) { Options.new }
+
+            firefox_options = opts.delete(:firefox_options)
+            if firefox_options
+              WebDriver.logger.deprecate ':firefox_options', 'Selenium::WebDriver::Firefox::Options'
+              firefox_options.each do |key, value|
+                options.add_option(key, value)
+              end
+            end
+
+            profile = opts.delete(:profile)
+            if profile
+              WebDriver.logger.deprecate ':profile', 'Selenium::WebDriver::Firefox::Options#profile='
+              options.profile = profile
+            end
+
+            options = options.as_json
+            caps.merge!(options) unless options.empty?
+
+            caps
+          end
+        end # Driver
+      end # Marionette
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,162 @@
+# 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
+      class Options < WebDriver::Common::Options
+        attr_reader :args, :prefs, :options, :profile
+        attr_accessor :binary, :log_level
+
+        KEY = 'moz:firefoxOptions'
+
+        #
+        # 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
+        #
+        # @param [Hash] opts the pre-defined options to create the Firefox::Options with
+        # @option opts [String] :binary Path to the Firefox executable to use
+        # @option opts [Array<String>] :args List of command-line arguments to use when starting geckodriver
+        # @option opts [Profile, String] :profile Encoded profile string or Profile instance
+        # @option opts [String, Symbol] :log_level Log level for geckodriver
+        # @option opts [Hash] :prefs A hash with each entry consisting of the key of the preference and its value
+        # @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) || {}
+        end
+
+        #
+        # Add a command-line argument to use when starting Firefox.
+        #
+        # @example Start geckodriver on a specific host
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.add_argument('--host=127.0.0.1')
+        #
+        # @param [String] arg The command-line argument to add
+        #
+
+        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
+        end
+
+        #
+        # Add a preference that is only applied to the user profile in use.
+        #
+        # @example Set the default homepage
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.add_preference('browser.startup.homepage', 'http://www.seleniumhq.com/')
+        #
+        # @param [String] name Key of the preference
+        # @param [Boolean, String, Integer] value Value of the preference
+        #
+
+        def add_preference(name, value)
+          prefs[name] = value
+        end
+
+        #
+        # Run Firefox in headless mode.
+        #
+        # @example Enable headless mode
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.headless!
+        #
+
+        def headless!
+          add_argument '-headless'
+        end
+
+        #
+        # Sets Firefox profile.
+        #
+        # @example Set the custom profile
+        #   profile = Selenium::WebDriver::Firefox::Profile.new
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.profile = profile
+        #
+        # @example Use existing profile
+        #   options = Selenium::WebDriver::Firefox::Options.new
+        #   options.profile = 'myprofile'
+        #
+        # @param [Profile, String] profile Profile to be used
+        #
+
+        def profile=(profile)
+          @profile = process_profile(profile)
+        end
+
+        #
+        # @api private
+        #
+
+        def as_json(*)
+          opts = @options
+
+          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
+
+          {KEY => generate_as_json(opts)}
+        end
+
+        private
+
+        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
+        end
+      end # Options
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -23,15 +23,15 @@ module Selenium
       class Profile
         include ProfileHelper
 
-        VALID_PREFERENCE_TYPES   = [TrueClass, FalseClass, Integer, Float, String]
+        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'
-        }
+          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'
+        }.freeze
 
         attr_reader   :name, :log_file
         attr_writer   :secure_ssl, :native_events, :load_no_focus_lib
@@ -42,7 +42,10 @@ module Selenium
           end
 
           def from_name(name)
-            ini[name]
+            profile = ini[name]
+            return profile if profile
+
+            raise Error::WebDriverError, "unable to find profile named: #{name.inspect}"
           end
 
           def default_preferences
@@ -78,18 +81,19 @@ module Selenium
             @additional_prefs  = {}
           else
             # TODO: clean this up
-            @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"
-            @load_no_focus_lib = model_prefs.delete(WEBDRIVER_PREFS[:load_no_focus_lib]) == "true" # not stored in profile atm, so will always be false.
+            @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
 
-          @extensions        = {}
+          @extensions = {}
         end
 
         def layout_on_disk
-          profile_dir = @model ? create_tmp_copy(@model) : Dir.mktmpdir("webdriver-profile")
+          profile_dir = @model ? create_tmp_copy(@model) : Dir.mktmpdir('webdriver-profile')
           FileReaper << profile_dir
 
           install_extensions(profile_dir)
@@ -100,7 +104,6 @@ module Selenium
           profile_dir
         end
 
-
         #
         # Set a preference for this particular profile.
         #
@@ -109,11 +112,11 @@ module Selenium
         #
 
         def []=(key, value)
-          unless VALID_PREFERENCE_TYPES.any? { |e| value.kind_of? e }
+          unless VALID_PREFERENCE_TYPES.any? { |e| value.is_a? e }
             raise TypeError, "expected one of #{VALID_PREFERENCE_TYPES.inspect}, got #{value.inspect}:#{value.class}"
           end
 
-          if value.kind_of?(String) && Util.stringified?(value)
+          if value.is_a?(String) && Util.stringified?(value)
             raise ArgumentError, "preference values must be plain strings: #{key.inspect} => #{value.inspect}"
           end
 
@@ -130,9 +133,9 @@ module Selenium
         end
 
         def add_webdriver_extension
-          unless @extensions.has_key?(:webdriver)
-            add_extension(WEBDRIVER_EXTENSION_PATH, :webdriver)
-          end
+          return if @extensions.key?(:webdriver)
+
+          add_extension(WEBDRIVER_EXTENSION_PATH, :webdriver)
         end
 
         #
@@ -164,24 +167,18 @@ module Selenium
         end
 
         def proxy=(proxy)
-          unless proxy.kind_of? Proxy
-            raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}"
-          end
+          raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}" unless proxy.is_a? Proxy
 
           case proxy.type
           when :manual
             self['network.proxy.type'] = 1
 
-            set_manual_proxy_preference "ftp", proxy.ftp
-            set_manual_proxy_preference "http", proxy.http
-            set_manual_proxy_preference "ssl", proxy.ssl
-            set_manual_proxy_preference "socks", proxy.socks
+            set_manual_proxy_preference 'ftp', proxy.ftp
+            set_manual_proxy_preference 'http', proxy.http
+            set_manual_proxy_preference 'ssl', proxy.ssl
+            set_manual_proxy_preference 'socks', proxy.socks
 
-            if proxy.no_proxy
-              self["network.proxy.no_proxies_on"] = proxy.no_proxy
-            else
-              self["network.proxy.no_proxies_on"] = ""
-            end
+            self['network.proxy.no_proxies_on'] = proxy.no_proxy || ''
           when :pac
             self['network.proxy.type'] = 2
             self['network.proxy.autoconfig_url'] = proxy.pac
@@ -190,8 +187,10 @@ module Selenium
           else
             raise ArgumentError, "unsupported proxy type #{proxy.type}"
           end
+        end
 
-          proxy
+        def encoded
+          Zipper.zip(layout_on_disk)
         end
 
         private
@@ -199,17 +198,17 @@ module Selenium
         def set_manual_proxy_preference(key, value)
           return unless value
 
-          host, port = value.to_s.split(":", 2)
+          host, port = value.to_s.split(':', 2)
 
           self["network.proxy.#{key}"] = host
           self["network.proxy.#{key}_port"] = Integer(port) if port
         end
 
         def install_extensions(directory)
-          destination = File.join(directory, "extensions")
+          destination = File.join(directory, 'extensions')
 
           @extensions.each do |name, extension|
-            p :extension => name if $DEBUG
+            WebDriver.logger.debug({extenstion: name}.inspect)
             extension.write_to(destination)
           end
         end
@@ -221,7 +220,7 @@ module Selenium
         end
 
         def delete_extensions_cache(directory)
-          FileUtils.rm_f File.join(directory, "extensions.cache")
+          FileUtils.rm_f File.join(directory, 'extensions.cache')
         end
 
         def delete_lock_files(directory)
@@ -247,7 +246,7 @@ module Selenium
           prefs[WEBDRIVER_PREFS[:untrusted_issuer]] = assume_untrusted_certificate_issuer?
 
           # 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
@@ -257,25 +256,25 @@ module Selenium
           return prefs unless File.exist?(path)
 
           File.read(path).split("\n").each do |line|
-            if line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
-              key, value = $1.strip, $2.strip
+            next unless line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
 
-              # wrap the value in an array to make it a valid JSON string.
-              prefs[key] = JSON.parse("[#{value}]").first
-            end
+            key = Regexp.last_match(1).strip
+            value = Regexp.last_match(2).strip
+
+            # wrap the value in an array to make it a valid JSON string.
+            prefs[key] = JSON.parse("[#{value}]").first
           end
 
           prefs
         end
 
         def write_prefs(prefs, path)
-          File.open(path, "w") { |file|
+          File.open(path, 'w') do |file|
             prefs.each do |key, value|
               file.puts %{user_pref("#{key}", #{value.to_json});}
             end
-          }
+          end
         end
-
       end # Profile
     end # Firefox
   end # WebDriver

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -20,12 +20,10 @@
 module Selenium
   module WebDriver
     module Firefox
-
       # @api private
       class ProfilesIni
-
         def initialize
-          @ini_path = File.join(Util.app_data_path, "profiles.ini")
+          @ini_path = File.join(Util.app_data_path, 'profiles.ini')
           @profile_paths = {}
 
           parse if File.exist?(@ini_path)
@@ -52,29 +50,24 @@ module Selenium
           string.split("\n").each do |line|
             case line
             when /^\[Profile/
-              if p = path_for(name, is_relative, path)
-                @profile_paths[name] = p
-                name, path = nil
-              end
+              name, path = nil if path_for(name, is_relative, path)
             when /^Name=(.+)$/
-              name = $1.strip
+              name = Regexp.last_match(1).strip
             when /^IsRelative=(.+)$/
-              is_relative = $1.strip == "1"
+              is_relative = Regexp.last_match(1).strip == '1'
             when /^Path=(.+)$/
-              path = $1.strip
+              path = Regexp.last_match(1).strip
+              p = path_for(name, is_relative, path)
+              @profile_paths[name] = p if p
             end
           end
-
-          if p = path_for(name, is_relative, path)
-            @profile_paths[name] = p
-          end
         end
 
         def path_for(name, is_relative, path)
           return unless [name, path].any?
-          path = is_relative ? File.join(Util.app_data_path, path) : path
-        end
 
+          is_relative ? File.join(Util.app_data_path, path) : path
+        end
       end # ProfilesIni
     end # Firefox
   end # WebDriver