Back to Repositories

Testing Attribute Alias Generation in FactoryBot

This test suite examines the alias functionality in FactoryBot, focusing on attribute and foreign key naming conventions. The tests verify how FactoryBot handles various alias patterns including standard attributes, foreign keys, and custom suffix configurations.

Test Coverage Overview

The test suite provides comprehensive coverage of FactoryBot’s alias system, particularly focusing on attribute naming patterns and foreign key relationships.

Tests standard attribute aliasing with ‘_id’ suffix
Verifies foreign key alias generation
Handles special cases with underscore prefixes
Tests custom alias pattern definitions

Implementation Analysis

The testing approach uses RSpec’s expect syntax to verify FactoryBot’s alias generation behavior. Tests implement a systematic pattern of checking array inclusion for expected alias variations, with particular attention to suffix handling and custom pattern matching using regular expressions.

Key implementation patterns include:

Direct interaction with FactoryBot.aliases_for method
Regular expression-based alias definition
Array inclusion verification

Technical Details

Testing tools and configuration:

RSpec as the testing framework
FactoryBot’s built-in aliases system
Custom alias pattern definition using regex
Array manipulation for alias verification

Best Practices Demonstrated

The test suite demonstrates several testing best practices including isolated test cases, clear naming conventions, and comprehensive edge case coverage.

Focused, single-responsibility test cases
Clear test descriptions using RSpec’s descriptive syntax
Proper separation of concerns between different alias scenarios
Thorough verification of both positive and negative cases

thoughtbot/factory_bot

spec/factory_bot/aliases_spec.rb

            
describe FactoryBot, "aliases" do
  it "for an attribute should include the original attribute and a version suffixed with '_id'" do
    aliases = FactoryBot.aliases_for(:test)

    expect(aliases).to include(:test, :test_id)
  end

  it "for a foreign key should include both the suffixed and un-suffixed variants" do
    aliases = FactoryBot.aliases_for(:test_id)

    expect(aliases).to include(:test, :test_id)
  end

  it "for an attribute which starts with an underscore should not include a non-underscored version" do
    aliases = FactoryBot.aliases_for(:_id)

    expect(aliases).not_to include(:id)
  end
end

describe FactoryBot, "after defining an alias" do
  it "the list of aliases should include a variant with no suffix at all, and one with an '_id' suffix" do
    FactoryBot.aliases << [/(.*)_suffix/, '\1']
    aliases = FactoryBot.aliases_for(:test_suffix)

    expect(aliases).to include(:test, :test_suffix_id)
  end
end