capybara 3.32.2

data/spec/selenium_spec_chrome.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'selenium-webdriver'
+require 'shared_selenium_session'
+require 'shared_selenium_node'
+require 'rspec/shared_spec_matchers'
+
+CHROME_DRIVER = :selenium_chrome
+
+Selenium::WebDriver::Chrome.path = '/usr/bin/google-chrome-beta' if ENV['CI'] && ENV['CHROME_BETA']
+
+browser_options = ::Selenium::WebDriver::Chrome::Options.new
+browser_options.headless! if ENV['HEADLESS']
+browser_options.add_option(:w3c, ENV['W3C'] != 'false')
+# Chromedriver 77 requires setting this for headless mode on linux
+# Different versions of Chrome/selenium-webdriver require setting differently - jus set them all
+browser_options.add_preference('download.default_directory', Capybara.save_path)
+browser_options.add_preference(:download, default_directory: Capybara.save_path)
+
+Capybara.register_driver :selenium_chrome do |app|
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options, timeout: 30).tap do |driver|
+    # Set download dir for Chrome < 77
+    driver.browser.download_path = Capybara.save_path
+  end
+end
+
+Capybara.register_driver :selenium_chrome_not_clear_storage do |app|
+  chrome_options = {
+    browser: :chrome,
+    options: browser_options
+  }
+  Capybara::Selenium::Driver.new(app, **chrome_options.merge(clear_local_storage: false, clear_session_storage: false))
+end
+
+Capybara.register_driver :selenium_chrome_not_clear_session_storage do |app|
+  chrome_options = {
+    browser: :chrome,
+    options: browser_options
+  }
+  Capybara::Selenium::Driver.new(app, **chrome_options.merge(clear_session_storage: false))
+end
+
+Capybara.register_driver :selenium_chrome_not_clear_local_storage do |app|
+  chrome_options = {
+    browser: :chrome,
+    options: browser_options
+  }
+  Capybara::Selenium::Driver.new(app, **chrome_options.merge(clear_local_storage: false))
+end
+
+Capybara.register_driver :selenium_driver_subclass_with_chrome do |app|
+  subclass = Class.new(Capybara::Selenium::Driver)
+  subclass.new(app, browser: :chrome, options: browser_options, timeout: 30)
+end
+
+module TestSessions
+  Chrome = Capybara::Session.new(CHROME_DRIVER, TestApp)
+end
+
+skipped_tests = %i[response_headers status_code trigger]
+
+Capybara::SpecHelper.log_selenium_driver_version(Selenium::WebDriver::Chrome) if ENV['CI']
+
+Capybara::SpecHelper.run_specs TestSessions::Chrome, CHROME_DRIVER.to_s, capybara_skip: skipped_tests do |example|
+  case example.metadata[:full_description]
+  when /#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_chrome Capybara::Window#maximize/
+    pending "Chrome headless doesn't support maximize" if ENV['HEADLESS']
+  when /Capybara::Window#fullscreen should be able to fullscreen the window/
+    skip 'Chromedriver hangs on attempts to fullscreen in headless mode' if ENV['HEADLESS']
+  when /details non-summary descendants should be non-visible/
+    pending 'Chromedriver built-in is_displayed is currently broken' if ENV['W3C'] == 'false'
+  when /node #right_click delay should delay the mouse up/
+    skip "Legacy selenium doesn't support separate right button down/up" if ENV['W3C'] == 'false'
+  end
+end
+
+RSpec.describe 'Capybara::Session with chrome' do
+  include Capybara::SpecHelper
+  ['Capybara::Session', 'Capybara::Node', Capybara::RSpecMatchers].each do |examples|
+    include_examples examples, TestSessions::Chrome, CHROME_DRIVER
+  end
+
+  context 'storage' do
+    describe '#reset!' do
+      it 'clears storage by default' do
+        session = TestSessions::Chrome
+        session.visit('/with_js')
+        session.find(:css, '#set-storage').click
+        session.reset!
+        session.visit('/with_js')
+        expect(session.evaluate_script('Object.keys(localStorage)')).to be_empty
+        expect(session.evaluate_script('Object.keys(sessionStorage)')).to be_empty
+      end
+
+      it 'does not clear storage when false' do
+        session = Capybara::Session.new(:selenium_chrome_not_clear_storage, TestApp)
+        session.visit('/with_js')
+        session.find(:css, '#set-storage').click
+        session.reset!
+        session.visit('/with_js')
+        expect(session.evaluate_script('Object.keys(localStorage)')).not_to be_empty
+        expect(session.evaluate_script('Object.keys(sessionStorage)')).not_to be_empty
+      end
+
+      it 'can not clear session storage' do
+        session = Capybara::Session.new(:selenium_chrome_not_clear_session_storage, TestApp)
+        session.visit('/with_js')
+        session.find(:css, '#set-storage').click
+        session.reset!
+        session.visit('/with_js')
+        expect(session.evaluate_script('Object.keys(localStorage)')).to be_empty
+        expect(session.evaluate_script('Object.keys(sessionStorage)')).not_to be_empty
+      end
+
+      it 'can not clear local storage' do
+        session = Capybara::Session.new(:selenium_chrome_not_clear_local_storage, TestApp)
+        session.visit('/with_js')
+        session.find(:css, '#set-storage').click
+        session.reset!
+        session.visit('/with_js')
+        expect(session.evaluate_script('Object.keys(localStorage)')).not_to be_empty
+        expect(session.evaluate_script('Object.keys(sessionStorage)')).to be_empty
+      end
+    end
+  end
+
+  context 'timeout' do
+    it 'sets the http client read timeout' do
+      expect(TestSessions::Chrome.driver.browser.send(:bridge).http.read_timeout).to eq 30
+    end
+  end
+
+  describe 'filling in Chrome-specific date and time fields with keystrokes' do
+    let(:datetime) { Time.new(1983, 6, 19, 6, 30) }
+    let(:session) { TestSessions::Chrome }
+
+    before do
+      session.visit('/form')
+    end
+
+    it 'should fill in a date input with a String' do
+      session.fill_in('form_date', with: '06/19/1983')
+      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: '06:30A')
+      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
+      session.fill_in('form_datetime', with: "06/19/1983\t06:30A")
+      session.click_button('awesome')
+      expect(Time.parse(extract_results(session)['datetime'])).to eq datetime
+    end
+  end
+
+  describe 'using subclass of selenium driver' do
+    it 'works' do
+      session = Capybara::Session.new(:selenium_driver_subclass_with_chrome, TestApp)
+      session.visit('/form')
+      expect(session).to have_current_path('/form')
+    end
+  end
+
+  describe 'log access' do
+    before { skip 'Only makes sense in W3C mode' if ENV['W3C'] == 'false' }
+
+    it 'does not error getting log types' do
+      skip if Gem::Version.new(session.driver.browser.capabilities['chrome']['chromedriverVersion'].split[0]) < Gem::Version.new('75.0.3770.90')
+      expect do
+        session.driver.browser.manage.logs.available_types
+      end.not_to raise_error
+    end
+
+    it 'does not error when getting logs' do
+      expect do
+        session.driver.browser.manage.logs.get(:browser)
+      end.not_to raise_error
+    end
+  end
+end

