selenium-webdriver 4.0.0.alpha2 → 4.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfdda64a93649dd407e9a99d0547280f33492826
-  data.tar.gz: 7c643c63e461f17cabb016812cffa21e3001f813
+  metadata.gz: da9450a24f91be2d365f304db93f1b3fbbb6d6e1
+  data.tar.gz: 61bec02fa4350770cab7be2fe53e090d2a082f60
 SHA512:
-  metadata.gz: a5b8faba158cabc734b9f0fa8e7fc00bdea0b127bafc2b6f363cefd3bc2aea78d176cc5d042eda9c2271d1dd52d951bd93c8449fdb381e7fa35ebafab3ffe88f
-  data.tar.gz: 113f4c13373c915447172e43cc5da4435bc785693c06e6a119f9ecdd5fcd3efc01a43b8d295f655be00e5176e3a901f721d6cfa053a606639e5c0b5d5092ecc5
+  metadata.gz: a80117bb49c8dcb0525a792adb68c55c76859e4773a3897b7c202a424dcc14e5b928034efd0fc6592098391c9a2a4b66ab034d7b5b84609bfaf59c742fb46441
+  data.tar.gz: 22c50b02ac458fe02a3a45bb8709dff6e3913b7d5727c82932a959c3fca9a4e41eeb808a71d1d5c5fd2b039ce4ca866a29a3d5b0e3fc829dd02b2c055d37a367

data/CHANGES

@@ -1,3 +1,16 @@
+4.0.0.alpha3 (2019-07-08)
+=========================
+
+Ruby:
+  * All documented driver capabilities supported in respective browser Options class by constructor and accessor
+  * driver constructor :options and :desired_capabilities generate the same capabilities for local and remote execution
+
+Chrome:
+  * Add support for browser logging with latest versions of chromedriver
+
+Edge:
+  * Add support for Chromium based implementation
+
 4.0.0.alpha2 (2019-05-02)
 =========================
 
