selenium-webdriver 2.45.0 → 3.142.7

data/lib/selenium/webdriver/remote/capabilities.rb

@@ -1,3 +1,22 @@
+# 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 Remote
@@ -6,132 +25,128 @@ module Selenium
       # server is being asked to create.
       #
       class Capabilities
-
         DEFAULTS = {
-          :browser_name          => "",
-          :version               => "",
-          :platform              => :any,
-          :javascript_enabled    => false,
-          :css_selectors_enabled => false,
-          :takes_screenshot      => false,
-          :native_events         => false,
-          :rotatable             => false,
-          :firefox_profile       => nil,
-          :proxy                 => nil
-        }
+          browser_name: '',
+          version: '',
+          platform: :any,
+          javascript_enabled: false,
+          css_selectors_enabled: false,
+          takes_screenshot: false,
+          native_events: false,
+          rotatable: false,
+          firefox_profile: nil,
+          proxy: nil
+        }.freeze
 
         DEFAULTS.each_key do |key|
-          define_method key do
-            @capabilities.fetch(key)
+          if key != :javascript_enabled
+            define_method key do
+              @capabilities.fetch(key)
+            end
           end
 
+          next if key == :proxy
+
           define_method "#{key}=" do |value|
             @capabilities[key] = value
           end
         end
 
+        #
+        # Returns javascript_enabled capability.
+        # It is true if not set explicitly.
+        #
+        def javascript_enabled
+          javascript_enabled = @capabilities.fetch(:javascript_enabled)
+          javascript_enabled.nil? ? true : javascript_enabled
+        end
+
         alias_method :css_selectors_enabled?, :css_selectors_enabled
-        alias_method :javascript_enabled?   , :javascript_enabled
-        alias_method :native_events?        , :native_events
-        alias_method :takes_screenshot?     , :takes_screenshot
-        alias_method :rotatable?            , :rotatable
+        alias_method :javascript_enabled?, :javascript_enabled
+        alias_method :native_events?, :native_events
+        alias_method :takes_screenshot?, :takes_screenshot
+        alias_method :rotatable?, :rotatable
 
         #
         # Convenience methods for the common choices.
         #
 
         class << self
-          def android(opts = {})
+          def chrome(opts = {})
             new({
-              :browser_name       => "android",
-              :platform           => :android,
-              :javascript_enabled => true,
-              :rotatable          => true,
-              :takes_screenshot   => true
+              browser_name: 'chrome',
+              javascript_enabled: true,
+              css_selectors_enabled: true
             }.merge(opts))
           end
 
-          def chrome(opts = {})
+          def edge(opts = {})
             new({
-              :browser_name          => "chrome",
-              :javascript_enabled    => true,
-              :css_selectors_enabled => true
+              browser_name: 'MicrosoftEdge',
+              platform: :windows
             }.merge(opts))
           end
 
           def firefox(opts = {})
+            opts[:browser_version] = opts.delete(:version) if opts.key?(:version)
+            opts[:platform_name] = opts.delete(:platform) if opts.key?(:platform)
+            opts[:timeouts] = {}
+            opts[:timeouts]['implicit'] = opts.delete(:implicit_timeout) if opts.key?(:implicit_timeout)
+            opts[:timeouts]['pageLoad'] = opts.delete(:page_load_timeout) if opts.key?(:page_load_timeout)
+            opts[:timeouts]['script'] = opts.delete(:script_timeout) if opts.key?(:script_timeout)
+            new({browser_name: 'firefox', marionette: true}.merge(opts))
+          end
+
+          def firefox_legacy(opts = {})
             new({
-              :browser_name          => "firefox",
-              :javascript_enabled    => true,
-              :takes_screenshot      => true,
-              :css_selectors_enabled => true
+              browser_name: 'firefox',
+              javascript_enabled: true,
+              takes_screenshot: true,
+              css_selectors_enabled: true
             }.merge(opts))
           end
 
           def htmlunit(opts = {})
             new({
-              :browser_name => "htmlunit"
+              browser_name: 'htmlunit'
             }.merge(opts))
           end
 
           def htmlunitwithjs(opts = {})
             new({
-              :browser_name => "htmlunit",
-              :javascript_enabled => true
+              browser_name: 'htmlunit',
+              javascript_enabled: true
             }.merge(opts))
           end
 
           def internet_explorer(opts = {})
             new({
-              :browser_name          => "internet explorer",
-              :platform              => :windows,
-              :takes_screenshot      => true,
-              :css_selectors_enabled => true,
-              :native_events         => true
+              browser_name: 'internet explorer',
+              platform: :windows,
+              takes_screenshot: true,
+              css_selectors_enabled: true,
+              native_events: true
             }.merge(opts))
           end
           alias_method :ie, :internet_explorer
 
