apirunner 0.4.1 → 0.4.2

data/Gemfile

@@ -9,6 +9,7 @@ source "http://rubygems.org"
 gem 'nokogiri', '~> 1.4.3.1'
 gem 'json'
 
+
 group :development do
   gem "rspec", ">= 2.0.0.beta.19"
   gem "cucumber", ">= 0"

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/apirunner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apirunner}
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jan@moviepilot.com"]
-  s.date = %q{2010-10-20}
+  s.date = %q{2010-10-25}
   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 = [
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
     "lib/apirunner.rb",
     "lib/apirunner/railtie.rb",
     "lib/checker.rb",
+    "lib/csv_writer.rb",
     "lib/expectation_matcher.rb",
     "lib/http_client.rb",
     "lib/plugins/plug01_response_json_syntax_checker.rb",
@@ -64,7 +65,8 @@ Gem::Specification.new do |s|
     "spec/http_client_spec.rb",
     "spec/response_body_checker_spec.rb",
     "spec/result_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/testcase_spec.rb"
   ]
   s.homepage = %q{http://github.com/moviepilot/apirunner}
   s.require_paths = ["lib"]
@@ -78,7 +80,8 @@ Gem::Specification.new do |s|
     "spec/http_client_spec.rb",
     "spec/response_body_checker_spec.rb",
     "spec/result_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/testcase_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/api_configuration.rb

@@ -1,6 +1,6 @@
 class ApiConfiguration
 
-  attr_accessor :protocol, :host, :namespace, :port, :verbosity, :priority, :substitution
+  attr_accessor :protocol, :host, :namespace, :port, :verbosity, :priority, :substitution, :csv_mode
 
   # initializes a configuration object from given YAML file for given environment
   def initialize(raw_config, env)
@@ -8,6 +8,7 @@ class ApiConfiguration
     self.verbosity = raw_config['general']['verbosity'].first
     self.priority = raw_config['general']['priority'] || 0
     self.substitution = raw_config['general']['substitution']
+    self.csv_mode = raw_config['general']['csv_mode'].first rescue "none"
     self
   end
 end

data/lib/api_runner.rb

@@ -1,16 +1,17 @@
 class ApiRunner
   require 'yaml'
+  require 'csv_writer'
   require 'string_ext' if not String.respond_to?(:underscore)
   require 'expectation_matcher'
   require 'http_client'
   require 'api_configuration'
   require 'testcase'
-  require 'string_ext'
   require 'json'
 
   CONFIG_FILE = "config/api_runner.yml"
   SPEC_PATH = "test/api_runner/"
   EXCLUDES_FILE = "test/api_runner/excludes.yml"
+  CSV_PATH = "tmp"
 
   # initializes the object, loads environment, build base_uri
   def initialize(env, performance=nil)
@@ -23,12 +24,14 @@ class ApiRunner
     load_url_spec
     @http_client = HttpClient.new(@configuration.protocol, @configuration.host, @configuration.port, @configuration.namespace)
     @expectation = ExpectationMatcher.new(@excludes)
+    @csv_writer = CsvWriter.new(self.class.csv_path, env)
   end
 
   # checks servers availability and invokes test cases
   def run
     if server_is_available?
       run_tests
+      @csv_writer.write(@configuration.csv_mode, @results) unless @results.empty?
       @results.each_with_index do |result, index|
         result.honk_in(@configuration.verbosity, index)
       end unless @results.empty?
@@ -37,7 +40,7 @@ class ApiRunner
     end
     error_count = @results.select{ |r| !r.succeeded }.count
     puts "\n\nResults: I greatfully ran #{ @spec.size } test(s), \033[32m#{ @spec.size - error_count }\033[0m succeeded, \033[31m#{ error_count }\033[0m failed."
-    exit(error_count)
+    return (error_count)
   end
 
   protected
@@ -87,63 +90,7 @@ class ApiRunner
     Dir.new(path).entries.sort.each do |dir_entry|
       specs.push *YAML.load_file(path+dir_entry) if not (File.directory? dir_entry or dir_entry.match(/^\./) or dir_entry.match(/excludes/))
     end
-    @spec = objectize(priorize(partition(explode_iterations(specs))))
-  end
-
-  # explodes specs that include iterations and interpolates the iteration variable into all occuring @@ placeholders
-  def explode_iterations(specs)
-    return specs unless specs.detect{ |s| s['iterations']}
-    exploded_specs = []
-    specs.each do |spec|
-      if spec['iterations'].nil?
-        exploded_specs << spec
-      else
-        1.upto(spec['iterations'].to_i) do |i|
-          exploded_specs << JSON.parse(spec.to_json.gsub(/@@/, "%07d" % i.to_s))
-        end
-      end
-    end
-    return exploded_specs
-  end
-
-  # converts the given array of raw testcases to an array of testcase objects
-  def objectize(raw_specs)
-    specs = []
-    raw_specs.each do |spec|
-      specs << Testcase.new(spec, @configuration.substitution)
-    end
-    specs
-  end
-
-  # returns only spec whose priority level is less or equals configures priority level
-  # if no priority level is configured for the api runner, 0 is assumed
-  # if no priority level ist configured for a story, 0 is assumed
-  def priorize(specs)
-    relevant_specs = []
-    specs.each do |spec|
-      relevant_specs << spec if spec['priority'].nil? or spec['priority'].to_i <= @configuration.priority.to_i
-    end
-    relevant_specs
-  end
-
-  # partitions the spec if keywords like 'focus', 'until' or 'from exist'
-  # and returns the relevant subset of specs that have to be tested then
-  def partition(specs)
-    relevant_specs = []
-    specs.each do |spec|
-      if spec['focus']
-        relevant_specs << spec
-        break
-      elsif spec['until']
-        relevant_specs = specs[0..specs.index(spec)]
-        break
-      elsif spec['from']
-        relevant_specs = specs[specs.index(spec)..specs.size+1]
-        break
-      end
-    end
-    relevant_specs = specs if relevant_specs.empty?
-    relevant_specs
+    @spec = Testcase.expand_specs(specs, @configuration)
   end
 
   # loads and parses items that need to be excluded from the checks in certain environments
@@ -166,4 +113,9 @@ class ApiRunner
   def self.excludes_file
     EXCLUDES_FILE
   end
+  
+  # returns csv file path that can be stubbed
+  def self.csv_path
+    CSV_PATH
+  end
 end

data/lib/csv_writer.rb

@@ -0,0 +1,80 @@
+class CsvWriter
+  require 'csv'
+
+  def initialize(path, env)
+    @file = qualified_csv_path(path, env)
+  end
+
+  # dispatches the configured CSV create style to the matching method
+  def write(method, data)
+    self.send(method.to_sym, convert_to_hash_array(data))
+  end
+
+  protected
+
+  def qualified_csv_path(path, env)
+    return path + "/" + "api_performance_report_#{env}.csv"
+  end
+
+  # appends given data to an existing CSV file
+  # if new testcases come in, their data is appended to the right of the csv
+  # if one or more testcases are missing but were known before, the structure of the csv stays clean
+  # and empty entries are made for these cases
+  # to be refactored!
+  def append(data)
+    STDERR.puts("appending #{data} to file #{@file}")
+    begin
+      # convert old data to array
+      old_data_array = CSV.read(@file, headers: true, header_converters: :symbol).to_a
+
+      # extend the headers by the ones for new testcases
+      data.each do |result|
+        old_data_array[0] << result[:identifier] if not old_data_array[0].include?(result[:identifier].to_sym)
+      end unless data.empty?
+
+      # create the new line column by column in the right order
+      line = []
+      old_data_array[0].each do |header|
+        line << (data.detect{ |field| field[:identifier] == header.to_s }[:runtime] rescue nil)
+      end unless old_data_array[0].empty?
+
+      # append the new line of data to existing data
+      old_data_array << line
+
+      # write the CSV
+      file = File.open(@file, "w")
+      CSV(file, col_sep: ",") do |csv|
+        old_data_array.each do |line|
+          csv << line
+        end
+      end
+      file.close
+    rescue
+      create(data)
+    end
+  end
+
+  # recreates the CSV file and writes the data to it
+  def create(data)
+    file = File.open(@file, "w")
+    CSV(file, col_sep: ",") do |csv|
+      csv << data.map{ |test| test[:identifier] }
+      csv << data.map{ |test| test[:runtime] }
+    end
+    file.close
+  end
+
+  # does not write any data ... for convenience only
+  def none(data)
+  end
+
+  # converts array of testcases into array of hashes containing only identifier and runtime of the testcases
+  def convert_to_hash_array(data)
+    hash_array = []
+    data.each do |result|
+      hash_array << { :identifier => result.testcase.unique_identifier, :runtime => result.response.runtime.round(3) }
+    end
+    return hash_array
+  end
+
+end

data/lib/result.rb

@@ -1,7 +1,6 @@
 class Result
 
-  attr_accessor :succeeded
-  attr_accessor :error_message
+  attr_accessor :succeeded, :error_message, :testcase, :response
 
   def initialize(testcase, response)
     @succeeded = true
@@ -47,7 +46,7 @@ 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.unique_identifier} - \"#{@testcase.name}\""
     puts @error_message
     puts("Request runtime: #{@response.runtime}")
     puts("  More more more verbosity\n")

