capybara 2.13.0 → 2.18.0

data/lib/capybara/selenium/driver.rb

@@ -14,13 +14,16 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def browser
     unless @browser
-      if options[:browser].to_s == "firefox"
-        options[:desired_capabilities] ||= Selenium::WebDriver::Remote::Capabilities.firefox
+      if firefox?
+        options[:desired_capabilities] ||= {}
         options[:desired_capabilities].merge!({ unexpectedAlertBehaviour: "ignore" })
       end
 
-      @browser = Selenium::WebDriver.for(options[:browser], options.reject { |key,_val| SPECIAL_OPTIONS.include?(key) })
+      @processed_options = options.reject { |key,_val| SPECIAL_OPTIONS.include?(key) }
+      @browser = Selenium::WebDriver.for(options[:browser], @processed_options)
 
+      @w3c = ((defined?(Selenium::WebDriver::Remote::W3CCapabilities) && @browser.capabilities.is_a?(Selenium::WebDriver::Remote::W3CCapabilities)) ||
+              (defined?(Selenium::WebDriver::Remote::W3C::Capabilities) && @browser.capabilities.is_a?(Selenium::WebDriver::Remote::W3C::Capabilities)))
       main = Process.pid
       at_exit do
         # Store the exit status of the test run since it goes away after calling the at_exit proc...
@@ -33,17 +36,8 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def initialize(app, options={})
-    begin
-      require 'selenium-webdriver'
-    rescue LoadError => e
-      if e.message =~ /selenium-webdriver/
-        raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
-      else
-        raise e
-      end
-    end
-
-
+    load_selenium
+    @session = nil
     @app = app
     @browser = nil
     @exit_status = nil
@@ -55,6 +49,13 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     browser.navigate.to(path)
   end
 
+  def refresh
+    accept_modal(nil, wait: 0.1) do
+      browser.navigate.refresh
+    end
+  rescue Capybara::ModalNotFound
+  end
+
   def go_back
     browser.navigate.back
   end
@@ -95,6 +96,12 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     unwrap_script_result(result)
   end
 
+  def evaluate_async_script(script, *args)
+    browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time
+    result = browser.execute_async_script(script, *args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg} )
+    unwrap_script_result(result)
+  end
+
   def save_screenshot(path, _options={})
     browser.save_screenshot(path)
   end
@@ -138,14 +145,14 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
           raise Capybara::ExpectationNotMet.new('Timed out waiting for Selenium session reset') if (Capybara::Helpers.monotonic_time - start_time) >= 10
           sleep 0.05
         end
-      rescue Selenium::WebDriver::Error::UnhandledAlertError
+      rescue Selenium::WebDriver::Error::UnhandledAlertError, Selenium::WebDriver::Error::UnexpectedAlertOpenError
         # This error is thrown if an unhandled alert is on the page
         # Firefox appears to automatically dismiss this alert, chrome does not
         # We'll try to accept it
         begin
           @browser.switch_to.alert.accept
           sleep 0.25 # allow time for the modal to be handled
-        rescue Selenium::WebDriver::Error::NoAlertPresentError
+        rescue modal_error
           # The alert is now gone - nothing to do
         end
         # try cleaning up the browser again
@@ -185,7 +192,12 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def resize_window_to(handle, width, height)
     within_given_window(handle) do
-      browser.manage.window.resize_to(width, height)
+      # Don't set the size if already set - See https://github.com/mozilla/geckodriver/issues/643
+      if marionette? && (window_size(handle) == [width, height])
+        {}
+      else
+        browser.manage.window.resize_to(width, height)
+      end
     end
   end
 
@@ -222,7 +234,9 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   def accept_modal(_type, options={})
     yield if block_given?
     modal = find_modal(options)
+
     modal.send_keys options[:with] if options[:with]
+
     message = modal.text
     modal.accept
     message
@@ -238,7 +252,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def quit
     @browser.quit if @browser
-  rescue Errno::ECONNREFUSED
+  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED
     # Browser must have already gone
   rescue Selenium::WebDriver::Error::UnknownError => e
     unless silenced_unknown_error_message?(e.message) # Most likely already gone
@@ -250,10 +264,15 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def invalid_element_errors
-    [Selenium::WebDriver::Error::StaleElementReferenceError,
-     Selenium::WebDriver::Error::UnhandledError,
-     Selenium::WebDriver::Error::ElementNotVisibleError,
-     Selenium::WebDriver::Error::InvalidSelectorError]  # Work around a race condition that can occur with chromedriver and #go_back/#go_forward
+    [::Selenium::WebDriver::Error::StaleElementReferenceError,
+     ::Selenium::WebDriver::Error::UnhandledError,
+     ::Selenium::WebDriver::Error::ElementNotVisibleError,
+     ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around a race condition that can occur with chromedriver and #go_back/#go_forward
+     ::Selenium::WebDriver::Error::ElementNotInteractableError,
+     ::Selenium::WebDriver::Error::ElementClickInterceptedError,
+     ::Selenium::WebDriver::Error::InvalidElementStateError,
+     ::Selenium::WebDriver::Error::ElementNotSelectableError,
+    ]
   end
 
   def no_such_window_error
