selenium-webdriver 2.53.3 → 3.142.7

data/lib/selenium/webdriver/firefox/service.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,104 +20,33 @@
 module Selenium
   module WebDriver
     module Firefox
-
       #
       # @api private
       #
-      class Service
-        START_TIMEOUT       = 20
-        SOCKET_LOCK_TIMEOUT = 45
-        STOP_TIMEOUT        = 5
-        DEFAULT_PORT        = 4444
-        MISSING_TEXT        = "Unable to find geckodriver. Please download the executable from https://github.com/mozilla/geckodriver/releases"
-
-        def self.executable_path
-          @executable_path ||= (
-            path = Platform.find_binary("geckodriver*") || Platform.find_binary("wires*")
-            path or raise Error::WebDriverError, MISSING_TEXT
-            Platform.assert_executable path
-
-            path
-          )
-        end
-
-        def self.executable_path=(path)
-          Platform.assert_executable path
-          @executable_path = path
-        end
-
-        def self.default_service(*extra_args)
-          new executable_path, DEFAULT_PORT, *extra_args
-        end
-
-        def initialize(executable_path, port, *extra_args)
-          @executable_path = executable_path
-          @host            = Platform.localhost
-          @port            = Integer(port)
-
-          raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
-
-          @extra_args = extra_args
-        end
-
-        def start
-          Platform.exit_hook { stop } # make sure we don't leave the server running
-
-          socket_lock.locked do
-            find_free_port
-            start_process
-            connect_until_stable
-          end
-        end
 
-        def stop
-          return if @process.nil? || @process.exited?
-
-          Net::HTTP.start(@host, @port) do |http|
-            http.open_timeout = STOP_TIMEOUT / 2
-            http.read_timeout = STOP_TIMEOUT / 2
-
-            http.head("/shutdown")
-          end
-        ensure
-          stop_process
-        end
-
-        def uri
-          URI.parse "http://#{@host}:#{@port}"
-        end
-
-        def find_free_port
-          @port = PortProber.above @port
-        end
-
-        def start_process
-          server_command = [@executable_path, "--binary=#{Firefox::Binary.path}", "--webdriver-port=#{@port}", *@extra_args]
-          @process       = ChildProcess.build(*server_command)
-
-          @process.io.inherit! if $DEBUG || Platform.os == :windows
-          @process.start
+      class Service < WebDriver::Service
+        @default_port = 4444
+        @executable = 'geckodriver'
+        @missing_text = <<~ERROR
+          Unable to find Mozilla geckodriver. Please download the server from
+          https://github.com/mozilla/geckodriver/releases and place it somewhere on your PATH.
+          More info at https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver.
+        ERROR
+        @shutdown_supported = false
+
+        private
+
+        # Note: This processing is deprecated
+        def extract_service_args(driver_opts)
+          driver_args = super
+          driver_opts = driver_opts.dup
+          driver_args << "--binary=#{driver_opts[:binary]}" if driver_opts.key?(:binary)
+          driver_args << "--log=#{driver_opts[:log]}" if driver_opts.key?(:log)
+          driver_args << "--marionette-port=#{driver_opts[:marionette_port]}" if driver_opts.key?(:marionette_port)
+          driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key?(:host)
+          driver_args
         end
-
-        def stop_process
-          @process.poll_for_exit STOP_TIMEOUT
-        rescue ChildProcess::TimeoutError
-          @process.stop STOP_TIMEOUT
-        end
-
-        def connect_until_stable
-          @socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
-
-          unless @socket_poller.connected?
-            raise Error::WebDriverError, "unable to connect to Mozilla geckodriver #{@host}:#{@port}"
-          end
-        end
-
-        def socket_lock
-          @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
-        end
-
       end # Service
     end # Firefox
   end # WebDriver
-end # Service
+end # Selenium

data/lib/selenium/webdriver/firefox/util.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,7 +20,6 @@
 module Selenium
   module WebDriver
     module Firefox
-
       # @api private
       module Util
         module_function
@@ -41,7 +40,6 @@ module Selenium
         def stringified?(str)
           str =~ /^".*"$/
         end
-
       end # Util
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox.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
@@ -21,31 +21,46 @@ require 'timeout'
 require 'socket'
 require 'rexml/document'
 
+require 'selenium/webdriver/firefox/driver'
+
 require 'selenium/webdriver/firefox/util'
 require 'selenium/webdriver/firefox/extension'
 require 'selenium/webdriver/firefox/binary'
 require 'selenium/webdriver/firefox/profiles_ini'
 require 'selenium/webdriver/firefox/profile'
 require 'selenium/webdriver/firefox/launcher'
