request-log-analyzer 1.0.2 → 1.6.3

data/spec/unit/tracker/frequency_tracker_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RequestLogAnalyzer::Tracker::Frequency do
+
+  context 'static category' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::Frequency.new(:category => :category)
+      @tracker.prepare
+    end
+
+    it "should register a request in the right category" do
+      @tracker.update(request(:category => 'a', :blah => 0.2))
+      @tracker.categories.should include('a')
+    end
+
+    it "should register a request in the right category" do
+      @tracker.update(request(:category => 'a', :blah => 0.2))
+      @tracker.update(request(:category => 'b', :blah => 0.2))
+      @tracker.update(request(:category => 'b', :blah => 0.2))
+
+      @tracker.frequency('a').should == 1
+      @tracker.frequency('b').should == 2
+      @tracker.overall_frequency.should == 3
+    end
+
+    it "should sort correctly by frequency" do
+      @tracker.update(request(:category => 'a', :blah => 0.2))
+      @tracker.update(request(:category => 'b', :blah => 0.2))
+      @tracker.update(request(:category => 'b', :blah => 0.2))
+
+      @tracker.sorted_by_frequency.should == [['b', 2], ['a', 1]]
+    end
+  end
+  
+
+  context 'dynamic category' do
+    before(:each) do
+      @categorizer = Proc.new { |request| request[:duration] > 0.2 ? 'slow' : 'fast' }
+      @tracker = RequestLogAnalyzer::Tracker::Frequency.new(:category => @categorizer)
+      @tracker.prepare
+    end
+
+    it "should use the categorizer to determine the right category" do
+      @tracker.update(request(:category => 'a', :duration => 0.2))
+      @tracker.update(request(:category => 'b', :duration => 0.3))
+      @tracker.update(request(:category => 'b', :duration => 0.4))
+
+      @tracker.frequency('fast').should == 1
+      @tracker.frequency('slow').should == 2
+      @tracker.frequency('moderate').should == 0
+    end
+  end
+
+  describe '#report' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::Frequency.new(:category => :category)
+      @tracker.prepare
+    end
+
+    it "should generate a report without errors when one category is present" do
+      @tracker.update(request(:category => 'a', :blah => 0.2))
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+
+    it "should generate a report without errors when no category is present" do
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+
+    it "should generate a report without errors when multiple categories are present" do
+      @tracker.update(request(:category => 'a', :blah => 0.2))
+      @tracker.update(request(:category => 'b', :blah => 0.2))
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+  end
+
+  describe '#to_yaml_object' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::Frequency.new(:category => :category)
+      @tracker.prepare
+    end
+
+    it "should generate a YAML output" do
+      @tracker.update(request(:category => 'a', :blah => 0.2))
+      @tracker.update(request(:category => 'b', :blah => 0.2))
+      @tracker.to_yaml_object.should == { "a" => 1, "b" => 1 }
+    end
+  end
+end

