autoapi_testing 0.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69a3af2449f91e96268858936dbb1d102036489eaea8fc79f4ff62197bd4d4d0
+  data.tar.gz: bdf4c0eb52fc405e7a399f56ce39cc479260fb2beb0d3a2c22e6f92bd54ce485
+SHA512:
+  metadata.gz: 5c1bdd2391e72511cf4ebc6cee3763746fcae0b9f4aa5c871c230950ea93d8e6c3a6ca4b6765607d70efd427d63186d2fbf75fb963fceb2aa11fa94baea09a0d
+  data.tar.gz: 128c8c2e46950b8d29afeb1e1caf5b4f4074d1cfb217362ad5da515fcddf2f17171683ee23c07968a6363eb2ad17660495f88afc0238796b736eff0730c997db

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-02-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at danny.porrello@procore.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in autoapi_testing.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem 'dry-types'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Danny Porrello
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# AutoapiTesting
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/autoapi_testing`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'autoapi_testing'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install autoapi_testing
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/autoapi_testing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/autoapi_testing/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AutoapiTesting project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/autoapi_testing/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "autoapi_testing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/autoapi/convert.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# domain: AutoAPI
+
+# TODO: follow guide and implement remaining changes
+# https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
+
+# convert schema from OAS 3.0 to 3.1
+def convert(schema)
+  if schema.class == Array
+    schema.map { |child| convert child }
+  elsif schema.class == Hash
+    if schema['nullable']
+      # not sure what to do when/if this happens
+      raise 'no type' unless schema['type']
+
+      schema['type'] = [schema['type'], nil]
+    end
+    schema.transform_values { |child| convert child }
+  else
+    schema
+  end
+end

data/lib/autoapi/run_autoapi.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# domain: AutoAPI
+
+# check if file of generated tests exists and return that
+# otherwise execute autoapi to create the file first
+def run_autoapi(oas_filename)
+  use_cache = ENV['CI'] || ENV.fetch('AUTOAPI_USE_CACHE', 'false').casecmp('true').zero?
+  # json_filename = Rails.root.join("doc/api_docs/autoapi/generated_tests/#{oas_filename.split('.')[0]}.json")
+  json_filename = Rails.root.join("doc/api_docs/autoapi/generated_tests/#{oas_filename.split('.')[0]}.json")
+  if use_cache && File.exist?(json_filename)
+    puts 'Reusing existing test file'
+    JSON.parse(File.read(json_filename))
+  else
+    puts 'Generating test file with AutoAPI'
+    jar_path = File.join(File.dirname(__FILE__), 'AutoAPI-0.0.1.jar')
+    oas_path = Rails.root.join('doc/api_docs', oas_filename)
+    json = `java -jar #{jar_path} --generatetests #{oas_path}`
+    begin
+      autoapi_test_fixture = JSON.parse(json)
+    rescue JSON::ParserError
+      raise "Error Generating test cases with AutoAPI. \n" + json
+    end
+    json_file_dir = File.dirname(json_filename)
+    unless File.directory?(json_file_dir)
+      FileUtils.mkdir_p(json_file_dir)
+    end
+    File.write(json_filename, json)
+    autoapi_test_fixture
+  end
+end

