capybara 2.18.0 → 3.40.0

data/spec/selenium_spec_firefox.rb

@@ -1,68 +1,228 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
-require "selenium-webdriver"
+require 'selenium-webdriver'
 require 'shared_selenium_session'
+require 'shared_selenium_node'
 require 'rspec/shared_spec_matchers'
 
+Selenium::WebDriver.logger.ignore(:selenium_manager)
+
+browser_options = Selenium::WebDriver::Firefox::Options.new
+browser_options.add_argument '-headless' if ENV['HEADLESS']
+# browser_options.add_option("log", {"level": "trace"})
+
+browser_options.profile = Selenium::WebDriver::Firefox::Profile.new.tap do |profile|
+  profile['browser.download.dir'] = Capybara.save_path
+  profile['browser.download.folderList'] = 2
+  profile['browser.helperApps.neverAsk.saveToDisk'] = 'text/csv'
+  profile['browser.startup.homepage'] = 'about:blank' # workaround bug in Selenium 4 alpha4-7
+  profile['accessibility.tabfocus'] = 7 # make tab move over links too
+end
+
 Capybara.register_driver :selenium_firefox do |app|
-  Capybara::Selenium::Driver.new(
-    app,
-    browser: :firefox,
-    desired_capabilities: Selenium::WebDriver::Remote::Capabilities.firefox(marionette: false)
-  )
+  # ::Selenium::WebDriver.logger.level = "debug"
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  driver_options = { browser: :firefox, timeout: 31 }.tap do |opts|
+    opts[options_key] = browser_options
+    # Get a trace level log from geckodriver
+    # :driver_opts => { args: ['-vv'] }
+  end
+
+  Capybara::Selenium::Driver.new(app, **driver_options)
 end
 
-Capybara.register_driver :selenium_firefox_cant_clear_storage do |app|
-  Capybara::Selenium::Driver.new(
-    app,
-    browser: :firefox,
-    desired_capabilities: Selenium::WebDriver::Remote::Capabilities.firefox(marionette: false),
-    clear_local_storage: true,
-    clear_session_storage: true
-  )
+Capybara.register_driver :selenium_firefox_not_clear_storage do |app|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  driver_options = { browser: :firefox, clear_local_storage: false, clear_session_storage: false }.tap do |opts|
+    opts[options_key] = browser_options
+  end
+
+  Capybara::Selenium::Driver.new(app, **driver_options)
 end
 
 module TestSessions
-  Selenium = Capybara::Session.new(:selenium_firefox, TestApp)
+  SeleniumFirefox = Capybara::Session.new(:selenium_firefox, TestApp)
 end
 
-skipped_tests = [
-  :response_headers,
-  :status_code,
-  :trigger
-]
-skipped_tests << :windows if ENV['TRAVIS'] && ENV['SKIP_WINDOW']
+skipped_tests = %i[response_headers status_code trigger]
 
-Capybara::SpecHelper.run_specs TestSessions::Selenium, "selenium", capybara_skip: skipped_tests
+Capybara::SpecHelper.log_selenium_driver_version(Selenium::WebDriver::Firefox) if ENV['CI']
 
