logrotate 1.0.0 → 1.1.0

data/lib/logrotate/rotateinfo.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+
+require 'stringio'
+
+module LogRotate
+
+  #
+  # This class is one of the possible return values from the
+  # LogRotate::rotate_file method.  It contains information about the
+  # rotated files.
+  #
+  class RotateInfoDateExtension
+
+    #
+    # This field is an array of rotated file names and dates.  Each
+    # element is a hash containing the following fields:
+    # +file+:: A rotated file name.
+    # +date_time+:: The associated date of the rotated file.
+    #
+    attr_accessor :rotated_files_and_dates
+    
+    #
+    # An array of rotated file names.  This list of file names will be
+    # the same as the file names listed in the rotated_files_and_dates
+    # field.
+    #
+    attr_accessor :rotated_files
+    
+    #
+    # An array of file names that were deleted during the rotate_file
+    # method call.
+    #
+    attr_accessor :deleted_files
+    
+    #
+    # The newly rotated file name created by the rotate_file method
+    # call.
+    #
+    attr_accessor :new_rotated_file
+    
+    #
+    # ====Description: 
+    # This method creates a RotateInfoDateExtension instance.  
+    # 
+    def initialize(rotated_files_and_dates,
+                   rotated_files,
+                   deleted_files,
+                   new_rotated_file)
+      @rotated_files_and_dates = rotated_files_and_dates
+      @rotated_files = rotated_files
+      @deleted_files = deleted_files
+      @new_rotated_file = new_rotated_file
+    end
+    
+    def ==(value)
+      return (@rotated_files_and_dates == value.rotated_files_and_dates &&
+              @rotated_files == value.rotated_files &&
+              @deleted_files == value.deleted_files &&
+              @new_rotated_file == value.new_rotated_file)
+    end
+    
+    def to_s()
+      os = StringIO.new
+      os.print "Rotated Files And Dates:\n"
+      @rotated_files_and_dates.each do |element|
+        os.print "   file -> ", element[:file], ", date_time -> ", element[:date_time], "\n"
+      end
+      
+      os.print "Rotated Files: \n"
+      if (@rotated_files.length() > 0)
+        os.print "   ", @rotated_files.join("\n   "), "\n"
+      end
+      
+      os.print "Deleted Files:\n"
+      if (@deleted_files.length() > 0)
+        os.print "   ", @deleted_files.join("\n   "), "\n"
+      end
+      
+      os.print "New Rotated File: \n"
+      os.print "   ", @new_rotated_file, "\n"
+      
+      return os.string()
+    end
+  end
+  
+  #
+  # This class is one of the possible return values from the
+  # LogRotate::rotate_file method.  It contains information about the
+  # rotated files.
+  #
+  class RotateInfoIntegerExtension
+  
+    #
+    # This field is an array of rotated file names and counts.  Each
+    # element is a hash containing the following fields:
+    # +file+:: A rotated file name.
+    # +index+:: The associated index of the rotated file.
+    #
+    attr_accessor :rotated_files_and_counts
+    
+    #
+    # An array of rotated file names.  This list of file names will be
+    # the same as the file names listed in the rotated_files_and_counts
+    # field.
+    #
+    attr_accessor :rotated_files
+    
+    #
+    # An array of file names that were deleted during the rotate_file
+    # method call.
+    #
+    attr_accessor :deleted_files
+    
+    #
+    # The newly rotated file name created by the rotate_file method
+    # call.
+    #
+    attr_accessor :new_rotated_file
+    
+    #
+    # ====Description: 
+    # This method creates a RotateInfoIntegerExtension instance.  
+    # 
+    def initialize(rotated_files_and_counts,
+                   rotated_files,
+                   deleted_files,
+                   new_rotated_file)
+      @rotated_files_and_counts = rotated_files_and_counts
+      @rotated_files = rotated_files
+      @deleted_files = deleted_files
+      @new_rotated_file = new_rotated_file
+    end
+    
+    def ==(value)
+      return (@rotated_files_and_counts == value.rotated_files_and_counts &&
+              @rotated_files == value.rotated_files &&
+              @deleted_files == value.deleted_files &&
+              @new_rotated_file == value.new_rotated_file)
+    end
+
+    def to_s()
+      os = StringIO.new
+      os.print "Rotated Files And Counts:\n"
+      @rotated_files_and_counts.each do |element|
+        os.print "   file -> ", element[:file], ", index -> ", element[:index], "\n"
+      end
+      
+      os.print "Rotated Files: \n"
+      if (@rotated_files.length() > 0)
+        os.print "   ", @rotated_files.join("\n   "), "\n"
+      end
+      
+      os.print "Deleted Files:\n"
+      if (@deleted_files.length() > 0)
+        os.print "   ", @deleted_files.join("\n   "), "\n"
+      end
+      
+      os.print "New Rotated File: \n"
+      os.print "   ", @new_rotated_file, "\n"
+      
+      return os.string()
+    end
+
+  end
+
+end

