kronk 1.4.0 → 1.5.0

data/History.rdoc

@@ -1,3 +1,25 @@
+=== 1.5.0 / 2011-08-11
+
+* Major Enhancements:
+
+  * JSON is the primary output format (instead of Ruby).
+
+  * Support for replay functionality from log files.
+
+  * Support for Suite, Stream, and Benchmark outputs.
+
+  * A great deal of Kronk, Cmd, Request and Response class refactoring.
+
+  * Plist and Nokogiri dependencies optional, based on usage.
+
+* Enhancements:
+
+  * Configurable output indentation.
+
+* Bugfixes:
+
+  * Custom config files would never load.
+
 === 1.4.0 / 2011-07-04
 
 * Enhancements:

data/Manifest.txt

@@ -4,15 +4,22 @@ Manifest.txt
 README.rdoc
 Rakefile
 bin/kronk
-bin/yzma
 lib/kronk.rb
+lib/kronk/constants.rb
 lib/kronk/cmd.rb
-lib/kronk/data_set.rb
+lib/kronk/data_renderer.rb
 lib/kronk/diff.rb
 lib/kronk/diff/ascii_format.rb
 lib/kronk/diff/color_format.rb
 lib/kronk/path.rb
 lib/kronk/path/transaction.rb
+lib/kronk/player.rb
+lib/kronk/player/benchmark.rb
+lib/kronk/player/input_reader.rb
+lib/kronk/player/output.rb
+lib/kronk/player/request_parser.rb
+lib/kronk/player/suite.rb
+lib/kronk/player/stream.rb
 lib/kronk/plist_parser.rb
 lib/kronk/request.rb
 lib/kronk/response.rb
@@ -21,9 +28,6 @@ lib/kronk/test/assertions.rb
 lib/kronk/test/core_ext.rb
 lib/kronk/test/helper_methods.rb
 lib/kronk/xml_parser.rb
-lib/yzma.rb
-lib/yzma/randomizer.rb
-lib/yzma/report.rb
 script/kronk_completion
 test/mocks/200_response.json
 test/mocks/200_response.plist
@@ -31,15 +35,20 @@ test/mocks/200_response.txt
 test/mocks/200_response.xml
 test/mocks/301_response.txt
 test/mocks/302_response.txt
+test/mocks/cookies.yml
+test/mocks/get_request.txt
 test/test_assertions.rb
 test/test_core_ext.rb
+test/test_cmd.rb
 test/test_helper_methods.rb
-test/test_data_set.rb
 test/test_diff.rb
 test/test_helper.rb
+test/test_input_reader.rb
 test/test_kronk.rb
 test/test_path.rb
+test/test_player.rb
 test/test_request.rb
+test/test_request_parser.rb
 test/test_response.rb
 test/test_transaction.rb
 test/test_xml_parser.rb

data/README.rdoc

@@ -29,7 +29,7 @@ Kronk was made possible by the sponsoring of AT&T Interactive.
 
 * Helper methods for test suites.
 
-* Auto-query reports with request randomization support.
+* Query and logfile playback with custom output.
 
 * Yes, it works on Windows.
 
@@ -141,6 +141,10 @@ Assign a default host to use when none is specified:
 
   :default_host: http://localhost:3000
 
+Set the number of spaces for indentation:
+
+  :indentation: 2
+
 === Bash Completion:
 
 Bash completion is available by sourcing the file returned by:
@@ -190,7 +194,6 @@ attribute, you can do so by appending "/.." to the path.
   {
     "data" => {
       "path2" => [
-        nil,
         {
           "first_child" => "first value",
           "child" => "child value",
@@ -262,10 +265,6 @@ single quotes around some of your paths.
 
 == REQUIREMENTS:
 
-* nokogiri gem
-
-* plist gem
-
 * json gem
 
 * cookiejar gem

data/Rakefile

@@ -22,12 +22,12 @@ Hoe.spec 'kronk' do
   self.history_file     = "History.rdoc"
   self.extra_rdoc_files = FileList['*.rdoc']
 
-  self.extra_deps << ['plist',         '~>3.1.0']
-  self.extra_deps << ['json',          '~>1.5']
-  self.extra_deps << ['nokogiri',      '~>1.4']
-  self.extra_deps << ['cookiejar',     '~>0.3.0']
+  self.extra_deps << ['json',      '~>1.5']
+  self.extra_deps << ['cookiejar', '~>0.3.0']
 
-  self.extra_dev_deps << ['mocha', '~>0.9.10']
+  self.extra_dev_deps << ['plist',    '~>3.1.0']
+  self.extra_dev_deps << ['nokogiri', '~>1.4']
+  self.extra_dev_deps << ['mocha',    '~>0.9.12']
 end
 
 

data/lib/kronk.rb

@@ -3,6 +3,10 @@ require 'rubygems'
 require 'json'
 require 'cookiejar'
 
+require 'thread'
+require 'stringio'
+require 'base64'
+
 require 'net/https'
 require 'optparse'
 require 'yaml'
@@ -10,13 +14,20 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.4.0'
-
-
+  VERSION = '1.5.0'
+
+  require 'kronk/constants'
+  require 'kronk/player'
+  require 'kronk/player/output'
+  require 'kronk/player/suite'
+  require 'kronk/player/stream'
+  require 'kronk/player/benchmark'
+  require 'kronk/player/request_parser'
+  require 'kronk/player/input_reader'
   require 'kronk/cmd'
   require 'kronk/path'
   require 'kronk/path/transaction'
-  require 'kronk/data_set'
+  require 'kronk/data_renderer'
   require 'kronk/diff/ascii_format'
   require 'kronk/diff/color_format'
   require 'kronk/diff'
@@ -26,74 +37,6 @@ class Kronk
   require 'kronk/xml_parser'
 
 
-  # Config directory.
-  CONFIG_DIR = File.expand_path "~/.kronk"
-
-  # Default config file to load. Defaults to ~/.kronk.
-  DEFAULT_CONFIG_FILE = File.join CONFIG_DIR, "rc"
-
-  # Default cache file.
-  DEFAULT_CACHE_FILE = File.join CONFIG_DIR, "cache"
-
-  # Default cookies file.
-  DEFAULT_COOKIES_FILE = File.join CONFIG_DIR, "cookies"
-
-  # Default file with history of unique URIs. (Used for autocomplete)
-  DEFAULT_HISTORY_FILE = File.join CONFIG_DIR, "history"
-
-
-  # Default Content-Type header to parser mapping.
-  DEFAULT_CONTENT_TYPES = {
-    'js'      => 'JSON',
-    'json'    => 'JSON',
-    'plist'   => 'PlistParser',
-    'xml'     => 'XMLParser'
-  }
-
-
-  # Aliases for various user-agents. Thanks Mechanize! :)
-  USER_AGENTS = {
-    'kronk'         =>
-    "Kronk/#{VERSION} (http://github.com/yaksnrainbows/kronk)",
-    'iphone'        =>
-    "Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1C28 Safari/419.3",
-    'linux_firefox' =>
-    "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.1) Gecko/20100122 firefox/3.6.1",
-    'linux_mozilla' =>
-    "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4) Gecko/20030624",
-    'mac_mozilla'   =>
-    "Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.4a) Gecko/20030401",
-    'linux_konqueror' =>
-    "Mozilla/5.0 (compatible; Konqueror/3; Linux)",
-    'mac_firefox'   =>
-    "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2) Gecko/20100115 Firefox/3.6",
-    'mac_safari'    =>
-    "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_2; de-at) AppleWebKit/531.21.8 (KHTML, like Gecko) Version/4.0.4 Safari/531.21.10",
-    'win_ie6'       =>
-    "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)",
-    'win_ie7'       =>
-    "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)",
-    'win_mozilla'   =>
-    "Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4b) Gecko/20030516 Mozilla Firebird/0.6"
-  }
-
-
-  # Default config to use.
-  DEFAULT_CONFIG = {
-    :content_types  => DEFAULT_CONTENT_TYPES.dup,
-    :cache_file     => DEFAULT_CACHE_FILE,
-    :cookies_file   => DEFAULT_COOKIES_FILE,
-    :default_host   => "http://localhost:3000",
-    :diff_format    => :ascii_diff,
-    :history_file   => DEFAULT_HISTORY_FILE,
-    :requires       => [],
-    :show_lines     => false,
-    :uri_options    => {},
-    :use_cookies    => true,
-    :user_agents    => USER_AGENTS.dup
-  }
-
-
   ##
   # Read the Kronk config hash.
 
@@ -106,107 +49,15 @@ class Kronk
   # Load a config file and apply to Kronk.config.
 
   def self.load_config filepath=DEFAULT_CONFIG_FILE
-    conf          = YAML.load_file DEFAULT_CONFIG_FILE
-    content_types = conf.delete :content_types
-    uri_options   = conf.delete :uri_options
-    user_agents   = conf.delete :user_agents
-
-    if conf[:requires]
-      requires = [*conf.delete(:requires)]
-      self.config[:requires] ||= []
-      self.config[:requires].concat requires
-    end
-
-    self.config[:uri_options].merge! uri_options     if uri_options
-    self.config[:content_types].merge! content_types if content_types
-    self.config[:user_agents].merge! user_agents     if user_agents
-
-    self.config.merge! conf
-  end
-
-
-  ##
-  # Load the config-based requires.
-
-  def self.load_requires more_requires=nil
-    return unless config[:requires] || more_requires
-    (config[:requires] | more_requires.to_a).each{|lib| require lib }
-  end
-
-
-  ##
-  # Creates the default config file at the given path.
-
-  def self.make_config_file
-    Dir.mkdir CONFIG_DIR unless File.directory? CONFIG_DIR
-
-    File.open DEFAULT_CONFIG_FILE, "w+" do |file|
-      file << DEFAULT_CONFIG.to_yaml
-    end
-  end
-
-
-  ##
-  # Returns merged config-defined options for a given uri.
-  # Values in cmd_opts take precedence.
-  # Returns cmd_opts Hash if none found.
-
-  def self.merge_options_for_uri uri, cmd_opts={}
-    return cmd_opts if Kronk.config[:no_uri_options]
-
-    out_opts = Hash.new.merge cmd_opts
-
-    Kronk.config[:uri_options].each do |matcher, opts|
-      next unless (uri == matcher || uri =~ %r{#{matcher}}) && Hash === opts
-
-      opts.each do |key, val|
-        if !out_opts[key]
-          out_opts[key] = val
-          next
-        end
-
-
-        case key
+    conf = YAML.load_file filepath
 
-        # Hash or uri query String
-        when :data, :query
-          val = Request.parse_nested_query val if String === val
-
-          out_opts[key] = Request.parse_nested_query out_opts[key] if
-            String === out_opts[key]
-
-          out_opts[key] = val.merge out_opts[key], &DataSet::DEEP_MERGE
-
-        # Hashes
-        when :headers, :auth
-          out_opts[key] = val.merge out_opts[key]
+    self.config[:requires].concat [*conf.delete(:requires)] if conf[:requires]
 
-        # Proxy hash or String
-        when :proxy
-          if Hash === val && Hash === out_opts[key]
-            out_opts[key] = val.merge out_opts[key]
-
-          elsif Hash === val && String === out_opts[key]
-            val[:address] = out_opts[key]
-            out_opts[key] = val
-
-          elsif String === val && Hash === out_opts[key]
-            out_opts[key][:address] ||= val
-          end
-
-        # Response headers - Boolean, String, or Array
-        when :with_headers
-          next if out_opts[key] == true || out_opts[key] && val == true
-          out_opts[key] = [*out_opts[key]] | [*val]
-
-        # String or Array
-        when :only_data, :only_data_with, :ignore_data, :ignore_data_with
-          out_opts[key] = [*out_opts[key]] | [*val]
-        end
-      end
+    [:content_types, :uri_options, :user_agents].each do |key|
+      self.config[key].merge! conf.delete(key) if conf[key]
     end
 
-    out_opts
+    self.config.merge! conf
   end
 
 
@@ -306,9 +157,29 @@ class Kronk
 
 
   ##
-  # Make requests, parse the responses and compare the data.
-  # Query arguments may be set to the special value :cache to use the
-  # last live http response retrieved.
+  # See Kronk#compare. Short for:
+  #   Kronk.new(opts).compare(uri1, uri2)
+
+  def self.compare uri1, uri2, opts={}
+    new(opts).compare uri1, uri2
+  end
+
+
+  ##
+  # See Kronk#retrieve. Short for:
+  #   Kronk.new(opts).retrieve(uri)
+
+  def self.retrieve uri, opts={}
+    new(opts).retrieve uri
+  end
+
+
+  attr_accessor :diff, :options, :response, :responses
+
+
+  ##
+  # Create a Kronk instance to keep references to all request, response,
+  # and diff data.
   #
   # Supports the following options:
   # :data:: Hash/String - the data to pass to the http request
@@ -321,51 +192,150 @@ class Kronk
   # :proxy:: Hash/String - http proxy to use; defaults to nil
   # :only_data:: String/Array - extracts the data from given data paths
   # :ignore_data:: String/Array - defines which data points to exclude
-  # :keep_indicies:: Boolean - keep the original indicies of modified arrays,
-  #   and return them as hashes.
+  # :keep_indicies:: Boolean - indicies of modified arrays display as hashes.
   # :with_headers:: Boolean/String/Array - defines which headers to include
   # :parser:: Object/String - the parser to use for the body; default nil
   # :raw:: Boolean - run diff on raw strings
+
+  def initialize opts={}
+    @options   = opts
+    @diff      = nil
+    @responses = []
+    @response  = nil
+  end
+
+
+  ##
+  # Make requests, parse the responses and compare the data.
+  # Query arguments may be set to the special value :cache to use the
+  # last live http response retrieved.
   #
   # Returns a diff object.
 
-  def self.compare uri1, uri2, options={}
+  def compare uri1, uri2
     str1 = str2 = ""
+    res1 = res2 = nil
+
+    t1 = Thread.new do
+          res1 = retrieve uri1
+          str1 = res1.stringify @options
+         end
 
-    t1 = Thread.new{ str1 = retrieve_data_string uri1, options }
-    t2 = Thread.new{ str2 = retrieve_data_string uri2, options }
+    t2 = Thread.new do
+          res2 = retrieve uri2
+          str2 = res2.stringify @options
+         end
 
     t1.join
     t2.join
 
-    Diff.new str1, str2
+    @responses = [res1, res2]
+    @response  = res2
+
+    @diff = Diff.new str1, str2
   end
 
 
   ##
-  # Return a data string, parsed or raw.
-  # See Kronk.compare for supported options.
+  # Returns a Response instance from a url, file, or IO as a String.
 
-  def self.retrieve_data_string uri, options={}
-    options = merge_options_for_uri uri, options
+  def retrieve uri
+    options = Kronk.config[:no_uri_options] ? options_for_uri(uri) : @options
 
-    resp = Request.retrieve uri, options
+    if IO === uri || StringIO === uri
+      Cmd.verbose "Reading IO #{uri}"
+      resp = Response.new uri
 
-    if options[:irb]
-      Cmd.irb resp
-
-    elsif options[:raw]
-      resp.selective_string options
+    elsif File.file? uri.to_s
+      Cmd.verbose "Reading file:  #{uri}\n"
+      resp = Response.read_file uri
 
     else
-      begin
-        data = resp.selective_data options
-        Diff.ordered_data_string data, options[:struct]
+      req = Request.new uri, options
+      Cmd.verbose "Retrieving URL:  #{req.uri}\n"
+      resp = req.retrieve
+      Kronk.history << uri
+    end
 
-      rescue Response::MissingParser
-        Cmd.verbose "Warning: No parser for #{resp['Content-Type']} [#{uri}]"
-        resp.selective_string options
+    max_rdir = options[:follow_redirects]
+    while resp.redirect? && (max_rdir == true || max_rdir.to_s.to_i > 0)
+      Cmd.verbose "Following redirect..."
+      resp     = resp.follow_redirect
+      max_rdir = max_rdir - 1 if Fixnum === max_rdir
+    end
+
+    @responses = [resp]
+    @response  = resp
+    @diff      = nil
+
+    resp
+
+  rescue SocketError, Errno::ENOENT, Errno::ECONNREFUSED
+    raise NotFoundError, "#{uri} could not be found"
+
+  rescue Timeout::Error
+    raise TimeoutError, "#{uri} took too long to respond"
+  end
+
+
+  ##
+  # Returns merged config-defined options for a given uri.
+  # Values in cmd_opts take precedence.
+  # Returns cmd_opts Hash if none found.
+
+  def options_for_uri uri
+    out_opts = @options.dup
+
+    Kronk.config[:uri_options].each do |matcher, opts|
+      next unless (uri == matcher || uri =~ %r{#{matcher}}) && Hash === opts
+
+      opts.each do |key, val|
+        if out_opts[key].nil?
+          out_opts[key] = val
+          next
+        end
+
+
+        case key
+
+        # Hash or uri query String
+        when :data, :query
+          val = Request.parse_nested_query val if String === val
+
+          out_opts[key] = Request.parse_nested_query out_opts[key] if
+            String === out_opts[key]
+
+          out_opts[key] = val.merge out_opts[key], &DEEP_MERGE
+
+        # Hashes
+        when :headers, :auth
+          out_opts[key] = val.merge out_opts[key]
+
+        # Proxy hash or String
+        when :proxy
+          if Hash === val && Hash === out_opts[key]
+            out_opts[key] = val.merge out_opts[key]
+
+          elsif Hash === val && String === out_opts[key]
+            val[:address] = out_opts[key]
+            out_opts[key] = val
+
+          elsif String === val && Hash === out_opts[key]
+            out_opts[key][:address] ||= val
+          end
+
+        # Response headers - Boolean, String, or Array
+        when :with_headers
+          next if out_opts[key] == true || out_opts[key] && val == true
+          out_opts[key] = [*out_opts[key]] | [*val]
+
+        # String or Array
+        when :only_data, :ignore_data
+          out_opts[key] = [*out_opts[key]] | [*val]
+        end
       end
     end
+
+    out_opts
   end
 end