-require 'selenium/webdriver/firefox/bridge'
-require 'selenium/webdriver/firefox/w3c_bridge'
-require 'selenium/webdriver/firefox/binary'
-require 'selenium/webdriver/firefox/service'
+require 'selenium/webdriver/firefox/legacy/driver'
+
+require 'selenium/webdriver/firefox/marionette/bridge'
+require 'selenium/webdriver/firefox/marionette/driver'
+require 'selenium/webdriver/firefox/options'
 
 module Selenium
   module WebDriver
     module Firefox
-
-      DEFAULT_PORT                    = 7055
-      DEFAULT_ENABLE_NATIVE_EVENTS    = Platform.os == :windows
-      DEFAULT_SECURE_SSL              = false
+      DEFAULT_PORT = 7055
+      DEFAULT_ENABLE_NATIVE_EVENTS = Platform.os == :windows
+      DEFAULT_SECURE_SSL = false
       DEFAULT_ASSUME_UNTRUSTED_ISSUER = true
-      DEFAULT_LOAD_NO_FOCUS_LIB       = false
+      DEFAULT_LOAD_NO_FOCUS_LIB = false
+
+      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 = 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
+      end
 
       def self.path=(path)
         Binary.path = path
       end
-
     end # Firefox
   end # WebDriver
 end # Selenium
+
+require 'selenium/webdriver/firefox/service'

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

