api-tester 1.1.1 → 1.1.2

data/lib/api-tester/definition/request.rb

@@ -5,10 +5,7 @@ require 'api-tester/definition/boundary_case'
 module ApiTester
   # Class for defining requests in a contract
   class Request
-    attr_accessor :definition
-    attr_accessor :header_fields
-    attr_accessor :fields
-    attr_accessor :query_params
+    attr_accessor :definition, :header_fields, :fields, :query_params
 
     def initialize
       self.fields = []
@@ -27,7 +24,7 @@ module ApiTester
     end
 
     def default_query
-      query_params.map { |param| "#{param.name}=#{param.default_value}" }.join('&')
+      query_params.map { |param| "#{param.name}=#{param.default}" }.join('&')
     end
 
     def add_header_field(new_header)
@@ -39,7 +36,7 @@ module ApiTester
       response = {}
       fields.each do |field|
         if field.required == true
-          response[field.name] = field.default_value
+          response[field.name] = field.default
         end
       end
       response
@@ -50,17 +47,17 @@ module ApiTester
     end
 
     def default_headers
-      if header_fields != []
-        headers
-      else
+      if header_fields == []
         { content_type: :json, accept: :json }
+      else
+        headers
       end
     end
 
     def headers
       header_response = {}
       header_fields.each do |header_field|
-        header_response[header_field.name] = header_field.default_value
+        header_response[header_field.name] = header_field.default
       end
       header_response
     end

data/lib/api-tester/definition/response.rb

@@ -3,8 +3,7 @@
 module ApiTester
   # Class for defining expected responses
   class Response
-    attr_accessor :code
-    attr_accessor :body
+    attr_accessor :code, :body
 
     def initialize(status_code: 200)
       self.code = status_code
@@ -19,7 +18,11 @@ module ApiTester
     def to_s
       des = {}
       body.map do |f|
-        des[f.name] = field_display f
+        if f.has_key
+          des[f.name] = field_display f
+        else
+          des = field_display f
+        end
       end
       des.to_json
     end
@@ -29,7 +32,11 @@ module ApiTester
       if field.subfields?
         des = {}
         field.fields.map do |f|
-          des[f.name] = field_display f
+          if f.has_key
+            des[f.name] = field_display f
+          else
+            des = field_display f
+          end
         end
         des.to_json
       end

data/lib/api-tester/method_case_test.rb

@@ -1,16 +1,11 @@
 # frozen_string_literal: true
 
-require 'api-tester/util/response_evaluator.rb'
+require 'api-tester/util/response_evaluator'
 
 module ApiTester
   # Class for testing methods
   class MethodCaseTest
-    attr_accessor :expected_response
-    attr_accessor :payload
-    attr_accessor :response
-    attr_accessor :reports
-    attr_accessor :url
-    attr_accessor :module_name
+    attr_accessor :expected_response, :payload, :response, :reports, :url, :module_name
 
     def initialize(response:, payload:, expected_response:, url:, verb:, module_name:)
       self.payload = payload
@@ -22,6 +17,7 @@ module ApiTester
     end
 
     def response_code_report
+      print 'F'
       report = StatusCodeReport.new description: "#{module_name} - Incorrect response code",
                                     url: url,
                                     request: payload,
@@ -32,6 +28,7 @@ module ApiTester
     end
 
     def missing_field_report(field)
+      print 'F'
       report = Report.new description: "#{module_name} - Missing field #{field}",
                           url: url,
                           request: payload,
@@ -42,6 +39,7 @@ module ApiTester
     end
 
     def extra_field_report(field)
+      print 'F'
       report = Report.new description: "#{module_name} - Found extra field #{field}",
                           url: url,
                           request: payload,
@@ -53,6 +51,7 @@ module ApiTester
 
     def check
       if check_response_code
+        print '.'
         evaluator = ApiTester::ResponseEvaluator.new actual_body: json_parse(response.body),
                                                      expected_fields: expected_response
         evaluator.missing_fields.map { |field| missing_field_report(field) }
