apirunner 0.2.4 → 0.2.5

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/apirunner.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apirunner}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jan@moviepilot.com"]
@@ -44,8 +44,13 @@ Gem::Specification.new do |s|
     "lib/api_runner.rb",
     "lib/apirunner.rb",
     "lib/apirunner/railtie.rb",
+    "lib/body_checker.rb",
+    "lib/checker.rb",
     "lib/expectation_matcher.rb",
+    "lib/header_checker.rb",
     "lib/http_client.rb",
+    "lib/json_syntax_checker.rb",
+    "lib/response_code_checker.rb",
     "lib/result.rb",
     "lib/tasks/api.rake",
     "lib/testcase.rb",

data/lib/body_checker.rb

@@ -0,0 +1,65 @@
+class BodyChecker < Checker
+
+  def check
+    result = Result.new(@testcase, @response)
+
+    # special case: the whole body has to be matched via a regular expression
+    if is_regex?(@testcase.response_expectation['body'])
+      if not regex_matches?(@testcase.response_expectation['body'], @response.body)
+        result.succeeded = false
+        result.error_message = " expected the whole body to match regex --#{@testcase.response_expectation['body']}--\n got --#{@response.body}--"
+      end
+      return result
+    end
+
+    expected_body_hash = @testcase.response_expectation['body']
+
+    # in case we have no body expectation we simply return success
+    return result if expected_body_hash.nil?
+
+    # in case the response body is nil or damaged we return an error
+    begin
+      responded_body_hash = JSON.parse(@response.body)
+    rescue
+      result = Result.new(@testcase, @response)
+      result.succeeded = false
+      result.error_message = " expected response to have a body\n got raw body --#{@response.body}-- which is nil or an unparseable hash"
+      return result
+    end
+
+    # else we build trees from both body structures...
+    expectation_tree = Nokogiri::XML(expected_body_hash.to_xml({ :indent => 0 }))
+    response_tree = Nokogiri::XML(responded_body_hash.to_xml({ :indent => 0 }))
+
+    # retrieve all the leafs pathes and match the leafs values using xpath
+    matcher_pathes_from(expectation_tree).each do |path|
+      expectation_node = expectation_tree.xpath(path).first
+      response_node = response_tree.xpath(path).first
+
+      debugger
+      # in some (not awesome) cases the root node occures as leaf, so we have to skip him here
+      next if expectation_node.name == "hash"
+
+      # return error if response body does not have the expected entry
+      if response_node.nil?
+        result.succeeded = false
+        result.error_message = " expected body to have identifier --#{expectation_node.name}--\n got nil"
+        return result
+      end
+
+      # last but not least try the regex or direct match and return errors in case of any
+      if is_regex?(expectation_node.text)
+        if not (excluded?(expectation_node.name) or regex_matches?(expectation_node.text, response_node.text))
+          result.succeeded = false
+          result.error_message = " expected body identifier --#{expectation_node.name}-- to match regex --#{expectation_node.text}--\n got --#{response_node.text}--"
+        end
+      else
+        if not (excluded?(expectation_node.name) or string_matches?(expectation_node.text, response_node.text))
+          result.succeeded = false
+          result.error_message = " expected body identifier --#{expectation_node.name}-- to match --#{expectation_node.text}--\n got --#{response_node.text}--"
+        end
+      end
+    end
+    result
+  end
+end

data/lib/checker.rb

