capybara 2.18.0 → 3.40.0

data/spec/selenium_spec_safari.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'selenium-webdriver'
+require 'shared_selenium_session'
+require 'shared_selenium_node'
+require 'rspec/shared_spec_matchers'
+
+SAFARI_DRIVER = :selenium_safari
+
+# if ::Selenium::WebDriver::Service.respond_to? :driver_path=
+#   ::Selenium::WebDriver::Safari::Service
+# else
+#   ::Selenium::WebDriver::Safari
+# end.driver_path = '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver'
+
+browser_options = Selenium::WebDriver::Safari::Options.new
+# browser_options.headless! if ENV['HEADLESS']
+
+Capybara.register_driver :selenium_safari do |app|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  driver_options = { browser: :safari, timeout: 30 }.tap do |opts|
+    opts[options_key] = browser_options
+  end
+
+  Capybara::Selenium::Driver.new(app, **driver_options).tap do |driver|
+    # driver.browser.download_path = Capybara.save_path
+  end
+end
+
+Capybara.register_driver :selenium_safari_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: :safari,
+    clear_local_storage: false,
+    clear_session_storage: false,
+    timeout: 30
+  }.tap do |opts|
+    opts[options_key] = browser_options
+  end
+
+  Capybara::Selenium::Driver.new(app, **driver_options)
+end
+
+module TestSessions
+  Safari = Capybara::Session.new(SAFARI_DRIVER, TestApp)
+end
+
+skipped_tests = %i[response_headers status_code trigger windows drag]
+
+Capybara::SpecHelper.log_selenium_driver_version(Selenium::WebDriver::Safari) 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 #within_frame works if the frame is closed/,
+       /Capybara::Session selenium_safari #switch_to_frame works if the frame is closed/
+    skip 'Safari has a race condition when clicking an element that causes the frame to close. It will sometimes raise a NoSuchFrameError'
+  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 #double_click should allow modifiers'
+    pending "safaridriver doesn't generate double click with key modifiers"
+  when /when w3c_click_offset is true should offset/
+    pending 'w3c_click_offset is not currently supported with safaridriver'
+  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 node #shadow_root should get the shadow root',
+    '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'
+    pending "Safari doesn't yet have W3C shadow root support"
+  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 safari' do
+  include Capybara::SpecHelper
+  ['Capybara::Session', 'Capybara::Node', Capybara::RSpecMatchers].each do |examples|
+    include_examples examples, TestSessions::Safari, SAFARI_DRIVER
+  end
+
+  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
+      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
+      # Safari doesn't support time inputs - so this is just a text input
+      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
+      pending "Safari doesn't support datetime inputs"
+      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

@@ -1,203 +1,314 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Capybara::Server do
+  it 'should spool up a rack server' do
+    app = proc { |_env| [200, {}, ['Hello Server!']] }
+    server = described_class.new(app).boot
 
-  it "should spool up a rack server" do
-    @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
+  it 'should do nothing when no server given' do
     expect do
-      @server = Capybara::Server.new(nil).boot
+      described_class.new(nil).boot
     end.not_to raise_error
   end
 
-  it "should bind to the specified host" do
+  it 'should bind to the specified host' do
+    # TODO: travis with jruby in container mode has an issue with this test
+    skip 'This platform has an issue with this test' if (ENV.fetch('TRAVIS', nil) && (RUBY_ENGINE == 'jruby')) || Gem.win_platform?
+
     begin
-      app = proc { |env| [200, {}, ['Hello Server!']] }
+      app = proc { |_env| [200, {}, ['Hello Server!']] }
 
       Capybara.server_host = '127.0.0.1'
-      server = Capybara::Server.new(app).boot
+      server = described_class.new(app).boot
       res = Net::HTTP.get(URI("http://127.0.0.1:#{server.port}"))
       expect(res).to eq('Hello Server!')
 
       Capybara.server_host = '0.0.0.0'
-      server = Capybara::Server.new(app).boot
+      server = described_class.new(app).boot
       res = Net::HTTP.get(URI("http://127.0.0.1:#{server.port}"))
       expect(res).to eq('Hello Server!')
     ensure
       Capybara.server_host = nil
     end
-  end unless ENV['TRAVIS'] and (RUBY_ENGINE == 'jruby') #TODO travis with jruby in container mode has an issue with this test
+  end
 
-  it "should use specified port" 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 = described_class.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, 22790).boot
+  it 'should use given port' do
+    app = proc { |_env| [200, {}, ['Hello Server!']] }
+    server = described_class.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!"]]}
+  it 'should find an available port' do
+    responses = ['Hello Server!', 'Hello Second Server!']
+    apps = responses.map do |response|
+      proc { |_env| [200, {}, [response]] }
+    end
+    servers = apps.map { |app| described_class.new(app).boot }
 