data/lib/testcase.rb

@@ -1,6 +1,8 @@
 class Testcase
+  require 'digest/md5'
 
   attr_reader :raw, :name, :request, :response_expectation, :wait_before_request
+  @@configuration ||= nil
 
   def initialize(raw, substitution)
     @raw = raw
@@ -11,7 +13,75 @@ class Testcase
     create_resource_substitutes(substitution)
   end
 
+  # creates an array of spec hashes by calling priorize, partition and explode_iterations
+  # to prepare the specs, automagically create the ierting ones and partition them
+  def self.expand_specs(specs, configuration)
+    @@configuration = configuration
+    objectize(partition(explode_iterations(priorize(specs))))
+  end
+
+  # returns an identifier of that testcase that should be unique
+  def unique_identifier
+   Digest::MD5.hexdigest(@name.to_s)[0..9]
+  end
+
   private
+  # explodes specs that include iterations and interpolates the iteration variable into all occuring @@ placeholders
+  def self.explode_iterations(specs)
+    return specs unless specs.detect{ |s| s['iterations']}
+    exploded_specs = []
+    specs.each do |spec|
+      if spec['iterations'].nil?
+        exploded_specs << spec
+      else
+        1.upto(spec['iterations'].to_i) do |i|
+          exploded_specs << JSON.parse(spec.to_json.gsub(/@@/, "%07d" % i.to_s))
+        end
+      end
+    end
+    return exploded_specs
+  end
+
+  # converts the given array of raw testcases to an array of testcase objects
+  def self.objectize(raw_specs)
+    specs = []
+    raw_specs.each do |spec|
+      specs << self.new(spec, @@configuration.substitution)
+    end
+    specs
+  end
+
+  # returns only spec whose priority level is less or equals configures priority level
+  # if no priority level is configured for the api runner, 0 is assumed
+  # if no priority level ist configured for a story, 0 is assumed
+  def self.priorize(specs)
+    relevant_specs = []
+    specs.each do |spec|
+      relevant_specs << spec if spec['priority'].nil? or spec['priority'].to_i <= @@configuration.priority.to_i
+    end
+    relevant_specs
+  end
+
+  # partitions the spec if keywords like 'focus', 'until' or 'from exist'
+  # and returns the relevant subset of specs that have to be tested then
+  def self.partition(specs)
+    relevant_specs = []
+    specs.each do |spec|
+      if spec['focus']
+        relevant_specs << spec
+        break
+      elsif spec['until']
+        relevant_specs = specs[0..specs.index(spec)]
+        break
+      elsif spec['from']
+        relevant_specs = specs[specs.index(spec)..specs.size+1]
+        break
+      end
+    end
+    relevant_specs = specs if relevant_specs.empty?
+    relevant_specs
+  end
+
   # substitutes rersource names cause of race conditions in multiple system scenarios
   def create_resource_substitutes(substitution)
     substitution['substitutes'].each do |substitute|

