selenium-webdriver 3.0.0.beta4.0 → 4.0.0.alpha5

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

@@ -0,0 +1,52 @@
+# 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(bridge: nil, listener: nil, **opts)
+          desired_capabilities = opts[:desired_capabilities]
+          if desired_capabilities.is_a?(Symbol)
+            unless Remote::Capabilities.respond_to?(desired_capabilities)
+              raise Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
+            end
+
+            opts[:desired_capabilities] = Remote::Capabilities.__send__(desired_capabilities)
+          end
+          opts[:url] ||= "http://#{Platform.localhost}:4444/wd/hub"
+          super
+        end
+      end # Driver
+    end # Remote
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/remote/http/common.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
@@ -23,8 +23,12 @@ module Selenium
       module Http
         class Common
           MAX_REDIRECTS   = 20 # same as chromium/gecko
-          CONTENT_TYPE    = 'application/json'.freeze
-          DEFAULT_HEADERS = {'Accept' => CONTENT_TYPE}.freeze
+          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
@@ -33,6 +37,10 @@ module Selenium
             @timeout = nil
           end
 
+          def quit_errors
+            [IOError]
+          end
+
           def close
             # hook for subclasses - will be called on Driver#quit
           end
@@ -44,13 +52,10 @@ module Selenium
 
             if command_hash
               payload                   = JSON.generate(command_hash)
-              headers['Content-Type']   = "#{CONTENT_TYPE}; charset=utf-8"
-              headers['Content-Length'] = payload.bytesize.to_s if [:post, :put].include?(verb)
+              headers['Content-Length'] = payload.bytesize.to_s if %i[post put].include?(verb)
 
-              if $DEBUG
-                puts "   >>> #{url} | #{payload}"
-                puts "     > #{headers.inspect}"
-              end
+              WebDriver.logger.info("   >>> #{url} | #{payload}")
+              WebDriver.logger.debug("     > #{headers.inspect}")
             elsif verb == :post
               payload = '{}'
               headers['Content-Length'] = '2'
@@ -63,6 +68,7 @@ module Selenium
 
           def server_url
             return @server_url if @server_url
+
             raise Error::WebDriverError, 'server_url not set'
           end
 
@@ -74,16 +80,20 @@ module Selenium
             code = code.to_i
             body = body.to_s.strip
             content_type = content_type.to_s
-            puts "<- #{body}\n" if $DEBUG
+            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, 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

data/lib/selenium/webdriver/remote/http/curb.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
@@ -22,8 +22,6 @@ require 'curb'
 module Selenium
   module WebDriver
     module Remote
-      # added for rescue
-      Bridge::QUIT_ERRORS << Curl::Err::RecvError
 
       module Http
         #
@@ -40,6 +38,11 @@ module Selenium
         #
 
         class Curb < Common
+
+          def quit_errors
+            [Curl::Err::RecvError] + super
+          end
+
           private
 
           def request(verb, url, headers, payload)
@@ -76,16 +79,16 @@ 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

data/lib/selenium/webdriver/remote/http/default.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
@@ -26,25 +26,46 @@ module Selenium
       module Http
         # @api private
         class Default < Common
-          attr_accessor :proxy
+          attr_writer :proxy
+
+          attr_accessor :open_timeout
+          attr_accessor :read_timeout
+
+          # Initializes object.
+          # Warning: Setting {#open_timeout} to non-nil values will cause a separate thread to spawn.
+          # Debuggers that freeze the process will not be able to evaluate any operations if that happens.
+          # @param [Numeric] open_timeout - Open timeout to apply to HTTP client.
+          # @param [Numeric] read_timeout - Read timeout (seconds) to apply to HTTP client.
+          def initialize(open_timeout: nil, read_timeout: nil)
+            @open_timeout = open_timeout
+            @read_timeout = read_timeout
+          end
+
+          def close
+            @http&.finish
+          end
 
           private
 
           def http
-            @http ||= (
-            http = new_http_client
-            if server_url.scheme == 'https'
-              http.use_ssl = true
-              http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-            end
+            @http ||= begin
+              http = new_http_client
+              if server_url.scheme == 'https'
+                http.use_ssl = true
+                http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+              end
 
-            if @timeout
-              http.open_timeout = @timeout
-              http.read_timeout = @timeout
+              # Defaulting open_timeout to nil to be consistent with Ruby 2.2 and earlier.
+              http.open_timeout = open_timeout
+              http.read_timeout = read_timeout if read_timeout
+
+              start(http)
+              http
             end
+          end
 
-            http
-            )
+          def start(http)
+            http.start
           end
 
           MAX_RETRIES = 3
@@ -64,23 +85,26 @@ module Selenium
               #
               # http://msdn.microsoft.com/en-us/library/aa560610%28v=bts.20%29.aspx
               raise if retries >= MAX_RETRIES
-              retries += 1
 
+              retries += 1
+              sleep 2
               retry
-            rescue Errno::EADDRNOTAVAIL => ex
+            rescue Errno::EADDRNOTAVAIL => e
               # a retry is sometimes needed when the port becomes temporarily unavailable
               raise if retries >= MAX_RETRIES
+
               retries += 1
               sleep 2
               retry
+            rescue Errno::ECONNREFUSED => e
+              raise e.class, "using proxy: #{proxy.http}" if use_proxy?
 