-          def iphone(opts = {})
-            new({
-              :browser_name       => "iPhone",
-              :platform           => :mac,
-              :javascript_enabled => true
-            }.merge(opts))
-          end
-
-          def ipad(opts = {})
-            new({
-              :browser_name       => "iPad",
-              :platform           => :mac,
-              :javascript_enabled => true
-            }.merge(opts))
-          end
-
-          def opera(opts = {})
-            new({
-              :browser_name          => "opera",
-              :javascript_enabled    => true,
-              :takes_screenshot      => true,
-              :css_selectors_enabled => true
-            }.merge(opts))
-          end
-
           def phantomjs(opts = {})
+            WebDriver.logger.deprecate 'Selenium support for PhantomJS', 'headless Chrome/Firefox or HTMLUnit'
             new({
-              :browser_name          => "phantomjs",
-              :javascript_enabled    => true,
-              :takes_screenshot      => true,
-              :css_selectors_enabled => true
+              browser_name: 'phantomjs',
+              javascript_enabled: true,
+              takes_screenshot: true,
+              css_selectors_enabled: true
             }.merge(opts))
           end
 
           def safari(opts = {})
             new({
-              :browser_name          => "safari",
-              :javascript_enabled    => true,
-              :takes_screenshot      => true,
-              :css_selectors_enabled => true
+              browser_name: 'safari',
+              platform: :mac,
+              javascript_enabled: true,
+              takes_screenshot: true,
+              css_selectors_enabled: true
             }.merge(opts))
           end
 
@@ -143,15 +158,15 @@ module Selenium
             data = data.dup
 
             caps = new
-            caps.browser_name          = data.delete("browserName")
-            caps.version               = data.delete("version")
-            caps.platform              = data.delete("platform").downcase.to_sym if data.has_key?('platform')
-            caps.javascript_enabled    = data.delete("javascriptEnabled")
-            caps.css_selectors_enabled = data.delete("cssSelectorsEnabled")
-            caps.takes_screenshot      = data.delete("takesScreenshot")
-            caps.native_events         = data.delete("nativeEvents")
-            caps.rotatable             = data.delete("rotatable")
-            caps.proxy                 = Proxy.json_create(data['proxy']) if data.has_key?('proxy')
+            caps.browser_name          = data.delete('browserName')
+            caps.version               = data.delete('version')
+            caps.platform              = data.delete('platform').downcase.tr(' ', '_').to_sym if data.key?('platform')
+            caps.javascript_enabled    = data.delete('javascriptEnabled')
+            caps.css_selectors_enabled = data.delete('cssSelectorsEnabled')
+            caps.takes_screenshot      = data.delete('takesScreenshot')
+            caps.native_events         = data.delete('nativeEvents')
+            caps.rotatable             = data.delete('rotatable')
+            caps.proxy                 = Proxy.json_create(data['proxy']) if data.key?('proxy') && !data['proxy'].empty?
 
             # any remaining pairs will be added as is, with no conversion
             caps.merge!(data)
@@ -160,6 +175,7 @@ module Selenium
           end
         end
 
+        #
         # @option :browser_name           [String] required browser name
         # @option :version                [String] required browser version number
         # @option :platform               [Symbol] one of :any, :win, :mac, or :x
@@ -169,10 +185,6 @@ module Selenium
         # @option :native_events          [Boolean] does this driver use native events?
         # @option :proxy                  [Selenium::WebDriver::Proxy, Hash] proxy configuration
         #
-        # Firefox-specific options:
-        #
-        # @option :firefox_profile        [Selenium::WebDriver::Firefox::Profile] the firefox profile to use
-        #
         # @api public
         #
 
@@ -194,12 +206,12 @@ module Selenium
         end
 
         def merge!(other)
-          if other.respond_to?(:capabilities, true) && other.capabilities.kind_of?(Hash)
+          if other.respond_to?(:capabilities, true) && other.capabilities.is_a?(Hash)
             @capabilities.merge! other.capabilities
