capybara 3.14.0 → 3.15.0

data/spec/selenium_spec_firefox_remote.rb

@@ -73,6 +73,8 @@ Capybara::SpecHelper.run_specs TestSessions::RemoteFirefox, FIREFOX_REMOTE_DRIVE
   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 #attach_file with a block can upload by clicking the file input'
+    pending "Geckodriver doesn't allow clicking on file inputs"
   end
 end
 

data/spec/selenium_spec_safari.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'selenium-webdriver'
+require 'shared_selenium_session'
+require 'rspec/shared_spec_matchers'
+
+SAFARI_DRIVER = :selenium_safari
+
+::Selenium::WebDriver::Safari.driver_path = '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver'
+
+browser_options = ::Selenium::WebDriver::Safari::Options.new
+# browser_options.headless! if ENV['HEADLESS']
+# browser_options.add_option(:w3c, !!ENV['W3C'])
+
+Capybara.register_driver :selenium_safari do |app|
+  Capybara::Selenium::Driver.new(app, browser: :safari, options: browser_options, timeout: 30).tap do |driver|
+    # driver.browser.download_path = Capybara.save_path
+  end
+end
+
+Capybara.register_driver :selenium_safari_not_clear_storage do |app|
+  safari_options = {
+    browser: :safari,
+    options: browser_options
+  }
+  Capybara::Selenium::Driver.new(app, safari_options.merge(clear_local_storage: false, clear_session_storage: false))
+end
+
+module TestSessions
+  Safari = Capybara::Session.new(SAFARI_DRIVER, TestApp)
+end
+
+skipped_tests = %i[response_headers status_code trigger windows drag]
+
+$stdout.puts `#{Selenium::WebDriver::Safari.driver_path} --version` if ENV['CI']
+
+Capybara::SpecHelper.run_specs TestSessions::Safari, SAFARI_DRIVER.to_s, capybara_skip: skipped_tests do |example|
+  case example.metadata[:full_description]
+  when /click_link can download a file/
+    skip "safaridriver doesn't provide a way to set the download directory"
+  when /Capybara::Session selenium_safari Capybara::Window#maximize/
+    pending "Safari headless doesn't support maximize" if ENV['HEADLESS']
+  when /Capybara::Session selenium_safari #visit without a server/,
+       /Capybara::Session selenium_safari #visit with Capybara.app_host set should override server/,
+       /Capybara::Session selenium_safari #reset_session! When reuse_server == false raises any standard errors caught inside the server during a second session/
+    skip "Safari webdriver doesn't support multiple sessions"
+  when /Capybara::Session selenium_safari #click_link with alternative text given to a contained image/,
+       'Capybara::Session selenium_safari #click_link_or_button with enable_aria_label should click on link'
+    pending 'safaridriver thinks these links are non-interactable for some unknown reason'
+  when /Capybara::Session selenium_safari #attach_file with a block can upload by clicking the file input/
+    skip "safaridriver doesn't allow clicking on file inputs"
+  when /Capybara::Session selenium_safari #attach_file with a block can upload by clicking the label/
+    skip 'hangs tests'
+  when /Capybara::Session selenium_safari #check when checkbox hidden with Capybara.automatic_label_click == false with allow_label_click == true should check via the label if input is visible but blocked by another element/,
+      'Capybara::Session selenium_safari node #click should not retry clicking when wait is disabled',
+      'Capybara::Session selenium_safari node #click should allow to retry longer',
+      'Capybara::Session selenium_safari node #click should retry clicking'
+    pending "safaridriver doesn't return a specific enough error to deal with this"
+  when /Capybara::Session selenium_safari #within_frame should find multiple nested frames/,
+       /Capybara::Session selenium_safari #within_frame works if the frame is closed/,
+       /Capybara::Session selenium_safari #switch_to_frame works if the frame is closed/
+    skip 'switch_to_frame(:parent) appears to go to the root in Safari rather than parent'
+  when /Capybara::Session selenium_safari #reset_session! removes ALL cookies/
+    skip 'Safari webdriver can only remove cookies for the current domain'
+  when /Capybara::Session selenium_safari #refresh it reposts/
+    skip "Safari opens an alert that can't be closed"
+  when 'Capybara::Session selenium_safari node #double_click should allow to adjust the offset',
+       'Capybara::Session selenium_safari node #double_click should double click an element'
+    pending "safardriver doesn't generate a double click event"
+  when 'Capybara::Session selenium_safari node #click should allow multiple modifiers',
+       /Capybara::Session selenium_safari node #(click|right_click|double_click) should allow modifiers/
+    pending "safaridriver doesn't take key state into account when clicking"
+  when 'Capybara::Session selenium_safari #fill_in on a pre-populated textfield with a reformatting onchange should trigger change when clearing field'
+    pending "safardriver clear doesn't generate change event"
+  when 'Capybara::Session selenium_safari #go_back should fetch a response from the driver from the previous page',
+       'Capybara::Session selenium_safari #go_forward should fetch a response from the driver from the previous page'
+    skip 'safaridriver loses the ability to find elements in the document after `go_back`'
+  when 'Capybara::Session selenium_safari node #send_keys should hold modifiers at top level'
+    skip 'Need to look into this'
+  end
+end
+
+RSpec.describe 'Capybara::Session with safari' do
+  include Capybara::SpecHelper
+  include_examples  'Capybara::Session', TestSessions::Safari, SAFARI_DRIVER
+  include_examples  Capybara::RSpecMatchers, TestSessions::Safari, SAFARI_DRIVER
+
+  context 'storage' do
+    describe '#reset!' do
+      it 'clears storage by default' do
+        session = TestSessions::Safari
+        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
+        skip "Safari webdriver doesn't support multiple sessions"
+        session = Capybara::Session.new(:selenium_safari_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
+    end
+  end
+
+  context 'timeout' do
+    it 'sets the http client read timeout' do
+      expect(TestSessions::Safari.driver.browser.send(:bridge).http.read_timeout).to eq 30
+    end
+  end
+
+  describe 'filling in Safari-specific date and time fields with keystrokes' do
+    let(:datetime) { Time.new(1983, 6, 19, 6, 30) }
+    let(:session) { TestSessions::Safari }
+
+    before do
+      skip 'Too many other things broken currently'
+      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
+end

data/spec/server_spec.rb

@@ -4,17 +4,17 @@ require 'spec_helper'
 
 RSpec.describe Capybara::Server do
   it 'should spool up a rack server' do
-    @app = proc { |_env| [200, {}, ['Hello Server!']] }
-    @server = Capybara::Server.new(@app).boot
+    app = proc { |_env| [200, {}, ['Hello Server!']] }
+    server = Capybara::Server.new(app).boot
 
-    @res = Net::HTTP.start(@server.host, @server.port) { |http| http.get('/') }
+    res = Net::HTTP.start(server.host, server.port) { |http| http.get('/') }
 
-    expect(@res.body).to include('Hello Server')
+    expect(res.body).to include('Hello Server')
   end
 
   it 'should do nothing when no server given' do
     expect do
-      @server = Capybara::Server.new(nil).boot
+      Capybara::Server.new(nil).boot
     end.not_to raise_error
   end
 
@@ -42,37 +42,36 @@ RSpec.describe Capybara::Server do
   it 'should use specified port' do
     Capybara.server_port = 22789
 
-    @app = proc { |_env| [200, {}, ['Hello Server!']] }
-    @server = Capybara::Server.new(@app).boot
+    app = proc { |_env| [200, {}, ['Hello Server!']] }
+    server = Capybara::Server.new(app).boot
 
-    @res = Net::HTTP.start(@server.host, 22789) { |http| http.get('/') }
-    expect(@res.body).to include('Hello Server')
+    res = Net::HTTP.start(server.host, 22789) { |http| http.get('/') }
+    expect(res.body).to include('Hello Server')
 
     Capybara.server_port = nil
   end
 
   it 'should use given port' do
-    @app = proc { |_env| [200, {}, ['Hello Server!']] }
-    @server = Capybara::Server.new(@app, port: 22790).boot
+    app = proc { |_env| [200, {}, ['Hello Server!']] }
+    server = Capybara::Server.new(app, port: 22790).boot
 
-    @res = Net::HTTP.start(@server.host, 22790) { |http| http.get('/') }
-    expect(@res.body).to include('Hello Server')
+    res = Net::HTTP.start(server.host, 22790) { |http| http.get('/') }
+    expect(res.body).to include('Hello Server')
 
     Capybara.server_port = nil
   end
 
   it 'should find an available port' do
-    @app1 = proc { |_env| [200, {}, ['Hello Server!']] }
-    @app2 = proc { |_env| [200, {}, ['Hello Second Server!']] }
-
-    @server1 = Capybara::Server.new(@app1).boot
-    @server2 = Capybara::Server.new(@app2).boot
-
-    @res1 = Net::HTTP.start(@server1.host, @server1.port) { |http| http.get('/') }
-    expect(@res1.body).to include('Hello Server')
+    responses = ['Hello Server!', 'Hello Second Server!']
+    apps = responses.map do |response|
+      proc { |_env| [200, {}, [response]] }
+    end
+    servers = apps.map { |app| Capybara::Server.new(app).boot }
 
-    @res2 = Net::HTTP.start(@server2.host, @server2.port) { |http| http.get('/') }
-    expect(@res2.body).to include('Hello Second Server')
+    servers.each_with_index do |server, idx|
+      result = Net::HTTP.start(server.host, server.port) { |http| http.get('/') }
+      expect(result.body).to include(responses[idx])
+    end
   end
 
   it 'should support SSL' do
@@ -98,28 +97,27 @@ RSpec.describe Capybara::Server do
   end
 
   context 'When Capybara.reuse_server is true' do
+    let!(:old_reuse_server) { Capybara.reuse_server }
+
     before do
-      @old_reuse_server = Capybara.reuse_server
       Capybara.reuse_server = true
     end
 
     after do
-      Capybara.reuse_server = @old_reuse_server
+      Capybara.reuse_server = old_reuse_server
     end
 
     it 'should use the existing server if it already running' do
-      @app = proc { |_env| [200, {}, ['Hello Server!']] }
-
-      @server1 = Capybara::Server.new(@app).boot
-      @server2 = Capybara::Server.new(@app).boot
+      app = proc { |_env| [200, {}, ['Hello Server!']] }
 
-      res = Net::HTTP.start(@server1.host, @server1.port) { |http| http.get('/') }
-      expect(res.body).to include('Hello Server')
+      servers = Array.new(2) { Capybara::Server.new(app).boot }
 
-      res = Net::HTTP.start(@server2.host, @server2.port) { |http| http.get('/') }
-      expect(res.body).to include('Hello Server')
+      servers.each do |server|
+        res = Net::HTTP.start(server.host, server.port) { |http| http.get('/') }
+        expect(res.body).to include('Hello Server')
+      end
 
-      expect(@server1.port).to eq(@server2.port)
+      expect(servers[0].port).to eq(servers[1].port)
     end
 
     it 'detects and waits for all reused server sessions pending requests' do
@@ -151,22 +149,20 @@ RSpec.describe Capybara::Server do
     end
 
     after do
-      Capybara.reuse_server = @old_reuse_server
+      Capybara.reuse_server = @old_reuse_server # rubocop:disable RSpec/InstanceVariable
     end
 
     it 'should not reuse an already running server' do
-      @app = proc { |_env| [200, {}, ['Hello Server!']] }
-
-      @server1 = Capybara::Server.new(@app).boot
-      @server2 = Capybara::Server.new(@app).boot
+      app = proc { |_env| [200, {}, ['Hello Server!']] }
 
-      res = Net::HTTP.start(@server1.host, @server1.port) { |http| http.get('/') }
-      expect(res.body).to include('Hello Server')
+      servers = Array.new(2) { Capybara::Server.new(app).boot }
 
-      res = Net::HTTP.start(@server2.host, @server2.port) { |http| http.get('/') }
-      expect(res.body).to include('Hello Server')
+      servers.each do |server|
+        res = Net::HTTP.start(server.host, server.port) { |http| http.get('/') }
+        expect(res.body).to include('Hello Server')
+      end
 
-      expect(@server1.port).not_to eq(@server2.port)
+      expect(servers[0].port).not_to eq(servers[1].port)
     end
 
     it 'detects and waits for only one sessions pending requests' do

data/spec/shared_selenium_session.rb

@@ -28,27 +28,28 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
     end
 
     describe 'exit codes' do
+      let(:env) { { 'SELENIUM_BROWSER' => session.driver.options[:browser].to_s } }
+      let!(:orig_dir) { Dir.getwd }
+
       before do
-        @current_dir = Dir.getwd
         Dir.chdir(File.join(File.dirname(__FILE__), '..'))
-        @env = { 'SELENIUM_BROWSER' => session.driver.options[:browser].to_s }
       end
 
       after do
-        Dir.chdir(@current_dir)
+        Dir.chdir(orig_dir)
       end
 
       it 'should have return code 1 when running selenium_driver_rspec_failure.rb' do
         skip 'only setup for local non-headless' if headless_or_remote?
 
-        system(@env, 'rspec spec/fixtures/selenium_driver_rspec_failure.rb', out: File::NULL, err: File::NULL)
+        system(env, 'rspec spec/fixtures/selenium_driver_rspec_failure.rb', out: File::NULL, err: File::NULL)
         expect($CHILD_STATUS.exitstatus).to eq(1)
       end
 
       it 'should have return code 0 when running selenium_driver_rspec_success.rb' do
         skip 'only setup for local non-headless' if headless_or_remote?
 
-        system(@env, 'rspec spec/fixtures/selenium_driver_rspec_success.rb', out: File::NULL, err: File::NULL)
+        system(env, 'rspec spec/fixtures/selenium_driver_rspec_success.rb', out: File::NULL, err: File::NULL)
         expect($CHILD_STATUS.exitstatus).to eq(0)
       end
     end
@@ -71,6 +72,7 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
 
     context '#fill_in_with empty string and no options' do
       it 'should trigger change when clearing a field' do
+        pending "safaridriver doesn't trigger change for clear" if safari?(session)
         session.visit('/with_js')
         session.fill_in('with_change_event', with: '')
         # click outside the field to trigger the change event
@@ -115,6 +117,7 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
 
       it 'should only trigger onchange once' do
         session.visit('/with_js')
+        sleep 2 if safari?(session) # Safari needs a delay (to load event handlers maybe ???)
         session.fill_in('with_change_event',
                         with: 'some value',
                         fill_options: { clear: :backspace })
@@ -139,13 +142,16 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
                         with: '',
                         fill_options: { clear: :backspace })
         # click outside the field to trigger the change event