-RSpec.describe "Capybara::Session with legacy firefox" do
+Capybara::SpecHelper.run_specs TestSessions::SeleniumFirefox, 'selenium', capybara_skip: skipped_tests do |example|
+  case example.metadata[:full_description]
+  when 'Capybara::Session selenium node #click should allow multiple modifiers'
+    pending "Firefox on OSX doesn't generate an event for shift+control+click" if firefox_gte?(62, @session) && Selenium::WebDriver::Platform.mac?
+  when /^Capybara::Session selenium node #double_click/
+    pending "selenium-webdriver/geckodriver doesn't generate double click event" if firefox_lt?(59, @session)
+  when 'Capybara::Session selenium #accept_prompt should accept the prompt with a blank response when there is a default'
+    pending "Geckodriver doesn't set a blank response in FF < 63 - https://bugzilla.mozilla.org/show_bug.cgi?id=1486485" if firefox_lt?(63, @session)
+  when 'Capybara::Session selenium #attach_file with multipart form should fire change once when uploading multiple files from empty'
+    pending "FF < 62 doesn't support setting all files at once" if firefox_lt?(62, @session)
+  when 'Capybara::Session selenium #accept_confirm should work with nested modals'
+    skip 'Broken in 63 <= FF < 69 - https://bugzilla.mozilla.org/show_bug.cgi?id=1487358' if firefox_gte?(63, @session) && firefox_lt?(69, @session)
+    skip 'Hangs in 69 <= FF < 71 - Dont know what issue for this - previous issue was closed as fixed but it is not' if firefox_gte?(69, @session) && firefox_lt?(71, @session)
+    skip 'Broken again intermittently in FF 71 - jus skip it' if firefox_lt?(109, @session) # don't really know when it was fixed
+  when 'Capybara::Session selenium #click_link can download a file'
+    skip 'Need to figure out testing of file downloading on windows platform' if Gem.win_platform?
+  when 'Capybara::Session selenium #reset_session! removes ALL cookies'
+    pending "Geckodriver doesn't provide a way to remove cookies outside the current domain"
+  when /drag_to.*HTML5/
+    pending "Firefox < 62 doesn't support a DataTransfer constructor" if firefox_lt?(62.0, @session)
+  when 'Capybara::Session selenium #accept_alert should handle the alert if the page changes',
+       'Capybara::Session selenium #accept_alert with an asynchronous alert should accept the alert'
+    skip 'No clue what Firefox is doing here - works fine on MacOS locally' if firefox_lt?(109, @session) # don't really know when it was fixed
+  when 'Capybara::Session selenium node #shadow_root should find elements inside the shadow dom using CSS',
+       'Capybara::Session selenium node #shadow_root should find nested shadow roots',
+       'Capybara::Session selenium node #shadow_root should click on elements',
+       'Capybara::Session selenium node #shadow_root should use convenience methods once moved to a descendant of the shadow root',
+       'Capybara::Session selenium node #shadow_root should produce error messages when failing',
+       'Capybara::Session with firefox with selenium driver #evaluate_script returns a shadow root'
+    pending "Firefox doesn't yet have full W3C shadow root support" if firefox_lt?(113, @session)
+  when 'Capybara::Session selenium #fill_in should handle carriage returns with line feeds in a textarea correctly'
+    pending 'Not sure what firefox is doing here'
+  when /Capybara::Session selenium node #shadow_root should get visible text/
+    pending "Selenium doesn't currently support getting visible text for shadow root elements"
+  when /Capybara::Session selenium node #shadow_root/
+    skip 'Not supported with this geckodriver version' if geckodriver_lt?('0.31.0', @session)
+  when /Capybara::Session selenium node #set should submit single text input forms if ended with \\n/
+    pending 'Firefox/geckodriver doesn\'t submit with values ending in \n'
+  end
+end
+
+RSpec.describe 'Capybara::Session with firefox' do # rubocop:disable RSpec/MultipleDescribes
   include Capybara::SpecHelper
-  include_examples  "Capybara::Session", TestSessions::Selenium, :selenium_firefox
-  include_examples  Capybara::RSpecMatchers, TestSessions::Selenium, :selenium_firefox
-
-  context "storage" do
-    it "warns storage clearing isn't available" do
-      @session = Capybara::Session.new(:selenium_firefox_cant_clear_storage, TestApp)
-      expect_any_instance_of(Kernel).to receive(:warn).with('sessionStorage clear requested but is not available for this driver')
-      expect_any_instance_of(Kernel).to receive(:warn).with('localStorage clear requested but is not available for this driver')
-      @session.visit('/')
-      @session.reset!
+  ['Capybara::Session', 'Capybara::Node', Capybara::RSpecMatchers].each do |examples|
+    include_examples examples, TestSessions::SeleniumFirefox, :selenium_firefox
+  end
+
+  describe 'filling in Firefox-specific date and time fields with keystrokes' do
+    let(:datetime) { Time.new(1983, 6, 19, 6, 30) }
+    let(:session) { TestSessions::SeleniumFirefox }
+
+    before do
+      session.visit('/form')
+    end
+
+    it 'should fill in a date input with a String' do
+      session.fill_in('form_date', with: datetime.to_date.iso8601)
+      session.click_button('awesome')
+      expect(Date.parse(extract_results(session)['date'])).to eq datetime.to_date
+    end
+
+    it 'should fill in a time input with a String' do
+      session.fill_in('form_time', with: datetime.to_time.strftime('%T'))
+      session.click_button('awesome')
+      results = extract_results(session)['time']
+      expect(Time.parse(results).strftime('%r')).to eq datetime.strftime('%r')
+    end
+
+    it 'should fill in a datetime input with a String' do
+      pending 'Need to figure out what string format this will actually accept'
+      session.fill_in('form_datetime', with: datetime.iso8601)
+      session.click_button('awesome')
+      expect(Time.parse(extract_results(session)['datetime'])).to eq datetime
     end
   end
 end
 
 RSpec.describe Capybara::Selenium::Driver do
