selenium-webdriver 3.142.7 → 4.0.0.alpha1

data/lib/selenium/webdriver/common/manager.rb

@@ -62,7 +62,7 @@ module Selenium
       #
 
       def cookie_named(name)
-        all_cookies.find { |c| c[:name] == name }
+        convert_cookie(@bridge.cookie(name))
       end
 
       #

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

@@ -19,35 +19,159 @@
 
 module Selenium
   module WebDriver
-    module Common
-      class Options
-        private
-
-        def generate_as_json(value)
-          if value.respond_to?(:as_json)
-            value.as_json
-          elsif value.is_a?(Hash)
-            value.each_with_object({}) { |(key, val), hash| hash[convert_json_key(key)] = generate_as_json(val) }
-          elsif value.is_a?(Array)
-            value.map(&method(:generate_as_json))
-          elsif value.is_a?(Symbol)
-            value.to_s
-          else
-            value
+    class Options
+      #
+      # @api private
+      #
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      #
+      # Add a cookie to the browser
+      #
+      # @param [Hash] opts the options to create a cookie with.
+      # @option opts [String] :name A name
+      # @option opts [String] :value A value
+      # @option opts [String] :path ('/') A path
+      # @option opts [String] :secure (false) A boolean
+      # @option opts [Time,DateTime,Numeric,nil] :expires (nil) Expiry date, either as a Time, DateTime, or seconds since epoch.
+      #
+      # @raise [ArgumentError] if :name or :value is not specified
+      #
+
+      def add_cookie(opts = {})
+        raise ArgumentError, 'name is required' unless opts[:name]
+        raise ArgumentError, 'value is required' unless opts[:value]
+
+        opts[:path] ||= '/'
+        opts[:secure] ||= false
+
+        obj = opts.delete(:expires)
+        opts[:expiry] = seconds_from(obj).to_i if obj
+
+        @bridge.add_cookie opts
+      end
+
+      #
+      # Get the cookie with the given name
+      #
+      # @param [String] name the name of the cookie
+      # @return [Hash, nil] the cookie, or nil if it wasn't found.
+      #
+
+      def cookie_named(name)
+        all_cookies.find { |c| c[:name] == name }
+      end
+
+      #
+      # Delete the cookie with the given name
+      #
+      # @param [String] name the name of the cookie to delete
+      #
+
+      def delete_cookie(name)
+        @bridge.delete_cookie name
+      end
+
+      #
+      # Delete all cookies
+      #
+
+      def delete_all_cookies
+        @bridge.delete_all_cookies
+      end
+
+      #
+      # Get all cookies
+      #
+      # @return [Array<Hash>] list of cookies
+      #
+
+      def all_cookies
+        @bridge.cookies.map { |cookie| convert_cookie(cookie) }
+      end
+
+      def timeouts
+        @timeouts ||= Timeouts.new(@bridge)
+      end
+
+      #
+      # @api beta This API may be changed or removed in a future release.
+      #
+
+      def logs
+        @logs ||= Logs.new(@bridge)
+      end
+
+      #
+      # Create a new top-level browsing context
+      # https://w3c.github.io/webdriver/#new-window
+      # @param type [Symbol] Supports two values: :tab and :window.
+      #  Use :tab if you'd like the new window to share an OS-level window
+      #  with the current browsing context.
+      #  Use :window otherwise
+      # @return [String] The value of the window handle
+      #
+      def new_window(type = :tab)
+        case type
+        when :tab, :window
+          result = @bridge.new_window(type)
+          unless result.key?('handle')
+            raise UnknownError, "the driver did not return a handle. " \
+                                "The returned result: #{result.inspect}"
           end
+          result['handle']
+        else
+          raise ArgumentError, "invalid argument for type. Got: '#{type.inspect}'. " \
+                               "Try :tab or :window"
         end
+      end
 
-        def convert_json_key(key)
-          key = camel_case(key) if key.is_a?(Symbol)
-          return key if key.is_a?(String)
+      #
+      # @api beta This API may be changed or removed in a future release.
+      #
 
-          raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
-        end
+      def window
+        @window ||= Window.new(@bridge)
+      end
+
+      private
+
+      SECONDS_PER_DAY = 86_400.0
 