data/spec/unit/tracker/hourly_spread_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RequestLogAnalyzer::Tracker::HourlySpread do
+
+  before(:each) do
+    @tracker = RequestLogAnalyzer::Tracker::HourlySpread.new
+    @tracker.prepare
+  end
+
+  it "should store timestamps correctly" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+
+    @tracker.hour_frequencies[0].should eql(3)
+  end
+
+  it "should count the number of timestamps correctly" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+    @tracker.update(request(:timestamp => 20090103010000))
+
+    @tracker.total_requests.should eql(4)
+  end
+
+  it "should set the first request timestamp correctly" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+
+    @tracker.first_timestamp.should == DateTime.parse('Januari 1, 2009 00:00:00')
+  end
+
+  it "should set the last request timestamp correctly" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+
+    @tracker.last_timestamp.should == DateTime.parse('Januari 3, 2009 00:00:00')
+  end
+
+  it "should return the correct timespan in days when multiple requests are given" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+
+    @tracker.timespan.should == 2
+  end
+
+end
+
+describe RequestLogAnalyzer::Tracker::HourlySpread, 'reporting' do
+
+  before(:each) do
+    @tracker = RequestLogAnalyzer::Tracker::HourlySpread.new
+    @tracker.prepare
+  end
+
+  it "should generate a report without errors when no request was tracked" do
+    lambda { @tracker.report(mock_output) }.should_not raise_error
+  end
+
+  it "should generate a report without errors when multiple requests were tracked" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+    @tracker.update(request(:timestamp => 20090103010000))
+    lambda { @tracker.report(mock_output) }.should_not raise_error
+  end
+  
+  it "should generate a YAML output" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+    @tracker.update(request(:timestamp => 20090103010000))
+    @tracker.to_yaml_object.should == {"22:00 - 23:00"=>0, "9:00 - 10:00"=>0, "7:00 - 8:00"=>0, "2:00 - 3:00"=>0, "12:00 - 13:00"=>0, "11:00 - 12:00"=>0, "16:00 - 17:00"=>0, "15:00 - 16:00"=>0, "19:00 - 20:00"=>0, "3:00 - 4:00"=>0, "21:00 - 22:00"=>0, "20:00 - 21:00"=>0, "14:00 - 15:00"=>0, "13:00 - 14:00"=>0, "4:00 - 5:00"=>0, "10:00 - 11:00"=>0, "18:00 - 19:00"=>0, "17:00 - 18:00"=>0, "8:00 - 9:00"=>0, "6:00 - 7:00"=>0, "5:00 - 6:00"=>0, "1:00 - 2:00"=>1, "0:00 - 1:00"=>3, "23:00 - 24:00"=>0}
+  end
+end

data/spec/unit/tracker/numeric_value_tracker_spec.rb

