bug: response received unexpected message :status with (no args)

[Spence1115]

Summary

If you use the words request or response for a variable in your tests, rspec-openapi will not work. I know these are preassigned words in rspec itself, but the use of them as variables does not break rspec, so I wouldn't expect it to break rspec-openapi.

Reproduction

...
describe "#index" do
  subject { get :index }
  
  before do
    allow(SomeThirdPartyGem).to receive(:call).and_return(response)
  end

  let(:response) { double(ThirdPartyGemResponse, body: "This succeeded", code: 200) }

  it "renders the index successfully" do
    expect(subject.status).to eq(200)
  end
end

When just running the test, rspec succeeds fine. When running openapi-rspec:

\e[1mFailure/Error: \e[0mexample.run
  #<Double ThirdPartyGemResponse> received unexpected message :status with (no args)

[exoego]

Does RSpec's response works in it block in that case?

  it "renders the index successfully" do
    expect(subject.status).to eq(200)
    expect(response.status).to eq(200)
  end

[Spence1115]

No, it'd be more like this

    subject { get :index }

    before do
      allow(ThirdPartyGemResponse).to receive(:new).and_return(response)
    end

    let(:response) { double(ThirdPartyGemResponse, body: "This succeeded", code: 200, status: "success") }

    it "renders the index successfully" do
      expect(subject.status).to eq(200)
      expect(response.status).to eq("success")
    end

An alternative might just be to add something in the docs about the use of reserved words like response, and even in the code itself. Something like:

raise "Response must be a ActionDispatch::TestResponse" unless response.is_a?(ActionDispatch::TestResponse)

So at least someone can figure out what's wrong.