indy 0.1.1

data/lib/indy/result_set.rb

@@ -0,0 +1,8 @@
+#
+# The current implementation extends an Array.  However, as this
+# has not been tested with a large data set it may need some new
+# Enumerable object that is multi-threaded and performance friendly
+#
+class ResultSet < Array
+
+end

data/performance/helper.rb

@@ -0,0 +1,5 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/indy") unless 
+  $:.include? File.expand_path("#{File.dirname(__FILE__)}/../lib/indy")
+  
+gem 'rspec-prof'
+require 'rspec-prof'

data/performance/profile_spec.rb

@@ -0,0 +1,35 @@
+require "#{File.dirname(__FILE__)}/helper"
+
+describe "Search Performance" do
+
+
+  context "with a small data set" do
+
+    longer_subject = [
+      "2000-09-07 14:07:41 INFO  MyApp - Entering application.\n",
+      "2000-09-07 14:07:42 DEBUG MyApp - Focusing application.\n",
+      "2000-09-07 14:07:43 DEBUG MyApp - Blurring application.\n",
+      "2000-09-07 14:07:44 WARN  MyApp - Low on Memory.\n",
+      "2000-09-07 14:07:45 ERROR MyApp - Out of Memory.\n",
+      "2000-09-07 14:07:46 INFO  MyApp - Exiting application.\n"
+    ].collect {|line| line * 70 }.join
+
+    profile :file => STDOUT, :printer => :flat, :min_percent => 1  do
+
+      it "should perform well using #for(:all)" do
+        Indy.search(longer_subject.dup).for(:all)
+      end
+
+      it "should perform well using #for(:field => 'value')" do
+        Indy.search(longer_subject.dup).for(:severity => 'INFO')
+      end
+
+      it "should perform well using #time()" do
+        Indy.search(longer_subject.dup).after(:time => "2000-09-07 14:07:45").for(:all)
+      end
+
+    end
+
+  end
+
+end

data/spec/data.log

@@ -0,0 +1,2 @@
+2000-09-07 14:07:41 INFO  MyApp - Entering application.
+2000-09-07 14:07:41 INFO  MyApp - Exiting application.

data/spec/helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/indy") unless 
+  $:.include? File.expand_path("#{File.dirname(__FILE__)}/../lib/indy")
+
+require 'rspec'

data/spec/indy_spec.rb