@@ -63,7 +62,8 @@ module ApiTester
     end
 
     def check_response_code
-      if response.code != expected_response.code
+      if response && (response.code != expected_response.code)
+        print 'F'
         response_code_report
         return false
       end

data/lib/api-tester/modules/benchmark_module.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'api-tester/reporter/response_time_report'
+
+module ApiTester
+  # Checks the response times collected during the test run
+  # Note: Needs at least one calling module, like GoodCase, to work
+  module BenchmarkModule
+    def self.go(contract)
+      reports = []
+
+      contract.endpoints.each do |endpoint|
+        longest_time = endpoint.longest_time
+        longest_time[:time] = longest_time[:time] * 1000.0 # Convert from seconds to ms
+        if longest_time[:time] > contract.max_time
+          print 'F'
+          reports << ResponseTimeReport.new(url: endpoint.url,
+                                            verb: longest_time[:verb],
+                                            payload: longest_time[:payload],
+                                            max_time: contract.max_time,
+                                            actual_time: longest_time[:time],
+                                            description: 'BenchmarkModule')
+        else
+          print '.'
+        end
+      end
+
+      reports
+    end
+
+    def self.order
+      99
+    end
+  end
+end

data/lib/api-tester/modules/extra_verbs.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'api-tester/util/supported_verbs'
+require 'api-tester/definition/method'
+require 'api-tester/method_case_test'
 
 module ApiTester
   # Check verbs not explicitly defined in contract
@@ -9,7 +11,7 @@ module ApiTester
       reports = []
 
       contract.endpoints.each do |endpoint|
-        extras = ApiTester::SupportedVerbs.all - endpoint.verbs
+        extras = supported_verbs - endpoint.verbs
         headers = endpoint.methods[0].request.default_headers
         extras.each do |verb|
           verb_case = BoundaryCase.new description: "Verb check with #{verb} for #{endpoint.name}",
@@ -34,6 +36,10 @@ module ApiTester
       reports
     end
 
+    def self.supported_verbs
+      ApiTester::SupportedVerbs.all
+    end
+
     def self.order
       3
     end

data/lib/api-tester/modules/good_case.rb

@@ -11,7 +11,7 @@ module ApiTester
 
       contract.endpoints.each do |endpoint|
         endpoint.methods.each do |method|
-          default_case = BoundaryCase.new description: contract.base_url + endpoint.url,
+          default_case = BoundaryCase.new description: contract.base_url + endpoint.display_url,
                                           payload: method.request.default_payload,
                                           headers: method.request.default_headers
           response = endpoint.call base_url: contract.base_url,

data/lib/api-tester/modules/good_variations.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'api-tester/reporter/status_code_report'
+require 'api-tester/method_case_test'
+
+module ApiTester
+  # Checks the good case as defined in contract
+  module GoodVariations
+    def self.go(contract)
+      reports = []
+
+      contract.endpoints.each do |endpoint|
+        endpoint.methods.each do |method|
+          method.request.fields.each do |field|
+            field.good_cases.each do |value|
+              payload = method.request.default_payload
+              payload[field.name] = value
+              call = BoundaryCase.new description: contract.base_url + endpoint.display_url,
+                                      payload: payload,
+                                      headers: method.request.default_headers
+              response = endpoint.call base_url: contract.base_url,
+                                       method: method,
+                                       payload: payload,
+                                       headers: call.headers
+              test = GoodVariationTest.new response: response,
+                                           url: contract.base_url + endpoint.url,
+                                           method: method
+              reports.concat test.check
+            end
+          end
+          method.request.query_params.each do |field|
+            field.good_cases.each do |value|
+              payload = method.request.default_payload
+              payload[field.name] = value
+              call = BoundaryCase.new description: contract.base_url + endpoint.display_url,
+                                      payload: payload,
+                                      headers: method.request.default_headers
+              response = endpoint.call base_url: contract.base_url,
+                                       method: method,
+                                       payload: payload,
+                                       headers: call.headers
+              test = GoodVariationTest.new response: response,
+                                           url: contract.base_url + endpoint.url,
+                                           method: method
+              reports.concat test.check
+            end
+          end
+        end
+      end
+      reports
+    end
+
+    def self.order
+      1
+    end
+  end
+
+  # Test layout used by module
+  class GoodVariationTest < MethodCaseTest
+    def initialize(response:, url:, method:)
+      super response: response,
+            payload: method.request.default_payload,
+            expected_response: method.expected_response,
+            url: url,
+            verb: method.verb,
+            module_name: 'GoodVariationsModule'
+    end
+  end
+end

