Back to Repositories

Testing Remote Form Widget Implementation in Rails Admin

This test suite validates remote form widget functionality in Rails Admin, focusing on modal interactions, filtering select widgets, and file upload capabilities. It ensures proper handling of associated records, validation errors, and form submissions in a Rails application.

Test Coverage Overview

The test suite provides comprehensive coverage of remote form widget functionality:

Modal focus handling and sub-modal interactions
Filtering select and multi-select widget operations
Associated record creation and updates
File upload processing
Validation error handling for create and update operations

Implementation Analysis

The testing approach utilizes RSpec request specs with JavaScript support, implementing behavior-driven development patterns. It leverages Factory Bot for test data generation and employs dynamic configuration of Rails Admin fields for different test scenarios.

The tests simulate user interactions using Capybara’s DSL, validating both UI elements and backend data persistence.

Technical Details

Key technical components include:

RSpec for test framework
Capybara for browser simulation
Factory Bot for test data generation
JavaScript-enabled tests (js: true)
CarrierWave for file upload testing
Custom RailsAdmin configurations

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Isolated test contexts with proper setup and teardown
Comprehensive edge case coverage
Clear test descriptions and organization
Proper use of subject and let blocks
Effective use of before blocks for configuration

railsadminteam/rails_admin

spec/integration/widgets/remote_form_spec.rb

            
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe 'Remote form widget', type: :request, js: true do
  subject { page }

  describe 'modal' do
    it 'supports focusing on sub-modals' do
      visit new_path(model_name: 'division')
      click_link 'Add a new League'
      is_expected.to have_content 'New League'
      is_expected.not_to have_css '#modal.modal-static'
      execute_script %($(document.body).append($('<div id="sub-modal" class="modal d-block"><input type="text" /></div>')))
      find('#sub-modal input').click
      is_expected.to have_css '#sub-modal input:focus'
    end
  end

  context 'with filtering select widget' do
    let(:league) { FactoryBot.create :league }
    let(:division) { FactoryBot.create :division, league: league }
    before do
      RailsAdmin.config Division do
        field :league
      end
      RailsAdmin.config League do
        field :name
      end
    end

    it 'creates an associated record' do
      visit new_path(model_name: 'division')
      click_link 'Add a new League'
      is_expected.to have_content 'New League'
      fill_in 'Name', with: 'National League'
      find('#modal .save-action').click
      expect(find('#division_custom_league_id', visible: false).value).to eq League.first.id.to_s
      expect(League.pluck(:name)).to eq ['National League']
    end

    it 'updates the associated record' do
      visit edit_path(model_name: 'division', id: division.id)
      expect(find('#division_custom_league_id', visible: false).value).to eq league.id.to_s
      click_link 'Edit this League'
      is_expected.to have_content "Edit League '#{league.name}'"
      fill_in 'Name', with: 'National League'
      find('#modal .save-action').click
      expect(find('#division_custom_league_id', visible: false).value).to eq league.id.to_s
      expect(league.reload.name).to eq 'National League'
    end
  end

  context 'with filtering multi-select widget' do
    let(:leagues) { FactoryBot.create_list :league, 2 }
    let!(:division) { FactoryBot.create :division, name: 'National League Central', league: leagues[0] }
    before do
      RailsAdmin.config League do
        field :divisions
      end
      RailsAdmin.config Division do
        field :name
        field :league
      end
    end

    it 'creates an associated record and adds into selection' do
      visit edit_path(model_name: 'league', id: leagues[1].id)
      click_link 'Add a new Division'
      is_expected.to have_content 'New Division'
      fill_in 'Name', with: 'National League West'
      find(%(#division_custom_league_id option[value="#{leagues[0].id}"]), visible: false).select_option
      find('#modal .save-action').click
      is_expected.to have_css('.ra-multiselect-selection option', text: 'National League West')
      new_division = Division.where(name: 'National League West').first
      expect(new_division).not_to be nil
      expect(find('#league_division_ids', visible: false).value).to eq [new_division.id.to_s]
    end

    it 'updates an unselected associated record with leaving it unselected' do
      visit edit_path(model_name: 'league', id: leagues[1].id)
      find('.ra-multiselect-collection option', text: division.name).double_click
      is_expected.to have_content "Edit Division 'National League Central'"
      fill_in 'Name', with: 'National League East'
      find('#modal .save-action').click
      is_expected.to have_css('.ra-multiselect-collection option', text: 'National League East')
      expect(find('#league_division_ids', visible: false).value).to eq []
      expect(division.reload.name).to eq 'National League East'
    end

    it 'updates a selected associated record' do
      visit edit_path(model_name: 'league', id: leagues[0].id)
      find('.ra-multiselect-selection option', text: division.name).double_click
      is_expected.to have_content "Edit Division 'National League Central'"
      fill_in 'Name', with: 'National League East'
      find('#modal .save-action').click
      expect(find('#league_division_ids', visible: false).value).to eq [division.id.to_s]
      expect(division.reload.name).to eq 'National League East'
    end

    context 'with inline_edit set to false' do
      before do
        RailsAdmin.config League do
          field :divisions do
            inline_edit false
          end
        end
      end

      it 'does not open the modal with double click' do
        visit edit_path(model_name: 'league', id: leagues[1].id)
        find('.ra-multiselect-collection option', text: division.name).double_click
        is_expected.not_to have_content "Edit Division 'National League Central'"
      end
    end
  end

  context 'with file upload' do
    before do
      RailsAdmin.config NestedFieldTest do
        field :field_test
      end
      RailsAdmin.config FieldTest do
        field :carrierwave_asset
      end
    end

    it 'submits successfully' do
      visit new_path(model_name: 'nested_field_test')
      click_link 'Add a new Field test'
      is_expected.to have_content 'New Field test'
      attach_file 'Carrierwave asset', file_path('test.jpg')
      find('#modal .save-action').click
      is_expected.to have_css('option', text: /FieldTest #/, visible: false)
      expect(FieldTest.first.carrierwave_asset.file.size).to eq 1575
    end
  end

  context 'with validation errors' do
    before do
      RailsAdmin.config Team do
        field :players
      end
      RailsAdmin.config Player do
        field :name
        field :number
        field :team
      end
    end

    context 'on create' do
      it 'shows the error messages' do
        visit new_path(model_name: 'team')
        click_link 'Add a new Player'
        is_expected.to have_content 'New Player'
        find('#player_name').set('on steroids')
        find('#modal .save-action').click
        is_expected.to have_css('#modal')
        is_expected.to have_content 'Player is cheating'
        is_expected.to have_css '.text-danger', text: 'is not a number'
      end
    end

    context 'on update' do
      let!(:player) { FactoryBot.create :player, name: 'Cheater' }

      it 'shows the error messages' do
        visit new_path(model_name: 'team')
        find('option', text: 'Cheater').double_click
        is_expected.to have_content "Edit Player 'Cheater'"
        find('#player_name').set('Cheater on steroids')
        find('#player_number').set('')
        find('#modal .save-action').click
        is_expected.to have_css('#modal')
        is_expected.to have_content 'Player is cheating'
        is_expected.to have_css '.text-danger', text: 'is not a number'
      end
    end
  end
end