data/lib/autoapi/test_case.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+# domain: AutoAPI
+
+=begin
+module Types
+  include Dry.Types()
+end
+
+class TestCase < Dry::Struct
+  attribute :request do
+    attribute :operation, Types::String
+    attribute :path, Types::String
+    attribute :media_type, Types::String
+    attribute :parameters, Types::Array
+    attribute :body_schema, Types::Hash.optional
+  end
+  attribute :response do
+    attribute :status, Types::Integer
+    attribute :body_schema, Types::Hash.optional
+    attribute :media_type, Types::String.optional
+    attribute :header_schema_map, Types::Hash.optional
+  end
+
+  def method
+    request.operation
+  end
+
+  def path
+    request.path
+  end
+
+  def media_type
+    request.media_type
+  end
+
+  def status
+    response.status
+  end
+
+  def query_params
+    @query_params ||=
+      request.parameters.filter { |p| p['in'] == 'query' }
+  end
+
+  def query_fields
+    @query_fields ||= query_params.map { |p| p['name'] }.sort
+  end
+
+  def path_params
+    @path_params ||=
+      request.parameters.filter { |p| p['in'] == 'path' }
+  end
+
+  def path_fields
+    @path_fields ||= path_params.map { |p| p['name'] }.sort
+  end
+
+  def header_params
+    @header_params ||=
+      request.parameters.filter { |p| p['in'] == 'header' }
+  end
+
+  def header_fields
+    @header_fields ||= header_params.map { |p| p['name'] }.sort
+  end
+
+  def id
+    "#{method} (#{status}) #{media_type} #{path}"
+  end
+
+  def full_id
+    "#{id} query: #{query_fields} header: #{header_fields}"
+  end
+
+  def config(path, operation=nil, &block)
+    if request.path.eql?(path) && (!operation.nil? && request.operation.eql?(operation))
+      instance_exec this, &block
+    end
+  end
+
+  def self.from_json(json)
+    new(
+      request: {
+        body_schema: json['request']['bodySchema'],
+        media_type: json['request']['contentMediaType'],
+        operation: json['request']['operation'],
+        parameters: json['request']['parameterList'],
+        path: json['path']
+      },
+      response: {
+        body_schema: json['expected']['bodySchema'],
+        media_type: json['expected']['contentMediaType'],
+        status: json['expected']['code'],
+        header_schema_map: json['expected']['headerSchemaMap']
+      }
+    )
+  end
+end
+
+class TestCaseResult < Dry::Struct
+  # https://dry-rb.org/gems/dry-struct/1.0/recipes/#resolving-default-values-on-code-nil-code
+  transform_types do |type|
+    if type.default?
+      type.constructor do |value|
+        value.nil? ? Dry::Types::Undefined : value
+      end
+    else
+      type
+    end
+  end
+  NIL_RESPONSE = ActionDispatch::TestResponse.new(0, {}, '').freeze
+  attribute :test, TestCase
+  attribute :actual, Types.Instance(ActionDispatch::TestResponse).default(NIL_RESPONSE)
+  attribute :filename, Types::String
+  attribute :info, Types::Hash.optional
+  attribute :validation_errors, Types::Array
+  attribute :autoapi_test_id, Types::String
+
+  def as_json
+    {
+      path: test.request.path,
+      filename: filename,
+      operation: test.request.operation,
+      autoapi_test_id: autoapi_test_id,
+      info: info,
+      transaction:
+        {
+          request: test_request,
+          expected: test_expected_response,
+          actual: actual_response,
+          result: test_result
+        }
+    }.to_json
+  end
+
+  def headers
+    headers = ''
+    actual.request.headers.each do |key, value|
+      headers += "#{key}='#{value}'; " if key.start_with? 'HTTP'
+    end
+    headers
+  end
+
+  def test_request
+    {
+      parameters: test.request.parameters,
+      headers: headers,
+      request_body: actual.request.raw_post.encode('utf-8', invalid: :replace, undef: :replace),
+      content_media_type: actual.request.media_type
+    }
+  end
+
+  def test_expected_response
+    { status_code: test.response.status, body_schema: test.response.body_schema, content_media_type: test.response.media_type }
+  end
+
+  def actual_response
+    { status_code: actual.status, body: actual.body, content_media_type: actual.media_type, headers: actual.headers }
+  end
+
+  def test_result
+    issues = []
+    validation_errors.each do |error|
+      issues.concat([{ message: error }])
+    end
+
+    { status: issues.empty? ? 'PASS' : 'FAIL', issues: issues }
+  end
+end
+=end

data/lib/autoapi_testing/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AutoapiTesting
+  VERSION = "0.1.9"
+end