@@ -0,0 +1,212 @@
+require "#{File.dirname(__FILE__)}/helper"
+
+describe Indy do
+
+  context :initialize do
+
+    # http://log4r.rubyforge.org/rdoc/Log4r/rdoc/patternformatter.html
+    it "should accept a log4r pattern string without error" do
+      lambda { Indy.new(:pattern => ["(%d) (%i) (%c) - (%m)", :time, :info, :class, :message]) }.should_not raise_error
+    end
+
+    # http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/PatternLayout.html
+    it "should accept a log4j pattern string without error" do
+      lambda { Indy.new(:pattern => ["%d [%M] %p %C{1} - %m", :time, :info, :class, :message])}
+    end
+
+    it "should not raise error with non-conforming data" do
+      @indy = Indy.new(:source => " \nfoobar\n\n baz", :pattern => ['([^\s]+) (\w+)', :time, :message])
+      lambda{ @indy.for(:all) }.should_not raise_error
+    end
+
+    it "should accept time_format parameter" do
+      @indy = Indy.new(:time_format => '%d-%m-%Y', :source => "1-13-2000 yes", :pattern => ['^([^\s]+) (\w+)$', :time, :message])
+      lambda{ @indy.for(:all) }.should_not raise_error
+      @indy.instance_variable_get(:@time_format).should == '%d-%m-%Y'
+    end
+
+    it "should accept an initialization hash passed to #search" do
+      hash = {:time_format => '%d-%m-%Y',
+        :source => "1-13-2000 yes",
+        :pattern => ['^([^\s]+) (\w+)$', :time, :message]}
+      lambda{ @indy = Indy.search( hash ) }.should_not raise_error
+      @indy.for(:all).count.should == 1
+    end
+
+
+  end
+
+  context 'instance' do
+
+    before(:all) do
+      @indy = Indy.new(:source => '1/2/2002 string', :pattern => ['([^\s]+) (\w+)', :time, :message])
+    end
+
+    context "method" do
+
+      it "parse_line() should return a hash" do
+        @indy.send(:parse_line, "1/2/2002 string").class.should == Hash
+      end
+
+      it "parse_line() should return :time and :message" do
+        hash = @indy.send(:parse_line, "1/2/2002 string")
+        hash[:time] == "1/2/2002"
+        hash[:message] == "string"
+      end
+
+    end
+
+  end
+
+  context :search do
+
+    it "should be a class method" do
+      Indy.should respond_to(:search)
+    end
+
+    it "should accept a string parameter" do
+      lambda{ Indy.search("String Log") }.should_not raise_error
+    end
+
+    it "should accept a :cmd symbol and a command string parameter" do
+      lambda{ Indy.search(:cmd =>"ls") }.should_not raise_error
+    end
+
+    it "should return an instance of Indy" do
+      Indy.search("source string").should be_kind_of(Indy)
+      Indy.search(:cmd => "ls").should be_kind_of(Indy)
+    end
+
+    it "the instance should have the source specified" do
+      Indy.search("source string").source.should_not be_nil
+      Indy.search(:cmd => "ls").source.should_not be_nil
+    end
+
+    context "for a String" do
+
+      let(:log_file) { "#{File.dirname(__FILE__)}/data.log" }
+
+      context "treat it first like a file" do
+
+        it "should attempt to open the file" do
+          IO.should_receive(:open).with("possible_file.ext").ordered
+          Indy.search("possible_file.ext")
+        end
+
+        it "should not throw an error for an invalid file" do
+          lambda { Indy.search("possible_file.ext") }.should_not raise_error
+        end
+
+        it "should return an IO object when there is a file" do
+          IO.should_receive(:open).with("file_exists.ext").and_return(StringIO.new("2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION."))
+          Indy.search("file_exists.ext").for(:application => 'MyApp').length.should == 1
+        end
+
+        it "should handle a real file" do
+          Indy.search(log_file).for(:application => 'MyApp').length.should == 2
+        end
+
+      end
+
+      context "treat it second like a string" do
+
+        it "should attempt to treat it as a string" do
+          expecting_string = mock("String With Expectation")
+          expecting_string.should_receive(:[])
+          expecting_string.should_receive(:to_s).and_return("2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION.")
+
+          IO.should_receive(:open).with(expecting_string).ordered
+
+          Indy.search(expecting_string).for(:application => 'MyApp').length.should == 1
+        end
+
+      end
+
+
+      context "treat it optionally like a command" do
+
+        it "should attempt open the command" do
+          IO.stub!(:popen).with('ssh user@system "bash --login -c \"cat /var/log/standard.log\" "')
+          Indy.search(:cmd => 'ssh user@system "bash --login -c \"cat /var/log/standard.log\" "')
+        end
+
+        it "should not throw an error for an invalid command" do
+          IO.stub!(:popen).with('an invalid command').and_return('')
+          lambda { Indy.search(:cmd => "an invalid command") }.should_not raise_error
+        end
+
+        it "should return an IO object upon a successful command" do
+          IO.stub!(:popen).with("a command").and_return(StringIO.new("2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION."))
+          Indy.search(:cmd => "a command").for(:application => 'MyApp').length.should == 1
+        end
+
+        it "should handle a real command" do
+          Indy.search(:cmd => "cat #{log_file}").for(:application => 'MyApp').length.should == 2
+        end
+
+      end
+
+    end
+
+  end
+
+  context "instance" do
+
+    before(:each) do
+      log = "2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION.\n \n2000-09-07 14:07:41 INFO  MyApp  Entering APPLICATION.\n2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION.\n\n"
+      @indy = Indy.search(log)
+    end
+
+    it "with() should be a method" do
+      @indy.should respond_to(:with)
+    end
+
+    # http://log4r.rubyforge.org/rdoc/Log4r/rdoc/patternformatter.html
+    it "with() should accept a log4r pattern string without error" do
+      lambda { @indy.with(["(%d) (%i) (%c) - (%m)", :time, :info, :class, :message]) }.should_not raise_error
+    end
+
+    # http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/PatternLayout.html
+    it "with() should accept a log4j pattern string without error" do
+      lambda { @indy.with(["(%d) (%i) (%c) - (%m)", :time, :info, :class, :message])}.should_not raise_error
+    end
+
+    it "should return itself" do
+      @indy.with(["(%d) (%i) (%c) - (%m)", :time, :info, :class, :message]).should == @indy
+    end
+
+    [:for, :search, :like, :matching].each do |method|
+      it "#{method}() should exist" do
+        @indy.should respond_to(method)
+      end
+
+      it "#{method}() should accept a hash of search criteria" do
+        lambda { @indy.send(method,:severity => "INFO") }.should_not raise_error
+      end
+
+      it "#{method}() should return a set of results" do
+        @indy.send(method,:severity => "DEBUG").should be_kind_of(Array)
+      end
+
+    end
+
+    context "_search when given source, param and value" do
+
+      before(:each) do
+        @results = @indy.send(:_search, StringIO.new("2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION."),[Indy::DEFAULT_LOG_PATTERN, Indy::DEFAULT_LOG_FIELDS].flatten) {|result| result if result[:application] == "MyApp" }
+      end
+
+      it "should not return nil" do
+        @results.should_not be_nil
+        @results.should be_kind_of(Array)
+        @results.should_not be_empty
+      end
+
+      it "should return an array of results" do
+        @results.first[:application].should == "MyApp"
+      end
+
+    end
+
+  end
+end

