committee_firetail 5.0.0

data/test/test/schema_coverage_test.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Committee::Test::SchemaCoverage do
+  before do
+    @schema_coverage = Committee::Test::SchemaCoverage.new(open_api_3_coverage_schema)
+  end
+
+  describe 'recording coverage' do
+    def response_as_str(response)
+      [:path, :method, :status].map { |key| response[key] }.join(' ')
+    end
+
+    def uncovered_responses
+      @schema_coverage.report_flatten[:responses].select { |r| !r[:is_covered] }.map { |r| response_as_str(r) }
+    end
+
+    def covered_responses
+      @schema_coverage.report_flatten[:responses].select { |r| r[:is_covered] }.map { |r| response_as_str(r) }
+    end
+    it 'can record and report coverage properly' do
+      @schema_coverage.update_response_coverage!('/posts', 'get', '200')
+      assert_equal([
+        '/posts get 200',
+      ], covered_responses)
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 404',
+        '/posts get default',
+        '/posts post 200',
+        '/likes post 200',
+        '/likes delete 200',
+      ], uncovered_responses)
+
+      @schema_coverage.update_response_coverage!('/likes', 'post', '200')
+      assert_equal([
+        '/posts get 200',
+        '/likes post 200',
+      ], covered_responses)
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 404',
+        '/posts get default',
+        '/posts post 200',
+        '/likes delete 200',
+      ], uncovered_responses)
+
+      @schema_coverage.update_response_coverage!('/likes', 'delete', '200')
+      assert_equal([
+        '/posts get 200',
+        '/likes post 200',
+        '/likes delete 200',
+      ], covered_responses)
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 404',
+        '/posts get default',
+        '/posts post 200',
+      ], uncovered_responses)
+
+      @schema_coverage.update_response_coverage!('/posts', 'get', '422')
+      assert_equal([
+        '/posts get 200',
+        '/posts get default',
+        '/likes post 200',
+        '/likes delete 200',
+      ], covered_responses)
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 404',
+        '/posts post 200',
+      ], uncovered_responses)
+
+      assert_equal({
+        '/threads/{id}' => {
+          'get' => {
+            'responses' => {
+              '200' => false,
+            },
+          },
+        },
+        '/posts' => {
+          'get' => {
+            'responses' => {
+              '200' => true,
+              '404' => false,
+              'default' => true,
+            },
+          },
+          'post' => {
+            'responses' => {
+              '200' => false,
+            },
+          },
+        },
+        '/likes' => {
+          'post' => {
+            'responses' => {
+              '200' => true,
+            },
+          },
+          'delete' => {
+            'responses' => {
+              '200' => true,
+            },
+          },
+        },
+      }, @schema_coverage.report)
+
+      @schema_coverage.update_response_coverage!('/posts', 'post', '200')
+      @schema_coverage.update_response_coverage!('/posts', 'get', '404')
+      @schema_coverage.update_response_coverage!('/threads/{id}', 'get', '200')
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 200',
+        '/posts get 404',
+        '/posts get default',
+        '/posts post 200',
+        '/likes post 200',
+        '/likes delete 200',
+      ], covered_responses)
+      assert_equal([], uncovered_responses)
+    end
+  end
+
+  describe '.merge_report' do
+    it 'can merge 2 coverage reports together' do
+      report = Committee::Test::SchemaCoverage.merge_report(
+        {
+          '/posts' => {
+            'get' => {
+              'responses' => {
+                '200' => true,
+                '404' => false,
+              },
+            },
+            'post' => {
+              'responses' => {
+                '200' => false,
+              },
+            },
+          },
+          '/likes' => {
+            'post' => {
+              'responses' => {
+                '200' => true,
+              },
+            },
+          },
+        },
+        {
+          '/posts' => {
+            'get' => {
+              'responses' => {
+                '200' => true,
+                '404' => true,
+              },
+            },
+            'post' => {
+              'responses' => {
+                '200' => false,
+              },
+            },
+          },
+          '/likes' => {
+            'post' => {
+              'responses' => {
+                '200' => false,
+                '400' => false,
+              },
+            },
+          },
+          '/users' => {
+            'get' => {
+              'responses' => {
+                '200' => true,
+              },
+            },
+          },
+        },
+      )
+
+      assert_equal({
+        '/posts' => {
+          'get' => {
+            'responses' => {
+              '200' => true,
+              '404' => true,
+            },
+          },
+          'post' => {
+            'responses' => {
+              '200' => false,
+            },
+          },
+        },
+        '/likes' => {
+          'post' => {
+            'responses' => {
+              '200' => true,
+              '400' => false,
+            },
+          },
+        },
+        '/users' => {
+          'get' => {
+            'responses' => {
+              '200' => true,
+            },
+          },
+        },
+      }, report)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start do
+  # We do our utmost to test our executables by modularizing them into
+  # testable pieces, but testing them to completion is nearly impossible as
+  # far as I can tell, so include them in our tests but don't calculate
+  # coverage.
+  add_filter "/bin/"
+  add_filter "/test/"
+
+  # This library has a pretty modest number of lines, so let's try to stick
+  # to a 99% coverage target for a while and see what happens.
+  # We can't use 100% because old rack version doesn't support media_type and it's not testable :(
+  # https://github.com/interagent/committee/pull/360/files#diff-ce1125b6594690a88a70dbe2869f7fcfa2962c2bca80751f3720888920e2dfabR54
+  minimum_coverage 99
+end
+
+require "minitest"
+require "minitest/spec"
+require "minitest/autorun"
+require "rack/test"
+require "rr"
+require "pry"
+require "stringio"
+
+require_relative "../lib/committee"
+
+# The OpenAPI sample specification provided directly from the organization uses
+# a couple custom "format" values for JSON schema, namely "int32" and "int64".
+# Provide basic definitions for them here so that we don't error when trying to
+# parse the sample.
+JsonSchema.configure do |c|
+  c.register_format 'int32', ->(data) {}
+  c.register_format 'int64', ->(data) {}
+end
+
+# For our hyper-schema example.
+ValidApp = {
+  "maintenance" => false,
+  "name"        => "example",
+}.freeze
+
+# For our OpenAPI example.
+ValidPet = {
+  "id"   => 123,
+  "name" => "example",
+  "tag"  => "tag-123",
+}.freeze
+
+def hyper_schema
+  @hyper_schema ||= Committee::Drivers.load_from_json(hyper_schema_schema_path)
+end
+
+def open_api_2_schema
+  @open_api_2_schema ||= Committee::Drivers.load_from_file(open_api_2_schema_path)
+end
+
+def open_api_2_form_schema
+  @open_api_2_form_schema ||= Committee::Drivers.load_from_file(open_api_2_form_schema_path)
+end
+
+def open_api_3_schema
+  @open_api_3_schema ||= Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true})
+end
+
+def open_api_3_coverage_schema
+  @open_api_3_coverage_schema ||= Committee::Drivers.load_from_file(open_api_3_coverage_schema_path, parser_options:{strict_reference_validation: true})
+end
+
+# Don't cache this because we'll often manipulate the created hash in tests.
+def hyper_schema_data
+  JSON.parse(File.read(hyper_schema_schema_path))
+end
+
+# Don't cache this because we'll often manipulate the created hash in tests.
+def open_api_2_data
+  JSON.parse(File.read(open_api_2_schema_path))
+end
+
+def open_api_2_form_data
+  JSON.parse(File.read(open_api_2_form_schema_path))
+end
+
+def open_api_3_data
+  if YAML.respond_to?(:unsafe_load_file)
+    YAML.unsafe_load_file(open_api_3_schema_path)
+  else
+    YAML.load_file(open_api_3_schema_path)
+  end
+end
+
+def hyper_schema_schema_path
+  "./test/data/hyperschema/paas.json"
+end
+
+def open_api_2_schema_path
+  "./test/data/openapi2/petstore-expanded.json"
+end
+
+def open_api_2_form_schema_path
+  "./test/data/openapi2/petstore-expanded-form.json"
+end
+
+def open_api_3_schema_path
+  "./test/data/openapi3/normal.yaml"
+end
+
+def open_api_3_coverage_schema_path
+  "./test/data/openapi3/coverage.yaml"
+end
+
+def open_api_3_0_1_schema_path
+  "./test/data/openapi3/3_0_1.yaml"
+end
+
+def open_api_3_invalid_reference_path
+  "./test/data/openapi3/invalid_reference.yaml"
+end