-        session.find(:css, 'body').click
+        # session.find(:css, 'body').click
+        session.find(:css, 'h1', text: 'FooBar').click
         expect(session).to have_xpath('//p[@class="input_event_triggered"]', count: 13)
       end
     end
 
     context '#fill_in with { clear: :none } fill_options' do
       it 'should append to content in a field' do
+        pending 'Safari overwrites by default - need to figure out a workaround' if safari?(session)
+
         session.visit('/form')
         session.fill_in('form_first_name',
                         with: 'Harry',
@@ -165,17 +171,20 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
           });
         JS
         # work around weird FF issue where it would create an extra focus issue in some cases
-        session.find(:css, 'body').click
+        session.find(:css, 'h1', text: 'Form').click
+        # session.find(:css, 'body').click
       end
 
       it 'should generate standard events on changing value' do
         pending "IE 11 doesn't support date input type" if ie?(session)
+        pending "Safari doesn't support date input type" if safari?(session)
         session.fill_in('form_date', with: Date.today)
         expect(session.evaluate_script('window.capybara_formDateFiredEvents')).to eq %w[focus input change]
       end
 
       it 'should not generate input and change events if the value is not changed' do
         pending "IE 11 doesn't support date input type" if ie?(session)
+        pending "Safari doesn't support date input type" if safari?(session)
         session.fill_in('form_date', with: Date.today)
         session.fill_in('form_date', with: Date.today)
         # Chrome adds an extra focus for some reason - ok for now