@@ -261,6 +280,40 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   # @api private
+  def marionette?
+    firefox? && browser && @w3c
+  end
+
+  # @api private
+  def firefox?
+    browser_name == "firefox"
+  end
+
+  # @api private
+  def chrome?
+    browser_name == "chrome"
+  end
+
+  # @deprecated This method is being removed
+  def browser_initialized?
+    super && !@browser.nil?
+  end
+
+  private
+
+  # @api private
+  def browser_name
+    options[:browser].to_s
+  end
+
+  def modal_error
+    if defined?(Selenium::WebDriver::Error::NoSuchAlertError)
+      Selenium::WebDriver::Error::NoSuchAlertError
+    else
+      Selenium::WebDriver::Error::NoAlertPresentError
+    end
+  end
+
   def find_window(locator)
     handles = browser.window_handles
     return locator if handles.include? locator
@@ -278,18 +331,60 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     raise Capybara::ElementNotFound, "Could not find a window identified by #{locator}"
   end
 
-  #@api private
-  def marionette?
-    (options[:browser].to_s == "firefox") && browser.capabilities.is_a?(Selenium::WebDriver::Remote::W3CCapabilities)
-  end
+  def insert_modal_handlers(accept, response_text)
+    prompt_response = if accept
+      if response_text.nil?
+        "default_text"
+      else
+        "'#{response_text.gsub("\\", "\\\\\\").gsub("'", "\\\\'")}'"
+      end
+    else
+      'null'
+    end
 
-  # @deprecated This method is being removed
-  def browser_initialized?
-    super && !@browser.nil?
+    script = <<-JS
+      if (typeof window.capybara  === 'undefined') {
+        window.capybara = {
+          modal_handlers: [],
+          current_modal_status: function() {
+            return [this.modal_handlers[0].called, this.modal_handlers[0].modal_text];
+          },
+          add_handler: function(handler) {
+            this.modal_handlers.unshift(handler);
+          },
+          remove_handler: function(handler) {
+            window.alert = handler.alert;
+            window.confirm = handler.confirm;
+            window.prompt = handler.prompt;
+          },
+          handler_called: function(handler, str) {
+            handler.called = true;
+            handler.modal_text = str;
+            this.remove_handler(handler);
+          }
+        };
+      };
+
+      var modal_handler = {
+        prompt: window.prompt,
+        confirm: window.confirm,
+        alert: window.alert,
+        called: false
+      }
+      window.capybara.add_handler(modal_handler);
+
+      window.alert = window.confirm = function(str = "") {
+        window.capybara.handler_called(modal_handler, str.toString());
+        return #{accept ? 'true' : 'false'};
+      }
+      window.prompt = function(str = "", default_text = "") {
+        window.capybara.handler_called(modal_handler, str.toString());
+        return #{prompt_response};
+      }
+    JS
+    execute_script script
   end
 
-  private
-
   def within_given_window(handle)
     original_handle = self.current_window_handle
     if handle == original_handle
@@ -306,8 +401,8 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time
     # Actual wait time may be longer than specified
     wait = Selenium::WebDriver::Wait.new(
-      timeout: (options[:wait] || Capybara.default_max_wait_time),
-      ignore: Selenium::WebDriver::Error::NoAlertPresentError)
+      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0 ,
+      ignore: modal_error)
     begin
       wait.until do
         alert = @browser.switch_to.alert
@@ -319,6 +414,36 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     end
   end
 