@@ -0,0 +1,66 @@
+class Checker
+
+  def initialize(testcase, response, excludes=nil)
+    @testcase = testcase
+    @response = response
+    @excludes = excludes
+  end
+
+  # executes the checking routine and returns a result object
+  # to be overwritten in child classes
+  def check
+    result = Result.new(@testcase, @response)
+  end
+
+private
+
+  # recursively parses the tree and returns a set of relative pathes
+  # that can be used to match the both trees leafs
+  def matcher_pathes_from(node, pathes = nil)
+    pathes ||= []
+    if not node.children.blank?
+      node.children.each do |sub_node|
+        matcher_pathes_from(sub_node, pathes)
+      end
+    else
+      pathes << relative_path(node.parent.path)
+    end
+    pathes
+  end
+
+  # returns relative path for matching the target tree of the response body
+  # explicit array adressing is replaced by *
+  def relative_path(path)
+    path.gsub(/\/([^\/]+)\[\d+\]\//i,"/*/")
+  end
+
+  # returns true if given attributes is an excluded item that does not have to be evaluated in this environment
+  def excluded?(item)
+    @excludes.include?(item)
+  end
+
+  # returns true if given string seems to be a regular expression
+  def is_regex?(string)
+    string.to_s.match(/^\/.+\/$/)
+  end
+
+  # returns true if the given regular expression matches the given value
+  def regex_matches?(regex, value)
+    regex = Regexp.compile( regex.gsub(/^\//, '').gsub(/\/$/,'') )
+    !!value.to_s.match(regex)
+  end
+
+  # returns true if the given string exactly matches the given value
+  def string_matches?(string, value)
+    string.to_s == value.to_s
+  end
+
+  # parses output into JSON object
+  def valid_json?(response_body)
+    # responses may be nil, return true then
+    return true if response_body.blank?
+    # returns true if given response is valid json, else false
+    JSON.parse(response_body.to_s) rescue false
+  end
+
+end

data/lib/expectation_matcher.rb

@@ -2,6 +2,11 @@ class ExpectationMatcher
   require 'result'
   require 'nokogiri'
   require 'JSON'
+  require 'checker'
+  require 'json_syntax_checker'
+  require 'header_checker'
+  require 'response_code_checker'
+  require 'body_checker'
 
   def initialize(excludes=nil)
     @test_types = [:response_code, :response_body_format, :response_headers, :response_body]
@@ -22,156 +27,21 @@ class ExpectationMatcher
 
   # matches the given response code
   def response_code(response, testcase)
-    result = Result.new(testcase, response)
-    if not testcase.response_expectation['status_code'].to_s == response.code.to_s
-      result.succeeded = false
-      result.error_message = " expected response code --#{testcase.response_expectation['status_code']}--\n got response code --#{response.code}--"
-    end
-    result
+    ResponseCodeChecker.new(testcase, response).check
   end
 
   # checks the format of the given data of JSON conformity
   def response_body_format(response, testcase)
-    result_struct = Struct.new(:succeeded, :error)
-    results = result_struct.new(:succeeded => true, :error => nil)
-    result = Result.new(testcase, response)
-    if not valid_json?(response.body)
-      result.succeeded = false
-      result.error_message = "expected valid JSON in body\n got --#{response.body[1..400]}--"
-    end
-    result
+    JsonSyntaxChecker.new(testcase, response).check
   end
 
   # matches the given response header
   def response_headers(response, testcase)
-    result = Result.new(testcase, response)
-
-    testcase.response_expectation['headers'].each_pair do |header_name, header_value|
-      if is_regex?(header_value)
-        if not (excluded?(header_name) or regex_matches?(header_value, response.headers[header_name]))
-          result.succeeded = false
-          result.error_message = " expected header identifier --#{header_name}-- to match regex --#{header_value}--\n got --#{response.headers[header_name]}--"
-        end
-      else
-        if not (excluded?(header_name) or string_matches?(header_value, response.headers[header_name]))
-          result.succeeded = false
-          result.error_message = " expected header identifier --#{header_name}-- to match --#{header_value}--\n got --#{response.headers[header_name]}--"
-        end
-      end
-    end unless (testcase.response_expectation['headers'].nil? or testcase.response_expectation['headers'].empty?)
-    return result
+    HeaderChecker.new(testcase, response, @excludes).check
   end
 
   # matches the given attributes and values against the ones from the response body
   def response_body(response, testcase)
-    result = Result.new(testcase, response)
-
-    # special case: the whole body has to be matched via a regular expression
-    if is_regex?(testcase.response_expectation['body'])
-      if not regex_matches?(testcase.response_expectation['body'], response.body)
-        result.succeeded = false
-        result.error_message = " expected the whole body to match regex --#{testcase.response_expectation['body']}--\n got --#{response.body}--"
-      end
-      return result
-    end
-
-    expected_body_hash = testcase.response_expectation['body']
-
-    # in case we have no body expectation we simply return success
-    return result if expected_body_hash.nil?
-
-    # in case the response body is nil or damaged we return an error
-    begin
-      responded_body_hash = JSON.parse(response.body)
-    rescue
-      result = Result.new(testcase, response)
-      result.succeeded = false
-      result.error_message = " expected response to have a body\n got raw body --#{response.body}-- which is nil or an unparseable hash"
-      return result
-    end
-
-    # else we build trees from both body structures...
-    expectation_tree = Nokogiri::XML(expected_body_hash.to_xml({ :indent => 0 }))
-    response_tree = Nokogiri::XML(responded_body_hash.to_xml({ :indent => 0 }))
-
-    # retrieve all the leafs pathes and match the leafs values using xpath
-    matcher_pathes_from(expectation_tree).each do |path|
-      expectation_node = expectation_tree.xpath(path).first
-      response_node = response_tree.xpath(path).first
-
-      debugger
-      # in some (not awesome) cases the root node occures as leaf, so we have to skip him here
-      next if expectation_node.name == "hash"
-
-      # return error if response body does not have the expected entry
-      if response_node.nil?
-        result.succeeded = false
-        result.error_message = " expected body to have identifier --#{expectation_node.name}--\n got nil"
-        return result
-      end
-
-      # last but not least try the regex or direct match and return errors in case of any
-      if is_regex?(expectation_node.text)
-        if not (excluded?(expectation_node.name) or regex_matches?(expectation_node.text, response_node.text))
-          result.succeeded = false
-          result.error_message = " expected body identifier --#{expectation_node.name}-- to match regex --#{expectation_node.text}--\n got --#{response_node.text}--"
-        end
-      else
-        if not (excluded?(expectation_node.name) or string_matches?(expectation_node.text, response_node.text))
-          result.succeeded = false
-          result.error_message = " expected body identifier --#{expectation_node.name}-- to match --#{expectation_node.text}--\n got --#{response_node.text}--"
-        end
-      end
-    end
-    result
-  end
-
-  # recursively parses the tree and returns a set of relative pathes
-  # that can be used to match the both trees leafs
-  def matcher_pathes_from(node, pathes = nil)
-    pathes ||= []
-    if not node.children.blank?
-      node.children.each do |sub_node|
-        matcher_pathes_from(sub_node, pathes)
-      end
-    else
-      pathes << relative_path(node.parent.path)
-    end
-    pathes
-  end
-
-  # returns relative path for matching the target tree of the response body
-  # explicit array adressing is replaced by *
-  def relative_path(path)
-    path.gsub(/\/([^\/]+)\[\d+\]\//i,"/*/")
-  end
-
-  # returns true if given attributes is an excluded item that does not have to be evaluated in this environment
-  def excluded?(item)
-    @excludes.include?(item)
-  end
-
-  # returns true if given string seems to be a regular expression
-  def is_regex?(string)
-    string.to_s.match(/^\/.+\/$/)
-  end
-
-  # returns true if the given regular expression matches the given value
-  def regex_matches?(regex, value)
-    regex = Regexp.compile( regex.gsub(/^\//, '').gsub(/\/$/,'') )
-    !!value.to_s.match(regex)
-  end
-
-  # returns true if the given string exactly matches the given value
-  def string_matches?(string, value)
-    string.to_s == value.to_s
-  end
-
-  # parses output into JSON object
-  def valid_json?(response_body)
-    # responses may be nil, return true then
-    return true if response_body.blank?
-    # returns true if given response is valid json, else false
-    JSON.parse(response_body.to_s) rescue false
+    BodyChecker.new(testcase, response, @excludes).check
   end
 end

data/lib/header_checker.rb

@@ -0,0 +1,22 @@
+class HeaderChecker < Checker
+
+  # checks given header against the given expepctation and returns a result object
+  def check
+    result = Result.new(@testcase, @response)
+    @testcase.response_expectation['headers'].each_pair do |header_name, header_value|
+      if is_regex?(header_value)
+        if not (excluded?(header_name) or regex_matches?(header_value, @response.headers[header_name]))
+          result.succeeded = false
+          result.error_message = " expected header identifier --#{header_name}-- to match regex --#{header_value}--\n got --#{@response.headers[header_name]}--"
+        end
+      else
+        if not (excluded?(header_name) or string_matches?(header_value, @response.headers[header_name]))
+          result.succeeded = false
+          result.error_message = " expected header identifier --#{header_name}-- to match --#{header_value}--\n got --#{@response.headers[header_name]}--"
+        end
+      end
+    end unless (@testcase.response_expectation['headers'].nil? or @testcase.response_expectation['headers'].empty?)
+    result
+  end
+
+end

data/lib/json_syntax_checker.rb

@@ -0,0 +1,13 @@
+class JsonSyntaxChecker < Checker
+
+  # checks if the given testcase body represents syntactically valid JSON
+  def check
+    result = Result.new(@testcase, @response)
+    if not valid_json?(@response.body)
+      result.succeeded = false
+      result.error_message = "expected valid JSON in body\n got --#{@response.body[1..400]}--"
+    end
+    result
+  end
+
+end

data/lib/response_code_checker.rb

@@ -0,0 +1,13 @@
+class ResponseCodeChecker < Checker
+
+  # checks the given responses status code against the one in the expectation and returns result object
+  def check
+    result = Result.new(@testcase, @response)
+    if not @testcase.response_expectation['status_code'].to_s == @response.code.to_s
+      result.succeeded = false
+      result.error_message = " expected response code --#{@testcase.response_expectation['status_code']}--\n got response code --#{@response.code}--"
+    end
+    result
+  end
+
+end

data/lib/result.rb

@@ -43,17 +43,17 @@ class Result
 
   # yields the verbose error messages
   def be_verbose(index)
-    puts "\n#{result_case} (#{index+1}) - \"#{@testcase['name']}\""
+    puts "\n#{result_case} (#{index+1}) - \"#{@testcase.name}\""
     puts @error_message
     puts("  More more more verbosity\n")
-    puts("  request method: #{@testcase['request']['method']}")
-    puts("  resource path: #{@testcase['request']['path']}")
-    puts("  request headers: #{@testcase['request']['headers']}")
-    puts("  JSON body sent: #{@testcase['request']['body']}")
+    puts("  request method: #{@testcase.request['method']}")
+    puts("  resource path: #{@testcase.request['path']}")
+    puts("  request headers: #{@testcase.request['headers']}")
+    puts("  JSON body sent: #{@testcase.request['body']}")
     puts("  expectation:")
-    puts("    response status code: #{@testcase['response_expectation']['status_code']}")
-    puts("    response headers: #{@testcase['response_expectation']['headers']}")
-    puts("    response body: #{@testcase['response_expectation']['body']}")
+    puts("    response status code: #{@testcase.response_expectation['status_code']}")
+    puts("    response headers: #{@testcase.response_expectation['headers']}")
+    puts("    response body: #{@testcase.response_expectation['body']}")
     puts("  result:")
     puts("    response status code: #{@response.code}")
     puts("    response headers: #{@response.headers}")

data/lib/testcase.rb

@@ -1,9 +1,10 @@
 class Testcase
 
-  attr_reader :raw, :request, :response_expectation
+  attr_reader :raw, :name, :request, :response_expectation
 
   def initialize(raw)
     @raw = raw
+    @name = raw['name']
     @request = @raw['request']
     @response_expectation = @raw['response_expectation']
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - jan@moviepilot.com
@@ -248,8 +248,13 @@ files:
 - lib/api_runner.rb
 - lib/apirunner.rb
 - lib/apirunner/railtie.rb
+- lib/body_checker.rb
+- lib/checker.rb
 - lib/expectation_matcher.rb
+- lib/header_checker.rb
 - lib/http_client.rb
+- lib/json_syntax_checker.rb
+- lib/response_code_checker.rb
 - lib/result.rb
 - lib/tasks/api.rake
 - lib/testcase.rb
@@ -272,7 +277,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4241672918987621375
+      hash: 197723826225118285
       segments: 
       - 0
       version: "0"