openapi_first 2.9.3 → 2.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef8ea95833884daf36e8a33742ce4a6eddfb9343b67de0b5e787ebc377c0691d
-  data.tar.gz: b63916918c1d1116d99c2e071c3e8e752b1cce66cd431dceb5076a3e70688c10
+  metadata.gz: 79f9fda1c73303674f66f87ff97d6749e085fb6a01ca1f9d604e53a9f9a1abd7
+  data.tar.gz: b15c401b9e9b83fc091e597b09765a3ec518005c79f4406af4abe4fa1a8b7735
 SHA512:
-  metadata.gz: 3cbf77e0a4a51b213a90458c1181bd29474f378195210cf76466c24ef832195b32e4cbd8aec7ba97ece0bd7d9a97b6022e02b5288600d8879b82401c398d1ddc
-  data.tar.gz: 8789c3dadcff66b6cbb831dfae948da5adcbcd2788ff40765f39d4a1a0ba238cef1d7df609b4dd57e8ba71653103e21f9fb6a7e1f0a212e45c02d4f8c5e41e39
+  metadata.gz: 84bbbc5bf681ec5f62ef7b66d68be805add8a4b013ea87d9081718677bcf617c89ffab7d61d660d1b498f99532b05106591837353d62a3355febaa739a80e631
+  data.tar.gz: 9c5771ee2b8a55e85d2841ce5d0e0058eec81df545f5eaf168176c41cd6e66c83436fffc19b6de156f444e1f58c010e8e443b0736fe6d08940774311c1ed87a3

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Unreleased
 
+## 2.10.1
+
+- Don't try to track coverage for skipped requests
+- Add Test::Configuration#skip_coverage to skip test coverage for specific paths + request methods and all responses
+- Deprecate setting minimum_coverage value. Use skip_response_coverage, ignored_unknown_status to configure coverage instead.
+- Update openapi_parameters to make parsing array query parameters more consistent.
+  Now parsing empty array query parameter like `ids=&` or `ids&` both result in an empty array value (`[]`) instead of `nil` or `""`.
+- Fix Test::Coverage.result returning < 100 even if plan is fully covered
+
+## 2.10.0 (yanked)
+
 ## 2.9.3
 
 - Fix OpenapiFirst.load when MultiJson is configured to return symbol keys

data/README.md

@@ -70,9 +70,9 @@ Here is how to set it up:
       end
       ```
     - Or inject a Module to wrap (prepend) the `call` method of your Rack app Class.
-    
+
       NOTE: This is still work in progress. It works with basic Sinatra apps, but does not work with Hanami or Rails out of the box, yet. PRs welcome 🤗
-      
+
       ```ruby
       OpenapiFirst::Test.observe(MyApplication)
       ```
@@ -80,14 +80,39 @@ Here is how to set it up:
 
 (✷1): It does not matter what method of openapi_first you use to validate requests/responses. Instead of using `OpenapiFirstTest.app` to wrap your application, you could also use the [middlewares](#rack-middlewares) or [test assertion method](#test-assertions), but you would have to do that for all requests/responses defined in your API description to make coverage work.
 
-OpenapiFirst' request validation raises an error when a request is not defined. You can deactivate this during testing:
+### Configure test coverage
+
+OpenapiFirst::Test raises an error when a request is not defined. You can deactivate this with:
 
 ```ruby
 OpenapiFirst::Test.setup do |test|