data/spec/selenium_spec_chrome_remote.rb

@@ -0,0 +1,96 @@
+# 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', 4444)
+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_chrome'
+    else
+      puts 'Waiting for Selenium docker instance...'
+      sleep 1
+      retry
+    end
+  end
+end
+
+def selenium_gte?(version)
+  defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= version)
+end
+
+Capybara.register_driver :selenium_chrome_remote do |app|
+  ensure_selenium_running!
+
+  url = "http://#{selenium_host}:#{selenium_port}/wd/hub"
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new
+
+  Capybara::Selenium::Driver.new app,
+                                 browser: :remote,
+                                 desired_capabilities: :chrome,
+                                 options: browser_options,
+                                 url: url
+end
+
+CHROME_REMOTE_DRIVER = :selenium_chrome_remote
+
+module TestSessions
+  Chrome = Capybara::Session.new(CHROME_REMOTE_DRIVER, TestApp)
+end
+
+skipped_tests = %i[response_headers status_code trigger download]
+
+Capybara::SpecHelper.run_specs TestSessions::Chrome, CHROME_REMOTE_DRIVER.to_s, capybara_skip: skipped_tests do |example|
+  case example.metadata[:full_description]
+  when 'Capybara::Session selenium_chrome_remote #attach_file with multipart form should not break when using HTML5 multiple file input uploading multiple files',
+       'Capybara::Session selenium_chrome_remote #attach_file with multipart form should fire change once for each set of files uploaded',
+       'Capybara::Session selenium_chrome_remote #attach_file with multipart form should fire change once when uploading multiple files from empty'
+    pending "Selenium with Remote Chrome doesn't support multiple file upload" unless selenium_gte?(3.14)
+  when /node #right_click delay should delay the mouse up/
+    skip "Legacy selenium doesn't support separate right button down/up" if ENV['W3C'] == 'false'
+  end
+end
+
+RSpec.describe 'Capybara::Session with remote Chrome' do
+  include Capybara::SpecHelper
+  ['Capybara::Session', 'Capybara::Node', Capybara::RSpecMatchers].each do |examples|
+    include_examples examples, TestSessions::Chrome, CHROME_REMOTE_DRIVER
+  end
+
+  it 'is considered to be chrome' do
+    expect(session.driver.browser.browser).to eq :chrome
+  end
+
+  describe 'log access' do
+    before { skip 'Only makes sense in W3C mode' if ENV['W3C'] == 'false' }
+
+    it 'does not error when getting log types' do
+      skip if Gem::Version.new(session.driver.browser.capabilities['chrome']['chromedriverVersion'].split[0]) < Gem::Version.new('75.0.3770.90')
+      expect do
+        session.driver.browser.manage.logs.available_types
+      end.not_to raise_error
+    end
+
+    it 'does not error when getting logs' do
+      expect do
+        session.driver.browser.manage.logs.get(:browser)
+      end.not_to raise_error
+    end
+  end
+end