-    @server1 = Capybara::Server.new(@app1).boot
-    @server2 = Capybara::Server.new(@app2).boot
+    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
 
-    @res1 = Net::HTTP.start(@server1.host, @server1.port) { |http| http.get('/') }
-    expect(@res1.body).to include('Hello Server')
+  it 'should handle that getting available ports fails randomly' do
+    # Use a port to force a EADDRINUSE error to be generated
+    server = TCPServer.new('0.0.0.0', 0)
+    server_port = server.addr[1]
+    d_server = instance_double(TCPServer, addr: [nil, server_port, nil, nil], close: nil)
+    call_count = 0
+    allow(TCPServer).to receive(:new).and_wrap_original do |m, *args|
+      call_count.zero? ? d_server : m.call(*args)
+    ensure
+      call_count += 1
+    end
+
+    port = described_class.new(Object.new, host: '0.0.0.0').port
+    expect(port).not_to eq(server_port)
+  ensure
+    server&.close
+  end
 
-    @res2 = Net::HTTP.start(@server2.host, @server2.port) { |http| http.get('/') }
-    expect(@res2.body).to include('Hello Second Server')
+  it 'should return its #base_url' do
+    app = proc { |_env| [200, {}, ['Hello Server!']] }
+    server = described_class.new(app).boot
+    uri = Addressable::URI.parse(server.base_url)
+    expect(uri.to_hash).to include(scheme: 'http', host: server.host, port: server.port)
   end
 