@@ -263,6 +272,7 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
 
       describe '#evaluate_async_script' do
         it 'will timeout if the script takes too long' do
+          skip 'safaridriver returns the wrong error type' if safari?(session)
           session.visit('/with_js')
           expect do
             session.using_wait_time(1) do
@@ -297,6 +307,7 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
       before do
         skip "Firefox < 62 doesn't support a DataTransfer constuctor" if firefox_lt?(62.0, session)
         skip "IE doesn't support a DataTransfer constuctor" if ie?(session)
+        skip "Safari doesn't support" if safari?(session)
       end
 
       it 'should HTML5 drag and drop an object' do
@@ -349,10 +360,12 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
         pending "Selenium remote doesn't support transferring a directory" if remote?(session)
         pending "Headless Chrome doesn't support directory upload - https://bugs.chromium.org/p/chromedriver/issues/detail?id=2521&q=directory%20upload&colspec=ID%20Status%20Pri%20Owner%20Summary" if chrome?(session) && ENV['HEADLESS']
         pending "IE doesn't support uploading a directory" if ie?(session)
+        pending 'Chrome/chromedriver 73 breaks this' unless chrome_lt?(73, session)
+        pending "Safari doesn't support uploading a directory" if safari?(session)
 
         session.visit('/form')
-        @test_file_dir = File.expand_path('./fixtures', File.dirname(__FILE__))
-        session.attach_file('Directory Upload', @test_file_dir)
+        test_file_dir = File.expand_path('./fixtures', File.dirname(__FILE__))
+        session.attach_file('Directory Upload', test_file_dir)
         session.click_button('Upload Multiple')
         expect(session.body).to include('5 | ') # number of files
       end