data/spec/selenium_spec_edge.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'selenium-webdriver'
+require 'shared_selenium_session'
+require 'shared_selenium_node'
+require 'rspec/shared_spec_matchers'
+
+# unless ENV['CI']
+#   Selenium::WebDriver::Edge::Service.driver_path = '/usr/local/bin/msedgedriver'
+# end
+
+if ::Selenium::WebDriver::Platform.mac?
+  Selenium::WebDriver::EdgeChrome.path = '/Applications/Microsoft Edge Dev.app/Contents/MacOS/Microsoft Edge Dev'
+end
+
+Capybara.register_driver :selenium_edge do |app|
+  # ::Selenium::WebDriver.logger.level = "debug"
+  # If we don't create an options object the path set above won't be used
+  browser_options = ::Selenium::WebDriver::EdgeChrome::Options.new
+  Capybara::Selenium::Driver.new(app, browser: :edge_chrome, options: browser_options).tap do |driver|
+    driver.browser
+    driver.download_path = Capybara.save_path
+  end
+end
+
+module TestSessions
+  SeleniumEdge = Capybara::Session.new(:selenium_edge, TestApp)
+end
+
+skipped_tests = %i[response_headers status_code trigger]
+
+Capybara::SpecHelper.log_selenium_driver_version(Selenium::WebDriver::EdgeChrome) if ENV['CI']
+
+Capybara::SpecHelper.run_specs TestSessions::SeleniumEdge, 'selenium', capybara_skip: skipped_tests do |example|
+  case example.metadata[:full_description]
+  when 'Capybara::Session selenium #attach_file with a block can upload by clicking the file input'
+    pending "EdgeChrome doesn't allow clicking on file inputs"
+  end
+end
+
+RSpec.describe 'Capybara::Session with Edge', capybara_skip: skipped_tests do
+  include Capybara::SpecHelper
+  ['Capybara::Session', 'Capybara::Node', Capybara::RSpecMatchers].each do |examples|
+    include_examples examples, TestSessions::SeleniumEdge, :selenium_edge
+  end
+end

data/spec/selenium_spec_firefox.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'selenium-webdriver'
+require 'shared_selenium_session'
+require 'shared_selenium_node'
+require 'rspec/shared_spec_matchers'
+
+browser_options = ::Selenium::WebDriver::Firefox::Options.new
+browser_options.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'
+end
+
+Capybara.register_driver :selenium_firefox do |app|
+  # ::Selenium::WebDriver.logger.level = "debug"
+  Capybara::Selenium::Driver.new(
+    app,
+    browser: :firefox,
+    options: browser_options,
+    timeout: 31
+    # Get a trace level log from geckodriver
+    # :driver_opts => { args: ['-vv'] }
+  )
+end
+
+Capybara.register_driver :selenium_firefox_not_clear_storage do |app|
+  Capybara::Selenium::Driver.new(
+    app,
+    browser: :firefox,
+    clear_local_storage: false,
+    clear_session_storage: false,
+    options: browser_options
+  )
+end
+
+module TestSessions
+  SeleniumFirefox = Capybara::Session.new(:selenium_firefox, TestApp)
+end
+
+skipped_tests = %i[response_headers status_code trigger]
+
+Capybara::SpecHelper.log_selenium_driver_version(Selenium::WebDriver::Firefox) if ENV['CI']
+
+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'
+  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 constuctor" 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'
+  end
+end
+
+RSpec.describe 'Capybara::Session with firefox' do # rubocop:disable RSpec/MultipleDescribes
+  include Capybara::SpecHelper
+  ['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
+      # FF doesn't currently support datetime-local so this is really just a text input
+      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
+  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_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