@@ -0,0 +1,166 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RequestLogAnalyzer::Tracker::NumericValue do
+
+  context 'static category' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::NumericValue.new(:category => :category, :value => :blah)
+      @tracker.prepare
+    end
+
+    it "should register a request in the right category" do
+      @tracker.update(request(:category => 'a', :blah => 2))
+      @tracker.categories.should include('a')
+    end
+
+    it "should register requests in the right category" do
+      @tracker.update(request(:category => 'a', :blah => 2))
+      @tracker.update(request(:category => 'b', :blah => 2))
+      @tracker.update(request(:category => 'b', :blah => 2))
+
+      @tracker.categories['a'][:sum].should == 2
+      @tracker.categories['b'][:sum].should == 4
+    end
+  end
+  
+
+  context 'dynamic category' do
+    before(:each) do
+      @categorizer = Proc.new { |request| request[:duration] > 0.2 ? 'slow' : 'fast' }
+      @tracker = RequestLogAnalyzer::Tracker::NumericValue.new(:category => @categorizer, :value => :blah)
+      @tracker.prepare
+    end
+
+    it "should use the categorizer to determine the right category" do
+      @tracker.update(request(:category => 'a', :duration => 0.2, :blah => 2))
+      @tracker.update(request(:category => 'b', :duration => 0.3, :blah => 2))
+      @tracker.update(request(:category => 'b', :duration => 0.4, :blah => 2))
+
+      @tracker.categories['fast'][:sum].should == 2
+      @tracker.categories['slow'][:sum].should == 4
+    end
+  end
+  
+  describe '#update' do
+
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::NumericValue.new(:value => :duration, :category => :category)
+      @tracker.prepare
+
+      @tracker.update(request(:category => 'a', :duration => 0.4))
+      @tracker.update(request(:category => 'a', :duration => 0.2))
+      @tracker.update(request(:category => 'a', :duration => 0.3))
+    end
+
+    it "should sum of the durations for a category correctly" do
+      @tracker.sum('a').should be_close(0.9, 0.000001)
+    end
+
+    it "should overall sum of the durations correctly" do
+      @tracker.sum_overall.should be_close(0.9, 0.000001)
+    end
+
+    it "should keep track of the minimum and maximum duration" do
+      @tracker.min('a').should == 0.2
+      @tracker.max('a').should == 0.4
+    end
+
+    it "should calculate the mean duration correctly" do
+      @tracker.mean('a').should be_close(0.3, 0.000001)
+    end
+
+    it "should calculate the overall mean duration correctly" do
+      @tracker.mean_overall.should be_close(0.3, 0.000001)
+    end
+
+    it "should calculate the duration variance correctly" do
+      @tracker.variance('a').should be_close(0.01, 0.000001)
+    end
+
+    it "should calculate the duration standard deviation correctly" do
+      @tracker.stddev('a').should be_close(0.1,  0.000001)
+    end
+  end  
+
+  describe '#report' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::NumericValue.new(:category => :category, :value => :blah)
+      @tracker.prepare
+    end
+
+    it "should generate a report without errors when one category is present" do
+      @tracker.update(request(:category => 'a', :blah => 2))
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+
+    it "should generate a report without errors when no category is present" do
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+
+    it "should generate a report without errors when multiple categories are present" do
+      @tracker.update(request(:category => 'a', :blah => 2))
+      @tracker.update(request(:category => 'b', :blah => 2))
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+  end
+
+  describe '#to_yaml_object' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::NumericValue.new(:category => :category, :value => :blah)
+      @tracker.prepare
+    end
+
+    it "should generate a YAML output" do
+      @tracker.update(request(:category => 'a', :blah => 2))
+      @tracker.update(request(:category => 'b', :blah => 3))
+      @tracker.to_yaml_object.should == {
+            "a" => { :min => 2, :hits => 1, :max => 2, :mean => 2.0, :sum => 2, :sum_of_squares => 0.0 },
+            "b" => { :min => 3, :hits => 1, :max => 3, :mean => 3.0, :sum => 3, :sum_of_squares => 0.0 }}
+    end
+  end
+
+  describe '#display_value' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::NumericValue.new(:category => :category, :value => :blah)
+      @tracker.prepare
+    end
+
+    it "should not crash on nil" do
+      lambda { @tracker.display_value(nil) }.should_not raise_error
+      @tracker.display_value(nil).should_not be_nil
+      @tracker.display_value(nil).should_not eql("")
+    end
+
+    it "should not touch thousands" do
+      @tracker.display_value(1000).should eql('1000 ')
+      @tracker.display_value(5000).should eql('5000 ')
+      @tracker.display_value(9001).should eql('9001 ')
+    end
+
+    it "should reduce milions to thousands (k)" do
+      @tracker.display_value(1000_000).should eql('1000k')
+      @tracker.display_value(5000_000).should eql('5000k')
+      @tracker.display_value(9000_001).should eql('9000k')
+    end
+
+    it "should reduce giga to millons (M)" do
+      @tracker.display_value(1000_000_000).should eql('1000M')
+      @tracker.display_value(5000_000_000).should eql('5000M')
+      @tracker.display_value(9000_000_001).should eql('9000M')
+    end
+
+    it "should reduce teras to gigas (G)" do
+      @tracker.display_value(1000_000_000_000).should eql('1000G')
+      @tracker.display_value(5000_000_000_000).should eql('5000G')
+      @tracker.display_value(9000_000_001_001).should eql('9000G')
+    end
+
+    it "should reduce petas to teras (T)" do
+      @tracker.display_value(1000_000_000_000_000).should eql('1000T')
+      @tracker.display_value(5000_000_000_000_000).should eql('5000T')
+      @tracker.display_value(9000_000_001_001_000).should eql('9000T')
+    end
+  end
+  
+  
+end