@@ -366,19 +379,17 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
       end
     end
 
+    # rubocop:disable RSpec/InstanceVariable
     describe 'Capybara#disable_animation' do
       context 'when set to `true`' do
         before(:context) do # rubocop:disable RSpec/BeforeAfterAll
+          skip "Safari doesn't support multiple sessions" if safari?(session)
           # NOTE: Although Capybara.SpecHelper.reset! sets Capybara.disable_animation to false,
           # it doesn't affect any of these tests because the settings are applied per-session
           Capybara.disable_animation = true
           @animation_session = Capybara::Session.new(session.mode, TestApp.new)
         end
 
-        after(:context) do # rubocop:disable RSpec/BeforeAfterAll
-          @animation_session = nil
-        end
-
         it 'should disable CSS transitions' do
           @animation_session.visit('with_animation')
           @animation_session.click_link('transition me away')
@@ -394,16 +405,13 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
 
       context 'if we pass in css that matches elements' do
         before(:context) do # rubocop:disable RSpec/BeforeAfterAll
+          skip "safaridriver doesn't support multiple sessions" if safari?(session)
           # NOTE: Although Capybara.SpecHelper.reset! sets Capybara.disable_animation to false,
           # it doesn't affect any of these tests because the settings are applied per-session
           Capybara.disable_animation = '#with_animation a'
           @animation_session_with_matching_css = Capybara::Session.new(session.mode, TestApp.new)
         end
 