data/spec/result_set_spec.rb

@@ -0,0 +1,9 @@
+require "#{File.dirname(__FILE__)}/helper"
+
+describe ResultSet do
+
+  it "should be Enumerable" do
+    ResultSet.new.should be_kind_of(Enumerable)
+  end
+
+end

data/spec/search_spec.rb

@@ -0,0 +1,97 @@
+require "#{File.dirname(__FILE__)}/helper"
+require 'tempfile'
+
+describe Indy do
+
+  context "search with string" do
+
+    before(:each) do
+      log_string = ["2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION.",
+                    "2000-09-07 14:08:41 INFO  MyOtherApp - Exiting APPLICATION.",
+                    "2000-09-07 14:10:55 INFO  MyApp - Exiting APPLICATION."].join("\n")
+      @indy = Indy.search(log_string)
+    end
+
+    it "should return 2 records" do
+      @indy.for(:application => 'MyApp').length.should == 2
+    end
+
+    it "should search entire string on each successive search" do
+      @indy.for(:application => 'MyApp').length.should == 2
+      @indy.for(:severity => 'INFO').length.should == 3
+      @indy.for(:application => 'MyApp').length.should == 2
+    end
+
+  end
+
+  context "search file" do
+
+    before(:all) do
+      @file = Tempfile.new('file_search_spec')
+      @file_path = @file.path
+      @file.write([ "2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION.",
+                    "2000-09-07 14:08:41 INFO  MyOtherApp - Exiting APPLICATION.",
+                    "2000-09-07 14:10:55 INFO  MyApp - Exiting APPLICATION."
+                  ].join("\n"))
+      @file.flush
+      @indy = Indy.search(@file_path)
+    end
+
+    it "should return 2 records" do
+      @indy.for(:application => 'MyApp').length.should == 2
+    end
+
+    it "should search entire file on each successive search" do
+      @indy.for(:application => 'MyApp').length.should == 2
+      @indy.for(:severity => 'INFO').length.should == 3
+      @indy.for(:application => 'MyApp').length.should == 2
+    end
+
+    it "should search reopened file on each successive search" do
+      @file.write("\n2000-09-07 14:10:55 INFO  MyApp - really really Exiting APPLICATION.\n")
+      @file.flush
+      @indy.for(:application => 'MyApp').length.should == 3
+      @indy.for(:severity => 'INFO').length.should == 4
+      @indy.for(:application => 'MyApp').length.should == 3
+    end
+
+  end
+
+  context "search using cmd" do
+
+    before(:all) do
+      @file = Tempfile.new('file_search_spec')
+      @file_path = @file.path
+      @file.write([ "2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION.",
+                    "2000-09-07 14:08:41 INFO  MyOtherApp - Exiting APPLICATION.",
+                    "2000-09-07 14:10:55 INFO  MyApp - Exiting APPLICATION."
+                  ].join("\n"))
+      @file.flush
+
+      cmd = "ruby -e 'puts File.open(\"#{@file_path}\").read'"
+
+      @indy = Indy.search(:cmd => cmd)
+    end
+
+    it "should return 2 records" do
+      @indy.for(:application => 'MyApp').length.should == 2
+    end
+
+    it "should execute cmd on each successive search" do
+      @indy.for(:application => 'MyApp').length.should == 2
+      @indy.for(:severity => 'INFO').length.should == 3
+      @indy.for(:application => 'MyApp').length.should == 2
+    end
+
+    it "should execute cmd on each successive search" do
+      @file.write("\n2000-09-07 14:10:55 INFO  MyApp - really really Exiting APPLICATION.\n")
+      @file.flush
+      @indy.for(:application => 'MyApp').length.should == 3
+      @indy.for(:severity => 'INFO').length.should == 4
+      @indy.for(:application => 'MyApp').length.should == 3
+    end
+
+
+  end
+
+end