-        def camel_case(str)
-          str.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+      def datetime_at(int)
+        DateTime.civil(1970) + (int / SECONDS_PER_DAY)
+      end
+
+      def seconds_from(obj)
+        case obj
+        when Time
+          obj.to_f
+        when DateTime
+          (obj - DateTime.civil(1970)) * SECONDS_PER_DAY
+        when Numeric
+          obj
+        else
+          raise ArgumentError, "invalid value for expiration date: #{obj.inspect}"
         end
-      end # Options
-    end # Common
+      end
+
+      def strip_port(str)
+        str.split(':', 2).first
+      end
+
+      def convert_cookie(cookie)
+        {
+          name: cookie['name'],
+          value: cookie['value'],
+          path: cookie['path'],
+          domain: cookie['domain'] && strip_port(cookie['domain']),
+          expires: cookie['expiry'] && datetime_at(cookie['expiry']),
+          secure: cookie['secure']
+        }
+      end
+    end # Options
   end # WebDriver
 end # Selenium

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

@@ -29,46 +29,28 @@ module Selenium
       SOCKET_LOCK_TIMEOUT = 45
       STOP_TIMEOUT = 20
 
-      @default_port = nil
-      @driver_path = nil
-      @executable = nil
-      @missing_text = nil
-
       class << self
-        attr_reader :default_port, :driver_path, :executable, :missing_text, :shutdown_supported
+        attr_reader :driver_path
 
-        def chrome(**opts)
-          Chrome::Service.new(**opts)
+        def chrome(*args)
+          Chrome::Service.new(*args)
         end
 
-        def firefox(**opts)
-          binary_path = Firefox::Binary.path
-          args = opts.delete(:args)
-          case args
-          when Hash
-            args[:binary] ||= binary_path
-            opts[:args] = args
-          when Array
-            opts[:args] = ["--binary=#{binary_path}"]
-            opts[:args] += args
-          else
-            opts[:args] = ["--binary=#{binary_path}"]
-          end
-
-          Firefox::Service.new(**opts)
+        def firefox(*args)
+          Firefox::Service.new(*args)
         end
 
-        def ie(**opts)
-          IE::Service.new(**opts)
+        def ie(*args)
+          IE::Service.new(*args)
         end
         alias_method :internet_explorer, :ie
 
-        def edge(**opts)
-          Edge::Service.new(**opts)
+        def edge(*args)
+          Edge::Service.new(*args)
         end
 
-        def safari(**opts)
-          Safari::Service.new(**opts)
+        def safari(*args)
+          Safari::Service.new(*args)
         end
 
         def driver_path=(path)
@@ -88,7 +70,7 @@ module Selenium
 
       def initialize(path: nil, port: nil, args: nil)
         path ||= self.class.driver_path
-        port ||= self.class.default_port
+        port ||= self.class::DEFAULT_PORT
         args ||= []
 
         @executable_path = binary_path(path)
@@ -113,7 +95,7 @@ module Selenium
       end
 
       def stop
-        return unless self.class.shutdown_supported
+        return unless self.class::SHUTDOWN_SUPPORTED
 
         stop_server
         @process.poll_for_exit STOP_TIMEOUT
@@ -131,9 +113,9 @@ module Selenium
 
       def binary_path(path = nil)
         path = path.call if path.is_a?(Proc)
-        path ||= Platform.find_binary(self.class.executable)
+        path ||= Platform.find_binary(self.class::EXECUTABLE)
 
-        raise Error::WebDriverError, self.class.missing_text unless path
+        raise Error::WebDriverError, self.class::MISSING_TEXT unless path
 
         Platform.assert_executable path
         path
@@ -201,7 +183,7 @@ module Selenium
       end
 
       def cannot_connect_error_text
-        "unable to connect to #{self.class.executable} #{@host}:#{@port}"
+        "unable to connect to #{self.class::EXECUTABLE} #{@host}:#{@port}"
       end
 
       def socket_lock

data/lib/selenium/webdriver/common/socket_poller.rb

@@ -66,8 +66,8 @@ module Selenium
       }.freeze
 
       if Platform.jruby?