-        after(:context) do # rubocop:disable RSpec/BeforeAfterAll
-          @animation_session_with_matching_css = nil
-        end
-
         it 'should disable CSS transitions' do
           @animation_session_with_matching_css.visit('with_animation')
           @animation_session_with_matching_css.click_link('transition me away')
@@ -419,16 +427,13 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
 
       context 'if we pass in css that does not match elements' do
         before(:context) do # rubocop:disable RSpec/BeforeAfterAll
+          skip "Safari doesn't support multiple sessions" if safari?(session)
           # NOTE: Although Capybara.SpecHelper.reset! sets Capybara.disable_animation to false,
           # it doesn't affect any of these tests because the settings are applied per-session
           Capybara.disable_animation = '.this-class-matches-nothing'
           @animation_session_without_matching_css = Capybara::Session.new(session.mode, TestApp.new)
         end
 
-        after(:context) do # rubocop:disable RSpec/BeforeAfterAll
-          @animation_session_without_matching_css = nil
-        end
-
         it 'should not disable CSS transitions' do
           @animation_session_without_matching_css.visit('with_animation')
           @animation_session_without_matching_css.click_link('transition me away')
@@ -446,6 +451,7 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
         end
       end
     end
+    # rubocop:enable RSpec/InstanceVariable
 
     describe ':element selector' do
       it 'can find html5 svg elements' do