Rails 测试从控制器调用该方法

Question

我有一个调用服务的控制器函数，我想测试是否使用正确的参数调用了该服务。

def send_for_signature
  client = Client.find(params[:client_id])
  external_documents = params[:document_ids].map{|id| ExternalDocument.find(id)}
  service = EsignGenieSendByTemplate.new(client: client, external_documents: external_documents, form_values: params[:form_values])
  result = service.process

  if result["result"] == "success"
    head 200
  else
    render json: result["error_description"], status: :unprocessable_entity
  end
end

如何编写测试以确保正确调用 EsignGenieSendByTemplate.new(client: client, external_documents: external_documents, form_values: params[:form_values])？

Answer 1

你需要的是一个叫做expecting messages的东西。

我通常会这样写：

it 'requests the signature' do
  expect(EsignGenieSendByTemplate).to receive(:new).with(client: 'A', external_documents: 'B', form_values: 'C')
  get :send_for_signature, params:  { ... }
  expect(response.status).to have_http_status(:success)
end

Answer 2

我将从向服务添加工厂方法开始：

class EsignGenieSendByTemplate
  # ...
  def self.process(**kwargs)
    new(**kwargs).process
  end
end

这种代码是几乎所有类型服务对象的样板代码，并在服务对象与其消费者（如控制器）之间提供更好的 API。

您的服务规范中的示例应涵盖此方法。

describe '.process' do
  let(:options) do
    { client: 'A', external_documents: 'B', form_values: 'C' }
  end

  it "forwards its arguments" do
    expect(described_class).to recieve(:new).with(**options)
    EsignGenieSendByTemplate.process(**options)
  end

  it "calls process on the instance" do
    dbl = instance_double('EsignGenieSendByTemplate')
    allow(described_class).to recieve(:new).and_return(dbl) 
    expect(dbl).to recieve(:process)
    EsignGenieSendByTemplate.process(**options)
  end
end

您的控制器应该只调用工厂方法而不是实例化 EsignGenieSendByTemplate：

def send_for_signature
  client = Client.find(params[:client_id])
  # Just pass an array to .find instead of looping - this create a single 
  # db query instead of n+1
  external_documents = ExternalDocument.find(params[:document_ids])
  result = EsignGenieSendByTemplate.process(
    client: client, 
    external_documents: external_documents, 
    form_values: params[:form_values]
  )

  if result["result"] == "success"
    head 200
  else
    render json: result["error_description"], status: :unprocessable_entity
  end
end

控制器和服务之间的这种更好的 API 让您可以对 EsignGenieSendByTemplate 类设置期望，这样您就不必胡乱使用 expect_any_instance 或存根 .new 方法。

it 'requests the signature' do
  expect(EsignGenieSendByTemplate).to receive(:process).with(client: 'A', external_documents: 'B', form_values: 'C')
  get :send_for_signature, params:  { ... }
end