@@ -0,0 +1,85 @@
+# 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 IE
+
+      #
+      # Driver implementation for Internet Explorer supporting
+      # both OSS and W3C dialects of JSON wire protocol.
+      # @api private
+      #
+
+      class Driver < WebDriver::Driver
+        include DriverExtensions::HasWebStorage
+        include DriverExtensions::TakesScreenshot
+
+        def initialize(opts = {})
+          opts[:desired_capabilities] = create_capabilities(opts)
+
+          opts[:url] ||= service_url(opts)
+
+          listener = opts.delete(:listener)
+          @bridge = Remote::Bridge.handshake(**opts)
+          super(@bridge, listener: listener)
+        end
+
+        def browser
+          :internet_explorer
+        end
+
+        def quit
+          super
+        ensure
+          @service&.stop
+        end
+
+        private
+
+        def create_capabilities(opts)
+          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.internet_explorer }
+          options = opts.delete(:options) { Options.new }
+
+          if opts.delete(:introduce_flakiness_by_ignoring_security_domains)
+            WebDriver.logger.deprecate ':introduce_flakiness_by_ignoring_security_domains',
+                                       'Selenium::WebDriver::IE::Options#ignore_protected_mode_settings='
+            options.ignore_protected_mode_settings = true
+          end
+
+          native_events = opts.delete(:native_events)
+          unless native_events.nil?
+            WebDriver.logger.deprecate ':native_events', 'Selenium::WebDriver::IE::Options#native_events='
+            options.native_events = native_events
+          end
+
+          # Backward compatibility with older IEDriverServer versions
+          caps[:ignore_protected_mode_settings] = options.ignore_protected_mode_settings
+          caps[:native_events] = options.native_events
+
+          options = options.as_json
+          caps.merge!(options) unless options.empty?
+
+          caps
+        end
+
+      end # Driver
+    end # IE
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,138 @@
+# 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 IE
+      class Options < WebDriver::Common::Options
+        KEY = 'se:ieOptions'
+        SCROLL_TOP = 0
+        SCROLL_BOTTOM = 1
+        CAPABILITIES = {
+          browser_attach_timeout: 'browserAttachTimeout',
+          element_scroll_behavior: 'elementScrollBehavior',
+          full_page_screenshot: 'ie.enableFullPageScreenshot',
+          ensure_clean_session: 'ie.ensureCleanSession',
+          file_upload_dialog_timeout: 'ie.fileUploadDialogTimeout',
+          force_create_process_api: 'ie.forceCreateProcessApi',
+          force_shell_windows_api: 'ie.forceShellWindowsApi',
+          ignore_protected_mode_settings: 'ignoreProtectedModeSettings',
+          ignore_zoom_level: 'ignoreZoomSetting',
+          initial_browser_url: 'initialBrowserUrl',
+          native_events: 'nativeEvents',
+          persistent_hover: 'enablePersistentHover',
+          require_window_focus: 'requireWindowFocus',
+          use_per_process_proxy: 'ie.usePerProcessProxy',
+          validate_cookie_document_type: 'ie.validateCookieDocumentType'
+        }.freeze
+
+        CAPABILITIES.each_key do |key|
+          define_method key do
+            @options[key]
+          end
+
+          define_method "#{key}=" do |value|
+            @options[key] = value
+          end
+        end
+
+        attr_reader :args, :options
+
+        #
+        # Create a new Options instance
+        #
+        # @example
+        #   options = Selenium::WebDriver::IE::Options.new(args: ['--host=127.0.0.1'])
+        #   driver = Selenium::WebDriver.for(:ie, options: options)
+        #
+        # @example
+        #   options = Selenium::WebDriver::IE::Options.new
+        #   options.element_scroll_behavior = Selenium::WebDriver::IE::Options::SCROLL_BOTTOM
+        #   driver = Selenium::WebDriver.for(:ie, options: options)
+        #
+        # @param [Hash] opts the pre-defined options
+        # @option opts [Array<String>] args
+        # @option opts [Integer] browser_attach_timeout
+        # @option opts [Integer] element_scroll_behavior Either SCROLL_TOP or SCROLL_BOTTOM
+        # @option opts [Boolean] full_page_screenshot
+        # @option opts [Boolean] ensure_clean_session
+        # @option opts [Integer] file_upload_dialog_timeout
+        # @option opts [Boolean] force_create_process_api
+        # @option opts [Boolean] force_shell_windows_api
+        # @option opts [Boolean] ignore_protected_mode_settings
+        # @option opts [Boolean] ignore_zoom_level
+        # @option opts [String] initial_browser_url
+        # @option opts [Boolean] native_events
+        # @option opts [Boolean] persistent_hover
+        # @option opts [Boolean] require_window_focus
+        # @option opts [Boolean] use_per_process_proxy
+        # @option opts [Boolean] validate_cookie_document_type
+        #
+
+        def initialize(**opts)
+          @args = Set.new(opts.delete(:args) || [])
+          @options = opts
+          @options[:native_events] = true if @options[:native_events].nil?
+        end
+
+        #
+        # Add a command-line argument to use when starting Internet Explorer.
+        #
+        # @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::IE::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
+
+        #
+        # @api private
+        #
+
+        def as_json(*)
+          opts = {}
+
+          CAPABILITIES.each do |capability_alias, capability_name|
+            capability_value = @options.delete(capability_alias)
+            opts[capability_name] = capability_value unless capability_value.nil?
+          end
+          opts['ie.browserCommandLineSwitches'] = @args.to_a.join(' ') if @args.any?
+          opts.merge!(@options)
+
+          {KEY => generate_as_json(opts)}
+        end
+      end # Options
+    end # IE
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,54 @@
+# 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 IE
+      #
+      # @api private
+      #
+
+      class Service < WebDriver::Service
+        @default_port = 5555
+        @executable = 'IEDriverServer'
+        @missing_text = <<~ERROR
+          Unable to find IEDriverServer. Please download the server from
+          http://selenium-release.storage.googleapis.com/index.html and place it somewhere on your PATH.
+          More info at https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver.
+        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 << "--log-level=#{driver_opts.delete(:log_level).to_s.upcase}" if driver_opts.key?(:log_level)
+          driver_args << "--log-file=#{driver_opts.delete(:log_file)}" if driver_opts.key?(:log_file)
+          driver_args << "--implementation=#{driver_opts.delete(:implementation).to_s.upcase}" if driver_opts.key?(:implementation)
+          driver_args << "--host=#{driver_opts.delete(:host)}" if driver_opts.key?(:host)
+          driver_args << "--extract_path=#{driver_opts.delete(:extract_path)}" if driver_opts.key?(:extract_path)
+          driver_args << "--silent" if driver_opts[:silent] == true
+          driver_args
+        end
+      end # Server
+    end # IE
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/ie.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
@@ -17,23 +17,25 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/ie/driver'
+require 'selenium/webdriver/ie/options'
+
 module Selenium
   module WebDriver
-
-    # @api private
     module IE
       def self.driver_path=(path)
-        Platform.assert_executable path
-        @driver_path = path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path=',
+                                   'Selenium::WebDriver::IE::Service#driver_path='
+        Selenium::WebDriver::IE::Service.driver_path = path
       end
 
       def self.driver_path
-        @driver_path ||= nil
+        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path',
+                                   'Selenium::WebDriver::IE::Service#driver_path'
+        Selenium::WebDriver::IE::Service.driver_path
       end
-
     end # IE
   end # WebDriver
 end # Selenium
 
-require 'selenium/webdriver/ie/server'
-require 'selenium/webdriver/ie/bridge'
+require 'selenium/webdriver/ie/service'