+  def find_headless_modal(options={})
+    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time
+    # Actual wait time may be longer than specified
+    wait = Selenium::WebDriver::Wait.new(
+      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0 ,
+      ignore: modal_error)
+    begin
+      wait.until do
+        called, alert_text = evaluate_script('window.capybara && window.capybara.current_modal_status()')
+        if called
+          execute_script('window.capybara && window.capybara.modal_handlers.shift()')
+          regexp = options[:text].is_a?(Regexp) ? options[:text] : Regexp.escape(options[:text].to_s)
+          if alert_text.match(regexp)
+            alert_text
+          else
+            raise Capybara::ModalNotFound.new("Unable to find modal dialog#{" with #{options[:text]}" if options[:text]}")
+          end
+        elsif called.nil?
+          # page changed so modal_handler data has gone away
+          warn "Can't verify modal text when page change occurs - ignoring" if options[:text]
+          ""
+        else
+          nil
+        end
+      end
+    rescue Selenium::WebDriver::Error::TimeOutError
+      raise Capybara::ModalNotFound.new("Unable to find modal dialog#{" with #{options[:text]}" if options[:text]}")
+    end
+  end
+
   def silenced_unknown_error_message?(msg)
     silenced_unknown_error_messages.any? { |r| msg =~ r }
   end
@@ -339,4 +464,23 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       arg
     end
   end
+
+  def load_selenium
+    begin
+      require 'selenium-webdriver'
+      # Fix for selenium-webdriver 3.4.0 which misnamed these
+      if !defined?(::Selenium::WebDriver::Error::ElementNotInteractableError)
+        ::Selenium::WebDriver::Error.const_set('ElementNotInteractableError', Class.new(::Selenium::WebDriver::Error::WebDriverError))
+      end
+      if !defined?(::Selenium::WebDriver::Error::ElementClickInterceptedError)
+        ::Selenium::WebDriver::Error.const_set('ElementClickInterceptedError', Class.new(::Selenium::WebDriver::Error::WebDriverError))
+      end
+    rescue LoadError => e
+      if e.message =~ /selenium-webdriver/
+        raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
+      else
+        raise e
+      end
+    end
+  end
 end

data/lib/capybara/selenium/node.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 class Capybara::Selenium::Node < Capybara::Driver::Node
+
   def visible_text
     # Selenium doesn't normalize Unicode whitespace.
     Capybara::Helpers.normalize_whitespace(native.text)
@@ -18,7 +19,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
 
   def value
     if tag_name == "select" and multiple?
-      native.find_elements(:xpath, ".//option").select { |n| n.selected? }.map { |n| n[:value] || n.text }
+      native.find_elements(:css, "option:checked").map { |n| n[:value] || n.text }
     else
       native[:value]
     end
@@ -38,61 +39,54 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   def set(value, options={})
     tag_name = self.tag_name
     type = self[:type]
+
     if (Array === value) && !multiple?
       raise ArgumentError.new "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
     end
-    if tag_name == 'input' and type == 'radio'
-      click
-    elsif tag_name == 'input' and type == 'checkbox'
-      click if value ^ native.attribute('checked').to_s.eql?("true")
-    elsif tag_name == 'input' and type == 'file'
-      path_names = value.to_s.empty? ? [] : value
-      if driver.options[:browser].to_s == "chrome"
-        native.send_keys(Array(path_names).join("\n"))
+
+    case tag_name
+    when 'input'
+      case type
+      when 'radio'
+        click
+      when 'checkbox'
+        click if value ^ native.attribute('checked').to_s.eql?("true")
+      when 'file'
+        path_names = value.to_s.empty? ? [] : value
+        if driver.chrome?
+          native.send_keys(Array(path_names).join("\n"))
+        else
+          native.send_keys(*path_names)
+        end
       else
-        native.send_keys(*path_names)
+        set_text(value, options)
       end
-    elsif tag_name == 'textarea' or tag_name == 'input'
-      if readonly?
-        warn "Attempt to set readonly element with value: #{value} \n *This will raise an exception in a future version of Capybara"
-      elsif value.to_s.empty?
-        native.clear
-      else
-        if options[:clear] == :backspace
-          # Clear field by sending the correct number of backspace keys.
-          backspaces = [:backspace] * self.value.to_s.length
-          native.send_keys(*(backspaces + [value.to_s]))
-        elsif options[:clear] == :none
-          native.send_keys(value.to_s)
-        elsif options[:clear].is_a? Array
-          native.send_keys(*options[:clear], value.to_s)
+    when 'textarea'
+      set_text(value, options)
+    else
+      if content_editable?
+        #ensure we are focused on the element
+        click
+
+        script = <<-JS
+          var range = document.createRange();
+          var sel = window.getSelection();
+          arguments[0].focus();
+          range.selectNodeContents(arguments[0]);
+          sel.removeAllRanges();
+          sel.addRange(range);
+        JS
+        driver.execute_script script, self
+
+        if driver.chrome? || driver.firefox?
+          # chromedriver raises a can't focus element for child elements if we use native.send_keys
+          # we've already focused it so just use action api
+          driver.browser.action.send_keys(value.to_s).perform
         else
-          # Clear field by JavaScript assignment of the value property.
-          # Script can change a readonly element which user input cannot, so
-          # don't execute if readonly.
-          driver.execute_script "arguments[0].value = ''", self
+          # action api is really slow here just use native.send_keys
           native.send_keys(value.to_s)
         end
       end
-    elsif native.attribute('isContentEditable')
-      #ensure we are focused on the element
-      native.click
-      script = <<-JS
-        var range = document.createRange();
-        arguments[0].focus();
-        range.selectNodeContents(arguments[0]);
-        window.getSelection().addRange(range);
-      JS
-      driver.execute_script script, self
-      if (driver.options[:browser].to_s == "chrome") ||
-         (driver.options[:browser].to_s == "firefox" && !driver.marionette?)
-        # chromedriver raises a can't focus element if we use native.send_keys
-        # we've already focused it so just use action api
-        driver.browser.action.send_keys(value.to_s).perform
-      else
-        # action api is really slow here just use native.send_keys
-        native.send_keys(value.to_s)
-      end
     end
   end
 
@@ -101,22 +95,33 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def unselect_option
-    if select_node['multiple'] != 'multiple' and select_node['multiple'] != 'true'
-      raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box."
-    end
+    raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box." if !select_node.multiple?
     native.click if selected?
   end
 
   def click
     native.click
+  rescue => e
+    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
+       e.message =~ /Other element would receive the click/
+      begin
+        driver.execute_script("arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'})", self)
+      rescue
+      end
+    end
+    raise e
   end
 
   def right_click
-    driver.browser.action.context_click(native).perform
+    scroll_if_needed do
+      driver.browser.action.context_click(native).perform
+    end
   end
 
   def double_click
-    driver.browser.action.double_click(native).perform
+    scroll_if_needed do
+      driver.browser.action.double_click(native).perform
+    end
   end
 
   def send_keys(*args)
@@ -124,11 +129,15 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def hover
-    driver.browser.action.move_to(native).perform
+    scroll_if_needed do
+      driver.browser.action.move_to(native).perform
+    end
   end
 
   def drag_to(element)
-    driver.browser.action.drag_and_drop(native, element.native).perform
+    scroll_if_needed do
+      driver.browser.action.drag_and_drop(native, element.native).perform
+    end
   end
 
   def tag_name
@@ -169,6 +178,10 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     multiple and multiple != "false"
   end
 
+  def content_editable?
+    native.attribute('isContentEditable')
+  end
+
   def find_xpath(locator)
     native.find_elements(:xpath, locator).map { |n| self.class.new(driver, n) }
   end
@@ -208,6 +221,44 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
 private
   # a reference to the select node if this is an option node
   def select_node
-    find_xpath('./ancestor::select').first
+    find_xpath('./ancestor::select[1]').first
+  end
+
+  def set_text(value, options)
+    if readonly?
+      warn "Attempt to set readonly element with value: #{value} \n *This will raise an exception in a future version of Capybara"
+    elsif value.to_s.empty? && options[:clear].nil?
+      native.clear
+    else
+      if options[:clear] == :backspace
+        # Clear field by sending the correct number of backspace keys.
+        backspaces = [:backspace] * self.value.to_s.length
+        native.send_keys(*(backspaces + [value.to_s]))
+      elsif options[:clear] == :none
+        native.send_keys(value.to_s)
+      elsif options[:clear].is_a? Array
+        native.send_keys(*options[:clear], value.to_s)
+      else
+        # Clear field by JavaScript assignment of the value property.
+        # Script can change a readonly element which user input cannot, so
+        # don't execute if readonly.
+        driver.execute_script "arguments[0].value = ''", self
+        native.send_keys(value.to_s)
+      end
+    end
+  end
+
+  def scroll_if_needed(&block)
+    block.call
+  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
+    script = <<-JS
+      try {
+        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
+      } catch(e) {
+        arguments[0].scrollIntoView(true);
+      }
+    JS
+    driver.execute_script(script, self)
+    block.call
   end
 end

data/lib/capybara/server.rb

@@ -25,9 +25,10 @@ module Capybara
 
       attr_accessor :error
 
-      def initialize(app)
+      def initialize(app, server_errors)
         @app = app
         @counter = Counter.new
+        @server_errors = server_errors
       end
 
       def pending_requests?
@@ -41,7 +42,7 @@ module Capybara
           @counter.increment
           begin
             @app.call(env)
-          rescue *Capybara.server_errors => e
+          rescue *@server_errors => e
             @error = e unless @error
             raise e
           ensure
@@ -59,10 +60,10 @@ module Capybara
 
     attr_reader :app, :port, :host
 
-    def initialize(app, port=Capybara.server_port, host=Capybara.server_host)
+    def initialize(app, port=Capybara.server_port, host=Capybara.server_host, server_errors=Capybara.server_errors)
       @app = app
       @server_thread = nil # suppress warnings
-      @host, @port = host, port
+      @host, @port, @server_errors = host, port, server_errors
       @port ||= Capybara::Server.ports[port_key]
       @port ||= find_available_port(host)
     end
@@ -112,7 +113,7 @@ module Capybara
   private
 
     def middleware
-      @middleware ||= Middleware.new(app)
+      @middleware ||= Middleware.new(app, @server_errors)
     end
 
     def port_key