@@ -34,6 +47,31 @@ Firefox:
     result in NoMethodError. Now it will find a profile with such name on your
     system and use it accordingly (issue #7119)
 
+3.142.3 (2019-05-21)
+====================
+
+Firefox:
+  * Fixed a regression when Firefox binary path was not sent to GeckoDriver
+    by default and browser could not be located (issue #7219)
+
+3.142.2 (2019-05-11)
+====================
+
+Chrome:
+  * Fixed an issue when getting/setting network conditions and sending CDP
+    commands didn't work with Grid (issue #7174)
+
+Safari:
+  * Fixed an issue when getting/setting permissions and attaching debugger
+    didn't work with Grid (issue #7174)
+
+3.142.1 (2019-05-07)
+====================
+
+Firefox:
+  * Fixed an issue when processing error in legacy driver would result
+    in NoMethodError (issue #7178)
+
 3.142.0 (2019-04-24)
 ====================
 

data/lib/selenium/server.rb

@@ -85,7 +85,7 @@ module Selenium
                   segment_count += 1
 
                   if (segment_count % 15).zero?
-                    percent = (progress.to_f / total.to_f) * 100
+                    percent = progress.fdiv(total) * 100
                     print "#{CL_RESET}Downloading #{download_file_name}: #{percent.to_i}% (#{progress} / #{total})"
                     segment_count = 0
                   end
@@ -179,7 +179,7 @@ module Selenium
       @timeout    = opts.fetch(:timeout, 30)
       @background = opts.fetch(:background, false)
       @log        = opts[:log]
-
+      @log_file   = nil
       @additional_args = []
     end
 

data/lib/selenium/webdriver.rb

@@ -35,13 +35,15 @@ module Selenium
     Rectangle = Struct.new(:x, :y, :width, :height)
     Location  = Struct.new(:latitude, :longitude, :altitude)
 
-    autoload :Chrome,    'selenium/webdriver/chrome'
-    autoload :Edge,      'selenium/webdriver/edge'
-    autoload :Firefox,   'selenium/webdriver/firefox'
-    autoload :IE,        'selenium/webdriver/ie'
-    autoload :Remote,    'selenium/webdriver/remote'
-    autoload :Safari,    'selenium/webdriver/safari'
-    autoload :Support,   'selenium/webdriver/support'
+    autoload :Chrome,     'selenium/webdriver/chrome'
+    autoload :Edge,       'selenium/webdriver/edge'
+    autoload :EdgeHtml,   'selenium/webdriver/edge'
+    autoload :EdgeChrome, 'selenium/webdriver/edge'
+    autoload :Firefox,    'selenium/webdriver/firefox'
+    autoload :IE,         'selenium/webdriver/ie'
+    autoload :Remote,     'selenium/webdriver/remote'
+    autoload :Safari,     'selenium/webdriver/safari'
+    autoload :Support,    'selenium/webdriver/support'
 
     # @api private
 

data/lib/selenium/webdriver/chrome.rb

@@ -19,14 +19,15 @@
 
 require 'net/http'
 
-require 'selenium/webdriver/chrome/bridge'
-require 'selenium/webdriver/chrome/driver'
-require 'selenium/webdriver/chrome/profile'
-require 'selenium/webdriver/chrome/options'
-
 module Selenium
   module WebDriver
     module Chrome
+      autoload :Bridge, 'selenium/webdriver/chrome/bridge'
+      autoload :Driver, 'selenium/webdriver/chrome/driver'
+      autoload :Profile, 'selenium/webdriver/chrome/profile'
+      autoload :Options, 'selenium/webdriver/chrome/options'
+      autoload :Service, 'selenium/webdriver/chrome/service'
+
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path=',
                                    'Selenium::WebDriver::Chrome::Service#driver_path='
@@ -50,5 +51,3 @@ module Selenium
     end # Chrome
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/chrome/service'

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

@@ -23,9 +23,11 @@ module Selenium
       module Bridge
 
         COMMANDS = {
-          get_network_conditions: [:get, '/session/:session_id/chromium/network_conditions'],
-          set_network_conditions: [:post, '/session/:session_id/chromium/network_conditions'],
-          send_command: [:post, '/session/:session_id/goog/cdp/execute']
+          get_network_conditions: [:get, 'session/:session_id/chromium/network_conditions'],
+          set_network_conditions: [:post, 'session/:session_id/chromium/network_conditions'],
+          send_command: [:post, 'session/:session_id/goog/cdp/execute'],
+          get_available_log_types: [:get, 'session/:session_id/se/log/types'],
+          get_log: [:post, 'session/:session_id/se/log']
         }.freeze
 
         def commands(command)
@@ -44,6 +46,22 @@ module Selenium
           execute :set_network_conditions, {}, {network_conditions: conditions}
         end
 
+        def available_log_types
+          types = execute :get_available_log_types
+          Array(types).map(&:to_sym)
+        end
+
+        def log(type)
+          data = execute :get_log, {}, {type: type.to_s}
+
+          Array(data).map do |l|
+            begin
+              LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+            rescue KeyError
+              next
+            end
+          end
+        end
       end # Bridge
     end # Chrome
   end # WebDriver

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

@@ -34,16 +34,17 @@ module Selenium
         include DriverExtensions::DownloadsFiles
 
         def initialize(opts = {})
-          opts[:desired_capabilities] = create_capabilities(opts)
+          opts[:desired_capabilities] ||= Remote::Capabilities.send(browser)
 
           opts[:url] ||= service_url(opts)
 
           listener = opts.delete(:listener)
           desired_capabilities = opts.delete(:desired_capabilities)
+          options = opts.delete(:options)
 
           @bridge = Remote::Bridge.new(opts)
           @bridge.extend Bridge
-          @bridge.create_session(desired_capabilities)
+          @bridge.create_session(desired_capabilities, options)
 
           super(@bridge, listener: listener)
         end
@@ -52,48 +53,9 @@ module Selenium
           :chrome
         end
 
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
-
         def execute_cdp(cmd, **params)
           @bridge.send_command(cmd: cmd, params: params)
         end
-
-        private
-
-        def create_capabilities(opts)
-          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.chrome }
-          options = opts.delete(:options) { Options.new }
-
-          profile = opts.delete(:profile)
-          if profile
-            profile = profile.as_json
-
-            options.add_argument("--user-data-dir=#{profile[:directory]}") if options.args.none?(&/user-data-dir/.method(:match?))
-
-            if profile[:extensions]
-              WebDriver.logger.deprecate 'Using Selenium::WebDriver::Chrome::Profile#extensions',
-                                         'Selenium::WebDriver::Chrome::Options#add_extension'
-              profile[:extensions].each do |extension|
-                options.add_encoded_extension(extension)
-              end
-            end
-          end
-
-          detach = opts.delete(:detach)
-          options.add_option(:detach, true) if detach
-
-          options = options.as_json
-          caps.merge!(options) unless options[Options::KEY].empty?
-
-          caps[:proxy] = opts.delete(:proxy) if opts.key?(:proxy)
-          caps[:proxy] ||= opts.delete('proxy') if opts.key?('proxy')
-
-          caps
-        end
       end # Driver
     end # Chrome
   end # WebDriver

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

@@ -20,19 +20,43 @@
 module Selenium
   module WebDriver
     module Chrome
-      class Options
-        attr_reader :args, :prefs, :options, :emulation, :extensions, :encoded_extensions
-        attr_accessor :binary
+      class Options < WebDriver::Options
+        attr_accessor :profile
 
         KEY = 'goog:chromeOptions'
 
-        #
+        # see: http://chromedriver.chromium.org/capabilities
+        CAPABILITIES = {args: 'args',
+                        binary: 'binary',
+                        extensions: 'extensions',
+                        local_state: 'localState',
+                        prefs: 'prefs',
+                        detach: 'detach',
+                        debugger_address: 'debuggerAddress',
+                        exclude_switches: 'excludeSwitches',
+                        minidump_path: 'minidumpPath',
+                        emulation: 'mobileEmulation',
+                        perf_logging_prefs: 'perfLoggingPrefs',
+                        window_types: 'windowTypes'}.freeze
+
+        CAPABILITIES.each_key do |key|
+          define_method key do
+            @options[key]
+          end
+
+          define_method "#{key}=" do |value|
+            @options[key] = value
+          end
+        end
+
         # Create a new Options instance.
         #
         # @example
         #   options = Selenium::WebDriver::Chrome::Options.new(args: ['start-maximized', 'user-data-dir=/tmp/temp_profile'])
         #   driver = Selenium::WebDriver.for(:chrome, options: options)
         #
+        # @param [Profile] :profile An instance of a Chrome::Profile Class
+        # @param [Array] :encoded_extensions List of extensions that do not need to be Base64 encoded
         # @param [Hash] opts the pre-defined options to create the Chrome::Options with
         # @option opts [Array<String>] :args List of command-line arguments to use when starting Chrome
         # @option opts [String] :binary Path to the Chrome executable to use
@@ -40,16 +64,21 @@ module Selenium
         # @option opts [Array<String>] :extensions A list of paths to (.crx) Chrome extensions to install on startup
         # @option opts [Hash] :options A hash for raw options
         # @option opts [Hash] :emulation A hash for raw emulation options
+        # @option opts [Hash] :local_state A hash for the Local State file in the user data folder
+        # @option opts [Boolean] :detach whether browser is closed when the driver is sent the quit command
+        # @option opts [String] :debugger_address address of a Chrome debugger server to connect to
+        # @option opts [Array<String>] :exclude_switches command line switches to exclude
+        # @option opts [String] :minidump_path Directory to store Chrome minidumps (linux only)
+        # @option opts [Hash] :perf_logging_prefs A hash for performance logging preferences
+        # @option opts [Array<String>] :window_types A list of window types to appear in the list of window handles
         #
 
-        def initialize(**opts)
-          @args = Set.new(opts.delete(:args) || [])
-          @binary = opts.delete(:binary) || Chrome.path
-          @prefs = opts.delete(:prefs) || {}
-          @extensions = opts.delete(:extensions) || []
-          @options = opts.delete(:options) || {}
-          @emulation = opts.delete(:emulation) || {}
-          @encoded_extensions = []
+        def initialize(profile: nil, encoded_extensions: nil, **opts)
+          super(opts)
+
+          @profile = profile
+          @options[:encoded_extensions] = encoded_extensions if encoded_extensions
+          @options[:extensions]&.each(&method(:validate_extension))
         end
 
         #
@@ -63,10 +92,9 @@ module Selenium
         #
 
         def add_extension(path)
-          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.file?(path)
-          raise Error::WebDriverError, "file was not an extension #{path.inspect}" unless File.extname(path) == '.crx'
-
-          @extensions << path
+          validate_extension(path)
+          @options[:extensions] ||= []
+          @options[:extensions] << path
         end
 
         #
@@ -80,8 +108,10 @@ module Selenium
         #
 
         def add_encoded_extension(encoded)
-          @encoded_extensions << encoded
+          @options[:encoded_extensions] ||= []
+          @options[:encoded_extensions] << encoded
         end
+        alias_method :encoded_extension=, :add_encoded_extension
 
         #
         # Add a command-line argument to use when starting Chrome.
@@ -94,22 +124,8 @@ module Selenium
         #
 
         def add_argument(arg)
-          @args << arg
-        end
-
-        #
-        # Add a new option not yet handled by bindings.
-        #
-        # @example Leave Chrome open when chromedriver is killed
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_option(:detach, true)
-        #
-        # @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
+          @options[:args] ||= []
+          @options[:args] << arg
         end
 
         #
@@ -124,7 +140,8 @@ module Selenium
         #
 
         def add_preference(name, value)
-          prefs[name] = value
+          @options[:prefs] ||= {}
+          @options[:prefs][name] = value
         end
 
         #
@@ -140,7 +157,9 @@ module Selenium
         end
 
         #
-        # Add an emulation device name
+        # Add emulation device information
+        #
+        # see: http://chromedriver.chromium.org/mobile-emulation
         #
         # @example Start Chrome in mobile emulation mode by device name
         #   options = Selenium::WebDriver::Chrome::Options.new
@@ -150,15 +169,14 @@ module Selenium
         #   options = Selenium::WebDriver::Chrome::Options.new
         #   options.add_emulation(device_metrics: {width: 400, height: 800, pixelRatio: 1, touch: true})
         #
-        # @param [String] device_name Name of the device or a hash containing width, height, pixelRatio, touch
-        # @param [Hash] device_metrics Hash containing width, height, pixelRatio, touch
-        # @param [String] user_agent Full user agent
+        # @param [Hash] opts the pre-defined options for adding mobilie emulation values
+        # @option opts [String] :device_name A valid device name from the Chrome DevTools Emulation panel
+        # @option opts [Hash] :device_metrics Hash containing width, height, pixelRatio, touch
+        # @option opts [String] :user_agent Full user agent
         #
 
-        def add_emulation(device_name: nil, device_metrics: nil, user_agent: nil)
-          @emulation[:deviceName] = device_name if device_name
-          @emulation[:deviceMetrics] = device_metrics if device_metrics
-          @emulation[:userAgent] = user_agent if user_agent
+        def add_emulation(**opts)
+          @options[:emulation] = opts
         end
 
         #
@@ -166,19 +184,36 @@ module Selenium
         #
 
         def as_json(*)
-          extensions = @extensions.map do |crx_path|
-            File.open(crx_path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
+          options = super
+
+          if @profile
+            options['args'] ||= []
+            options['args'] << "--user-data-dir=#{@profile[:directory]}"
           end
-          extensions.concat(@encoded_extensions)
 
-          opts = @options
-          opts[:binary] = @binary if @binary
-          opts[:args] = @args.to_a if @args.any?
-          opts[:extensions] = extensions if extensions.any?
-          opts[:mobileEmulation] = @emulation unless @emulation.empty?
-          opts[:prefs] = @prefs unless @prefs.empty?
+          options['binary'] ||= binary_path if binary_path
+          extensions = options['extensions'] || []
+          encoded_extensions = options.delete(:encoded_extensions) || []
+
+          options['extensions'] = extensions.map(&method(:encode_extension)) + encoded_extensions
+          options.delete('extensions') if options['extensions'].empty?
+
+          {KEY => generate_as_json(options)}
+        end
 
-          {KEY => opts}
+        private
+
+        def binary_path
+          Chrome.path
+        end
+
+        def encode_extension(path)
+          File.open(path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
+        end
+
+        def validate_extension(path)
+          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.file?(path)
+          raise Error::WebDriverError, "file was not an extension #{path.inspect}" unless File.extname(path) == '.crx'
         end
       end # Options
     end # Chrome