+  # …
   test.ignore_unknown_requests = true
 end
 ```
 
+Exclude certain _responses_ from coverage with `skip_coverage`:
+
+```ruby
+OpenapiFirst::Test.setup do |test|
+  # …
+  test.skip_response_coverage do |response_definition|
+    response_definition.status == '5XX'
+  end
+end
+```
+
+Skip coverage for a request and all responses alltogether of a route with `skip_coverage`:
+
+```ruby
+OpenapiFirst::Test.setup do |test|
+  # …
+  test.skip_coverage do |path, request_method|
+    path == '/bookings/{bookingId}' && requests_method == 'DELETE'
+  end
+end
+```
+
 ## Rack Middlewares
 
 ### Request validation

data/lib/openapi_first/test/configuration.rb

@@ -9,6 +9,7 @@ module OpenapiFirst
         @coverage_formatter = Coverage::TerminalFormatter
         @coverage_formatter_options = {}
         @skip_response_coverage = nil
+        @skip_coverage = nil
         @response_raise_error = true
         @ignored_unknown_status = [404]
         @report_coverage = true
@@ -29,9 +30,9 @@ module OpenapiFirst
         @apps[api] = app
       end
 
-      attr_accessor :coverage_formatter_options, :coverage_formatter, :response_raise_error, :minimum_coverage,
+      attr_accessor :coverage_formatter_options, :coverage_formatter, :response_raise_error,
                     :ignore_unknown_requests
-      attr_reader :registry, :apps, :report_coverage, :ignored_unknown_status
+      attr_reader :registry, :apps, :report_coverage, :ignored_unknown_status, :minimum_coverage
 
       # Configure report coverage
       # @param [Boolean, :warn] value Whether to report coverage or just warn.
@@ -44,11 +45,24 @@ module OpenapiFirst
         @report_coverage = value
       end
 
+      # @deprecated Use skip_response_coverage, ignored_unknown_status or skip_coverage to configure coverage
+      def minimum_coverage=(value)
+        warn 'OpenapiFirst::Test::Configuration#minimum_coverage= is deprecated. ' \
+             'Use skip_response_coverage, ignored_unknown_status to configure coverage instead.'
+        @minimum_coverage = value
+      end
+
       def skip_response_coverage(&block)
         return @skip_response_coverage unless block_given?
 
         @skip_response_coverage = block
       end
+
+      def skip_coverage(&block)
+        return @skip_coverage unless block_given?
+
+        @skip_coverage = block
+      end
     end
   end
 end

data/lib/openapi_first/test/coverage/plan.rb

@@ -12,9 +12,11 @@ module OpenapiFirst
       class Plan
         class UnknownRequestError < StandardError; end
 
-        def self.for(oad, skip_response: nil)
+        def self.for(oad, skip_response: nil, skip_route: nil)
           plan = new(definition_key: oad.key, filepath: oad.filepath)
-          oad.routes.each do |route|
+          routes = oad.routes
+          routes = routes.reject { |route| skip_route[route.path, route.request_method] } if skip_route
+          routes.each do |route|
             responses = skip_response ? route.responses.reject(&skip_response) : route.responses
             plan.add_route request_method: route.request_method,
                            path: route.path,
@@ -35,7 +37,7 @@ module OpenapiFirst
         private attr_reader :index
 
         def track_request(validated_request)
-          index[validated_request.request_definition.key].track(validated_request) if validated_request.known?
+          index[validated_request.request_definition.key]&.track(validated_request) if validated_request.known?
         end
 
         def track_response(validated_response)
@@ -51,6 +53,8 @@ module OpenapiFirst
           return 0 if done.zero?
 
           all = tasks.count
+          return 100 if done == all
+
           (done / (all.to_f / 100))
         end
 

data/lib/openapi_first/test/coverage.rb

@@ -19,9 +19,9 @@ module OpenapiFirst
 
         def install = Test.install
 
-        def start(skip_response: nil)
+        def start(skip_response: nil, skip_route: nil)
           @current_run = Test.definitions.values.to_h do |oad|
-            plan = Plan.for(oad, skip_response:)
+            plan = Plan.for(oad, skip_response:, skip_route:)
             [oad.key, plan]
           end
         end

data/lib/openapi_first/test.rb

@@ -41,7 +41,7 @@ module OpenapiFirst
 
       configuration.registry.each { |name, oad| register(oad, as: name) }
       configuration.apps.each { |name, app| observe(app, api: name) }
-      Coverage.start(skip_response: configuration.skip_response_coverage)
+      Coverage.start(skip_response: configuration.skip_response_coverage, skip_route: configuration.skip_coverage)
 
       if definitions.empty?
         raise NotRegisteredError,

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '2.9.3'
+  VERSION = '2.10.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 2.9.3
+  version: 2.10.1
 platform: ruby
 authors:
 - Andreas Haller
@@ -49,7 +49,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -59,7 +59,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'