data/lib/api-tester/modules/injection_module.rb

@@ -21,7 +21,7 @@ module ApiTester
 
       method.request.fields.each do |field|
         sql_injections.each do |injection|
-          injection_value = "#{field.default_value}#{injection}"
+          injection_value = "#{field.default}#{injection}"
           payload = method.request.altered_payload field_name: field.name,
                                                    value: injection_value
           response = endpoint.call base_url: base_url,
@@ -41,7 +41,12 @@ module ApiTester
     end
 
     def self.check_response(response, endpoint)
-      response.code == 200 || check_error(response, endpoint)
+      if response.code == 200 || check_error(response, endpoint)
+        print '.'
+        return true
+      end
+      print 'F'
+      false
     end
 
     def self.check_error(response, endpoint)
@@ -54,15 +59,16 @@ module ApiTester
       response.code == endpoint.bad_request_response.code &&
         missing_fields.size.zero? && extra_fields.size.zero?
     end
+
+    def self.order
+      5
+    end
   end
 end
 
 # Report for InjectionModule
 class InjectionReport
-  attr_accessor :injection_type
-  attr_accessor :url
-  attr_accessor :payload
-  attr_accessor :response
+  attr_accessor :injection_type, :url, :payload, :response
 
   def initialize(injection_type, url, payload, response)
     self.injection_type = injection_type

data/lib/api-tester/modules/missing_resource.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'api-tester/reporter/status_code_report'
+require 'api-tester/util/supported_verbs'
+require 'pry'
+
+module ApiTester
+  # Module checking various not found scenarios
+  module MissingResource
+    def self.go(contract)
+      reports = []
+
+      contract.endpoints.each do |endpoint|
+        endpoint.path_params.each do |path_param|
+          bad_resource = endpoint.relative_url.gsub("{#{path_param}}", 'gibberish')
+
+          bad_endpoint = ApiTester::Endpoint.new name: 'Bad Resource',
+                                                 relative_url: bad_resource
+          method = ApiTester::Method.new verb: ApiTester::SupportedVerbs::GET,
+                                         response: ApiTester::Response.new(
+                                           status_code: 200
+                                         ),
+                                         request: ApiTester::Request.new
+          response = bad_endpoint.call base_url: contract.base_url + bad_resource,
+                                       method: method,
+                                       payload: {},
+                                       headers: contract.required_headers
+          test = MissingResourceTest.new response,
+                                         {},
+                                         endpoint.not_found_response,
+                                         bad_resource,
+                                         ApiTester::SupportedVerbs::GET
+          test.check
+        end
+      end
+
+      reports
+    end
+
+    def self.allowed_verbs(endpoint)
+      allowances = []
+      endpoint.methods.each do |method|
+        allowances << method.verb
+      end
+      allowances.uniq
+    end
+
+    def self.order
+      4
+    end
+  end
+
+  # Test layout for Missing Resource
+  class MissingResourceTest < MethodCaseTest
+    def initialize(response, payload, expected_response, url, verb)
+      super response: response,
+            payload: payload,
+            expected_response: expected_response,
+            url: url,
+            verb: verb,
+            module_name: 'Missing Resource'
+    end
+  end
+end

data/lib/api-tester/modules/server_information.rb

@@ -26,8 +26,7 @@ end
 
 # Report used by module
 class ServerBroadcastReport
