Question

对于控制器规范中的每个HTTP方法/控制器操作组合，我重复了以下测试一次：

it "requires authentication" do
  get :show, id: project.id
  # Unauthenticated users should be redirected to the login page
  expect(response).to redirect_to new_user_session_path
end

我发现以下三种方法可以重构它并消除重复。哪一个最合适？

共享示例

在我看来，共享示例是最合适的解决方案。但是，为了将params传递给共享示例而必须使用块感觉有点尴尬。

shared_examples "requires authentication" do |http_method, action|
  it "requires authentication" do
    process(action, http_method.to_s, params)
    expect(response).to redirect_to new_user_session_path
  end
end

RSpec.describe ProjectsController, type: :controller do
  describe "GET show", :focus do
    let(:project) { Project.create(name: "Project Rigpa") }

    include_examples "requires authentication", :GET, :show do
      let(:params) { {id: project.id} }
    end
  end
end

助手方法

这样做的好处是不需要块将project.id传递给辅助方法。

RSpec.describe ProjectsController, type: :controller do
  def require_authentication(http_method, action, params)
    process(action, http_method.to_s, params)
    expect(response).to redirect_to new_user_session_path
  end

  describe "GET show", :focus do
    let(:project) { Project.create(name: "Project Rigpa") }

    it "requires authentication" do
      require_authentication(:GET, :show, id: project.id )
    end
  end
end

自定义匹配器

进行单线测试会很不错。

RSpec::Matchers.define :require_authentication do |http_method, action, params|
  match do
    process(action, http_method.to_s, params)
    expect(response).to redirect_to Rails.application.routes.url_helpers.new_user_session_path
  end
end

RSpec.describe ProjectsController, type: :controller do
  describe "GET show", :focus do
    let(:project) { Project.create(name: "Project Rigpa") }

    it { is_expected.to require_authentication(:GET, :show, {id: project.id}) }
  end
end

提前致谢。

Answer 1

在您描述的情况下，我会选择 RSpec Custom Matchers 。它们使您的规范更易于阅读并更贴近您的应用程序域。 https://relishapp.com/rspec/rspec-expectations/v/2-4/docs/custom-matchers/define-matcher

我会使用shared_examples来指定更复杂的场景，并调用it_behaves_like在不同的上下文中一次性检查它。

如果可能的话，你应该尽量避免使用辅助方法，只有在有助于保持规格清洁的情况下才能在单个文件中使用它们。

Answer 2

didroe在this Reddit post中提供的建议让我想到将方法/动作调用（process）置于共享代码中并不是一个好主意，因为它会增加复杂性（降低可读性）而不会实际上减少了代码重复。

在搜索了更多内容之后，我在Everyday Rails Testing with RSpec by Aaron Sumner一书（第102页）中找到了我认为最佳选择。

创建以下自定义匹配器：

# spec/support/matchers/require_login.rb
RSpec::Matchers.define :require_login do |expected|
  match do |actual|
    expect(actual).to redirect_to \
      Rails.application.routes.url_helpers.new_user_session_path
  end

  failure_message do |actual|
    "expected to require login to access the method"
  end

  failure_message_when_negated do |actual|
    "expected not to require login to access the method"
  end

  description do
    "redirect to the login form"
  end
end

对每个控制器的每个动作使用如下测试：

it "requires authentication" do
  get :show, id: project.id
  expect(response).to require_login
end

与在所有测试中重复expect(response).to redirect_to new_user_session_path相比，此方法具有以下优点：

改善了可维护性。如果我们最终必须更改此断言，我们会在一个地方更改它，而不必更改数十个或数百个测试。
更好的失败信息。

您怎么看？

Rails RSpec，DRY规范：共享示例与辅助方法与自定义匹配器

共享示例

助手方法

自定义匹配器

2 个答案: