Testing Session Reset Management in Capybara Framework

teamcapybara/capybara

lib/capybara/spec/session/reset_session_spec.rb

            
# frozen_string_literal: true

Capybara::SpecHelper.spec '#reset_session!' do
  it 'removes cookies from current domain' do
    @session.visit('/set_cookie')
    @session.visit('/get_cookie')
    expect(@session).to have_content('test_cookie')

    @session.reset_session!
    @session.visit('/get_cookie')
    expect(@session.body).not_to include('test_cookie')
  end

  it 'removes ALL cookies', requires: [:server] do
    domains = ['localhost', '127.0.0.1']
    domains.each do |domain|
      @session.visit("http://#{domain}:#{@session.server.port}/set_cookie")
      @session.visit("http://#{domain}:#{@session.server.port}/get_cookie")
      expect(@session).to have_content('test_cookie')
    end
    @session.reset_session!
    domains.each do |domain|
      @session.visit("http://#{domain}:#{@session.server.port}/get_cookie")
      expect(@session.body).not_to include('test_cookie')
    end
  end

  it 'resets current url, host, path' do
    @session.visit '/foo'
    expect(@session.current_url).not_to be_empty
    expect(@session.current_host).not_to be_empty
    expect(@session.current_path).to eq('/foo')

    @session.reset_session!
    expect(@session.current_url).to satisfy('be a blank url') { |url| [nil, '', 'about:blank'].include? url }
    expect(@session.current_path).to satisfy('be a blank path') { |path| ['', nil].include? path }
    expect(@session.current_host).to be_nil
  end

  it 'resets page body' do
    @session.visit('/with_html')
    expect(@session).to have_content('This is a test')
    expect(@session.find('.//h1').text).to include('This is a test')

    @session.reset_session!
    expect(@session.body).not_to include('This is a test')
    expect(@session).to have_no_selector('.//h1')
  end

  it 'is synchronous' do
    @session.visit('/with_slow_unload')
    expect(@session).to have_selector(:css, 'div')
    @session.reset_session!
    expect(@session).to have_no_selector :xpath, '/html/body/*', wait: false
  end

  it 'handles modals during unload', requires: [:modals] do
    @session.visit('/with_unload_alert')
    expect(@session).to have_selector(:css, 'div')
    expect { @session.reset_session! }.not_to raise_error
    expect(@session).to have_no_selector :xpath, '/html/body/*', wait: false
  end

  it 'handles already open modals', requires: [:modals] do
    @session.visit('/with_unload_alert')
    @session.click_link('Go away')
    expect { @session.reset_session! }.not_to raise_error
    expect(@session).to have_no_selector :xpath, '/html/body/*', wait: false
  end

  it 'raises any standard errors caught inside the server', requires: [:server] do
    quietly { @session.visit('/error') }
    expect do
      @session.reset_session!
    end.to raise_error(TestApp::TestAppError)
    @session.visit('/')
    expect(@session.current_path).to eq('/')
  end

  it 'closes extra windows', requires: [:windows] do
    @session.visit('/with_html')
    @session.open_new_window
    @session.open_new_window
    expect(@session.windows.size).to eq 3
    @session.reset_session!
    expect(@session.windows.size).to eq 1
  end

  it 'closes extra windows when not on the first window', requires: [:windows] do
    @session.visit('/with_html')
    @session.switch_to_window(@session.open_new_window)
    @session.open_new_window
    expect(@session.windows.size).to eq 3
    @session.reset_session!
    expect(@session.windows.size).to eq 1
  end

  it 'does not block opening a new window after a frame was switched to and not switched back', requires: [:windows] do
    @session.visit('/with_iframe?id=test_iframe&url=/')
    @session.switch_to_frame(@session.find(:frame, 'test_iframe'))
    within_window_test = lambda do
      @session.within_window(@session.open_new_window) do
        @session.visit('/')
      end
    end
    expect(&within_window_test).to raise_error(Capybara::ScopeError)
    @session.reset_session!
    expect(&within_window_test).not_to raise_error
  end

  context 'When reuse_server == false' do
    let!(:orig_reuse_server) { Capybara.reuse_server }

    before do
      Capybara.reuse_server = false
    end

    after do
      Capybara.reuse_server = orig_reuse_server
    end

    it 'raises any standard errors caught inside the server during a second session', requires: [:server] do
      Capybara.using_driver(@session.mode) do
        Capybara.using_session(:another_session) do
          another_session = Capybara.current_session
          quietly { another_session.visit('/error') }
          expect do
            another_session.reset_session!
          end.to raise_error(TestApp::TestAppError)
          another_session.visit('/')
          expect(another_session.current_path).to eq('/')
        end
      end
    end
  end

  it 'raises configured errors caught inside the server', requires: [:server] do
    prev_errors = Capybara.server_errors.dup

    Capybara.server_errors = [LoadError]
    quietly { @session.visit('/error') }
    expect do
      @session.reset_session!
    end.not_to raise_error

    quietly { @session.visit('/load_error') }
    expect do
      @session.reset_session!
    end.to raise_error(LoadError)

    Capybara.server_errors = prev_errors
  end

  it 'ignores server errors when `Capybara.raise_server_errors = false`', requires: [:server] do
    Capybara.raise_server_errors = false
    quietly { @session.visit('/error') }
    @session.reset_session!
    @session.visit('/')
    expect(@session.current_path).to eq('/')
  end
end