data/test/test_logrotate.rb

@@ -1,39 +1,22 @@
 #!/usr/bin/env ruby
 
 require 'logrotate'
+require 'logrotate/impl'
+require 'logrotate/rotateinfo'
+
+require 'fileutils'
 
 require 'test/unit'
 
 class LogRotateTest < Test::Unit::TestCase
   TEMP_DIR = "./temp"
 
-  def remove_directory(directory)
-    if (!File.directory?(directory)) then return end
-    
-    entries = Dir.entries(directory).select {|entry| (entry != ".") && (entry != "..") }
-    entries.map! { |entry| File.join(directory, entry) }
-    
-    entries.each do |entry|
-      if File.directory?(entry) 
-        remove_directory(entry) 
-      else
-        File.delete(entry)
-      end
-    end
-
-    Dir.delete(directory)
-  end
-
-  def remove_temp_directory
-    remove_directory(TEMP_DIR)
-  end
-
   def setup
-    remove_temp_directory()
+    teardown()
   end
 
   def teardown
-    remove_temp_directory()
+    FileUtils::rm_r(TEMP_DIR, :force => true)
   end
 
   def test_rotate_integer_extension()
@@ -46,7 +29,7 @@ class LogRotateTest < Test::Unit::TestCase
   end
 
   def test_rotate_date_extension()
-    date_time_format = "%F_%T"
+    date_time_format = "%F"
     
     output_dir = nil
     rotate_date_extension(3, 10, gzip = false)
@@ -58,6 +41,22 @@ class LogRotateTest < Test::Unit::TestCase
     rotate_date_extension(3, 10, gzip = true, output_dir)
     rotate_date_extension(3, 10, gzip = true, output_dir, date_time_format)
   end
+
+  def get_expected_results_integer_extension(iteration, base_name, count, gzip, output_dir)
+    expected_result = LogRotate::RotateInfoIntegerExtension.new(nil, nil, nil, nil)
+    expected_result.rotated_files_and_counts = []
+    
+    1.upto(iteration > count ? count : iteration) do |i|
+      rotated_file = "#{output_dir}/#{base_name}.#{i}" + (gzip ? ".gz" : "")
+      expected_result.rotated_files_and_counts.push({ :index => i, :file => rotated_file })
+    end
+    
+    expected_result.rotated_files = expected_result.rotated_files_and_counts.map { |entry| entry[:file] }
+    expected_result.deleted_files = iteration > count ? [ "#{output_dir}/#{base_name}.#{count}" + (gzip ? ".gz" : "") ] : []
+    expected_result.new_rotated_file = "#{output_dir}/#{base_name}.1" + (gzip ? ".gz" : "")
+
+    return expected_result
+  end
   
   def rotate_integer_extension(count, rotations, gzip, output_dir = nil)
     source_dir = "#{TEMP_DIR}"
@@ -75,26 +74,30 @@ class LogRotateTest < Test::Unit::TestCase
     
     manipulate_garbage_files(output_dir, base_name, :insert)
 
-    #rotate the file
-    rotations.downto(1) do |i|
+    #rotate the file rotations times
+    1.upto(rotations) do |iteration|
+      data = rotations - iteration + 1
       File.open(file, "w") do |file_stream|
-        file_stream.write("#{i}")
+        file_stream.write("#{data}")
       end
 
       options = {:count => count}
       if (gzip) then options[:gzip] = true end
       if (is_output_dir) then options[:directory] = output_dir end
-
-      LogRotate.rotate_files(file, options) 
+      
+      result = LogRotate.rotate_file(file, options)
+      
+      expected_result = get_expected_results_integer_extension(iteration, base_name, count, gzip, output_dir)
+      assert_equal(expected_result, result)
     end
     
     manipulate_garbage_files(output_dir, base_name, :delete)
-
+    
     #verify there are count rotated files.
     entries = Dir.glob("#{output_dir}/*").map {|entry| File.split(entry)[1]}
     assert_equal(entries.length, count)
     
-    #verify the contents
+    #verify the contents of the remaining files.
     expected = (1..count).map { |i| "#{base_name}.#{i}" + (gzip ? ".gz" : "") }
     assert_equal(entries.sort, expected)
 