-  before do
-    @driver = Capybara::Selenium::Driver.new(TestApp, browser: :firefox, desired_capabilities: Selenium::WebDriver::Remote::Capabilities.firefox(marionette: false))
-  end
+  let(:driver) { described_class.new(TestApp, browser: :firefox, options: browser_options) }
 
   describe '#quit' do
-    it "should reset browser when quit" do
-      expect(@driver.browser).to be
-      @driver.quit
-      #access instance variable directly so we don't create a new browser instance
-      expect(@driver.instance_variable_get(:@browser)).to be_nil
+    it 'should reset browser when quit' do
+      expect(driver.browser).to be_truthy
+      driver.quit
+      # access instance variable directly so we don't create a new browser instance
+      expect(driver.instance_variable_get(:@browser)).to be_nil
+    end
+
+    context 'with errors' do
+      let!(:original_browser) { driver.browser }
+
+      after do
+        # Ensure browser is actually quit so we don't leave hanging processe
+        RSpec::Mocks.space.proxy_for(original_browser).reset
+        original_browser.quit
+      end
+
+      it 'warns UnknownError returned during quit because the browser is probably already gone' do
+        allow(driver).to receive(:warn)
+        allow(driver.browser).to(
+          receive(:quit)
+          .and_raise(Selenium::WebDriver::Error::UnknownError, 'random message')
+        )
+
+        expect { driver.quit }.not_to raise_error
+        expect(driver.instance_variable_get(:@browser)).to be_nil
+        expect(driver).to have_received(:warn).with(/random message/)
+      end
+
+      it 'ignores silenced UnknownError returned during quit because the browser is almost definitely already gone' do
+        allow(driver).to receive(:warn)
+        allow(driver.browser).to(
+          receive(:quit)
+          .and_raise(Selenium::WebDriver::Error::UnknownError, 'Error communicating with the remote browser')
+        )
+
+        expect { driver.quit }.not_to raise_error
+        expect(driver.instance_variable_get(:@browser)).to be_nil
+        expect(driver).not_to have_received(:warn)
+      end
+    end
+  end
+
+  context 'storage' do
+    describe '#reset!' do
+      it 'clears storage by default' do
+        session = TestSessions::SeleniumFirefox
+        session.visit('/with_js')
+        session.find(:css, '#set-storage').click
+        session.reset!
+        session.visit('/with_js')
+        expect(session.driver.browser.local_storage.keys).to be_empty
+        expect(session.driver.browser.session_storage.keys).to be_empty
+      end
+
+      it 'does not clear storage when false' do
+        session = Capybara::Session.new(:selenium_firefox_not_clear_storage, TestApp)
+        session.visit('/with_js')
+        session.find(:css, '#set-storage').click
+        session.reset!
+        session.visit('/with_js')
+        expect(session.driver.browser.local_storage.keys).not_to be_empty
+        expect(session.driver.browser.session_storage.keys).not_to be_empty
+      end
+    end
+  end
+
+  context 'timeout' do
+    it 'sets the http client read timeout' do
+      expect(TestSessions::SeleniumFirefox.driver.browser.send(:bridge).http.read_timeout).to eq 31
     end
   end
 end
 
