Shoulda-Matchers 中验证只读属性存在的问题及解决方案

背景介绍

在 Rails 开发中，Shoulda-Matchers 是一个广泛使用的测试工具库，它提供了简洁的语法来测试 ActiveRecord 模型的各种验证和关联。随着 Rails 7.1 的发布，一个重要的行为变更影响了 Shoulda-Matchers 的使用方式。

问题描述

Rails 7.1 引入了一个重要的安全变更：默认启用了 raise_on_assign_to_attr_readonly 配置。这意味着当尝试修改被标记为 attr_readonly 的属性时，Rails 会抛出异常，而不是像之前版本那样静默忽略。

这一变更暴露了 Shoulda-Matchers 中的一个问题：当使用 validate_presence_of 验证器测试只读属性时，它会尝试修改这些属性，导致测试失败。

问题重现

假设我们有一个模型类：

class MyClass < ActiveRecord::Base
  attr_readonly :company_id
  validates :company_id, presence: true
end

对应的测试代码如下：

RSpec.describe MyClass, type: :model do
  describe 'validation' do
    subject { create(:my_class) }
    
    it { is_expected.to validate_presence_of(:company_id) }
  end
end

当 raise_on_assign_to_attr_readonly 设置为 true 时（Rails 7.1 默认），这个测试会失败，因为 Shoulda-Matchers 内部尝试修改只读的 company_id 属性。

解决方案

方案一：使用 build 而非 create

最简单的解决方案是修改测试用例，使用 build 而非 create 来初始化测试对象：

RSpec.describe MyClass, type: :model do
  describe 'validation' do
    subject { build(:my_class) }
    
    it { is_expected.to validate_presence_of(:company_id) }
  end
end

这是因为 build 方法创建的是未保存到数据库的对象实例，此时只读限制尚未生效。

方案二：明确指定验证上下文

另一种解决方案是指定验证上下文为 :create：

it { is_expected.to validate_presence_of(:company_id).on(:create) }

这告诉 Shoulda-Matchers 只在创建上下文中测试验证规则。

技术原理分析

Shoulda-Matchers 的 validate_presence_of 内部实现会尝试修改属性值来验证验证规则是否生效。对于只读属性，这种行为在 Rails 7.1 之前是被静默忽略的，但现在会抛出异常。

当使用 build 而非 create 时，对象尚未持久化，Rails 的只读属性保护机制尚未完全激活，因此可以修改这些属性值用于测试目的。

最佳实践建议

1. 优先使用 build：在测试模型验证时，除非特别需要测试保存后的行为，否则应优先使用 build 而非 create。

2. 明确验证上下文：对于只读属性的验证，明确指定 on: :create 可以更准确地表达业务意图。

3. 测试设计考量：考虑将只读属性的验证测试与其他测试分开，使用不同的测试策略。

总结

Rails 7.1 的安全变更使得 Shoulda-Matchers 在处理只读属性时需要特别注意。通过使用 build 或明确指定验证上下文，我们可以确保测试既符合 Rails 的新安全要求，又能有效验证业务逻辑。这一变更也提醒我们在设计模型时需要更谨慎地考虑属性的读写权限和验证规则。