data/spec/unit/tracker/timespan_tracker_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RequestLogAnalyzer::Tracker::Timespan do
+
+  before(:each) do
+    @tracker = RequestLogAnalyzer::Tracker::Timespan.new
+    @tracker.prepare
+  end
+
+  it "should set the first request timestamp correctly" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+
+    @tracker.first_timestamp.should == DateTime.parse('Januari 1, 2009 00:00:00')
+  end
+
+  it "should set the last request timestamp correctly" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+
+    @tracker.last_timestamp.should == DateTime.parse('Januari 3, 2009 00:00:00')
+  end
+
+  it "should return the correct timespan in days when multiple requests are given" do
+    @tracker.update(request(:timestamp => 20090102000000))
+    @tracker.update(request(:timestamp => 20090101000000))
+    @tracker.update(request(:timestamp => 20090103000000))
+
+    @tracker.timespan.should == 2
+  end
+
+  it "should return a timespan of 0 days when only one timestamp is set" do
+    @tracker.update(request(:timestamp => 20090103000000))
+    @tracker.timespan.should == 0
+  end
+
+  it "should raise an error when no timestamp is set" do
+    lambda { @tracker.timespan }.should raise_error
+  end
+end
+
+describe RequestLogAnalyzer::Tracker::Timespan, 'reporting' do
+
+  before(:each) do
+    @tracker = RequestLogAnalyzer::Tracker::Timespan.new
+    @tracker.prepare
+  end
+  
+  it "should have a title" do
+    @tracker.title.should_not eql("")
+  end
+
+  it "should generate a report without errors when no request was tracked" do
+    lambda { @tracker.report(mock_output) }.should_not raise_error
+  end
+
+  it "should generate a report without errors when multiple requests were tracked" do
+    @tracker.update(request(:category => 'a', :timestamp => 20090102000000))
+    @tracker.update(request(:category => 'a', :timestamp => 20090101000000))
+    @tracker.update(request(:category => 'a', :timestamp => 20090103000000))
+    lambda { @tracker.report(mock_output) }.should_not raise_error
+  end
+  
+  it "should generate a YAML output" do
+    @tracker.update(request(:category => 'a', :timestamp => 20090102000000))
+    @tracker.update(request(:category => 'a', :timestamp => 20090101000000))
+    @tracker.update(request(:category => 'a', :timestamp => 20090103000000))
+    @tracker.to_yaml_object.should == { :first => DateTime.parse('20090101000000'), :last => DateTime.parse('20090103000000')}
+  end
+  
+end

data/spec/unit/tracker/tracker_api_spec.rb

