Testing File Attachment Workflows in Capybara

teamcapybara/capybara

lib/capybara/spec/session/attach_file_spec.rb

            
# frozen_string_literal: true

Capybara::SpecHelper.spec '#attach_file' do
  let(:test_file_path) { File.expand_path('../fixtures/test_file.txt', File.dirname(__FILE__)) }
  let(:another_test_file_path) { File.expand_path('../fixtures/another_test_file.txt', File.dirname(__FILE__)) }
  let(:test_jpg_file_path) { File.expand_path('../fixtures/capybara.jpg', File.dirname(__FILE__)) }
  let(:no_extension_file_path) { File.expand_path('../fixtures/no_extension', File.dirname(__FILE__)) }

  before do
    @session.visit('/form')
  end

  context 'with normal form' do
    it 'should set a file path by id' do
      @session.attach_file 'form_image', with_os_path_separators(__FILE__)
      @session.click_button('awesome')
      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
    end

    it 'should set a file path by label' do
      @session.attach_file 'Image', with_os_path_separators(__FILE__)
      @session.click_button('awesome')
      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
    end

    it 'should be able to set on element if no locator passed' do
      ff = @session.find(:file_field, 'Image')
      ff.attach_file(with_os_path_separators(__FILE__))
      @session.click_button('awesome')
      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
    end

    it 'casts to string' do
      @session.attach_file :form_image, with_os_path_separators(__FILE__)
      @session.click_button('awesome')
      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
    end
  end

  context 'with multipart form' do
    it 'should set a file path by id' do
      @session.attach_file 'form_document', with_os_path_separators(test_file_path)
      @session.click_button('Upload Single')
      expect(@session).to have_content(File.read(test_file_path))
    end

    it 'should set a file path by label' do
      @session.attach_file 'Single Document', with_os_path_separators(test_file_path)
      @session.click_button('Upload Single')
      expect(@session).to have_content(File.read(test_file_path))
    end

    it 'should not break if no file is submitted' do
      @session.click_button('Upload Single')
      expect(@session).to have_content('No file uploaded')
    end

    it 'should send prior hidden field if no file submitted' do
      @session.click_button('Upload Empty With Hidden')
      expect(extract_results(@session)['document2']).to eq('hidden_field')
      expect(extract_content_type(@session)).to start_with('multipart/form-data;')
    end

    it 'should send content type text/plain when uploading a text file' do
      @session.attach_file 'Single Document', with_os_path_separators(test_file_path)
      @session.click_button 'Upload Single'
      expect(@session).to have_content('text/plain')
    end

    it 'should send content type image/jpeg when uploading an image' do
      @session.attach_file 'Single Document', with_os_path_separators(test_jpg_file_path)
      @session.click_button 'Upload Single'
      expect(@session).to have_content('image/jpeg')
    end

    it 'should not break when uploading a file without extension' do
      @session.attach_file 'Single Document', with_os_path_separators(no_extension_file_path)
      @session.click_button 'Upload Single'
      expect(@session).to have_content(File.read(no_extension_file_path))
    end

    it 'should not break when using HTML5 multiple file input' do
      @session.attach_file 'Multiple Documents', with_os_path_separators(test_file_path)
      @session.click_button('Upload Multiple')
      expect(@session).to have_content(File.read(test_file_path))
      expect(@session.body).to include('1 | ') # number of files
    end

    it 'should not break when using HTML5 multiple file input uploading multiple files' do
      @session.attach_file('Multiple Documents',
                           [test_file_path, another_test_file_path].map { |f| with_os_path_separators(f) })
      @session.click_button('Upload Multiple')
      expect(@session).to have_content('2 | ') # number of files
      expect(@session.body).to include(File.read(test_file_path))
      expect(@session.body).to include(File.read(another_test_file_path))
    end

    it 'should not send anything when attaching no files to a multiple upload field' do
      @session.click_button('Upload Empty Multiple')
      expect(@session).to have_content('Successfully ignored empty file field')
    end

    it 'should not append files to already attached' do
      @session.attach_file 'Multiple Documents', with_os_path_separators(test_file_path)
      @session.attach_file 'Multiple Documents', with_os_path_separators(another_test_file_path)
      @session.click_button('Upload Multiple')
      expect(@session).to have_content('1 | ') # number of files
      expect(@session.body).to include(File.read(another_test_file_path))
      expect(@session.body).not_to include(File.read(test_file_path))
    end

    it 'should fire change once when uploading multiple files from empty', requires: [:js] do
      @session.visit('with_js')
      @session.attach_file('multiple-file',
                           [test_file_path, another_test_file_path].map { |f| with_os_path_separators(f) })
      expect(@session).to have_css('.file_change', count: 1)
    end

    it 'should fire change once for each set of files uploaded', requires: [:js] do
      @session.visit('with_js')
      @session.attach_file('multiple-file', [test_jpg_file_path].map { |f| with_os_path_separators(f) })
      @session.attach_file('multiple-file',
                           [test_file_path, another_test_file_path].map { |f| with_os_path_separators(f) })
      expect(@session).to have_css('.file_change', count: 2)
    end
  end

  context "with a locator that doesn't exist" do
    it 'should raise an error' do
      msg = /Unable to find file field "does not exist"/
      expect do
        @session.attach_file('does not exist', with_os_path_separators(test_file_path))
      end.to raise_error(Capybara::ElementNotFound, msg)
    end
  end

  context "with a path that doesn't exist" do
    it 'should raise an error' do
      expect { @session.attach_file('Image', '/no_such_file.png') }.to raise_error(Capybara::FileNotFound)
    end
  end

  context 'with :exact option' do
    it 'should set a file path by partial label when false' do
      @session.attach_file 'Imag', with_os_path_separators(__FILE__), exact: false
      @session.click_button('awesome')
      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
    end

    it 'should not allow partial matches when true' do
      expect do
        @session.attach_file 'Imag', with_os_path_separators(__FILE__), exact: true
      end.to raise_error(Capybara::ElementNotFound)
    end
  end

  context 'with :make_visible option', requires: %i[js es_args] do
    it 'applies a default style change when true' do
      @session.visit('/with_js')
      expect do
        @session.attach_file('hidden_file', with_os_path_separators(__FILE__))
      end.to raise_error Capybara::ElementNotFound
      expect do
        @session.attach_file('hidden_file', with_os_path_separators(__FILE__), make_visible: true)
      end.not_to raise_error
    end

    it 'accepts a hash of styles to be applied' do
      @session.visit('/with_js')
      expect do
        @session.attach_file('hidden_file',
                             with_os_path_separators(__FILE__),
                             make_visible: { opacity: 1, display: 'block' })
      end.not_to raise_error
    end

    it 'raises an error when the file input is not made visible' do
      @session.visit('/with_js')
      expect do
        @session.attach_file('hidden_file', with_os_path_separators(__FILE__), make_visible: { color: 'red' })
      end.to raise_error(Capybara::ExpectationNotMet)
    end

    it 'resets the style when done' do
      @session.visit('/with_js')
      @session.attach_file('hidden_file', with_os_path_separators(__FILE__), make_visible: true)
      expect(@session.evaluate_script('arguments[0].style.display', @session.find(:css, '#hidden_file', visible: :all))).to eq 'none'
    end

    it 'should fire change' do
      @session.visit('/with_js')
      @session.attach_file('hidden_file', with_os_path_separators(__FILE__), make_visible: true)
      expect(@session).to have_css('.file_change')
    end
  end

  context 'with a block', requires: %i[js] do
    it 'can upload by clicking the file input' do
      @session.attach_file(with_os_path_separators(__FILE__)) do
        @session.find(:file_field, 'form[image]').click
      end
      @session.click_button('awesome')
      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
    end

    it 'can upload by clicking the label' do
      @session.attach_file(with_os_path_separators(__FILE__)) do
        @session.find(:label, 'Hidden Image').click
      end
      @session.click_button('awesome')
      expect(extract_results(@session)['hidden_image']).to end_with(File.basename(__FILE__))
    end

    it 'should fire change' do
      @session.visit('/with_js')
      @session.attach_file(with_os_path_separators(__FILE__)) do
        @session.find(:label, 'Label for hidden file input').click
      end
      expect(@session).to have_css('.file_change')
    end
  end
end