capybara 2.18.0 → 3.40.0

data/spec/selenium_spec_chrome.rb

@@ -1,62 +1,209 @@
 # 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.fetch('CI', nil) && ENV.fetch('CHROME_BETA', nil)
+
+Selenium::WebDriver.logger.ignore(:selenium_manager)
+
+browser_options = if ENV['HEADLESS']
+  Selenium::WebDriver::Options.chrome(args: ['--headless=new'])
+else
+  Selenium::WebDriver::Options.chrome
+end
+
+# 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|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  driver_options = { browser: :chrome, timeout: 30 }.tap do |opts|
+    opts[options_key] = browser_options
+  end
+
+  Capybara::Selenium::Driver.new(app, **driver_options).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|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  chrome_options = { browser: :chrome, clear_local_storage: false, clear_session_storage: false }.tap do |opts|
+    opts[options_key] = browser_options
+  end
 
-CHROME_DRIVER = if ENV['HEADLESS'] then :selenium_chrome_headless else :selenium_chrome end
+  Capybara::Selenium::Driver.new(app, **chrome_options)
+end
+
+Capybara.register_driver :selenium_chrome_not_clear_session_storage do |app|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  chrome_options = { browser: :chrome, clear_session_storage: false }.tap do |opts|
+    opts[options_key] = browser_options
+  end
+
+  Capybara::Selenium::Driver.new(app, **chrome_options)
+end
+
+Capybara.register_driver :selenium_chrome_not_clear_local_storage do |app|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  chrome_options = { browser: :chrome, clear_local_storage: false }.tap do |opts|
+    opts[options_key] = browser_options
+  end
+  Capybara::Selenium::Driver.new(app, **chrome_options)
+end
 
-# if ENV['HEADLESS'] && ENV['TRAVIS']
-#   Selenium::WebDriver::Chrome.path='/usr/bin/google-chrome-beta'
-# end
+Capybara.register_driver :selenium_driver_subclass_with_chrome do |app|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  subclass = Class.new(Capybara::Selenium::Driver)
+  chrome_options = { browser: :chrome, timeout: 30 }.tap do |opts|
+    opts[options_key] = browser_options
+  end
 
-Capybara.register_driver :selenium_chrome_clear_storage do |app|
-  chrome_options = {
-    browser: :chrome,
-    options: ::Selenium::WebDriver::Chrome::Options.new()
-  }
-  chrome_options[:options].args << 'headless' if ENV['HEADLESS']
-  Capybara::Selenium::Driver.new(app, chrome_options.merge(clear_local_storage: true, clear_session_storage: true))
+  subclass.new(app, **chrome_options)
 end
 
 module TestSessions
   Chrome = Capybara::Session.new(CHROME_DRIVER, TestApp)
 end
 
-skipped_tests = [:response_headers, :status_code, :trigger]
-# skip window tests when headless for now - closing a window not supported by chromedriver/chrome
-skipped_tests << :windows if ENV['TRAVIS']  && (ENV['SKIP_WINDOW'] || ENV['HEADLESS'])
+skipped_tests = %i[response_headers status_code trigger]
 
-Capybara::SpecHelper.run_specs TestSessions::Chrome, CHROME_DRIVER.to_s, capybara_skip: skipped_tests
+Capybara::SpecHelper.log_selenium_driver_version(Selenium::WebDriver::Chrome) if ENV['CI']
 
-RSpec.describe "Capybara::Session with chrome" do
+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 node #shadow_root should get visible text/
+    pending "Selenium doesn't currently support getting visible text for shadow root elements"
+  when /Capybara::Session selenium_chrome node #shadow_root/
+    skip 'Not supported with this chromedriver version' if chromedriver_lt?('96.0', @session)
+  end
+end
+
+RSpec.describe 'Capybara::Session with chrome' do
   include Capybara::SpecHelper
-  include_examples  "Capybara::Session", TestSessions::Chrome, CHROME_DRIVER
-
-  context "storage" do
-    describe "#reset!" do
-      it "does not clear either 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.driver.browser.local_storage.keys).not_to be_empty
-        # expect(@session.driver.browser.session_storage.keys).not_to be_empty
-        expect(@session.evaluate_script('Object.keys(localStorage)')).not_to be_empty
-        expect(@session.evaluate_script('Object.keys(sessionStorage)')).not_to be_empty
+  ['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 "clears storage when set" do
-        @session = Capybara::Session.new(:selenium_chrome_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).to be_empty
-        # expect(@session.driver.browser.session_storage.keys).to be_empty
-        expect(@session.evaluate_script('Object.keys(localStorage)')).to be_empty
-        expect(@session.evaluate_script('Object.keys(sessionStorage)')).to be_empty
+      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
+    let(:logs) do
+      session.driver.browser.then do |chrome_driver|
+        chrome_driver.respond_to?(:logs) ? chrome_driver : chrome_driver.manage
+      end.logs
+    end
+
+    it 'does not error getting log types' do
+      expect do
+        logs.available_types
+      end.not_to raise_error
+    end
+
+    it 'does not error when getting logs' do
+      expect do
+        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) && (Gem::Version.new(Selenium::WebDriver::VERSION) >= Gem::Version.new(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,
+                                 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 node #shadow_root should get visible text/
+    pending "Selenium doesn't currently support getting visible text for shadow root elements"
+  when /Capybara::Session selenium_chrome_remote node #shadow_root/
+    skip 'Not supported with this chromedriver version' if chromedriver_lt?('96.0', @session)
+  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
+    let(:logs) do
+      session.driver.browser.then do |chrome_driver|
+        chrome_driver.respond_to?(:logs) ? chrome_driver : chrome_driver.manage
+      end.logs
+    end
+
+    it 'does not error when getting log types' do
+      expect do
+        logs.available_types
+      end.not_to raise_error
+    end
+
+    it 'does not error when getting logs' do
+      expect do
+        logs.get(:browser)
+      end.not_to raise_error
+    end
+  end
+end

data/spec/selenium_spec_edge.rb

@@ -0,0 +1,60 @@
+# 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
+
+Selenium::WebDriver.logger.ignore(:selenium_manager)
+
+if Selenium::WebDriver::Platform.mac?
+  Selenium::WebDriver::Edge.path = '/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge'
+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::Edge::Options.new
+  # browser_options.add_argument('--headless') if ENV['HEADLESS']
+
+  browser_options = if ENV['HEADLESS']
+    Selenium::WebDriver::Options.edge(args: ['--headless=new'])
+  else
+    Selenium::WebDriver::Options.edge
+  end
+
+  Capybara::Selenium::Driver.new(app, browser: :edge, 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::Edge) 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 "Edge doesn't allow clicking on file inputs"
+  when /Capybara::Session selenium 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 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