-          elsif other.kind_of? Hash
+          elsif other.is_a? Hash
             @capabilities.merge! other
           else
-            raise ArgumentError, "argument should be a Hash or implement #capabilities"
+            raise ArgumentError, 'argument should be a Hash or implement #capabilities'
           end
         end
 
@@ -214,10 +226,11 @@ module Selenium
           end
         end
 
+        #
         # @api private
         #
 
-        def as_json(opts = nil)
+        def as_json(*) # rubocop:disable Metrics/CyclomaticComplexity
           hash = {}
 
           @capabilities.each do |key, value|
@@ -225,10 +238,16 @@ module Selenium
             when :platform
               hash['platform'] = value.to_s.upcase
             when :firefox_profile
-              hash['firefox_profile'] = value.as_json['zip'] if value
+              if value
+                WebDriver.logger.deprecate(':firefox_profile capabilitiy', 'Selenium::WebDriver::Firefox::Options#profile')
+                hash['firefox_profile'] = value.as_json['zip']
+              end
             when :proxy
               hash['proxy'] = value.as_json if value
             when String, :firefox_binary
+              if key == :firefox_binary && value
+                WebDriver.logger.deprecate(':firefox_binary capabilitiy', 'Selenium::WebDriver::Firefox::Options#binary')
+              end
               hash[key.to_s] = value
             when Symbol
               hash[camel_case(key.to_s)] = value
@@ -240,28 +259,26 @@ module Selenium
           hash
         end
 
-        def to_json(*args)
-          WebDriver.json_dump as_json
+        def to_json(*)
+          JSON.generate as_json
         end
 
         def ==(other)
-          return false unless other.kind_of? self.class
+          return false unless other.is_a? self.class
+
           as_json == other.as_json
         end
         alias_method :eql?, :==
 
         protected
 
-        def capabilities
-          @capabilities
-        end
+        attr_reader :capabilities
 
         private
 
         def camel_case(str)
-          str.gsub(/_([a-z])/) { $1.upcase }
+          str.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
         end
-
       end # Capabilities
     end # Remote
   end # WebDriver

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

@@ -0,0 +1,51 @@
+# 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 Remote
+
+      #
+      # Driver implementation for remote server.
+      # @api private
+      #
+
+      class Driver < WebDriver::Driver
+        include DriverExtensions::UploadsFiles
+        include DriverExtensions::TakesScreenshot
+        include DriverExtensions::HasSessionId
+        include DriverExtensions::Rotatable
+        include DriverExtensions::HasRemoteStatus
+        include DriverExtensions::HasWebStorage
+
+        def initialize(opts = {})
+          listener = opts.delete(:listener)
+          @bridge = Bridge.handshake(opts)
+          if @bridge.dialect == :oss
+            extend DriverExtensions::HasTouchScreen
+            extend DriverExtensions::HasLocation
+            extend DriverExtensions::HasNetworkConnection
+          end
+          super(@bridge, listener: listener)
+        end
+
+      end # Driver
+    end # Remote
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/remote/http/common.rb

@@ -1,11 +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 Remote
       module Http
         class Common
           MAX_REDIRECTS   = 20 # same as chromium/gecko
-          CONTENT_TYPE    = "application/json"
-          DEFAULT_HEADERS = { "Accept" => CONTENT_TYPE }
+          CONTENT_TYPE    = 'application/json'
+          DEFAULT_HEADERS = {
+            'Accept' => CONTENT_TYPE,
+            'Content-Type' => "#{CONTENT_TYPE}; charset=UTF-8",
+            'User-Agent' => "selenium/#{WebDriver::VERSION} (ruby #{Platform.os})"
+          }.freeze
 
           attr_accessor :timeout
           attr_writer :server_url
@@ -14,27 +37,28 @@ module Selenium
             @timeout = nil
           end
 
+          def quit_errors
+            [IOError]
+          end
+
           def close
             # hook for subclasses - will be called on Driver#quit
           end
 
           def call(verb, url, command_hash)
-            url      = server_url.merge(url) unless url.kind_of?(URI)
+            url      = server_url.merge(url) unless url.is_a?(URI)
             headers  = DEFAULT_HEADERS.dup