data/spec/api_runner_spec.rb

@@ -74,17 +74,4 @@ describe 'apirunner' do
     it 'should return true if the requested server is available'
     it 'should return false if the given server is not available'
   end
-
-  describe 'explode_iterations' do
-    it 'should explode iterations if iterations is set to a proper value' do
-      yaml_fixture = [{"name"=>"Create new User", "iterations" => "10", "request"=>{"headers"=>{"Content-Type"=>"application/json"}, "path"=>"/users/duffyduck@@", "method"=>"PUT", "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "expires_at"=>"2011-09-10 00:41:50 +0200"}}, "response_expectation"=>{"status_code"=>201, "headers"=>{"Last-Modified"=>"/.*/"}, "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "fsk"=>"18"}}}]
-      @a.send(:explode_iterations,yaml_fixture).size.should == 10
-      @a.send(:explode_iterations,yaml_fixture).map{ |x| x['request']['path']}.sort.should == ["/users/duffyduck0000001","/users/duffyduck0000002","/users/duffyduck0000003","/users/duffyduck0000004","/users/duffyduck0000005","/users/duffyduck0000006","/users/duffyduck0000007","/users/duffyduck0000008","/users/duffyduck0000009","/users/duffyduck0000010",]
-    end
-    it 'should not explode iterations if iterations is not set' do
-      yaml_fixture = [{"name"=>"Create new User", "request"=>{"headers"=>{"Content-Type"=>"application/json"}, "path"=>"/users/duffyduck@@", "method"=>"PUT", "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "expires_at"=>"2011-09-10 00:41:50 +0200"}}, "response_expectation"=>{"status_code"=>201, "headers"=>{"Last-Modified"=>"/.*/"}, "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "fsk"=>"18"}}}]
-      @a.send(:explode_iterations, yaml_fixture).size.should == 1
-      @a.send(:explode_iterations, yaml_fixture).should eql yaml_fixture
-    end
-  end
 end