+RSpec.describe Capybara::Selenium::Node do
+  describe '#click' do
+    it 'warns when attempting on a table row' do
+      session = TestSessions::SeleniumFirefox
+      session.visit('/tables')
+      tr = session.find(:css, '#agent_table tr:first-child')
+      allow(tr.base).to receive(:warn)
+      tr.click
+      expect(tr.base).to have_received(:warn).with(/Clicking the first cell in the row instead/)
+    end
+
+    it 'should allow multiple modifiers', requires: [:js] do
+      session = TestSessions::SeleniumFirefox
+      session.visit('with_js')
+      # Firefox v62+ doesn't generate an event for control+shift+click
+      session.find(:css, '#click-test').click(:alt, :ctrl, :meta)
+      # it also triggers a contextmenu event when control is held so don't check click type
+      expect(session).to have_link('Has been alt control meta')
+    end
+  end
+end

data/spec/selenium_spec_firefox_remote.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'selenium-webdriver'
+require 'shared_selenium_session'
+require 'shared_selenium_node'
+require 'rspec/shared_spec_matchers'
+
+def selenium_host
+  ENV.fetch('SELENIUM_HOST', '0.0.0.0')
+end
+
+def selenium_port
+  ENV.fetch('SELENIUM_PORT', 4445)
+end
+
+def ensure_selenium_running!
+  timer = Capybara::Helpers.timer(expire_in: 20)
+  begin
+    TCPSocket.open(selenium_host, selenium_port)
+  rescue StandardError
+    if timer.expired?
+      raise 'Selenium is not running. ' \
+            "You can run a selenium server easily with: \n. " \
+            '$ docker-compose up -d selenium_firefox'
+    else
+      puts 'Waiting for Selenium docker instance...'
+      sleep 1
+      retry
+    end
+  end
+end
+
+Capybara.register_driver :selenium_firefox_remote do |app|
+  ensure_selenium_running!
+
+  url = "http://#{selenium_host}:#{selenium_port}/wd/hub"
+  browser_options = Selenium::WebDriver::Firefox::Options.new
+
+  Capybara::Selenium::Driver.new app,
+                                 browser: :remote,
+                                 options: browser_options,
+                                 url: url
+end
+
+FIREFOX_REMOTE_DRIVER = :selenium_firefox_remote
+
+module TestSessions
+  RemoteFirefox = Capybara::Session.new(FIREFOX_REMOTE_DRIVER, TestApp)
+end
+
+skipped_tests = %i[response_headers status_code trigger download]
+
+Capybara::SpecHelper.run_specs TestSessions::RemoteFirefox, FIREFOX_REMOTE_DRIVER.to_s, capybara_skip: skipped_tests do |example|
+  case example.metadata[:full_description]
+  when 'Capybara::Session selenium_firefox_remote node #click should allow multiple modifiers'
+    skip "Firefox doesn't generate an event for shift+control+click" if firefox_gte?(62, @session)
+  when 'Capybara::Session selenium_firefox_remote #accept_prompt should accept the prompt with a blank response when there is a default'
+    pending "Geckodriver doesn't set a blank response in FF < 63 - https://bugzilla.mozilla.org/show_bug.cgi?id=1486485" if firefox_lt?(63, @session)
+  when 'Capybara::Session selenium_firefox_remote #attach_file with multipart form should fire change once when uploading multiple files from empty'
+    pending "FF < 62 doesn't support setting all files at once" if firefox_lt?(62, @session)
+  when 'Capybara::Session selenium_firefox_remote #reset_session! removes ALL cookies'
+    pending "Geckodriver doesn't provide a way to remove cookies outside the current domain"
+  when /#accept_confirm should work with nested modals$/
+    # skip because this is timing based and hence flaky when set to pending
+    skip 'Broken in FF 63 - https://bugzilla.mozilla.org/show_bug.cgi?id=1487358' if firefox_gte?(63, @session)
+  when 'Capybara::Session selenium_firefox_remote #fill_in should handle carriage returns with line feeds in a textarea correctly'
+    pending 'Not sure what firefox is doing here'
+  when 'Capybara::Session selenium_firefox_remote node #shadow_root should find elements inside the shadow dom using CSS',
+       'Capybara::Session selenium_firefox_remote node #shadow_root should find nested shadow roots',
+       'Capybara::Session selenium_firefox_remote node #shadow_root should click on elements',
+       'Capybara::Session selenium_firefox_remote node #shadow_root should use convenience methods once moved to a descendant of the shadow root',
+       'Capybara::Session selenium_firefox_remote node #shadow_root should produce error messages when failing',
+       'Capybara::Session with remote firefox with selenium driver #evaluate_script returns a shadow root'
+    pending "Firefox doesn't yet have full W3C shadow root support"
+  when /Capybara::Session selenium_firefox_remote node #shadow_root should get visible text/
+    pending "Selenium doesn't currently support getting visible text for shadow root elements"
+  when /Capybara::Session selenium_firefox_remote node #shadow_root/
+    skip 'Not supported with this geckodriver version' if geckodriver_lt?('0.31.0', @session)
+  when /Capybara::Session selenium node #set should submit single text input forms if ended with \\n/
+    pending 'Firefox/geckodriver doesn\'t submit with values ending in \n'
+  end
+end
+
+RSpec.describe 'Capybara::Session with remote firefox' do
+  include Capybara::SpecHelper
+  ['Capybara::Session', 'Capybara::Node', Capybara::RSpecMatchers].each do |examples|
+    include_examples examples, TestSessions::RemoteFirefox, FIREFOX_REMOTE_DRIVER
+  end
+
+  it 'is considered to be firefox' do
+    expect(session.driver.browser.browser).to eq :firefox
+  end
+end