data/lib/autoapi_testing.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+require_relative "autoapi_testing/version"
+
+require 'autoapi/run_autoapi'
+require 'autoapi/test_case'
+require 'autoapi/convert'
+
+module AutoapiTesting
+  class Error < StandardError; end
+  # Your code goes here...
+  class Sumo
+    def self.logger
+      @logger ||=
+        begin
+          Dir.glob('./test-results/autoapi/sumo.log*').each { |f| File.delete(f) }
+          FileUtils.mkdir_p './test-results/autoapi'
+          Logger.new('./test-results/autoapi/sumo.log', 100, 1.megabyte).tap do |logger|
+            logger.level = Logger::INFO
+            logger.formatter = proc do |_severity, _datetime, _progname, msg|
+              "#{msg}\n"
+            end
+          end
+        end
+    end
+  end
+  # Track validation errors found so they can be sent to sumo
+  # after the test ends
+  class ValidationErrors
+    attr_reader :errors
+    def initialize
+      @errors = []
+    end
+
+    def process(error)
+      if error != true
+        error.each { |e| ::Rails.logger.error("Validation error Thrown by AutoAPI rails client: \n" + e.to_s) }
+        @errors.concat(error)
+      end
+    end
+  end
+  class AutoAPI
+
+    def printy
+      puts 'TESTING'
+    end
+
+    def run_autoapi_2(oas_filename)
+      run_autoapi(oas_filename)
+    end
+
+    # bundle name and schema so `match_param` and `match_response_header`
+    # can provide the field name for context in the error message
+    NameAndSchema = Struct.new(:name, :schema)
+
+    # Send message to logger and to the rspec reporter
+    # which will display it to text-based formatters
+    # like progress and documentation that listen for
+    # the `message` event
+    def log_message(msg)
+      Rails.logger.info msg
+      RSpec.configuration.reporter.message msg
+    end
+
+    def output_request(path, params, headers)
+      log_message 'Request:'
+      log_message "  Path: #{path}"
+      log_message "  Parameters: #{params}"
+      log_message "  Headers: #{headers}"
+    end
+
+    def output_response(status, body, headers)
+      log_message 'Response:'
+      log_message "  Status Code: #{status}"
+      log_message "  Headers: #{headers}"
+      log_message "  Body: #{body}\n\n"
+    end
+
+    # Suppress type error for attachments.
+    #
+    # Attachments are added as Rack::Test::UploadedFile objects
+    # which raises a schema validation error as the interpretted
+    # type is `any` rather than `string` which is how attachments
+    # are marked in OAS 3.0.3
+    # https://procoretech.atlassian.net/browse/ACV-1019
+    def suppress_attachment_type_error(validation_errors)
+      validation_errors.select! do |error|
+        if error.match?(/attachment.*of type any did not match the following type: string/)
+          puts "Suppressing validation error: #{error}"
+          false
+        else
+          true
+        end
+      end
+    end
+
+    # run OpenAPI specification tests generated by autoapi
+    def generate_autoapi(oas_filename, &block)
+      autoapi_test_id = ENV.fetch('CIRCLE_BUILD_NUM', RSpec.configuration.start_time.to_i).to_s
+      RSpec.describe oas_filename, :autoapi, type: :request, order: :defined do
+        matcher :match_body do |expected|
+          validation_errors = []
+          match do |actual|
+            validation_errors.concat(JSON::Validator.fully_validate(expected, actual, parse_data: false))
+            suppress_attachment_type_error(validation_errors)
+            validation_errors.empty?
+          end
+          failure_message { validation_errors.join("\n") }
+        end
+
+        matcher :match_param do |expected|
+          match do |actual|
+            JSON::Validator.fully_validate(expected.schema, actual, parse_data: false).empty?
+          end
+          failure_message do |actual|
+            "\"#{expected.name}\": expected \"#{actual}\" to match schema #{expected.schema}"
+          end
+        end
+
+        matcher :match_response_header do |expected|
+          match do |actual|
+            JSON::Validator.fully_validate(expected.schema, actual).empty?
+          end
+          failure_message do |actual|
+            "\"#{expected.name}\": expected \"#{actual}\" to match schema #{expected.schema}"
+          end
+        end
+
+        test_fixture = run_autoapi(oas_filename)
+        # rubocop:disable Metrics/BlockLength
+        test_fixture['test_cases'].each do |test_json|
+          validation_errors = ValidationErrors.new
+          test = TestCase.from_json(test_json)
+          describe test.full_id do
+            after do
+              unless response.nil?
+                Sumo.logger.info TestCaseResult.new(test: test, actual: @response, filename: test_fixture['filename'], info: test_fixture['info'], validation_errors: validation_errors.errors, autoapi_test_id: autoapi_test_id).as_json
+              end
+            end
+            let(:headers) { {} }
+            let(:path_params) { {} }
+            let(:query_params) { {} }
+            let(:body_params) { {} }
+            # run test setup defined by test writer
+            # if a failure is encountered, save and re-raise within the test
+            # so the test run can continue
+            setup_error = nil
+            begin
+              instance_exec test, &block
+            rescue StandardError => e
+              setup_error = e
+            end
+            it 'matches spec' do
+              raise setup_error unless setup_error.nil?
+
+              path = test.path.gsub('{', '%{') % path_params
+              # create query string parameters based on the test,
+              # for the value use the query_params block and fallback to the static example
+              computed_qs_params = Hash[
+                test.query_params.map do |p|
+                  [p['name'], query_params.fetch(p['name'], p['example'])]
+                end
+              ]
+              # merge body and query parameters since rails does not differentiate between them
+              params =
+                case test.request.media_type
+                when ''
+                  computed_qs_params
+                when 'application/json'
+                  computed_qs_params.merge(body_params).to_json
+                when 'multipart/form-data'
+                  computed_qs_params.merge(body_params)
+                else
+                  raise 'Unknown media type'
+                end
+
+              # Add Accept and Content-Type headers if they have not been set
+              # The header's class performs case standardization and handles
+              # whether the user used HTTP_ACCEPT or Accept
+              http_headers = ActionDispatch::Http::Headers.from_hash(headers)
+              unless http_headers.include?('Accept') || test.response.media_type.blank?
+                headers['HTTP_ACCEPT'] = test.response.media_type
+              end
+              unless http_headers.include?('Content-Type') || test.request.media_type.blank?
+                headers['CONTENT_TYPE'] = test.request.media_type
+              end
+
+              output_request path, params, headers
+              process test.method.to_sym, path, params: params, headers: headers
+              output_response response.status, response.body, response.headers
+
+              aggregate_failures 'validate request and response' do
+                # request query string parameters
+                test.query_params.each do |query_param|
+                  expected_query_param = NameAndSchema.new(query_param['name'], query_param['schema'])
+                  query_param_value = computed_qs_params[expected_query_param.name]
+                  validation_errors.process(
+                    expect(query_param_value).to(match_param(expected_query_param))
+                  )
+                end
+                # request headers
+                unless test.request.media_type.blank?
+                  validation_errors.process(
+                    expect(response.request.headers['Content-Type']).to(start_with test.request.media_type)
+                  )
+                end
+                unless test.response.media_type.blank?
+                  validation_errors.process(
+                    expect(response.request.headers['Accept']).to(eq test.response.media_type)
+                  )
+                end
+                # request body
+                unless test.request.body_schema.nil?
+                  validation_errors.process(
+                    expect(body_params).to(match_body(test.request.body_schema))
+                  )
+                end
+                # response status code
+                status_code_mismatch = "Expected response code to be #{test.status} but actual was #{response.status}. \nResponse body: #{response.body}"
+                validation_errors.process(
+                  expect(response).to(have_http_status(test.status), status_code_mismatch)
+                )
+                # response body
+                response_body = response.body.blank? ? response.body : json_response
+                expected_response_body_schema = convert test.response.body_schema
+                if expected_response_body_schema
+                  if test.response.media_type == 'application/json'
+                    validation_errors.process(
+                      expect(response_body).to(match_body(expected_response_body_schema))
+                    )
+                    if expected_response_body_schema['type'] == 'array'
+                      validation_errors.process(
+                        expect(response_body).not_to(be_empty,
+                                                     'Response was an empty list, setup the test so some data is returned')
+                      )
+                    end
+                  else
+                    log_message 'Non-json response bodies are not validated'
+                  end
+                  # response body content-type header
+                  # using start_with instead of eq since the charset
+                  # may be added like "application/json; utf-8"
+                  validation_errors.process(
+                    expect(response.headers['Content-Type']).to(start_with(test.response.media_type))
+                  )
+                else
+                  validation_errors.process(
+                    expect(response_body).to(be_blank)
+                  )
+                end
+                # response headers
+                expected_response_header_schemas = convert test.response.header_schema_map
+                expected_response_header_schemas&.each do |header_key, header_schema|
+                  # Treat all response headers as optional until AutoAPI starts sending
+                  # whether the header is required or optional
+                  if response.has_header? header_key
+                    response_header_value = response.headers[header_key]
+                    expected_response_header = NameAndSchema.new(header_key, header_schema)
+                    validation_errors.process(
+                      expect(response_header_value).to(match_response_header(expected_response_header))
+                    )
+                  end
+                end
+              end
+            end
+          end
+        end
+        # rubocop:enable Metrics/BlockLength
+      end
+    end
+
+  end
+
+
+
+
+
+
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: autoapi_testing
+version: !ruby/object:Gem::Version
+  version: 0.1.9
+platform: ruby
+authors:
+- Danny Porrello
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Testing Description
+email:
+- danny.porrello@procore.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/autoapi/AutoAPI-0.0.1.jar
+- lib/autoapi/convert.rb
+- lib/autoapi/run_autoapi.rb
+- lib/autoapi/test_case.rb
+- lib/autoapi_testing.rb
+- lib/autoapi_testing/version.rb
+homepage: https://example.com
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://example.com
+  source_code_uri: https://example.com
+  changelog_uri: https://example.com
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Testing Summary
+test_files: []