@@ -0,0 +1,125 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RequestLogAnalyzer::Tracker::Base do
+
+  describe 'API' do
+
+    before(:each) do
+      @tracker    = Class.new(RequestLogAnalyzer::Tracker::Base).new
+
+      @summarizer = RequestLogAnalyzer::Aggregator::Summarizer.new(mock_source)
+      @summarizer.trackers << @tracker
+    end
+
+    it "should receive :prepare when the summarizer is preparing" do
+      @tracker.should_receive(:prepare).once
+      @summarizer.prepare
+    end
+
+    it "should receive :update for every request for which should_update? returns true" do
+      @tracker.should_receive(:should_update?).twice.and_return(true)
+      @tracker.should_receive(:update).twice
+
+      @summarizer.aggregate(testing_format.request(:field => 'value1'))
+      @summarizer.aggregate(testing_format.request(:field => 'value2'))
+    end
+
+    it "should not :update for every request for which should_update? returns false" do
+      @tracker.should_receive(:should_update?).twice.and_return(false)
+      @tracker.should_not_receive(:update)
+
+      @summarizer.aggregate(testing_format.request(:field => 'value1'))
+      @summarizer.aggregate(testing_format.request(:field => 'value2'))
+    end
+
+    it "should receive :report when the summary report is being built" do
+      m = mock_output
+      m.should_receive(:report_tracker).with(@tracker)
+      @summarizer.report(m)
+    end
+
+    it "should receieve :finalize when the summarizer is finalizing" do
+      @tracker.should_receive(:finalize).once
+      @summarizer.finalize
+    end
+  end
+
+  describe '#should_update?' do
+    before(:each) do
+      @tracker_class = Class.new(RequestLogAnalyzer::Tracker::Base)
+    end
+
+    it "should return true by default, when no checks are installed" do
+      tracker = @tracker_class.new
+      tracker.should_update?(testing_format.request).should be_true
+    end
+
+    it "should return false if the line type is not in the request" do
+      tracker = @tracker_class.new(:line_type => :not_there)
+      tracker.should_update?(request(:line_type => :different)).should be_false
+    end
+
+    it "should return true if the line type is in the request" do
+      tracker = @tracker_class.new(:line_type => :there)
+      tracker.should_update?(request(:line_type => :there)).should be_true
+    end
+
+    it "should return true if a field name is given to :if and it is in the request" do
+      tracker = @tracker_class.new(:if => :field)
+      tracker.should_update?(request(:field => 'anything')).should be_true
+    end
+
+    it "should return false if a field name is given to :if and it is not the request" do
+      tracker = @tracker_class.new(:if => :field)
+      tracker.should_update?(request(:other_field => 'anything')).should be_false
+    end
+
+    it "should return false if a field name is given to :unless and it is in the request" do
+      tracker = @tracker_class.new(:unless => :field)
+      tracker.should_update?(request(:field => 'anything')).should be_false
+    end
+
+    it "should return true if a field name is given to :unless and it is not the request" do
+      tracker = @tracker_class.new(:unless => :field)
+      tracker.should_update?(request(:other_field => 'anything')).should be_true
+    end
+
+    it "should return the value of the block if one is given to the :if option" do
+      tracker = @tracker_class.new(:if => lambda { |r| false } )
+      tracker.should_update?(request(:field => 'anything')).should be_false
+    end
+
+    it "should return the inverse value of the block if one is given to the :if option" do
+      tracker = @tracker_class.new(:unless => lambda { |r| false } )
+      tracker.should_update?(request(:field => 'anything')).should be_true
+    end
+
+    it "should return false if any of the checks fail" do
+      tracker = @tracker_class.new(:if => :field, :unless => lambda { |r| false }, :line_type => :not_present )
+      tracker.should_update?(request(:line_type => :present, :field => 'anything')).should be_false
+    end
+
+    it "should return true if all of the checks succeed" do
+      tracker = @tracker_class.new(:if => :field, :unless => lambda { |r| false }, :line_type => :present )
+      tracker.should_update?(request(:line_type => :present, :field => 'anything')).should be_true
+    end
+
+
+  end
+
+  describe '#to_yaml_object' do
+
+    before(:each) do
+      @tracker    = Class.new(RequestLogAnalyzer::Tracker::Base).new
+
+      @summarizer = RequestLogAnalyzer::Aggregator::Summarizer.new(mock_source)
+      @summarizer.trackers << @tracker
+    end
+
+    it "should receive :to_yaml object when finalizing" do
+      @summarizer.options[:yaml] = temp_output_file(:yaml)
+      @tracker.should_receive(:to_yaml_object).once
+      @summarizer.to_yaml
+    end
+  end
+end

data/spec/unit/tracker/traffic_tracker_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe RequestLogAnalyzer::Tracker::Traffic do
+
+  describe '#report' do
+    before(:each) do
+      @tracker = RequestLogAnalyzer::Tracker::Traffic.new(:category => :category, :traffic => :traffic)
+      @tracker.prepare
+    end
+
+    it "should generate a report without errors when one category is present" do
+      @tracker.update(request(:category => 'a', :traffic => 2))
+      @tracker.report(mock_output)
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+
+    it "should generate a report without errors when no category is present" do
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+
+    it "should generate a report without errors when multiple categories are present" do
+      @tracker.update(request(:category => 'a', :traffic => 2))
+      @tracker.update(request(:category => 'b', :traffic => 2))
+      lambda { @tracker.report(mock_output) }.should_not raise_error
+    end
+
+  end
+end