apirunner 0.1.8 → 0.1.9

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.1.9

data/apirunner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apirunner}
-  s.version = "0.1.8"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jan@moviepilot.com"]
-  s.date = %q{2010-09-23}
+  s.date = %q{2010-09-27}
   s.description = %q{apirunner is a testsuite to query your RESTful JSON API and match response with your defined expectations}
   s.email = %q{developers@moviepilot.com}
   s.extra_rdoc_files = [
@@ -34,11 +34,13 @@ Gem::Specification.new do |s|
     "features/apirunner.feature",
     "features/step_definitions/apirunner_steps.rb",
     "features/support/env.rb",
+    "lib/api_configuration.rb",
     "lib/api_runner.rb",
     "lib/apirunner.rb",
     "lib/apirunner/railtie.rb",
     "lib/expectation_matcher.rb",
     "lib/http_client.rb",
+    "lib/result.rb",
     "lib/tasks/api.rake",
     "spec/.rspec",
     "spec/api_runner_spec.rb",

data/examples/config/api_runner.yml

@@ -13,3 +13,9 @@ production:
   host: www.moviepilot.com
   port: 80
   namespace: api1v0
+general:
+  verbosity:
+    - rspec
+    - verbose_on_error
+    - verbose_on_success
+    - verbose_with_curl

data/lib/api_configuration.rb

@@ -0,0 +1,6 @@
+class ApiConfiguration
+
+  attr_accessor :protocol, :host, :namespace, :port, :verbosity
+
+end
+

data/lib/api_runner.rb

@@ -2,6 +2,7 @@ class ApiRunner
   require 'yaml'
   require 'expectation_matcher'
   require 'http_client'
+  require 'api_configuration'
 
   CONFIG_FILE = "config/api_runner.yml"
   SPEC_PATH = "test/api_runner/"
@@ -10,12 +11,13 @@ class ApiRunner
   # initializes the object, loads environment, build base_uri
   def initialize(env)
     @spec = []
-    @errors = []
+    @results = []
     @excludes = []
+    @configuration = ApiConfiguration.new
     load_config(env)
     load_excludes(env)
     load_url_spec
-    @http_client = HttpClient.new(@host, @port, @namespace)
+    @http_client = HttpClient.new(@configuration.host, @configuration.port, @configuration.namespace)
     @expectation = ExpectationMatcher.new(@excludes)
   end
 
@@ -23,11 +25,11 @@ class ApiRunner
   def run
     if server_is_available?
       run_tests
-      @errors.each_with_index do |error, index|
-        puts("\n\nError (#{index+1}): #{error}")
-      end unless @errors.empty?
+      @results.each_with_index do |result, index|
+        result.honk_in(@configuration.verbosity, index)
+      end unless @results.empty?
     else
-      puts("Server #{@host} seems to be unavailable!")
+      puts("Server #{@configuration.host} seems to be unavailable!")
     end
   end
 
@@ -38,13 +40,16 @@ class ApiRunner
     @spec.each do |test_case|
       response = send_request(test_case['request']['method'].downcase.to_sym, test_case['request']['path'], test_case['request']['body'])
       @expectation.test_types.each do |test_type|
-        test = @expectation.check(test_type, response, test_case)
-        if not test.succeeded
-          @errors << test.error
+        result = @expectation.check(test_type, response, test_case)
+        if not result.succeeded
           putc "F"
+          @results << result
           break
         else
-          putc "." if test_type == @expectation.test_types.last
+          if test_type == @expectation.test_types.last
+            @results << result
+            putc "."
+          end
         end
       end
     end
@@ -57,19 +62,20 @@ class ApiRunner
 
   # builds target uri from base uri generated of host port and namespace as well as the ressource path
   def target_uri
-    "#{@protocol}://#{@host}"
+    "#{@configuration.protocol}://#{@configuration.host}"
   end
 
   # returns true if server is available
   def server_is_available?
     return true
-    !@http_client.send_request(:get, "#{@protocol}://#{@host}:#{@port}", {:timeout => 5}).nil?
+    !@http_client.send_request(:get, "#{@configuration.protocol}://#{@configuration.host}:#{@configuration.port}", {:timeout => 5}).nil?
   end
 
   # loads environment config data from yaml file
   def load_config(env)
     config = YAML.load_file(self.class.config_file)
-    config[env.to_s].each { |key, value| instance_variable_set("@#{key}", value) }
+    config[env.to_s].each { |key, value| @configuration.instance_variable_set("@#{key}", value) }
+    @configuration.verbosity = config['general']['verbosity'].first
   end
 
   # loads spec cases from yaml files

data/lib/expectation_matcher.rb

@@ -1,4 +1,5 @@
 class ExpectationMatcher
+  require 'result'
   require 'nokogiri'
   require 'JSON'
 
@@ -21,13 +22,12 @@ class ExpectationMatcher
 
   # matches the given response code
   def response_code(response, testcase)
-    result_struct = Struct.new(:succeeded, :error)
-    results = result_struct.new(:succeeded => true, :error => nil)
+    result = Result.new(testcase, response)
     if not testcase['response_expectation']['status_code'].to_s == response.code.to_s
-      results.succeeded = false
-      results.error = "testcase '#{testcase['name']}'\n expected response code --#{testcase['response_expectation']['status_code']}--\n got response code --#{response.code}--"
+      result.succeeded = false
+      result.error_message = " expected response code --#{testcase['response_expectation']['status_code']}--\n got response code --#{response.code}--"
     end
-    results
+    result
   end
 
   # checks the format of the given data of JSON conformity
@@ -35,55 +35,51 @@ class ExpectationMatcher
   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)