-        # we use a plain TCPSocket here since JRuby has issues select()ing on a connecting socket
-        # see http://jira.codehaus.org/browse/JRUBY-5165
+        # we use a plain TCPSocket here since JRuby has issues closing socket
+        # see https://github.com/jruby/jruby/issues/5709
         def listening?
           TCPSocket.new(@host, @port).close
           true

data/lib/selenium/webdriver/common/w3c_options.rb

@@ -0,0 +1,45 @@
+# 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
+    class W3COptions < Options
+
+      #
+      # Get the cookie with the given name
+      #
+      # @param [String] name the name of the cookie
+      # @return [Hash, nil] the cookie, or nil if it wasn't found.
+      #
+
+      def cookie_named(name)
+        convert_cookie(@bridge.cookie(name))
+      end
+
+      #
+      # Delete all cookies
+      #
+
+      def delete_all_cookies
+        @bridge.delete_all_cookies
+      end
+
+    end # WC3Options
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/edge.rb

@@ -19,7 +19,6 @@
 
 require 'net/http'
 
-require 'selenium/webdriver/edge/bridge'
 require 'selenium/webdriver/edge/driver'
 require 'selenium/webdriver/edge/options'
 

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

@@ -27,25 +27,19 @@ module Selenium
       #
 
       class Driver < WebDriver::Driver
+        include DriverExtensions::HasWebStorage
         include DriverExtensions::TakesScreenshot
 
         def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::Capabilities.edge
+          opts[:desired_capabilities] = create_capabilities(opts)
 
           opts[:url] ||= service_url(opts)
 
           listener = opts.delete(:listener)
-
-          # Edge is mostly using W3C dialect, but a request to
-          # create session responds with OSS-like body,
-          # so we need to force W3C implementation.
           desired_capabilities = opts.delete(:desired_capabilities)
-          bridge = Remote::Bridge.new(opts)
-          capabilities = bridge.create_session(desired_capabilities)
 
-          WebDriver.logger.info 'Forcing W3C dialect.'
-          @bridge = Remote::W3C::Bridge.new(capabilities, bridge.session_id, **opts)
-          @bridge.extend Edge::Bridge
+          @bridge = Remote::Bridge.new(opts)
+          @bridge.create_session(desired_capabilities)
 
           super(@bridge, listener: listener)
         end
@@ -60,6 +54,16 @@ module Selenium
           @service&.stop
         end
 
+        private
+
+        def create_capabilities(opts)
+          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.edge }
+          options = opts.delete(:options) { Options.new }
+          options = options.as_json
+          caps.merge!(options) unless options.empty?
+
+          caps
+        end
       end # Driver
     end # Edge
   end # WebDriver

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

@@ -25,14 +25,13 @@ module Selenium
       #
 
       class Service < WebDriver::Service
-        @default_port = 17556
-        @executable = 'MicrosoftWebDriver'
-        @missing_text = <<~ERROR
-          Unable to find MicrosoftWebDriver. Please download the server from
-          https://www.microsoft.com/en-us/download/details.aspx?id=48212 and place it somewhere on your PATH.
-          More info at https://github.com/SeleniumHQ/selenium/wiki/MicrosoftWebDriver.
+        DEFAULT_PORT = 17556
+        EXECUTABLE = 'MicrosoftWebDriver'
+        MISSING_TEXT = <<~ERROR
+          Unable to find MicrosoftWebDriver. Please install it following instructions
+          at https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/.
         ERROR
-        @shutdown_supported = true
+        SHUTDOWN_SUPPORTED = false
 
         private
 

data/lib/selenium/webdriver/firefox.rb

@@ -23,16 +23,12 @@ 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/legacy/driver'
-
-require 'selenium/webdriver/firefox/marionette/bridge'
-require 'selenium/webdriver/firefox/marionette/driver'
+require 'selenium/webdriver/firefox/bridge'
+require 'selenium/webdriver/firefox/driver'
 require 'selenium/webdriver/firefox/options'
 
 module Selenium

data/lib/selenium/webdriver/firefox/binary.rb

@@ -22,83 +22,6 @@ module Selenium
     module Firefox
       # @api private
       class Binary
