selenium-webdriver 2.45.0 → 3.142.7

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

@@ -1,13 +1,34 @@
+# 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
-
+      #
       # @api private
+      #
+
       class Extension
+        NAMESPACE = 'http://www.mozilla.org/2004/em-rdf#'
+
         def initialize(path)
-          unless File.exist?(path)
-            raise Error::WebDriverError, "could not find extension at #{path.inspect}"
-          end
+          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.exist?(path)
 
           @path             = path
           @should_reap_root = false
@@ -15,10 +36,10 @@ module Selenium
 
         def write_to(extensions_dir)
           root_dir = create_root
-          ext_path = File.join extensions_dir, read_id_from_install_rdf(root_dir)
+          ext_path = File.join extensions_dir, read_id(root_dir)
 
           FileUtils.rm_rf ext_path
-          FileUtils.mkdir_p File.dirname(ext_path), :mode => 0700
+          FileUtils.mkdir_p File.dirname(ext_path), mode: 0o700
           FileUtils.cp_r root_dir, ext_path
 
           FileReaper.reap(root_dir) if @should_reap_root
@@ -31,7 +52,7 @@ module Selenium
             @path
           else
             unless Zipper::EXTENSIONS.include? File.extname(@path)
-              raise Error::WebDriverError, "expected #{Zipper::EXTENSIONS.join(" or ")}, got #{@path.inspect}"
+              raise Error::WebDriverError, "expected #{Zipper::EXTENSIONS.join(' or ')}, got #{@path.inspect}"
             end
 
             @should_reap_root = true
@@ -39,25 +60,35 @@ module Selenium
           end
         end
 
-        def read_id_from_install_rdf(directory)
-          rdf_path = File.join(directory, "install.rdf")
-          doc = REXML::Document.new(File.read(rdf_path))
+        def read_id(directory)
+          read_id_from_install_rdf(directory) || read_id_from_manifest_json(directory)
+        end
 
-          id_node = REXML::XPath.first(doc, "//em:id")
+        def read_id_from_install_rdf(directory)
+          rdf_path = File.join(directory, 'install.rdf')
+          return unless File.exist?(rdf_path)
 
-          if id_node
-            id_node.text
-          else
-            attr_node = REXML::XPath.first(doc, "//@em:id")
+          doc = REXML::Document.new(File.read(rdf_path))
+          namespace = doc.root.namespaces.key(NAMESPACE)
 
-            if attr_node.nil?
-              raise Error::WebDriverError, "cannot locate extension id in #{rdf_path}"
-            end
+          if namespace
+            id_node = REXML::XPath.first(doc, "//#{namespace}:id")
+            return id_node.text if id_node
 
-            attr_node.value
+            attr_node = REXML::XPath.first(doc, "//@#{namespace}:id")
+            return attr_node.value if attr_node
           end
+
+          raise Error::WebDriverError, "cannot locate extension id in #{rdf_path}"
         end
 
+        def read_id_from_manifest_json(directory)
+          manifest_path = File.join(directory, 'manifest.json')
+          return unless File.exist?(manifest_path)
+
+          manifest = JSON.parse(File.read(manifest_path))
+          [manifest['name'].delete(' '), manifest['version']].join('@')
+        end
       end # Extension
     end # Firefox
   end # WebDriver

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

@@ -1,10 +1,27 @@
+# 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
-
       # @api private
       class Launcher
-
         SOCKET_LOCK_TIMEOUT       = 45
         STABLE_CONNECTION_TIMEOUT = 60
 
@@ -14,14 +31,14 @@ module Selenium
 
           raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
 
-          if profile.kind_of? Profile
+          if profile.is_a? Profile
             @profile = profile
           else
             @profile_name = profile
             @profile = nil
           end
 
-          @host = "127.0.0.1"
+          @host = '127.0.0.1'
         end
 
         def url
@@ -32,7 +49,6 @@ module Selenium
           socket_lock.locked do
             find_free_port
             create_profile
-            start_silent_and_wait
             start
             connect_until_stable
           end
@@ -61,45 +77,34 @@ module Selenium
 
         def start
           assert_profile
-          @binary.start_with @profile, @profile_dir, "-foreground"
-        end
-
-        def start_silent_and_wait
-          assert_profile
-
-          @binary.start_with @profile, @profile_dir, "-silent"
-          @binary.wait
+          @binary.start_with @profile, @profile_dir, '-foreground'
         end
 
         def connect_until_stable
           poller = SocketPoller.new(@host, @port, STABLE_CONNECTION_TIMEOUT)
 
-          unless poller.connected?
-            @binary.quit
-            raise Error::WebDriverError, "unable to obtain stable firefox connection in #{STABLE_CONNECTION_TIMEOUT} seconds (#{@host}:#{@port})"
-          end
+          return if poller.connected?
+
+          @binary.quit
+          error = "unable to obtain stable firefox connection in #{STABLE_CONNECTION_TIMEOUT} seconds (#{@host}:#{@port})"
+          raise Error::WebDriverError, error
         end
 
         def fetch_profile
-          if @profile_name
-            @profile = Profile.from_name @profile_name
-
-            unless @profile
-              raise Error::WebDriverError, "unable to find profile named: #{@profile_name.inspect}"
-            end
-          else
-            @profile = Profile.new
-          end
+          @profile = if @profile_name
+                       Profile.from_name @profile_name
+                     else
+                       Profile.new
+                     end
         end
 
         def assert_profile
-          raise Error::WebDriverError, "must create_profile first" unless @profile && @profile_dir
+          raise Error::WebDriverError, 'must create_profile first' unless @profile && @profile_dir
         end
 
         def socket_lock
           @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
         end
-
       end # Launcher
     end # Firefox
   end # WebDriver

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