-            rescue Errno::ECONNREFUSED => ex
-              raise ex.class, "using proxy: #{proxy.http}" if use_proxy?
               raise
             end
 
             if response.is_a? Net::HTTPRedirection
               raise Error::WebDriverError, 'too many redirects' if redirects >= MAX_REDIRECTS
+
               request(:get, URI.parse(response['Location']), DEFAULT_HEADERS.dup, nil, redirects + 1)
             else
               create_response response.code, response.body, response.content_type
@@ -90,9 +114,7 @@ module Selenium
           def new_request_for(verb, url, headers, payload)
             req = Net::HTTP.const_get(verb.to_s.capitalize).new(url.path, headers)
 
-            if server_url.userinfo
-              req.basic_auth server_url.user, server_url.password
-            end
+            req.basic_auth server_url.user, server_url.password if server_url.userinfo
 
             req.body = payload if payload
 
@@ -106,9 +128,7 @@ module Selenium
           def new_http_client
             if use_proxy?
               url = @proxy.http
-              unless proxy.respond_to?(:http) && url
-                raise Error::WebDriverError, "expected HTTP proxy, got #{@proxy.inspect}"
-              end
+              raise Error::WebDriverError, "expected HTTP proxy, got #{@proxy.inspect}" unless proxy.respond_to?(:http) && url
 
               proxy = URI.parse(url)
 
@@ -120,15 +140,15 @@ module Selenium
           end
 
           def proxy
-            @proxy ||= (
-            proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
-            no_proxy = ENV['no_proxy'] || ENV['NO_PROXY']
+            @proxy ||= begin
+              proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
+              no_proxy = ENV['no_proxy'] || ENV['NO_PROXY']
 
-            if proxy
-              proxy = "http://#{proxy}" unless proxy.start_with?('http://')
-              Proxy.new(http: proxy, no_proxy: no_proxy)
+              if proxy
+                proxy = "http://#{proxy}" unless proxy.start_with?('http://')
+                Proxy.new(http: proxy, no_proxy: no_proxy)
+              end
             end
-            )
           end
 
           def use_proxy?
@@ -143,7 +163,7 @@ module Selenium
                 rescue ArgumentError
                   false
                 end
-                  )
+              )
               end
 
               !ignored

data/lib/selenium/webdriver/remote/http/persistent.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
@@ -26,11 +26,15 @@ module Selenium
         # @api private
         class Persistent < Default
           def close
-            @http.shutdown if @http
+            @http&.shutdown
           end
 
           private
 
+          def start(*)
+            # no need to explicitly start connection
+          end
+
           def new_http_client
             proxy = nil
 
@@ -42,7 +46,7 @@ module Selenium
               proxy = URI.parse(url)
             end
 
-            Net::HTTP::Persistent.new 'webdriver', proxy
+            Net::HTTP::Persistent.new name: 'webdriver', proxy: proxy
           end
 
           def response_for(request)

data/lib/selenium/webdriver/remote/response.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,10 +20,13 @@
 module Selenium
   module WebDriver
     module Remote
+
+      #
       # @api private
+      #
+
       class Response
         attr_reader :code, :payload
-        attr_writer :payload
 
         def initialize(code, payload = nil)
           @code    = code
@@ -33,32 +36,16 @@ module Selenium
         end
 
         def error
-          klass = Error.for_code(status) || return
+          error, message, backtrace = process_error
+          klass = Error.for_error(error) || return
 
-          ex = klass.new(error_message)
+          ex = klass.new(message)
           ex.set_backtrace(caller)
-          add_backtrace ex
+          add_backtrace ex, backtrace
 
           ex
         end
 
-        def error_message
-          val = value
-
-          case val
-          when Hash
-            msg = val['message']
-            return 'unknown error' unless msg
-            msg << ": #{val['alert']['text'].inspect}" if val['alert'].is_a?(Hash) && val['alert']['text']
-            msg << " (#{val['class']})" if val['class']
-            msg
-          when String
-            val
-          else
-            "unknown error, status=#{status}: #{val.inspect}"
-          end
-        end
-
         def [](key)
           @payload[key]
         end
@@ -69,15 +56,25 @@ module Selenium
           e = error
           raise e if e
           return unless @code.nil? || @code >= 400
+
           raise Error::ServerError, self
         end
 
-        def add_backtrace(ex)
-          return unless value.is_a?(Hash) && value['stackTrace']
+        def add_backtrace(ex, server_trace)
+          return unless server_trace
 
-          server_trace = value['stackTrace']
+          backtrace = case server_trace
+                      when Array
+                        backtrace_from_remote(server_trace)
+                      when String
+                        server_trace.split("\n")
+                      end
 
-          backtrace = server_trace.map do |frame|
+          ex.set_backtrace(backtrace + ex.backtrace)
+        end
+
+        def backtrace_from_remote(server_trace)
+          server_trace.map { |frame|
             next unless frame.is_a?(Hash)
 
             file = frame['fileName']
@@ -90,17 +87,17 @@ module Selenium
             meth = 'unknown' if meth.nil? || meth.empty?
 
             "[remote server] #{file}:#{line}:in `#{meth}'"
-          end.compact
-
-          ex.set_backtrace(backtrace + ex.backtrace)
+          }.compact
         end
 
-        def status
-          @payload['status'] || @payload['error']
-        end
+        def process_error
+          return unless self['value'].is_a?(Hash)
 
-        def value
-          @payload['value'] || @payload['message']
+          [
+            self['value']['error'],
+            self['value']['message'],
+            self['value']['stacktrace']
+          ]
         end
       end # Response
     end # Remote