selenium-webdriver 2.45.0 → 3.142.7

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,19 +1,41 @@
+# 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/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
-  end
-end
+    end # IE
+  end # WebDriver
+end # Selenium
 
-require 'selenium/webdriver/ie/server'
-require 'selenium/webdriver/ie/bridge'
+require 'selenium/webdriver/ie/service'