-            headers['Cache-Control'] = "no-cache" if verb == :get
+            headers['Cache-Control'] = 'no-cache' if verb == :get
 
             if command_hash
-              payload                   = WebDriver.json_dump(command_hash)
-              headers["Content-Type"]   = "#{CONTENT_TYPE}; charset=utf-8"
-              headers["Content-Length"] = payload.bytesize.to_s if [:post, :put].include?(verb)
-
-              if $DEBUG
-                puts "   >>> #{url} | #{payload}"
-                puts "     > #{headers.inspect}"
-              end
+              payload                   = JSON.generate(command_hash)
+              headers['Content-Length'] = payload.bytesize.to_s if %i[post put].include?(verb)
+
+              WebDriver.logger.info("   >>> #{url} | #{payload}")
+              WebDriver.logger.debug("     > #{headers.inspect}")
             elsif verb == :post
-              payload = "{}" # work around http://code.google.com/p/selenium/issues/detail?id=1396
-              headers["Content-Length"] = "2"
+              payload = '{}'
+              headers['Content-Length'] = '2'
             end
 
             request verb, url, headers, payload
@@ -43,30 +67,37 @@ module Selenium
           private
 
           def server_url
-            @server_url or raise Error::WebDriverError, "server_url not set"
+            return @server_url if @server_url
+
+            raise Error::WebDriverError, 'server_url not set'
           end
 
-          def request(verb, url, headers, payload)
-            raise NotImplementedError, "subclass responsibility"
+          def request(*)
+            raise NotImplementedError, 'subclass responsibility'
           end
 
           def create_response(code, body, content_type)
-            code, body, content_type = code.to_i, body.to_s.strip, content_type.to_s
-            puts "<- #{body}\n" if $DEBUG
+            code = code.to_i
+            body = body.to_s.strip
+            content_type = content_type.to_s
+            WebDriver.logger.info("<- #{body}")
 
             if content_type.include? CONTENT_TYPE
               raise Error::WebDriverError, "empty body: #{content_type.inspect} (#{code})\n#{body}" if body.empty?
-              Response.new(code, WebDriver.json_load(body))
+
+              Response.new(code, JSON.parse(body))
             elsif code == 204
               Response.new(code)
             else
-              msg = "unexpected response, code=#{code}, content-type=#{content_type.inspect}"
-              msg << "\n#{body}" unless body.empty?
+              msg = if body.empty?
+                      "unexpected response, code=#{code}, content-type=#{content_type.inspect}"
+                    else
+                      "unexpected response, code=#{code}, content-type=#{content_type.inspect}\n#{body}"
+                    end
 
               raise Error::WebDriverError, msg
             end
           end
-
         end # Common
       end # Http
     end # Remote

data/lib/selenium/webdriver/remote/http/curb.rb

@@ -1,14 +1,29 @@
+# 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 'curb'
 
 module Selenium
   module WebDriver
     module Remote
 
-      # added for rescue
-      Bridge::QUIT_ERRORS << Curl::Err::RecvError
-
       module Http
-
         #
         # An alternative to the default Net::HTTP client.
         #
@@ -24,14 +39,18 @@ module Selenium
 
         class Curb < Common
 
+          def quit_errors
+            [Curl::Err::RecvError] + super
+          end
+
           private
 
           def request(verb, url, headers, payload)
-            client.url     = url.to_s
+            client.url = url.to_s
 
             # workaround for http://github.com/taf2/curb/issues/issue/40
             # curb will handle this for us anyway
-            headers.delete "Content-Length"
+            headers.delete 'Content-Length'
 
             client.headers = headers
 
@@ -43,10 +62,10 @@ module Selenium
             when :get
               client.http_get
             when :post
-              client.post_body = payload || ""
+              client.post_body = payload || ''
               client.http_post
             when :put
-              client.put_data = payload || ""
+              client.put_data = payload || ''
               client.http_put
             when :delete
               client.http_delete
@@ -60,18 +79,17 @@ module Selenium
           end
 
           def client
-            @client ||= (
+            @client ||= begin
               c = Curl::Easy.new
 
               c.max_redirects   = MAX_REDIRECTS
               c.follow_location = true
               c.timeout         = @timeout if @timeout
-              c.verbose         = !!$DEBUG
+              c.verbose         = WebDriver.logger.info?
 
               c
-            )
+            end
           end
-
         end # Curb
       end # Http
     end # Remote