-        NO_FOCUS_LIBRARY_NAME = 'x_ignore_nofocus.so'
-        NO_FOCUS_LIBRARIES = [
-          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/amd64/#{NO_FOCUS_LIBRARY_NAME}",
-           "amd64/#{NO_FOCUS_LIBRARY_NAME}"],
-          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/x86/#{NO_FOCUS_LIBRARY_NAME}",
-           "x86/#{NO_FOCUS_LIBRARY_NAME}"]
-        ].freeze
-
-        WAIT_TIMEOUT = 90
-        QUIT_TIMEOUT = 5
-
-        def start_with(profile, profile_path, *args)
-          if Platform.cygwin?
-            profile_path = Platform.cygwin_path(profile_path, windows: true)
-          elsif Platform.windows?
-            profile_path = Platform.windows_path(profile_path)
-          end
-
-          ENV['XRE_CONSOLE_LOG'] = profile.log_file if profile.log_file
-          ENV['XRE_PROFILE_PATH'] = profile_path
-          ENV['MOZ_NO_REMOTE'] = '1' # able to launch multiple instances
-          ENV['MOZ_CRASHREPORTER_DISABLE'] = '1' # disable breakpad
-          ENV['NO_EM_RESTART'] = '1' # prevent the binary from detaching from the console
-
-          modify_link_library_path profile_path if Platform.linux? && (profile.native_events? || profile.load_no_focus_lib?)
-
-          execute(*args)
-        end
-
-        def quit
-          return unless @process
-
-          @process.poll_for_exit QUIT_TIMEOUT
-        rescue ChildProcess::TimeoutError
-          # ok, force quit
-          @process.stop QUIT_TIMEOUT
-        end
-
-        def wait
-          return unless @process
-
-          begin
-            @process.poll_for_exit(WAIT_TIMEOUT)
-          rescue ChildProcess::TimeoutError => e
-            @process.stop
-            raise e
-          end
-        end
-
-        private
-
-        def execute(*extra_args)
-          args = [self.class.path, '-no-remote'] + extra_args
-          @process = ChildProcess.build(*args)
-          WebDriver.logger.debug("Executing Process #{args}")
-
-          @process.io.stdout = @process.io.stderr = WebDriver.logger.io if WebDriver.logger.debug?
-          @process.start
-        end
-
-        def modify_link_library_path(profile_path)
-          paths = []
-
-          NO_FOCUS_LIBRARIES.each do |from, to|
-            dest = File.join(profile_path, to)
-            FileUtils.mkdir_p File.dirname(dest)
-            FileUtils.cp from, dest
-
-            paths << File.expand_path(File.dirname(dest))
-          end
-
-          paths += ENV['LD_LIBRARY_PATH'].to_s.split(File::PATH_SEPARATOR)
-
-          ENV['LD_LIBRARY_PATH'] = paths.uniq.join(File::PATH_SEPARATOR)
-          ENV['LD_PRELOAD'] = NO_FOCUS_LIBRARY_NAME
-        end
-
         class << self
           #
           # @api private
@@ -130,8 +53,8 @@ module Selenium
             @path = Platform.cygwin_path(@path, windows: true) if Platform.cygwin?
 
             unless File.file?(@path.to_s)
-              error = "Could not find Firefox binary (os=#{Platform.os}). " \
-                      "Make sure Firefox is installed or set the path manually with #{self}.path="
+              error = "Could not find Firefox binary (os=#{Platform.os}). "
+              error << "Make sure Firefox is installed or set the path manually with #{self}.path="
               raise Error::WebDriverError, error
             end
 
@@ -173,7 +96,7 @@ module Selenium
             lm = Win32::Registry::HKEY_LOCAL_MACHINE
             lm.open('SOFTWARE\\Mozilla\\Mozilla Firefox') do |reg|
               main = lm.open("SOFTWARE\\Mozilla\\Mozilla Firefox\\#{reg.keys[0]}\\Main")
-              entry = main.find { |key, _type, _data| key =~ /pathtoexe/i }
+              entry = main.find { |key, _type, _data| /pathtoexe/i.match? key }
               return entry.last if entry
             end
           rescue LoadError