-  attr_accessor :server_info
-  attr_accessor :server_key
+  attr_accessor :server_info, :server_key
 
   def initialize(server_info, server_key)
     self.server_info = server_info

data/lib/api-tester/modules/typo.rb

@@ -9,7 +9,9 @@ module ApiTester
     def self.go(contract)
       reports = []
 
-      contract.endpoints.each do |endpoint|
+      # Filtering out endpoints with ids since not a better way to check this
+      # Need to redesign system to handle this better
+      contract.endpoints.reject { |e| e.relative_url.include?('{') }.each do |endpoint|
         allowances(endpoint).each do
           reports.concat check_typo_url(contract.base_url, endpoint)
         end

data/lib/api-tester/modules/unused_fields.rb

@@ -10,7 +10,7 @@ module ApiTester
 
       contract.endpoints.each do |endpoint|
         endpoint.methods.each do |method|
-          method.expected_response.body.each do |field|
+          method.expected_response.body.filter(&:has_key).each do |field|
             next unless field.is_seen.zero?
 
             reports << MissingFieldReport.new(url: endpoint.url,

data/lib/api-tester/reporter/api_report.rb

@@ -31,14 +31,15 @@ module ApiTester
     end
 
     def print
+      puts ''
       if reports.size.zero?
         puts 'No issues found'
       else
         puts "Issues discovered: #{reports.size}"
         reports.each do |report|
           report.print
-          puts '\n'
-          puts '\n'
+          puts ''
+          puts ''
         end
         puts "Total issues: #{reports.size}"
       end

data/lib/api-tester/reporter/missing_field_report.rb

@@ -3,10 +3,7 @@
 module ApiTester
   # Report used for when response is missing a field
   class MissingFieldReport
-    attr_accessor :url
-    attr_accessor :verb
-    attr_accessor :expected_field
-    attr_accessor :description
+    attr_accessor :url, :verb, :expected_field, :description
 
     def initialize(url:, verb:, expected_field:, description:)
       self.url = url

data/lib/api-tester/reporter/report.rb

@@ -3,11 +3,7 @@
 module ApiTester
   # Standard report format for differing responses
   class Report
-    attr_accessor :description
-    attr_accessor :url
-    attr_accessor :request
-    attr_accessor :expected_response
-    attr_accessor :actual_response
+    attr_accessor :description, :url, :request, :expected_response, :actual_response
 
     def initialize(description:, url:, request:, expected_response:, actual_response:)
       self.description = description
@@ -22,7 +18,7 @@ module ApiTester
       puts "   Requested #{url} with payload:"
       puts "      #{request.to_json}"
       puts '   Expecting: '
-      puts '      ' + expected_response.to_s
+      puts "      #{expected_response}"
       puts '   Receiving: '
       puts "      #{actual_response}"
     end

data/lib/api-tester/reporter/response_time_report.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ApiTester
+  # Report used for when response took too long
+  class ResponseTimeReport
+    attr_accessor :url, :verb, :payload, :max_time, :actual_time, :description
+
+    def initialize(url:, verb:, payload:, max_time:, actual_time:, description:)
+      self.url = url
+      self.verb = verb
+      self.payload = payload
+      self.max_time = max_time
+      self.actual_time = actual_time
+      self.description = description
+    end
+
+    def print
+      puts "#{description}:"
+      puts "   #{verb} #{url} took #{actual_time}ms, the max time is #{max_time}ms:"
+      puts '     Payload:'
+      puts "      #{payload}"
+    end
+  end
+end

data/lib/api-tester/reporter/status_code_report.rb

@@ -5,8 +5,7 @@ require 'api-tester/reporter/report'
 module ApiTester
   # Report for when status code is different than expected
   class StatusCodeReport < Report
-    attr_accessor :expected_status_code
-    attr_accessor :actual_status_code
+    attr_accessor :expected_status_code, :actual_status_code
 
     def initialize(description:, url:, request:, expected_status_code:, actual_status_code:)
       super description: description,

data/lib/api-tester/test_helper.rb

@@ -3,6 +3,8 @@
 module ApiTester
   # Interface for when things need to be done before or after an api call
   class TestHelper
+    def initialize(url); end
+
     def before; end
 
     def retrieve_param(key); end

data/lib/api-tester/util/response_evaluator.rb

@@ -3,12 +3,12 @@
 module ApiTester
   # Class for evaluating responses against what is expected
   class ResponseEvaluator
-    attr_accessor :response_body
-    attr_accessor :expected_response
+    attr_accessor :response_body, :expected_response, :expected_fields_hash
 
     def initialize(actual_body:, expected_fields:)
       self.response_body = actual_body
       self.expected_response = expected_fields
+      self.expected_fields_hash = expected_field_array(expected_response.body)
     end
 
     def response_field_array
@@ -29,10 +29,6 @@ module ApiTester
       seen
     end
 
-    def expected_fields_hash
-      expected_field_array expected_response.body
-    end
-
     def extra_fields
       response_field_array - expected_fields
     end
@@ -44,9 +40,14 @@ module ApiTester
     def expected_field_array(expected_fields)
       fields = {}
       expected_fields.each do |field|
-        fields[field.name] = field
+        field_name = field.name
+        if field.has_key
+          fields[field.name] = field
+        else
+          field_name = field.type
+        end
         fields = fields.merge inner_expected_field(expected_fields: field.fields,
-                                                   name: field.name)
+                                                   name: field_name)
       end
       fields
     end
