ngmoco-request-log-analyzer 1.4.2

data/spec/fixtures/rails_22.log

@@ -0,0 +1,12 @@
+Processing PageController#demo (for 127.0.0.1 at 2008-12-10 16:28:09) [GET]
+  Parameters: {"action"=>"demo", "controller"=>"page"}
+Logging in from session data...
+Logged in as test@example.com
+Using locale: en-US, http-accept: ["en-US"], session: , det browser: en-US, det domain: 
+Rendering template within layouts/demo
+Rendering page/demo
+Rendered shared/_analytics (0.2ms)
+Rendered layouts/_actions (0.6ms)
+Rendered layouts/_menu (2.2ms)
+Rendered layouts/_tabbar (0.5ms)
+Completed in 614ms (View: 120, DB: 31) | 200 OK [http://www.example.com/demo]

data/spec/fixtures/rails_22_cached.log

@@ -0,0 +1,10 @@
+Processing CachedController#cached (for 1.1.1.1 at 2008-12-24 07:36:53) [GET]
+  Parameters: {"action"=>"cached", "controller"=>"cached"}
+Logging in from session data...
+Logging in using cookie...
+Using locale: zh-Hans, http-accept: ["zh-CN", "zh-HK", "zh-TW", "en-US"], session: , det browser: zh-Hans, det domain: , user pref locale: 
+Referer: http://www.example.com/referer
+Cached fragment hit: views/zh-Hans-www-cached-cached-all-CN--- (0.0ms)
+Filter chain halted as [#<ActionController::Caching::Actions::ActionCacheFilter:0x2a999ad620 @check=nil, @options={:store_options=>{}, :layout=>nil, :cache_path=>#<Proc:0x0000002a999b8890@/app/controllers/cached_controller.rb:8>}>] rendered_or_redirected.
+Filter chain halted as [#<ActionController::Filters::AroundFilter:0x2a999ad120 @identifier=nil, @kind=:filter, @options={:only=>#<Set: {"cached"}>, :if=>:not_logged_in?, :unless=>nil}, @method=#<ActionController::Caching::Actions::ActionCacheFilter:0x2a999ad620 @check=nil, @options={:store_options=>{}, :layout=>nil, :cache_path=>#<Proc:0x0000002a999b8890@/app/controllers/cached_controller.rb:8>}>>] did_not_yield.
+Completed in 3ms (View: 0, DB: 0) | 200 OK [http://www.example.com/cached/cached/]

data/spec/fixtures/rails_unordered.log

@@ -0,0 +1,24 @@
+Processing AccountController#dashboard (for 1.1.1.1 at 2008-12-24 07:36:49) [GET]
+  Parameters: {"action"=>"dashboard", "controller"=>"account", "first_use"=>"true"}
+Logging in from session data...
+
+
+Processing ProjectsController#new (for 1.1.1.1 at 2008-12-24 07:36:49) [GET]
+  Parameters: {"action"=>"new", "controller"=>"projects"}
+Rendering template within layouts/default
+Rendering account/dashboard
+Logging in from session data...
+Logging in using cookie...
+Using locale: en-US, http-accept: [], session: , det browser: , det domain: , user pref locale: 
+Rendered shared/_maintenance (0.6ms)
+Rendering template within layouts/templates/general_default/index.html.erb
+Rendered projects/_recent_designs (4.3ms)
+Rendered projects/_project (13.6ms)
+Rendered projects/_projects (18.7ms)
+Rendered layouts/_menu (1.4ms)
+Completed in 36ms (View: 30, DB: 3) | 200 OK [http://www.example.com/projects/new]
+Rendered layouts/_actions (0.3ms)
+Rendered layouts/_menu (1.6ms)
+Rendered layouts/_tabbar (1.9ms)
+Rendered layouts/_footer (3.2ms)
+Completed in 50ms (View: 41, DB: 4) | 200 OK [http://www.example.com/dashboard?first_use=true]

data/spec/fixtures/syslog_1x.log

@@ -0,0 +1,5 @@
+Jul 13 06:25:58 10.1.1.32 app_p [1957]: Processing EmployeeController#index (for 10.1.1.33 at 2008-07-13 06:25:58) [GET]
+Jul 13 06:25:58 10.1.1.32 app_p [1957]: Session ID: bd1810833653be11c38ad1e5675635bd
+Jul 13 06:25:58 10.1.1.32 app_p [1957]: Parameters: {"format"=>"xml", "action"=>"index}
+Jul 13 06:25:58 10.1.1.32 app_p [1957]: Rendering employees
+Jul 13 06:25:58 10.1.1.32 app_p [1957]: Completed in 0.21665 (4 reqs/sec) | Rendering: 0.00926 (4%) | DB: 0.00000 (0%) | 200 OK [http://example.com/employee.xml]

data/spec/fixtures/test_file_format.log

@@ -0,0 +1,13 @@
+processing request 1
+testing
+testing methods
+testing is cool
+testing fixtures
+testing is amazing
+testing can be cumbersome
+testing 
+nonsense
+testing is
+
+more nonsense
+finishing request 1

data/spec/fixtures/test_language_combined.log

@@ -0,0 +1,14 @@
+initializing
+
+processing request 1
+
+testing is amazing
+testing is cool
+
+finishing request 1
+
+asdfad # garbage
+dsaads # garbage
+
+processing request 1
+finishing request 1

data/spec/fixtures/test_order.log

@@ -0,0 +1,16 @@
+initializing
+
+processing request 1
+
+testing is amazing
+testing is cool
+
+processing request 1
+testing is cool
+finishing request 1
+
+asdfad # garbage
+dsaads # garbage
+
+
+finishing request 1

data/spec/integration/command_line_usage_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe RequestLogAnalyzer, 'running from command line' do
+
+  before(:each) do
+    cleanup_temp_files!
+  end
+
+  after(:each) do
+    cleanup_temp_files!
+  end
+
+  it "should find 4 requests in default mode" do
+    output = run("#{log_fixture(:rails_1x)}")
+    output.any? { |line| /^Parsed requests\:\s*4\s/ =~ line }.should be_true
+  end
+
+  it "should find 2 requests when parsing a compressed file" do
+    output = run("#{log_fixture(:decompression, :tgz)}")
+    output.any? { |line| /^Parsed requests\:\s*2\s/ =~ line }.should be_true
+  end
+
+
+  it "should skip 1 requests with a --select option" do
+    output = run("#{log_fixture(:rails_1x)} --select controller PeopleController")
+    output.any? { |line| /^Skipped requests\:\s*1\s/ =~ line }.should be_true
+  end
+
+  it "should skip 3 requests with a --reject option" do
+    output = run("#{log_fixture(:rails_1x)} --reject controller PeopleController")
+    output.any? { |line| /^Skipped requests\:\s*3\s/ =~ line }.should be_true
+  end
+
+  it "should write output to a file with the --file option" do
+    run("#{log_fixture(:rails_1x)} --file #{temp_output_file(:report)}")
+    File.exist?(temp_output_file(:report)).should be_true
+  end
+
+  it "should write only ASCII characters to a file with the --file option" do
+    run("#{log_fixture(:rails_1x)} --file #{temp_output_file(:report)}")
+    /^[\x00-\x7F]*$/.match(File.read(temp_output_file(:report))).should_not be_nil
+  end
+
+  it "should write HTML if --output HTML is provided" do
+    output = run("#{log_fixture(:rails_1x)} --output HTML")
+    output.any? { |line| /<html[^>]*>/ =~ line}.should be_true
+  end
+
+  it "should run with the --database option" do
+    run("#{log_fixture(:rails_1x)} --database #{temp_output_file(:database)}")
+    File.exist?(temp_output_file(:database)).should be_true
+  end
+
+  it "should use no colors in the report with the --boring option" do
+    output = run("#{log_fixture(:rails_1x)} --boring")
+    output.any? { |line| /\e/ =~ line }.should be_false
+  end
+
+  it "should use only ASCII characters in the report with the --boring option" do
+    output = run("#{log_fixture(:rails_1x)} --boring")
+    output.all? { |line| /^[\x00-\x7F]*$/ =~ line }.should be_true
+  end
+
+  it "should parse a Merb file if --format merb is set" do
+    output = run("#{log_fixture(:merb)} --format merb")
+    output.any? { |line| /Parsed requests\:\s*11/ =~ line }.should be_true
+  end
+
+  it "should parse a Apache access log file if --apache-format is set" do
+    output = run("#{log_fixture(:apache_combined)} --apache-format combined")
+    output.any? { |line| /Parsed requests\:\s*5/ =~ line }.should be_true
+  end
+
+  it "should dump the results to a YAML file" do
+    run("#{log_fixture(:rails_1x)} --dump #{temp_output_file(:yaml)}")
+    File.exist?(temp_output_file(:yaml)).should be_true
+    YAML::load(File.read(temp_output_file(:yaml))).should have_at_least(1).item
+  end
+
+  it "should parse 4 requests from the standard input" do
+    output = run("- < #{log_fixture(:rails_1x)}")
+    output.any? { |line| /^Parsed requests\:\s*4\s/ =~ line }.should be_true
+  end
+end

data/spec/integration/munin_plugins_rails_spec.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe RequestLogAnalyzer, 'when harvesting like munin-plugins-rails the YAML output' do
+  
+  before(:each) do 
+    cleanup_temp_files!    
+    run("#{log_fixture(:rails_1x)} --dump #{temp_output_file(:yaml)}")
+    @rla = YAML::load(File.read(temp_output_file(:yaml)))
+  end
+  
+  after(:each) do
+    cleanup_temp_files!
+  end
+  
+  it "should contain database times" do
+    @rla["Database time"].each do |item|
+      item[1][:min].should_not be_nil
+      item[1][:max].should_not be_nil
+      item[1][:hits].should_not be_nil
+      item[1][:sum].should_not be_nil
+    end
+  end
+
+  it "should contain request times" do
+    @rla["Request duration"].each do |item|
+      item[1][:min].should_not be_nil
+      item[1][:max].should_not be_nil
+      item[1][:hits].should_not be_nil
+      item[1][:sum].should_not be_nil
+    end
+  end
+
+  it "should contain failed requests" do
+    @rla.keys.should include("Failed requests")
+  end
+
+  it "should contain Process blockers" do
+    @rla.keys.should include("Process blockers (> 1 sec duration)")
+  end
+
+  it "should contain HTTP Methods" do
+    @rla["HTTP methods"]["GET"].should_not be_nil
+  end
+
+  it "should contain HTTP Methods" do
+    @rla["HTTP methods"]["GET"].should_not be_nil
+  end
+
+  it "should contain view rendering times" do
+    @rla["View rendering time"].each do |item|
+      item[1][:min].should_not be_nil
+      item[1][:max].should_not be_nil
+      item[1][:hits].should_not be_nil
+      item[1][:sum].should_not be_nil
+    end
+  end
+
+end

data/spec/integration/scout_spec.rb

@@ -0,0 +1,151 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+def capture_stdout_and_stderr_with_warnings_on
+  $stdout, $stderr, warnings, $VERBOSE =
+    StringIO.new, StringIO.new, $VERBOSE, true
+  yield
+  return $stdout.string, $stderr.string
+ensure
+  $stdout, $stderr, $VERBOSE = STDOUT, STDERR, warnings
+end
+
+describe RequestLogAnalyzer, 'when using the rla API like the scout plugin' do
+  
+  before(:each) do
+    # prepare a place to capture the output
+    sio = StringIO.new
+    
+    # place an IO object where I want RequestLogAnalyzer to read from
+    open(log_fixture(:rails_1x)) do |log|
+      completed_count = 0
+      log.each do |line|
+        completed_count += 1 if line =~ /\ACompleted\b/
+        break if completed_count == 2  # skipping first two requests
+      end
+      
+      # trigger the log parse
+      @stdout, @stderr = capture_stdout_and_stderr_with_warnings_on do
+        RequestLogAnalyzer::Controller.build(
+          :output       => EmbeddedHTML,
+          :file         => sio,
+          :after        => Time.local(2008, 8, 14, 21, 16, 31),  # after 3rd req
+          :source_files => log
+        ).run!
+      end
+    end
+    
+    # read the resulting output
+    @analysis = sio.string
+  end
+  
+  it "should generate an analysis" do
+    @analysis.should_not be_empty
+  end
+  
+  it "should generate customized output using the passed Class" do
+    credit = %r{<p>Powered by request-log-analyzer v\d+(?:\.\d+)+</p>\z}
+    @analysis.should match(credit)
+  end
+  
+  it "should skip requests before :after Time" do
+    @analysis.should_not include("PeopleController#show")
+  end
+  
+  it "should include requests after IO#pos and :after Time" do
+    @analysis.should include("PeopleController#picture")
+  end
+  
+  it "should skip requests before IO#pos" do
+    @analysis.should_not include("PeopleController#index")
+  end
+  
+  it "should not print to $stdout" do
+    @stdout.should be_empty
+  end
+  
+  it "should not print to $stderr (with warnings on)" do
+    @stderr.should be_empty
+  end
+
+end
+
+# Helpers
+class EmbeddedHTML < RequestLogAnalyzer::Output::Base
+  def print(str)
+    @io << str
+  end
+  alias_method :<<, :print
+
+  def puts(str = "")
+    @io << "#{str}<br/>\n"
+  end
+
+  def title(title)
+    @io.puts(tag(:h2, title))
+  end
+
+  def line(*font)  
+    @io.puts(tag(:hr))
+  end
+
+  def link(text, url = nil)
+    url = text if url.nil?
+    tag(:a, text, :href => url)
+  end
+
+  def table(*columns, &block)
+    rows = Array.new
+    yield(rows)
+
+    @io << tag(:table, :cellspacing => 0) do |content|
+      if table_has_header?(columns)
+        content << tag(:tr) do
+          columns.map { |col| tag(:th, col[:title]) }.join("\n")
+        end
+      end
+
+      odd = false
+      rows.each do |row|
+        odd = !odd
+        content << tag(:tr) do
+          if odd
+            row.map { |cell| tag(:td, cell, :class => "alt") }.join("\n") 
+          else
+            row.map { |cell| tag(:td, cell) }.join("\n") 
+          end
+        end
+      end
+    end
+  end
+
+  def header
+  end
+
+  def footer
+    @io << tag(:hr) << tag(:p, "Powered by request-log-analyzer v#{RequestLogAnalyzer::VERSION}")
+  end
+
+  private
+
+  def tag(tag, content = nil, attributes = nil)
+    if block_given?
+      attributes = content.nil? ? "" : " " + content.map { |(key, value)| "#{key}=\"#{value}\"" }.join(" ")
+      content_string = ""
+      content = yield(content_string)
+      content = content_string unless content_string.empty? 
+      "<#{tag}#{attributes}>#{content}</#{tag}>"
+    else
+      attributes = attributes.nil? ? "" : " " + attributes.map { |(key, value)| "#{key}=\"#{value}\"" }.join(" ")
+      if content.nil?
+        "<#{tag}#{attributes} />"
+      else
+        if content.class == Float
+          "<#{tag}#{attributes}><div class='color_bar' style=\"width:#{(content*200).floor}px;\"/></#{tag}>"
+        else
+          "<#{tag}#{attributes}>#{content}</#{tag}>"
+        end
+      end
+    end
+  end  
+end
+

data/spec/lib/helpers.rb

@@ -0,0 +1,52 @@
+module RequestLogAnalyzer::Spec::Helpers
+
+  # Create or return a new TestingFormat
+  def testing_format
+    @testing_format ||= TestingFormat.create
+  end
+
+  # Load a log file from the fixture folder
+  def log_fixture(name, extention = "log")
+    File.dirname(__FILE__) + "/../fixtures/#{name}.#{extention}"
+  end
+
+  # Creates a log file given some lines
+  def log_stream(*lines)
+    StringIO.new(lines.join("\n") + "\n")
+  end
+
+  # Request loopback
+  def request(fields, format = testing_format)
+    if fields.kind_of?(Array)
+      format.request(*fields)
+    else
+      format.request(fields)
+    end
+  end
+
+  # Run a specific command
+  # Used to call request-log-analyzer through binary
+  def run(arguments)
+    binary = "#{File.dirname(__FILE__)}/../../bin/request-log-analyzer"
+    arguments = arguments.join(' ') if arguments.kind_of?(Array)
+
+    output = []
+    IO.popen("#{binary} #{arguments}") do |pipe|
+      output = pipe.readlines
+    end
+    $?.exitstatus.should == 0
+    output
+  end
+
+  # Cleanup all temporary files generated by specs
+  def cleanup_temp_files!
+    Dir["#{File.dirname(__FILE__)}/../../tmp/spec.*tmp"].each do |file|
+      File.unlink(file)
+    end
+  end
+
+  # Return a filename that can be used as temporary file in specs
+  def temp_output_file(file_type)
+    "#{File.dirname(__FILE__)}/../../tmp/spec.#{file_type}.tmp"
+  end
+end