data/spec/testcase_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'testcase' do
+  describe 'explode_iterations' do
+    it 'should explode iterations if iterations is set to a proper value' do
+      yaml_fixture = [{"name"=>"Create new User", "iterations" => "10", "request"=>{"headers"=>{"Content-Type"=>"application/json"}, "path"=>"/users/duffyduck@@", "method"=>"PUT", "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "expires_at"=>"2011-09-10 00:41:50 +0200"}}, "response_expectation"=>{"status_code"=>201, "headers"=>{"Last-Modified"=>"/.*/"}, "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "fsk"=>"18"}}}]
+      Testcase.send(:explode_iterations,yaml_fixture).size.should == 10
+      Testcase.send(:explode_iterations,yaml_fixture).map{ |x| x['request']['path']}.sort.should == ["/users/duffyduck0000001","/users/duffyduck0000002","/users/duffyduck0000003","/users/duffyduck0000004","/users/duffyduck0000005","/users/duffyduck0000006","/users/duffyduck0000007","/users/duffyduck0000008","/users/duffyduck0000009","/users/duffyduck0000010",]
+    end
+    it 'should not explode iterations if iterations is not set' do
+      yaml_fixture = [{"name"=>"Create new User", "request"=>{"headers"=>{"Content-Type"=>"application/json"}, "path"=>"/users/duffyduck@@", "method"=>"PUT", "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "expires_at"=>"2011-09-10 00:41:50 +0200"}}, "response_expectation"=>{"status_code"=>201, "headers"=>{"Last-Modified"=>"/.*/"}, "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "fsk"=>"18"}}}]
+      Testcase.send(:explode_iterations, yaml_fixture).size.should == 1
+      Testcase.send(:explode_iterations, yaml_fixture).should eql yaml_fixture
+    end
+  end
+  describe 'unique_identifier' do
+    before(:each) do
+      @testcase_hash = {"name"=>"Create new User", "request"=>{"headers"=>{"Content-Type"=>"application/json"}, "path"=>"/users/duffyduck@@", "method"=>"PUT", "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "expires_at"=>"2011-09-10 00:41:50 +0200"}}, "response_expectation"=>{"status_code"=>201, "headers"=>{"Last-Modified"=>"/.*/"}, "body"=>{"username"=>"duffyduck", "watchlist"=>["m1035", "m2087"], "blacklist"=>["m1554", "m2981"], "skiplist"=>["m1590", "m1056"], "ratings"=>{"m12493"=>4.0, "m1875"=>2.5, "m7258"=>3.0, "m7339"=>4.0, "m3642"=>5.0}, "fsk"=>"18"}}}
+    end
+    it 'should create a certian md5 hash for a certain testcase' do
+      t = Testcase.new(@testcase_hash, nil)
+      t.unique_identifier.should == "eb46f75b6a"
+    end
+    it 'should create a different md5 hash for a the same testcase with minimum changes' do
+      testcase_hash2 = @testcase_hash.merge({"name" => "Create new User with different hash this time"})
+      t = Testcase.new(testcase_hash2, nil)
+      t.unique_identifier.should_not == "eb46f75b6a"
+    end
+    it 'should return a string with length 10' do
+      t = Testcase.new(@testcase_hash, nil)
+      t.unique_identifier.should be_a(String)
+      t.unique_identifier.length.should == 10
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - jan@moviepilot.com
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 +02:00
+date: 2010-10-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -247,6 +247,7 @@ files:
 - lib/apirunner.rb
 - lib/apirunner/railtie.rb
 - lib/checker.rb
+- lib/csv_writer.rb
 - lib/expectation_matcher.rb
 - lib/http_client.rb
 - lib/plugins/plug01_response_json_syntax_checker.rb
@@ -267,6 +268,7 @@ files:
 - spec/response_body_checker_spec.rb
 - spec/result_spec.rb
 - spec/spec_helper.rb
+- spec/testcase_spec.rb
 has_rdoc: true
 homepage: http://github.com/moviepilot/apirunner
 licenses: []
@@ -281,7 +283,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2852718756556817364
+      hash: -952737511013591802
       segments: 
       - 0
       version: "0"
@@ -309,3 +311,4 @@ test_files:
 - spec/response_body_checker_spec.rb
 - spec/result_spec.rb
 - spec/spec_helper.rb
+- spec/testcase_spec.rb