Plans for 2.x

[ahx]

Hi. Here is what I am working on for 2.x:

UPDATE: Splitted in 2.0 and beyond

2.0

1. ✅ A more structured code base. – Currently some things are grouped pretty randomly.
2. ✅ Performance improvements. – Faster is better.
3. ✅ Hooks! – Run code after validation was called. See https://github.com/ahx/openapi_first/tree/dev?tab=readme-ov-file#hooks
4. ✅ Assertion methods to do contract testing without using the middlewares.
5. ✅ Getting the full response with the ResponseInvalidError

2.x

1. An ambitious (test-)coverage implementation. – Coverage should, for example, report about un-tested query parameters.
2. Validating OpenAPI files?

[MrBananaLord]

Thanks for putting it all together in a plan! 🌟

Do you have an idea on how to approach the assertions? From the looks of it something like this should be enough for the request specs:

let(:definition) { OpenapiFirst.load("./openapi.yml") }

it "fails when the 'bar' param is not an integer" do
  get "/foo", params: { bar: "asd" } 

  openapi_first_request = definition.request(Rack::Request.new(request.env))
  
  expect(openapi_first_request.valid?).to eq(false)
end

it "fails when the 'foo' in response is not an integer" do
  get "/foo", params: { bar: "asd" } 

  openapi_first_request = definition.request(Rack::Request.new(request.env))
  openapi_first_response = openapi_first_request.response(Rack::Response[*response.to_a])
  
   expect(openapi_first_response.valid?).to eq(false)
end

maybe extracting the logic above to separate assertions would be enough? 🤔

[ahx]

@MrBananaLord Yes, I think that should be enough. Having something a little more concise without the need to instantiate Rack::Request etc would be nice.

it "fails when the 'bar' param is not an integer" do
  get "/foo", params: { bar: "asd" } 

  expect(request).to be_valid_request(super_api_description)
end

or

it "fails when the 'bar' param is not an integer" do
  get "/foo", params: { bar: "asd" } 

  assert_something_something(request, definition) # I cannot think of a good name
end

openapi_contracts and skooma have closer integration with RSpec, but I could also think of having a very simple assert_something method that just raises an exception with a useful error message and having no test-framework specifics going on, similar to committee.
I would love to get some feedback about what people would like to use here.

[ahx]

Hi. I have just merged my local changes into main and updated the plan above. I would like to release 2.0 soon and focus on test coverage and the others later.

The biggest change on main is probably the assert_api_conform method (see Readme), which makes openapi_first more usable in situations where you don't want to use the middlewares.

Any feedback would be very much appreciated.

[ahx]

2.0 has just been release (CHANGELOG)