data/spec/selenium_spec_ie.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'selenium-webdriver'
+require 'shared_selenium_session'
+require 'shared_selenium_node'
+require 'rspec/shared_spec_matchers'
+
+# if ENV['CI']
+#   if ::Selenium::WebDriver::Service.respond_to? :driver_path=
+#     ::Selenium::WebDriver::IE::Service
+#   else
+#     ::Selenium::WebDriver::IE
+#   end.driver_path = 'C:\Tools\WebDriver\IEDriverServer.exe'
+# end
+
+def selenium_host
+  ENV.fetch('SELENIUM_HOST', '192.168.56.102')
+end
+
+def selenium_port
+  ENV.fetch('SELENIUM_PORT', 4444)
+end
+
+def server_host
+  ENV.fetch('SERVER_HOST', '10.24.4.135')
+end
+
+Capybara.register_driver :selenium_ie do |app|
+  # ::Selenium::WebDriver.logger.level = "debug"
+  options = Selenium::WebDriver::IE::Options.new
+  # options.require_window_focus = true
+  # options.add_option("log", {"level": "trace"})
+
+  if ENV['REMOTE']
+    Capybara.server_host = server_host
+
+    url = "http://#{selenium_host}:#{selenium_port}/wd/hub"
+    Capybara::Selenium::Driver.new(app,
+                                   browser: :remote,
+                                   options: options,
+                                   url: url)
+  else
+    Capybara::Selenium::Driver.new(
+      app,
+      browser: :ie,
+      options: options
+    )
+  end
+end
+
+module TestSessions
+  SeleniumIE = Capybara::Session.new(:selenium_ie, TestApp)
+end
+
+TestSessions::SeleniumIE.current_window.resize_to(800, 500)
+
+skipped_tests = %i[response_headers status_code trigger modals hover form_attribute windows]
+
+Capybara::SpecHelper.log_selenium_driver_version(Selenium::WebDriver::IE) if ENV['CI']
+
+TestSessions::SeleniumIE.current_window.resize_to(1600, 1200)
+
+Capybara::SpecHelper.run_specs TestSessions::SeleniumIE, 'selenium', capybara_skip: skipped_tests do |example|
+  case example.metadata[:full_description]
+  when /#refresh it reposts$/
+    skip 'IE insists on prompting without providing a way to suppress'
+  when /#click_link can download a file$/
+    skip 'Not sure how to configure IE for automatic downloading'
+  when /#fill_in with Date /
+    pending "IE 11 doesn't support date input types"
+  when /#click_link_or_button with :disabled option happily clicks on links which incorrectly have the disabled attribute$/
+    skip 'IE 11 obeys non-standard disabled attribute on anchor tag'
+  when /#click should allow modifiers$/, /#double_click should allow modifiers$/
+    pending "Doesn't work with IE for some unknown reason$"
+    pending "Doesn't work with IE for some unknown reason$"
+  when /#click should allow multiple modifiers$/, /#right_click should allow modifiers$/
+    skip "Windows can't :meta click because :meta triggers start menu"
+  when /#double_click should allow multiple modifiers$/
+    skip "Windows can't :alt double click due to being properties shortcut"
+  when /#has_css\? should support case insensitive :class and :id options$/
+    pending "IE doesn't support case insensitive CSS selectors"
+  when /#reset_session! removes ALL cookies$/
+    pending "IE driver doesn't provide a way to remove ALL cookies"
+  when /#click_button should send button in document order$/
+    pending "IE 11 doesn't support the 'form' attribute"
+  when /#click_button should follow permanent redirects that maintain method$/
+    pending "Window 7 and 8.1 don't support 308 http status code"
+  when /#scroll_to can scroll an element to the center of the viewport$/,
+       /#scroll_to can scroll an element to the center of the scrolling element$/
+    pending "IE doesn't support ScrollToOptions"
+  when /#attach_file with multipart form should fire change once for each set of files uploaded$/,
+       /#attach_file with multipart form should fire change once when uploading multiple files from empty$/,
+       /#attach_file with multipart form should not break when using HTML5 multiple file input uploading multiple files$/
+    pending "IE requires all files be uploaded from same directory. Selenium doesn't provide that." if ENV['REMOTE']
+  when %r{#attach_file with multipart form should send content type image/jpeg when uploading an image$}
+    pending 'IE gets text/plain type for some reason'
+  # when /#click should not retry clicking when wait is disabled$/
+  #   Fixed in IEDriverServer 3.141.0.5
+  #   pending "IE driver doesn't error when clicking on covered elements, it just clicks the wrong element"
+  when /#click should go to the same page if href is blank$/
+    pending 'IE treats blank href as a parent request (against HTML spec)'
+  when /#attach_file with a block/
+    skip 'Hangs IE testing for unknown reason'
+  when /drag_to.*HTML5/
+    pending "IE doesn't support a DataTransfer constructor"
+  when /template elements should not be visible/
+    skip "IE doesn't support template elements"
+  when /Element#drop/
+    pending "IE doesn't support DataTransfer constructor"
+  when /Capybara::Session selenium_chrome node #shadow_root should get visible text/
+    pending "Selenium doesn't currently support getting visible text for shadow root elements"
+  end
+end
+
+RSpec.describe 'Capybara::Session with Internet Explorer', capybara_skip: skipped_tests do # rubocop:disable RSpec/MultipleDescribes
+  include Capybara::SpecHelper
+  ['Capybara::Session', 'Capybara::Node', Capybara::RSpecMatchers].each do |examples|
+    include_examples examples, TestSessions::SeleniumIE, :selenium_ie
+  end
+end
+
+RSpec.describe Capybara::Selenium::Node do
+  it '#right_click should allow modifiers' do
+    # pending "Actions API doesn't appear to work for this"
+    session = TestSessions::SeleniumIE
+    session.visit('/with_js')
+    el = session.find(:css, '#click-test')
+    el.right_click(:control)
+    expect(session).to have_link('Has been control right clicked')
+  end
+
+  it '#click should allow multiple modifiers' do
+    # pending "Actions API doesn't appear to work for this"
+    session = TestSessions::SeleniumIE
+    session.visit('with_js')
+    # IE triggers system behavior with :meta so can't use those here
+    session.find(:css, '#click-test').click(:ctrl, :shift, :alt)
+    expect(session).to have_link('Has been alt control shift clicked')
+  end
+
+  it '#double_click should allow modifiers' do
+    # pending "Actions API doesn't appear to work for this"
+    session = TestSessions::SeleniumIE
+    session.visit('/with_js')
+    session.find(:css, '#click-test').double_click(:shift)
+    expect(session).to have_link('Has been shift double clicked')
+  end
+end