data/spec/time_spec.rb

@@ -0,0 +1,80 @@
+require "#{File.dirname(__FILE__)}/helper"
+
+describe Indy do
+
+  context "default time handling" do
+
+    before(:all) do
+      @indy = Indy.search("2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION.")
+    end
+
+    it "should parse a standard date" do
+      line_hash = {:time => "2000-09-07 14:07:41", :message => "Entering APPLICATION"}
+      @indy.send(:parse_date, line_hash).class.should == DateTime
+    end
+
+  end
+
+  context "non-default time handling" do
+
+    before(:all) do
+      pattern = "(\w+) (\d{4}-\d{2}-\d{2}) (\w+) - (.*)"
+      @indy = Indy.new(:source => "INFO 2000-09-07 MyApp - Entering APPLICATION.", :pattern => [pattern, :severity, :time, :application, :message])
+    end
+
+    it "should parse a non-standard date" do
+      line_hash = {:time => "2000/09/07", :message => "Entering APPLICATION"}
+      @indy.send(:parse_date, line_hash).class.should == DateTime
+    end
+
+  end
+
+  context "explicit time format" do
+
+    before(:each) do
+      pattern = "^([^\s]+) (.*)$"
+      @indy = Indy.new(:time_format => '%m-%d-%Y', :source => "1-13-2002 message\n1-14-2002 another message\n1-15-2002 another message", :pattern => [pattern, :time, :message])
+    end
+
+    it "should parse a US style date when given a time format" do
+      line_hash = {:time => '1-13-2002', :message => 'message'}
+      @indy.send(:parse_date, line_hash).class.should == DateTime
+    end
+
+    it "should accept standard time format searches even while using an explicit log time format" do
+      @indy.after(:time => 'Jan 13 2002').for(:all).count.should == 2
+      @indy.after(:time => 'Jan 14 2002').for(:all).last._time.mday.should == 15
+    end
+
+  end
+
+  context "built-in _time field" do
+
+    before(:all) do
+      log_string = ["2000-09-07 14:07:41 INFO  MyApp - Entering APPLICATION.",
+        "2000-09-07 14:08:41 INFO  MyApp - Exiting APPLICATION.",
+        "2000-09-07 14:10:55 INFO  MyApp - Exiting APPLICATION."].join("\n")
+      @search_result = Indy.search(log_string).for(:application => 'MyApp')
+      @time_search_result = Indy.search(log_string).before(:time => "2100-09-07").for(:application => 'MyApp')
+    end
+
+    it "should not exist as an attribute when unless performing a time search" do
+      @search_result.first._time.class.should == NilClass
+      @time_search_result.first._time.class.should == DateTime
+    end
+
+    it "should be accurate" do
+      @time_search_result.first._time.to_s.should == "2000-09-07T14:07:41+00:00"
+    end
+
+    it "should allow for time range calculations" do
+      time_span = @time_search_result.last._time - @time_search_result.first._time
+      hours,minutes,seconds,frac = Date.day_fraction_to_time( time_span )
+      hours.should == 0
+      minutes.should == 3
+      seconds.should == 14
+    end
+
+  end
+
+end