-      results.succeeded = false
-      results.error = "testcase '#{testcase['name']}'\n expected valid JSON in body\n got --#{response.body[1..400]}--"
+      result.succeeded = false
+      result.error_message = "expected valid JSON in body\n got --#{response.body[1..400]}--"
     end
-    results
+    result
   end
 
   # matches the given response header
   def response_headers(response, testcase)
-    result_struct = Struct.new(:succeeded, :error)
-    results = result_struct.new(:succeeded => true, :error => nil)
+    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]))
-          results.succeeded = false
-          results.error = "testcase '#{testcase['name']}'\n expected header identifier --#{header_name}-- to match regex --#{header_value}--\n got --#{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]))
-          results.succeeded = false
-          results.error = "testcase '#{testcase['name']}'\n expected header identifier --#{header_name}-- to match --#{header_value}--\n got --#{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 results
+    return result
   end
 
   # matches the given attributes and values against the ones from the response body
   def response_body(response, testcase)
-    puts("Testcase #{testcase['name']}\n")
-    puts("got response --#{response.body}--\n\n")
-    puts("exp response --#{testcase['response_expectation']['body']}--\n")
-    puts("___________________________\n\n\n")
-    result_struct = Struct.new(:succeeded, :error)
-    results = result_struct.new(:succeeded => true, :error => nil)
+    result = Result.new(testcase, response)
 
     expected_body_hash = testcase['response_expectation']['body']
 
     # in case we have no body expectation we simply return success
-    return results if expected_body_hash.nil?
+    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
-      results.succeeded = false
-      results.error = "testcase '#{testcase['name']}'\n expected response to have a body\n got raw body --#{response.body}-- which is nil or an unparseable hash"
-      return results
+      result = Result.new(testcase, response)
+      result.success = 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...
@@ -97,25 +93,25 @@ class ExpectationMatcher
 
       # return error if response body does not have the expected entry
       if response_node.nil?
-        results.succeeded = false
-        results.error = "testcase '#{testcase['name']}'\n expected body to have identifier --#{expectation_node.name}--\n got nil"
-        return results
+        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))
-          results.succeeded = false
-          results.error = "testcase '#{testcase['name']}'\n expected body identifier --#{expectation_node.name}-- to match regex --#{expectation_node.text}--\n got --#{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))
-          results.succeeded = false
-          results.error = "testcase '#{testcase['name']}'\n expected body identifier --#{expectation_node.name}-- to match --#{expectation_node.text}--\n got --#{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
-    results
+    result
   end
 
   # recursively parses the tree and returns a set of relative pathes

data/lib/result.rb

@@ -0,0 +1,69 @@
+class Result
+
+  attr_accessor :succeeded
+  attr_accessor :error_message
+
+  def initialize(testcase, response)
+    @succeeded = true
+    @testcase = testcase
+    @response = response
+    @error_message = nil
+  end
+
+  # honk out the errors message corresponding to the verbosity configuration the user took
+  def honk_in(verbosity="rspec", index)
+    self.send(verbosity.to_sym, index)
+  end
+
+  private
+
+  # yields out rspec like error messages only in case of an error
+  def rspec(index)
+    if not @succeeded
+      puts "\nError (#{index}) - \"#{@testcase['name']}\""
+      puts @error_message
+    end
+  end
+
+  # yields a more verbose error message only in case of an error
+  def verbose_on_error(index)
+    if not @succeeded
+      be_verbose(index)
+    end
+  end
+
+  # yields a more verbose message in case of an error AND success
+  def verbose_on_success(index)
+    be_verbose(index)
+  end
+
+  # yields a more verbose message in any case and includes a curl command to manually simulate the testcase
+  def verbose_with_curl(index)
+    be_verbose(index)
+    puts "\n  simulate this call with: \"curl TODO\""
+  end
+
+  # yields the verbose error messages
+  def be_verbose(index)
+      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 ("  response status code: #{@testcase['response_expectation']['status_code']}")
+      puts ("  response headers: #{@testcase['response_expectation']['headers']}")
+      puts ("  response body: #{@testcase['response_expectation']['body']}")
+  end
+
+  # returns the result case for interpolation in the output message header
+  def result_case
+    if @succeeded
+      "Success"
+    else
+      "Error"
+    end
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 8
-  version: 0.1.8
+  - 9
+  version: 0.1.9
 platform: ruby
 authors: 
 - jan@moviepilot.com
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 +02:00
+date: 2010-09-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -238,11 +238,13 @@ files:
 - features/apirunner.feature
 - features/step_definitions/apirunner_steps.rb
 - features/support/env.rb
+- lib/api_configuration.rb
 - lib/api_runner.rb
 - lib/apirunner.rb
 - lib/apirunner/railtie.rb
 - lib/expectation_matcher.rb
 - lib/http_client.rb
+- lib/result.rb
 - lib/tasks/api.rake
 - spec/.rspec
 - spec/api_runner_spec.rb
@@ -263,7 +265,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1758241369738370513
+      hash: -2943715373765808099
       segments: 
       - 0
       version: "0"