如何用Rspec测试Rails控制器index方法返回的实例变量？

当然可以在控制器层面直接测试返回给视图的实例变量！这其实是Rspec控制器测试的经典场景之一，完全不需要跑到视图层去验证表头——毕竟控制器的职责就是准备好视图需要的数据，我们直接测试这个准备过程就够了。

具体实现步骤 #

1. 搭建控制器测试的基本结构，指定测试类型为:controller
2. 调用目标动作GET #index
3. 验证控制器设置的@some_variable是否符合预期值

代码示例 #

假设你的控制器叫YourController，对应的测试文件放在spec/controllers/your_controller_spec.rb，可以这么写：

RSpec.describe YourController, type: :controller do
  describe "GET #index" do
    it "assigns the correct header titles to @some_variable" do
      # 触发index动作
      get :index

      # 定义预期的表头值（直接用I18n翻译，和控制器逻辑保持一致）
      expected_titles = [
        I18n.t('controllerFileName.index.someTitle1'),
        I18n.t('controllerFileName.index.someTitle2')
      ]

      # 验证实例变量的值是否匹配
      expect(assigns(:some_variable)).to eq(expected_titles)
    end
  end
end

关于Rspec 3+的注意事项 #

如果你的Rspec版本是3.x及以上，默认可能禁用了assigns方法（这个方法用来获取控制器的实例变量）。你需要在spec/spec_helper.rb或者spec/rails_helper.rb里启用它：

RSpec.configure do |config|
  # 启用控制器测试的辅助方法，包括assigns
  config.include RSpec::Rails::ControllerExampleGroup, type: :controller
  # 默认不需要渲染视图，这样测试会更快
  config.render_views = false
end

如果不想启用assigns，也可以直接通过控制器实例获取变量：

expect(controller.instance_variable_get(:@some_variable)).to eq(expected_titles)

进阶：隔离翻译依赖 #

如果担心locale文件的修改会影响测试稳定性，可以用Rspec的stub来模拟I18n的翻译结果，让测试不依赖实际的翻译文件：

it "assigns the correct header titles to @some_variable" do
  # 模拟翻译返回固定值
  allow(I18n).to receive(:t).with('controllerFileName.index.someTitle1').and_return('第一列标题')
  allow(I18n).to receive(:t).with('controllerFileName.index.someTitle2').and_return('第二列标题')

  get :index

  expect(assigns(:some_variable)).to eq(['第一列标题', '第二列标题'])
end

这种方式的好处是测试更独立，即使后续修改了翻译文案，只要控制器逻辑没变，测试依然能通过。

内容的提问来源于stack exchange，提问作者Chintu Karthi