@@ -109,11 +112,11 @@ class LogRotateTest < Test::Unit::TestCase
       end
     end
 
-    remove_temp_directory()
+    teardown()
   end
 
   def manipulate_garbage_files(dir, base_name, operation)
-    bogus_extensions = [ ".back", ".back123", ".2008-10-04_00:00:00foo", ".123x", "." ]
+    bogus_extensions = [ ".back", ".back123", ".2008-10-04foo", ".123x" ]
     
     bogus_extensions.each do |bogus_extension|
       bogus_file_1 = File.join(dir, base_name + bogus_extension)
@@ -128,9 +131,40 @@ class LogRotateTest < Test::Unit::TestCase
     end
   end
 
+  def get_expected_result_date_extension(iteration, base_name, date_times, count, date_time_format, gzip, output_dir)
+    index = iteration - 1
+
+    expected_result = LogRotate::RotateInfoDateExtension.new(nil, nil, nil, nil)
+    expected_result.rotated_files_and_dates = []
+    oldest_existing_date_iteration = (iteration - count + 1 <= 1) ? 1 : (iteration - count + 1)
+    oldest_existing_date_index = oldest_existing_date_iteration - 1
+    index.downto(oldest_existing_date_index) do |i|
+      str_date_time = date_times[i].strftime(date_time_format)
+      reconstructed_date_time = DateTime.strptime(str_date_time, date_time_format)
+      rotated_file = "#{output_dir}/#{base_name}.#{str_date_time}" + (gzip ? ".gz" : "")
+      
+      expected_result.rotated_files_and_dates.push({ :date_time => reconstructed_date_time, 
+                                                     :file => rotated_file })
+    end
+    
+    expected_result.rotated_files = expected_result.rotated_files_and_dates.map { |entry| entry[:file] }
+    
+    if (iteration > count)
+      str_date_time = date_times[index - count].strftime(date_time_format)
+      expected_result.deleted_files = [ "#{output_dir}/#{base_name}.#{str_date_time}" + (gzip ? ".gz" : "") ]
+    else
+      expected_result.deleted_files = []
+    end
+    
+    str_date_time = date_times[index].strftime(date_time_format)
+    expected_result.new_rotated_file = "#{output_dir}/#{base_name}.#{str_date_time}" + (gzip ? ".gz" : "")
+
+    return expected_result
+  end
+  
   def rotate_date_extension(count, rotations, gzip, 
                             output_dir = nil, 
-                            date_time_format = LogRotate::DEFAULT_DATE_TIME_FORMAT)
+                            date_time_format = LogRotate::Impl::DEFAULT_DATE_TIME_FORMAT)
     
     source_dir = "#{TEMP_DIR}"
     base_name = "file.dat"
@@ -151,7 +185,10 @@ class LogRotateTest < Test::Unit::TestCase
     now = DateTime.now
     date_times = (0..(rotations - 1)).map { |i| now + i }
     
-    date_times.each do |date_time|
+    1.upto(rotations) do |iteration|
+      index = iteration - 1
+      date_time = date_times[index]
+      
       File.open(file, "w") do |file_stream|
         file_stream.write(date_time.strftime(date_time_format))
       end
@@ -161,7 +198,11 @@ class LogRotateTest < Test::Unit::TestCase
       if (is_output_dir) then options[:directory] = output_dir end
       if date_time_format then options[:date_time_format] = date_time_format end
       
-      LogRotate.rotate_files(file, options)
+      result = LogRotate.rotate_file(file, options)
+      
+      expected_result = get_expected_result_date_extension(iteration, base_name, date_times, count, 
+                                                           date_time_format, gzip, output_dir)
+      assert_equal(expected_result, result)
     end
     
     #verify there are count rotated files.
@@ -190,7 +231,7 @@ class LogRotateTest < Test::Unit::TestCase
       end
     end
 
-    remove_temp_directory()
+    teardown()
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: logrotate
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - DesigningPatterns
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-17 00:00:00 -04:00
+date: 2008-08-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,9 +40,12 @@ files:
 - README.txt
 - Rakefile
 - lib/logrotate.rb
+- lib/logrotate/impl.rb
+- lib/logrotate/logrotate.rb
+- lib/logrotate/rotateinfo.rb
 - test/test_logrotate.rb
 has_rdoc: true
-homepage: "Project Page: http://rubyforge.org/projects/logrotate/"
+homepage: This package is a library of methods that perform log rotation.  The
 post_install_message: 
 rdoc_options: 
 - --main