-  context "When Capybara.reuse_server is true" do
+  it 'should call #clamp on the puma configuration to ensure that environment is a string' do
+    Capybara.server = :puma
+    app_proc = proc { |_env| [200, {}, ['Hello Puma!']] }
+    require 'puma'
+    allow(Puma::Server).to receive(:new).and_wrap_original do |method, app, events, options|
+      # If #clamp is not called on the puma config then this will be a Proc
+      expect(options.fetch(:environment)).to be_a(String)
+      method.call(app, events, options)
+    end
+    server = described_class.new(app_proc).boot
+    expect(Puma::Server).to have_received(:new).with(
+      anything,
+      anything,
+      satisfy { |opts| opts.final_options[:Port] == server.port }
+    )
+  ensure
+    Capybara.server = :default
+  end
+
+  it 'should not emit any warnings when booting puma' do
+    Capybara.server = :puma
+    app_proc = proc { |_env| [200, {}, ['Hello Puma!']] }
+    require 'puma'
+
+    expect do
+      described_class.new(app_proc).boot
+    end.not_to output.to_stderr
+  ensure
+    Capybara.server = :default
+  end
+
+  it 'should support SSL' do
+    key = File.join(Dir.pwd, 'spec', 'fixtures', 'key.pem')
+    cert = File.join(Dir.pwd, 'spec', 'fixtures', 'certificate.pem')
+    Capybara.server = :puma, { Host: "ssl://#{Capybara.server_host}?key=#{key}&cert=#{cert}" }
+    app = proc { |_env| [200, {}, ['Hello SSL Server!']] }
+    server = described_class.new(app).boot
+
+    expect do
+      Net::HTTP.start(server.host, server.port, max_retries: 0) { |http| http.get('/__identify__') }
+    end.to(raise_error do |e|
+      expect(e.is_a?(EOFError) || e.is_a?(Net::ReadTimeout)).to be true
+    end)
+
+    res = Net::HTTP.start(server.host, server.port, use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE) do |https|
+      https.get('/')
+    end
+
+    expect(res.body).to include('Hello SSL Server!')
+    uri = Addressable::URI.parse(server.base_url)
+    expect(uri.to_hash).to include(scheme: 'https', host: server.host, port: server.port)
+  ensure
+    Capybara.server = :default
+  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
+    it 'should use the existing server if it already running' do
+      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) { described_class.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
-      done = false
+    it 'detects and waits for all reused server sessions pending requests' do
+      done = 0
 
       app = proc do |env|
         request = Rack::Request.new(env)
         sleep request.params['wait_time'].to_f
-        done = true
-        [200, {}, ["Hello Server!"]]
+        done += 1
+        [200, {}, ['Hello Server!']]
       end
 
-      server1 = Capybara::Server.new(app).boot
-      server2 = Capybara::Server.new(app).boot
+      server1 = described_class.new(app).boot
+      server2 = described_class.new(app).boot
 
-      start_request(server1, 0.5)
-      start_request(server2, 1.0)
-
-      expect {
+      expect do
+        start_request(server1, 1.0)
+        start_request(server2, 3.0)
         server1.wait_for_pending_requests
-      }.to change{done}.from(false).to(true)
-      expect(server2.send(:pending_requests?)).to eq(false)
+      end.to change { done }.from(0).to(2)
+      expect(server2.send(:pending_requests?)).to be(false)
     end
-
   end
 
-  context "When Capybara.reuse_server is false" do
+  context 'When Capybara.reuse_server is false' do
     before do
       @old_reuse_server = Capybara.reuse_server
       Capybara.reuse_server = false
     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
+    it 'should not reuse an already running server' do
+      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) { described_class.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
-      done = false
+    it 'detects and waits for only one sessions pending requests' do
+      done = 0
 
       app = proc do |env|
         request = Rack::Request.new(env)
         sleep request.params['wait_time'].to_f
-        done = true
-        [200, {}, ["Hello Server!"]]
+        done += 1
+        [200, {}, ['Hello Server!']]
       end
 
-      server1 = Capybara::Server.new(app).boot
-      server2 = Capybara::Server.new(app).boot
-
-      start_request(server1, 0.5)
-      start_request(server2, 1.0)
+      server1 = described_class.new(app).boot
+      server2 = described_class.new(app).boot
 
-      expect {
+      expect do
+        start_request(server1, 1.0)
+        start_request(server2, 3.0)
         server1.wait_for_pending_requests
-      }.to change{done}.from(false).to(true)
-      expect(server2.send(:pending_requests?)).to eq(true)
+      end.to change { done }.from(0).to(1)
+      expect(server2.send(:pending_requests?)).to be(true)
+      expect do
+        server2.wait_for_pending_requests
+      end.to change { done }.from(1).to(2)
     end
-
   end
 
-  it "should raise server errors when the server errors before the timeout" do
-    begin
-      Capybara.server do
-        sleep 0.1
-        raise 'kaboom'
-      end
+  it 'should raise server errors when the server errors before the timeout' do
+    Capybara.register_server :kaboom do
+      sleep 0.1
+      raise 'kaboom'
+    end
+    Capybara.server = :kaboom
 
-      expect do
-        Capybara::Server.new(proc {|e|}).boot
-      end.to raise_error(RuntimeError, 'kaboom')
-    ensure
-      # TODO refactor out the defaults so it's reliant on unset state instead of
-      # a one-time call in capybara.rb
-      Capybara.server {|app, port| Capybara.run_default_server(app, port)}
+    expect do
+      described_class.new(proc { |e| }).boot
+    end.to raise_error(RuntimeError, 'kaboom')
+  ensure
+    Capybara.server = :default
+  end
+
+  it 'should raise an error when there are pending requests' do
+    app = proc do |env|
+      request = Rack::Request.new(env)
+      sleep request.params['wait_time'].to_f
+      [200, {}, ['Hello Server!']]
     end
+
+    server = described_class.new(app).boot
+
+    expect do
+      start_request(server, 59.0)
+      server.wait_for_pending_requests
+    end.not_to raise_error
+
+    expect do
+      start_request(server, 61.0)
+      server.wait_for_pending_requests
+    end.to raise_error('Requests did not finish in 60 seconds: ["/?wait_time=61.0"]')
   end
 
-  it "is not #responsive? when Net::HTTP raises a SystemCallError" do
-    app = lambda { [200, {}, ['Hello, world']] }
-    server = Capybara::Server.new(app)
-    expect(Net::HTTP).to receive(:start).and_raise(SystemCallError.allocate)
-    expect(server.responsive?).to eq false
+  it 'is not #responsive? when Net::HTTP raises a SystemCallError' do
+    app = -> { [200, {}, ['Hello, world']] }
+    server = described_class.new(app)
+    allow(Net::HTTP).to receive(:start).and_raise(SystemCallError.allocate)
+    expect(server.responsive?).to be false
+  end
+
+  [EOFError, Net::ReadTimeout].each do |err|
+    it "should attempt an HTTPS connection if HTTP connection returns #{err}" do
+      app = -> { [200, {}, ['Hello, world']] }
+      ordered_errors = [Errno::ECONNREFUSED, err]
+      allow(Net::HTTP).to receive(:start).with(anything, anything, hash_excluding(:use_ssl)) do
+        raise ordered_errors.shift
+      end
+      response = Net::HTTPSuccess.allocate
+      allow(response).to receive(:body).and_return app.object_id.to_s
+      allow(Net::HTTP).to receive(:start).with(anything, anything, hash_including(use_ssl: true)).and_return(response).once
+      described_class.new(app).boot
+      expect(Net::HTTP).to have_received(:start).exactly(3).times
+    end
   end
 
   def start_request(server, wait_time)
     # Start request, but don't wait for it to finish
     socket = TCPSocket.new(server.host, server.port)
-    socket.write "GET /?wait_time=#{wait_time.to_s} HTTP/1.0\r\n\r\n"
+    socket.write "GET /?wait_time=#{wait_time} HTTP/1.0\r\n\r\n"
+    sleep 0.1
     socket.close
     sleep 0.1
   end