@@ -55,7 +56,11 @@ module ApiTester
       fields = {}
       expected_fields.each do |field|
         inner_name = "#{name}.#{field.name}"
-        fields[inner_name] = field
+        if field.has_key
+          fields[inner_name] = field
+        else
+          inner_name = "#{name}.#{field.type}"
+        end
         fields = fields.merge inner_expected_field(expected_fields: field.fields,
                                                    name: inner_name)
       end
@@ -65,21 +70,31 @@ module ApiTester
     def field_array(object)
       fields = []
 
-      object.each do |key, value|
-        if key.respond_to?('each')
-          fields.concat(field_array(key))
-        elsif value == nil || value == 0 || value == false
-          fields << key.to_s
-          fields.concat(field_array(value).map { |i| "#{key}.#{i}" })
-        elsif value.to_s[0] == '[' && value.to_s[-1] == ']' && !value.to_s.include?('=>')
-          fields << key.to_s
-        elsif value
-          fields << key.to_s
-          fields.concat(field_array(value).map { |i| "#{key}.#{i}" })
-        else
-          fields.concat(field_array(key))
+      if object.instance_of?(Array)
+        name = 'array'
+        fields.concat(field_array(object[0]).map { |i| "#{name}.#{i}" })
+      else
+        object.each do |key, value|
+          if key.respond_to?('each')
+            fields.concat(field_array(key))
+          elsif value == nil || value == 0 || value == false
+            fields << key.to_s
+            fields.concat(field_array(value).map { |i| "#{key}.#{i}" })
+          elsif value.to_s[0] == '[' && value.to_s[-1] == ']' && !value.to_s.include?('=>')
+            fields << key.to_s
+          elsif value
+            passed_value = value
+            fields << key.to_s
+            if value.instance_of?(Array)
+              passed_value = value[0]
+            end
+            fields.concat(field_array(passed_value).map { |i| "#{key}.#{i}" })
+          else
+            fields.concat(field_array(key))
+          end
         end
       end
+
       fields
     rescue NoMethodError
       fields

data/lib/api-tester/util/supported_verbs.rb

@@ -12,8 +12,8 @@ module ApiTester
       @hash[key]
     end
 
-    def self.each
-      @hash.each { |key, value| yield(key, value) }
+    def self.each(&block)
+      @hash.each(&block)
     end
 
     def self.all

data/lib/api-tester/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApiTester
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end