data/test/validation_error_test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Committee::ValidationError do
+  before do
+    @error = Committee::ValidationError.new(400, :bad_request, "Error")
+  end
+
+  it "creates an error body with the id and message" do
+    assert_equal @error.error_body, { id: :bad_request, message: "Error" }
+  end
+
+  it "creates a Rack response object to render" do
+    body = { id: :bad_request, message: "Error" }
+
+    response = [
+      400,
+      { "Content-Type" => "application/json" },
+      [JSON.generate(body)]
+    ]
+
+    assert_equal @error.render, response
+  end
+end

metadata

@@ -0,0 +1,328 @@
+--- !ruby/object:Gem::Specification
+name: committee_firetail
+version: !ruby/object:Gem::Version
+  version: 5.0.0
+platform: ruby
+authors:
+- Brandur
+- geemus (Wesley Beary)
+- ota42y
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.3
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: openapi_parser_firetail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- brandur@mutelight.org
+- geemus+github@gmail.com
+- ota42y@gmail.com
+executables:
+- committee-stub
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/committee-stub
+- lib/committee.rb
+- lib/committee/bin/committee_stub.rb
+- lib/committee/drivers.rb
+- lib/committee/drivers/driver.rb
+- lib/committee/drivers/hyper_schema.rb
+- lib/committee/drivers/hyper_schema/driver.rb
+- lib/committee/drivers/hyper_schema/link.rb
+- lib/committee/drivers/hyper_schema/schema.rb
+- lib/committee/drivers/open_api_2.rb
+- lib/committee/drivers/open_api_2/driver.rb
+- lib/committee/drivers/open_api_2/header_schema_builder.rb
+- lib/committee/drivers/open_api_2/link.rb
+- lib/committee/drivers/open_api_2/parameter_schema_builder.rb
+- lib/committee/drivers/open_api_2/schema.rb
+- lib/committee/drivers/open_api_2/schema_builder.rb
+- lib/committee/drivers/open_api_3.rb
+- lib/committee/drivers/open_api_3/driver.rb
+- lib/committee/drivers/open_api_3/schema.rb
+- lib/committee/drivers/schema.rb
+- lib/committee/errors.rb
+- lib/committee/middleware.rb
+- lib/committee/middleware/base.rb
+- lib/committee/middleware/request_validation.rb
+- lib/committee/middleware/response_validation.rb
+- lib/committee/middleware/stub.rb
+- lib/committee/request_unpacker.rb
+- lib/committee/schema_validator.rb
+- lib/committee/schema_validator/hyper_schema.rb
+- lib/committee/schema_validator/hyper_schema/parameter_coercer.rb
+- lib/committee/schema_validator/hyper_schema/request_validator.rb
+- lib/committee/schema_validator/hyper_schema/response_generator.rb
+- lib/committee/schema_validator/hyper_schema/response_validator.rb
+- lib/committee/schema_validator/hyper_schema/router.rb
+- lib/committee/schema_validator/hyper_schema/string_params_coercer.rb
+- lib/committee/schema_validator/open_api_3.rb
+- lib/committee/schema_validator/open_api_3/operation_wrapper.rb
+- lib/committee/schema_validator/open_api_3/request_validator.rb
+- lib/committee/schema_validator/open_api_3/response_validator.rb
+- lib/committee/schema_validator/open_api_3/router.rb
+- lib/committee/schema_validator/option.rb
+- lib/committee/test/methods.rb
+- lib/committee/test/schema_coverage.rb
+- lib/committee/utils.rb
+- lib/committee/validation_error.rb
+- lib/committee/version.rb
+- test/bin/committee_stub_test.rb
+- test/bin_test.rb
+- test/committee_test.rb
+- test/drivers/hyper_schema/driver_test.rb
+- test/drivers/hyper_schema/link_test.rb
+- test/drivers/open_api_2/driver_test.rb
+- test/drivers/open_api_2/header_schema_builder_test.rb
+- test/drivers/open_api_2/link_test.rb
+- test/drivers/open_api_2/parameter_schema_builder_test.rb
+- test/drivers/open_api_3/driver_test.rb
+- test/drivers_test.rb
+- test/middleware/base_test.rb
+- test/middleware/request_validation_open_api_3_test.rb
+- test/middleware/request_validation_test.rb
+- test/middleware/response_validation_open_api_3_test.rb
+- test/middleware/response_validation_test.rb
+- test/middleware/stub_test.rb
+- test/request_unpacker_test.rb
+- test/schema_validator/hyper_schema/parameter_coercer_test.rb
+- test/schema_validator/hyper_schema/request_validator_test.rb
+- test/schema_validator/hyper_schema/response_generator_test.rb
+- test/schema_validator/hyper_schema/response_validator_test.rb
+- test/schema_validator/hyper_schema/router_test.rb
+- test/schema_validator/hyper_schema/string_params_coercer_test.rb
+- test/schema_validator/open_api_3/operation_wrapper_test.rb
+- test/schema_validator/open_api_3/request_validator_test.rb
+- test/schema_validator/open_api_3/response_validator_test.rb
+- test/test/methods_new_version_test.rb
+- test/test/methods_test.rb
+- test/test/schema_coverage_test.rb
+- test/test_helper.rb
+- test/validation_error_test.rb
+homepage: https://github.com/interagent/committee
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A collection of Rack middleware to support JSON Schema.
+test_files: []