file_monitoring 0.0.9 → 1.0.0

data/lib/file_monitoring.rb

@@ -1,12 +1,29 @@
 require 'file_monitoring/file_monitoring'
 
-# TODO add description
-module BBFS
-  module FileMonitoring
-    # The main method. Loops on all paths each time span and monitors them.
-    def monitor_files
-      fm = FileMonitoring.new
-      fm.monitor_files
-    end
+# Daemon for monitoring directories for changes.
+# Paths are checked for changes per user-defined period of time.
+#
+# Directory defined changed when:
+# 1. Directory structure changed, i.e. sub-directories or files were added/removed
+# 2. One of the files located in the directory or one of its sub-directories was changed
+# 3. One of sub-directories changed (see 1. and 2. above)
+#
+# File monitoring controled by following configuration parameters:
+# * <tt>default_monitoring_log_path</tt> - holds path of file monitoring log.
+#   This log containd track of changes found during monitoring
+# * <tt>monitoring_paths</tt> - path and file monitoring configuration data
+#   regarding these paths.
+
+module FileMonitoring
+  Params.path('default_monitoring_log_path', '~/.bbfs/log/file_monitoring.log',
+              'Default path for file monitoring log file. ' \
+              'This log containd track of changes found during monitoring')
+  Params.complex('monitoring_paths', nil, 'Array of Hashes with 3 fields: ' \
+                 'path, scan_period and stable_state.')
+
+  # @see FileMonitoring#monitor_files
+  def monitor_files
+    fm = FileMonitoring.new
+    fm.monitor_files
   end
 end

data/lib/file_monitoring/file_monitoring.rb

@@ -2,71 +2,73 @@ require 'algorithms'
 require 'fileutils'
 require 'log'
 require 'params'
-require 'yaml'
 
 require 'file_monitoring/monitor_path'
 
-module BBFS
-  module FileMonitoring
+module FileMonitoring
+  # Manages file monitoring of number of file system locations
+  class FileMonitoring
 
-    Params.string('default_log_path', File.expand_path('~/.bbfs/log/file_monitoring.log'),
-                     'Default path for log file.')
-
-    class FileMonitoring
-
-      def set_config_path(config_path)
-        @config_path = config_path
-      end
-
-      def set_event_queue(queue)
-        @event_queue = queue
-      end
-
-      def monitor_files
-        config_yml = YAML::load_file(@config_path)
-
-        conf_array = config_yml['paths']
-
-        pq = Containers::PriorityQueue.new
-        conf_array.each { |elem|
-          priority = (Time.now + elem['scan_period']).to_i
-          dir_stat = DirStat.new(elem['path'], elem['stable_state'])
-          dir_stat.set_event_queue(@event_queue) if @event_queue
-          Log.info [priority, elem, dir_stat]
-          pq.push([priority, elem, dir_stat], -priority)
-        }
-
-        log_path = Params['default_log_path']
-        if config_yml.key?('log_path')
-          log_path = File.expand_path(config_yml['log_path'])
-        end
-
-        Log.info 'Log path:' + log_path
-        FileUtils.mkdir_p(File.dirname(log_path))
-        log = File.open(log_path, 'w')
-        FileStat.set_log(log)
-
-        while true do
-          time, conf, dir_stat = pq.pop
-          #Log.info 'time:' + time.to_s()
-          #Log.info 'now:' + Time.now.to_i.to_s()
-          #Log.info conf
-
-          time_span = time - Time.now.to_i
-          if (time_span > 0)
-            sleep(time_span)
-          end
-          dir_stat.monitor
+    # Set event queue used for communication between different proceses.
+    # @param queue [Queue]
+    def set_event_queue(queue)
+      @event_queue = queue
+    end
 
-          #Log.info conf['path']
-          #Log.info conf['scan_period']
-          priority = (Time.now + conf['scan_period']).to_i
-          pq.push([priority, conf, dir_stat], -priority)
+    # The main method. Loops on all paths, each time span and monitors them.
+    #
+    # =Algorithm:
+    # There is a loop that performs at every iteration:
+    #   1.Pull entry with a minimal time of check from queue
+    #   2.Recursively check path taken from entry for changes
+    #     a.Notify subscribed processes on changes
+    #   3.Push entry to the queue with new time of next check
+    #
+    # This methods controlled by <tt>monitoring_paths</tt> configuration parameter,
+    # that provides path and file monitoring configuration data
+    def monitor_files
+      conf_array = Params['monitoring_paths']
+
+      # Directories states stored in the priority queue,
+      # where the key (priority) is a time when it should be checked next time.
+      # Priority queue means that all entries arranged by key (time to check) in increasing order.
+      pq = Containers::PriorityQueue.new
+      conf_array.each { |elem|
+        priority = (Time.now + elem['scan_period']).to_i
+        dir_stat = DirStat.new(File.expand_path(elem['path']), elem['stable_state'])
+        dir_stat.set_event_queue(@event_queue) if @event_queue
+        Log.info "File monitoring started for: #{elem}"
+        pq.push([priority, elem, dir_stat], -priority)
+      }
+
+      log_path = Params['default_monitoring_log_path']
+
+      Log.info 'File monitoring log: ' + log_path
+      log_dir = File.dirname(log_path)
+      FileUtils.mkdir_p(log_dir) unless File.exists?(log_dir)
+      log = File.open(log_path, 'w')
+      FileStat.set_log(log)
+
+      while true do
+        # pull entry that should be checked next,
+        # according to it's scan_period
+        time, conf, dir_stat = pq.pop
+
+        # time remains to wait before directory should be checked
+        time_span = time - Time.now.to_i
+        if (time_span > 0)
+          sleep(time_span)
         end
+        dir_stat.monitor
 
-        log.close
+        # push entry with new a next time it should be checked as a priority key
+        priority = (Time.now + conf['scan_period']).to_i
+        pq.push([priority, conf, dir_stat], -priority)
       end
-    end
 
+      log.close
+    end
   end
+
 end
+

data/lib/file_monitoring/monitor_path.rb

@@ -1,292 +1,291 @@
 require 'log'
 require 'params'
 
-module BBFS
-  module FileMonitoring
-    #  Path monitoring.
-
-    #  Enum-like structure that includes possible filesystem entities (files/directories) states:
-    # * <tt>NON_EXISTING</tt> - Entity that was treated during previous run, but absent currently
-    # * <tt>NEW</tt> - Entity that was found and added to control during this run
-    # * <tt>CHANGED</tt> - State was changed between two checks
-    # * <tt>UNCHANGED</tt> - Opposite to CHANGED
-    # * <tt>STABLE</tt> - Entity is in the UNCHANGED state for a defined (by user) number of iterations
-    class FileStatEnum
-      NON_EXISTING = "NON_EXISTING"
-      NEW = "NEW"
-      CHANGED = "CHANGED"
-      UNCHANGED = "UNCHANGED"
-      STABLE = "STABLE"
-    end
+module FileMonitoring
+  #  Path monitoring.
+
+  #  Enum-like structure that includes possible filesystem entities (files/directories) states:
+  # * <tt>NON_EXISTING</tt> - Entity that was treated during previous run, but absent currently
+  # * <tt>NEW</tt> - Entity that was found and added to control during this run
+  # * <tt>CHANGED</tt> - State was changed between two checks
+  # * <tt>UNCHANGED</tt> - Opposite to CHANGED
+  # * <tt>STABLE</tt> - Entity is in the UNCHANGED state for a defined (by user) number of iterations
+  class FileStatEnum
+    NON_EXISTING = "NON_EXISTING"
+    NEW = "NEW"
+    CHANGED = "CHANGED"
+    UNCHANGED = "UNCHANGED"
+    STABLE = "STABLE"
+  end
 
-    #  This class holds current state of file and methods to control and report changes
-    class FileStat
-      attr_reader :cycles, :path, :stable_state, :state, :size, :modification_time
+  #  This class holds current state of file and methods to control and report changes
+  class FileStat
+    attr_reader :cycles, :path, :stable_state, :state, :size, :modification_time
 
-      DEFAULT_STABLE_STATE = 10
+    DEFAULT_STABLE_STATE = 10
 
-      @@log = nil
+    @@log = nil
 
-      #  Initializes new file monitoring object
-      # ==== Arguments:
-      #
-      # * <tt>path</tt> - File location
-      # * <tt>stable_state</tt> - Number of iterations to move unchanged file to stable state
-      def initialize(path, stable_state = DEFAULT_STABLE_STATE)
-        @path ||= path
-        @size = nil
-        @creation_time = nil
-        @modification_time = nil
-        @cycles = 0  # number of iterations from the last file modification
-        @state = FileStatEnum::NON_EXISTING
+    #  Initializes new file monitoring object
+    # ==== Arguments:
+    #
+    # * <tt>path</tt> - File location
+    # * <tt>stable_state</tt> - Number of iterations to move unchanged file to stable state
+    def initialize(path, stable_state = DEFAULT_STABLE_STATE)
+      @path ||= path
+      @size = nil
+      @creation_time = nil
+      @modification_time = nil
+      @cycles = 0  # number of iterations from the last file modification
+      @state = FileStatEnum::NON_EXISTING
 
-        @stable_state = stable_state  # number of iteration to move unchanged file to stable state
-      end
+      @stable_state = stable_state  # number of iteration to move unchanged file to stable state
+    end
 
-      def set_output_queue(event_queue)
-        @event_queue = event_queue
-      end
+    def set_output_queue(event_queue)
+      @event_queue = event_queue
+    end
 
-      #  Sets a log file to report changes
-      # ==== Arguments:
-      #
-      # * <tt>log</tt> - already opened ruby File object
-      def self.set_log (log)
-        @@log = log
-      end
+    #  Sets a log file to report changes
+    # ==== Arguments:
+    #
+    # * <tt>log</tt> - already opened ruby File object
+    def self.set_log (log)
+      @@log = log
+    end
 
-      #  Checks whether file was changed from the last iteration.
-      #  For files size and modification time are checked.
-      def monitor
-        file_stats = File.lstat(@path) rescue nil
-        new_state = nil
-        if file_stats == nil
-          new_state = FileStatEnum::NON_EXISTING
-          @size = nil
-          @creation_time = nil
-          @modification_time = nil
-          @cycles = 0
-        elsif @size == nil
-          new_state = FileStatEnum::NEW
-          @size = file_stats.size
-          @creation_time = file_stats.ctime.utc
-          @modification_time = file_stats.mtime.utc
-          @cycles = 0
-        elsif changed?(file_stats)
-          new_state = FileStatEnum::CHANGED
-          @size = file_stats.size
-          @creation_time = file_stats.ctime.utc
-          @modification_time = file_stats.mtime.utc
-          @cycles = 0
-        else
-          new_state = FileStatEnum::UNCHANGED
-          @cycles += 1
-          if @cycles >= @stable_state
-            new_state = FileStatEnum::STABLE
-          end
+    # Checks whether file was changed from the last iteration.
+    # For files, size and modification time are checked.
+    def monitor
+      file_stats = File.lstat(@path) rescue nil
+      new_state = nil
+      if file_stats == nil
+        new_state = FileStatEnum::NON_EXISTING
+        @size = nil
+        @creation_time = nil
+        @modification_time = nil
+        @cycles = 0
+      elsif @size == nil
+        new_state = FileStatEnum::NEW
+        @size = file_stats.size
+        @creation_time = file_stats.ctime.utc
+        @modification_time = file_stats.mtime.utc
+        @cycles = 0
+      elsif changed?(file_stats)
+        new_state = FileStatEnum::CHANGED
+        @size = file_stats.size
+        @creation_time = file_stats.ctime.utc
+        @modification_time = file_stats.mtime.utc
+        @cycles = 0
+      else
+        new_state = FileStatEnum::UNCHANGED
+        @cycles += 1
+        if @cycles >= @stable_state
+          new_state = FileStatEnum::STABLE
         end
-
-        # The assignment
-        self.state= new_state
       end
 
-      #  Checks that stored file attributes are the same as file attributes taken from file system.
-      def changed?(file_stats)
-        not (file_stats.size == @size &&
-            file_stats.ctime.utc == @creation_time.utc &&
-            file_stats.mtime.utc == @modification_time.utc)
-      end
+      # The assignment
+      self.state= new_state
+    end
 
-      def set_event_queue(queue)
-        @event_queue = queue
-      end
+    #  Checks that stored file attributes are the same as file attributes taken from file system.
+    def changed?(file_stats)
+      not (file_stats.size == @size &&
+          file_stats.ctime.utc == @creation_time.utc &&
+          file_stats.mtime.utc == @modification_time.utc)
+    end
 
-      #  Sets and writes to the log a new state.
-      def state= (new_state)
-        if (@state != new_state or @state == FileStatEnum::CHANGED)
-          @state = new_state
-          if (@@log)
-            @@log.puts(cur_stat)
-            @@log.flush  #Ruby1.9.3: note that this is Ruby internal buffering only; the OS may buffer the data as well
-          end
-          if (!@event_queue.nil?)
-            Log.info "Writing to event queue [#{self.state}, #{self.path}]"
-            @event_queue.push([self.state, self.instance_of?(DirStat), self.path])
-          end
+    def set_event_queue(queue)
+      @event_queue = queue
+    end
+
+    #  Sets and writes to the log a new state.
+    def state= (new_state)
+      if (@state != new_state or @state == FileStatEnum::CHANGED)
+        @state = new_state
+        if (@@log)
+          @@log.puts(cur_stat)
+          @@log.flush  #Ruby1.9.3: note that this is Ruby internal buffering only; the OS may buffer the data as well
+        end
+        if (!@event_queue.nil?)
+          Log.info "Writing to event queue [#{self.state}, #{self.path}]"
+          @event_queue.push([self.state, self.instance_of?(DirStat), self.path])
         end
       end
+    end
 
-      #  Checks whether path and state are the same as of the argument
-      def == (other)
-        @path == other.path and @stable_state == other.stable_state
-      end
+    #  Checks whether path and state are the same as of the argument
+    def == (other)
+      @path == other.path and @stable_state == other.stable_state
+    end
 
-      #  Returns path and state of the file with indentation
-      def to_s (indent = 0)
-        (" " * indent) + path.to_s + " : " + state.to_s
-      end
+    #  Returns path and state of the file with indentation
+    def to_s (indent = 0)
+      (" " * indent) + path.to_s + " : " + state.to_s
+    end
 
-      #  Reports current state with identification.
-      #  # This format used by log file.
-      def cur_stat
-        # TODO what output format have to be ?
-        Time.now.utc.to_s + " : " + self.state + " : " + self.path
-      end
+    #  Reports current state with identification.
+    #  NOTE This format used by log file.
+    def cur_stat
+      # TODO what output format have to be ?
+      Time.now.utc.to_s + " : " + self.state + " : " + self.path
     end
+  end
 
-    #  This class holds current state of directory and methods to control changes
-    class DirStat < FileStat
-      #  Initializes new directory monitoring object
-      # ==== Arguments:
-      #
-      # * <tt>path</tt> - File location
-      # * <tt>stable_state</tt> - Number of iterations to move unchanged directory to stable state
-      def initialize(path, stable_state = DEFAULT_STABLE_STATE)
-        super
-        @dirs = nil
-        @files = nil
-      end
+  #  This class holds current state of directory and methods to control changes
+  class DirStat < FileStat
+    #  Initializes new directory monitoring object
+    # ==== Arguments:
+    #
+    # * <tt>path</tt> - File location
+    # * <tt>stable_state</tt> - Number of iterations to move unchanged directory to stable state
+    def initialize(path, stable_state = DEFAULT_STABLE_STATE)
+      super
+      @dirs = nil
+      @files = nil
+    end
 
-      #  Adds directory for monitoring.
-      def add_dir (dir)
-        @dirs[dir.path] = dir
-      end
+    #  Adds directory for monitoring.
+    def add_dir (dir)
+      @dirs[dir.path] = dir
+    end
 
-      #  Adds file for monitoring.
-      def add_file (file)
-        @files[file.path] = file
-      end
+    #  Adds file for monitoring.
+    def add_file (file)
+      @files[file.path] = file
+    end
 
-      #  Removes directory from monitoring.
-      def rm_dir(dir)
-        @dirs.delete(dir.path)
-      end
+    #  Removes directory from monitoring.
+    def rm_dir(dir)
+      @dirs.delete(dir.path)
+    end
 
-      #  Removes file from monitoring.
-      def rm_file(file)
-        @files.delete(file.path)
-      end
+    #  Removes file from monitoring.
+    def rm_file(file)
+      @files.delete(file.path)
+    end
 
-      #  Checks that there is a sub-folder with a given path.
-      def has_dir?(path)
-        @dirs.has_key?(path)
-      end
+    #  Checks that there is a sub-folder with a given path.
+    def has_dir?(path)
+      @dirs.has_key?(path)
+    end
 
-      #  Checks that there is a file with a given path.
-      def has_file?(path)
-        @files.has_key?(path)
-      end
+    #  Checks that there is a file with a given path.
+    def has_file?(path)
+      @files.has_key?(path)
+    end
 
-      #  Returns string with contains path and state of this directory as well as it's structure.
-      def to_s(indent = 0)
-        indent_increment = 2
-        child_indent = indent + indent_increment
-        res = super
-        @files.each_value do |file|
-          res += "\n" + file.to_s(child_ident)
-        end if @files
-        @dirs.each_value do |dir|
-          res += "\n" + dir.to_s(child_ident)
-        end if @dirs
-        res
-      end
+    #  Returns string which contains path and state of this directory as well as it's structure.
+    def to_s(indent = 0)
+      indent_increment = 2
+      child_indent = indent + indent_increment
+      res = super
+      @files.each_value do |file|
+        res += "\n" + file.to_s(child_ident)
+      end if @files
+      @dirs.each_value do |dir|
+        res += "\n" + dir.to_s(child_ident)
+      end if @dirs
+      res
+    end
 
-      #  Checks that directory structure (i.e. files and directories located directly under this directory)
-      #  wasn't changed since the last iteration.
-      def monitor
-        was_changed = false
-        new_state = nil
-        self_stat = File.lstat(@path) rescue nil
-        if self_stat == nil
-          new_state = FileStatEnum::NON_EXISTING
-          @files = nil
-          @dirs = nil
-          @cycles = 0
-        elsif @files == nil
-          new_state = FileStatEnum::NEW
-          @files = Hash.new
-          @dirs = Hash.new
-          @cycles = 0
-          update_dir
-        elsif update_dir
-          new_state = FileStatEnum::CHANGED
-          @cycles = 0
-        else
-          new_state = FileStatEnum::UNCHANGED
-          @cycles += 1
-          if @cycles >= @stable_state
-            new_state = FileStatEnum::STABLE
-          end
+    # Checks that directory structure (i.e. files and directories located directly under this directory)
+    # wasn't changed since the last iteration.
+    def monitor
+      was_changed = false
+      new_state = nil
+      self_stat = File.lstat(@path) rescue nil
+      if self_stat == nil
+        new_state = FileStatEnum::NON_EXISTING
+        @files = nil
+        @dirs = nil
+        @cycles = 0
+      elsif @files == nil
+        new_state = FileStatEnum::NEW
+        @files = Hash.new
+        @dirs = Hash.new
+        @cycles = 0
+        update_dir
+      elsif update_dir
+        new_state = FileStatEnum::CHANGED
+        @cycles = 0
+      else
+        new_state = FileStatEnum::UNCHANGED
+        @cycles += 1
+        if @cycles >= @stable_state
+          new_state = FileStatEnum::STABLE
         end
-
-        # The assignment
-        self.state= new_state
       end
 
-      # Updates the files and directories hashes and globs the directory for changes.
-      def update_dir
-        was_changed = false
+      # The assignment
+      self.state= new_state
+    end
 
-        # monitor existing and absent files
-        @files.each_value do |file|
-          file.monitor
+    # Updates the files and directories hashes and globs the directory for changes.
+    def update_dir
+      was_changed = false
 
-          if file.state == FileStatEnum::NON_EXISTING
-            was_changed = true
-            rm_file(file)
-          end
+      # monitor existing and absent files
+      @files.each_value do |file|
+        file.monitor
+
+        if file.state == FileStatEnum::NON_EXISTING
+          was_changed = true
+          rm_file(file)
         end
+      end
 
-        @dirs.each_value do |dir|
-          dir.monitor
+      @dirs.each_value do |dir|
+        dir.monitor
 
-          if dir.state == FileStatEnum::NON_EXISTING
-            was_changed = true
-            rm_dir(dir)
-          end
+        if dir.state == FileStatEnum::NON_EXISTING
+          was_changed = true
+          rm_dir(dir)
         end
+      end
 
-        was_changed = was_changed || glob_me
+      was_changed = was_changed || glob_me
 
-        return was_changed
-      end
+      return was_changed
+    end
 
-      #  Globs the directory for new files and directories
-      def glob_me
-        was_changed = false
-        files = Dir.glob(path + "/*")
-
-        # add and monitor new files and directories
-        files.each do |file|
-          file_stat = File.lstat(file) rescue nil
-          if (file_stat.directory?)
-            unless (has_dir?(file)) # new directory
-                                    # change state only for existing directories
-                                    # newly added directories have to remain with NEW state
-              was_changed = true
-              ds = DirStat.new(file, self.stable_state)
-              ds.set_event_queue(@event_queue) unless @event_queue.nil?
-              ds.monitor
-              add_dir(ds)
-            end
-          else # it is a file
-            unless(has_file?(file)) # new file
-                                    # change state only for existing directories
-                                    # newly added directories have to remain with NEW state
-              was_changed = true
-              fs = FileStat.new(file, self.stable_state)
-              fs.set_event_queue(@event_queue) unless @event_queue.nil?
-              fs.monitor
-              add_file(fs)
-            end
+    #  Globs the directory for new files and directories
+    def glob_me
+      was_changed = false
+      files = Dir.glob(path + "/*")
+
+      # add and monitor new files and directories
+      files.each do |file|
+        file_stat = File.lstat(file) rescue nil
+        if (file_stat.directory?)
+          unless (has_dir?(file)) # new directory
+                                  # change state only for existing directories
+                                  # newly added directories have to remain with NEW state
+            was_changed = true
+            ds = DirStat.new(file, self.stable_state)
+            ds.set_event_queue(@event_queue) unless @event_queue.nil?
+            ds.monitor
+            add_dir(ds)
+          end
+        else # it is a file
+          unless(has_file?(file)) # new file
+                                  # change state only for existing directories
+                                  # newly added directories have to remain with NEW state
+            was_changed = true
+            fs = FileStat.new(file, self.stable_state)
+            fs.set_event_queue(@event_queue) unless @event_queue.nil?
+            fs.monitor
+            add_file(fs)
           end
         end
-
-        return was_changed
       end
 
-      protected :add_dir, :add_file, :rm_dir, :rm_file, :update_dir, :glob_me
+      return was_changed
     end
 
+    protected :add_dir, :add_file, :rm_dir, :rm_file, :update_dir, :glob_me
   end
+
 end
+

data/lib/file_monitoring/version.rb

@@ -1,5 +1,3 @@
-module BBFS
-  module FileMonitoring
-    VERSION = "0.0.9"
-  end
+module FileMonitoring
+  VERSION = "1.0.0"
 end

data/test/file_monitoring/monitor_path_test.rb

@@ -2,156 +2,152 @@ require './lib/file_monitoring/monitor_path'
 require 'test/unit'
 require 'fileutils'
 
-module BBFS
-  module FileMonitoring
-    module Test
-      class TestPathMonitor < ::Test::Unit::TestCase
-        # directory where tested files will be placed: __FILE__/time_modification_test
-        RESOURCES_DIR = File.expand_path(File.dirname(__FILE__) + '/path_monitor_test')
-        MOVE_DIR = '/dir1500' # directory that will be moved
-        MOVE_FILE = '/test_file.1000' # file that will be moved
-        MOVE_SRC_DIR = RESOURCES_DIR + '/dir1000' # directory where moved entities where placed
-        MOVE_DEST_DIR = RESOURCES_DIR # directory where moved entities will be placed
-        LOG_PATH = RESOURCES_DIR + '/../log.txt'
-
-        def setup
-          @sizes = [500, 1000, 1500]
-          @numb_of_copies = 2
-          @numb_entities = @sizes.size * (@numb_of_copies + 1) + @sizes.size
-          @test_file_name = 'test_file'   # file name format: <test_file_name_prefix>.<size>[.serial_number_if_more_then_1]
-          @test_dir_name = 'dir'
-          ::FileUtils.rm_rf(RESOURCES_DIR) if (File.exists?(RESOURCES_DIR))
-
-          # prepare files for testing
-          cur_dir = nil; # directory where currently files created in this iteration will be placed
-
-          @sizes.each do |size|
-            file_name = @test_file_name + '.' + size.to_s
-
-            if (cur_dir == nil)
-              cur_dir = String.new(RESOURCES_DIR)
-            else
-              cur_dir = cur_dir + "/#{@test_dir_name}" + size.to_s
-            end
-            Dir.mkdir(cur_dir) unless (File.exists?(cur_dir))
-            raise "Can't create writable working directory: #{cur_dir}" unless (File.exists?(cur_dir) and File.writable?(cur_dir))
-
-            file_path = cur_dir + '/' + file_name
-            File.open(file_path, 'w') do |file|
-              content = Array.new
-              size.times do |i|
-                content.push(sprintf('%5d ', i))
-              end
-              file.puts(content)
-            end
-
-            @numb_of_copies.times do |i|
-              ::FileUtils.cp(file_path, "#{file_path}.#{i}")
+module FileMonitoring
+  module Test
+    class TestPathMonitor < ::Test::Unit::TestCase
+      # directory where tested files will be placed: __FILE__/time_modification_test
+      RESOURCES_DIR = File.expand_path(File.dirname(__FILE__) + '/path_monitor_test')
+      MOVE_DIR = '/dir1500' # directory that will be moved
+      MOVE_FILE = '/test_file.1000' # file that will be moved
+      MOVE_SRC_DIR = RESOURCES_DIR + '/dir1000' # directory where moved entities where placed
+      MOVE_DEST_DIR = RESOURCES_DIR # directory where moved entities will be placed
+      LOG_PATH = RESOURCES_DIR + '/../log.txt'
+
+      def setup
+        @sizes = [500, 1000, 1500]
+        @numb_of_copies = 2
+        @numb_entities = @sizes.size * (@numb_of_copies + 1) + @sizes.size
+        @test_file_name = 'test_file'   # file name format: <test_file_name_prefix>.<size>[.serial_number_if_more_then_1]
+        @test_dir_name = 'dir'
+        ::FileUtils.rm_rf(RESOURCES_DIR) if (File.exists?(RESOURCES_DIR))
+
+        # prepare files for testing
+        cur_dir = nil; # directory where currently files created in this iteration will be placed
+
+        @sizes.each do |size|
+          file_name = @test_file_name + '.' + size.to_s
+
+          if (cur_dir == nil)
+            cur_dir = String.new(RESOURCES_DIR)
+          else
+            cur_dir = cur_dir + "/#{@test_dir_name}" + size.to_s
+          end
+          Dir.mkdir(cur_dir) unless (File.exists?(cur_dir))
+          raise "Can't create writable working directory: #{cur_dir}" unless (File.exists?(cur_dir) and File.writable?(cur_dir))
+
+          file_path = cur_dir + '/' + file_name
+          File.open(file_path, 'w') do |file|
+            content = Array.new
+            size.times do |i|
+              content.push(sprintf('%5d ', i))
             end
+            file.puts(content)
           end
-        end
-
-        def test_monitor
-          log = File.open(LOG_PATH, 'w+')
-          FileStat.set_log(log)
-          test_dir = DirStat.new(RESOURCES_DIR)
-
-          # Initial run of monitoring -> initializing DirStat object
-          # all found object will be set to NEW state
-          # no output to the log
-          test_dir.monitor
 
-          # all files will be set to UNCHANGED
-          log_prev_pos = log.pos
-          log_prev_line = log.lineno
-          test_dir.monitor
-          sleep(1) # to be sure that data was indeed written
-          log.pos= log_prev_pos
-          log.each_line do |line|
-            assert_equal(true, line.include?(FileStatEnum::UNCHANGED))
+          @numb_of_copies.times do |i|
+            ::FileUtils.cp(file_path, "#{file_path}.#{i}")
           end
-          assert_equal(@numb_entities, log.lineno - log_prev_line)  # checking that all entities were monitored
+        end
+      end
 
-          # move (equivalent to delete and create new) directory with including files to new location
-          ::FileUtils.mv MOVE_SRC_DIR + MOVE_DIR, MOVE_DEST_DIR + MOVE_DIR
-          log_prev_pos = log.pos
-          log_prev_line = log.lineno
-          test_dir.monitor
-          sleep(1)
-          log.pos= log_prev_pos
-          log.each_line do |line|
-            if (line.include?(MOVE_SRC_DIR + MOVE_DIR))
-              assert_equal(true, line.include?(FileStatEnum::NON_EXISTING))
-            elsif (line.include?(MOVE_DEST_DIR + MOVE_DIR))
-              assert_equal(true, line.include?(FileStatEnum::NEW))
-            elsif (line.include?(MOVE_SRC_DIR) or line.include?(MOVE_DEST_DIR))
-              assert_not_equal(true, line.include?(FileStatEnum::UNCHANGED))
-              assert_equal(true, line.include?(FileStatEnum::CHANGED))
-            end
-          end
-          # old and new containing directories: 2
-          # moved directory: 1
-          # deleted directory: 1
-          # moved files: @numb_of_copies + 1
-          assert_equal(5 + @numb_of_copies, log.lineno - log_prev_line)  # checking that only  MOVE_DIR_SRC, MOVE_DIR_DEST states were changed
-
-          # no changes:
-          # changed and new files moved to UNCHANGED
-          log_prev_pos = log.pos
-          log_prev_line = log.lineno
-          test_dir.monitor
-          sleep(1)
-          log.pos= log_prev_pos
-          log.each_line do |line|
-            assert_equal(true, line.include?(FileStatEnum::UNCHANGED))
+      def test_monitor
+        log = File.open(LOG_PATH, 'w+')
+        FileStat.set_log(log)
+        test_dir = DirStat.new(RESOURCES_DIR)
+
+        # Initial run of monitoring -> initializing DirStat object
+        # all found object will be set to NEW state
+        # no output to the log
+        test_dir.monitor
+
+        # all files will be set to UNCHANGED
+        log_prev_pos = log.pos
+        log_prev_line = log.lineno
+        test_dir.monitor
+        sleep(1) # to be sure that data was indeed written
+        log.pos= log_prev_pos
+        log.each_line do |line|
+          assert_equal(true, line.include?(FileStatEnum::UNCHANGED))
+        end
+        assert_equal(@numb_entities, log.lineno - log_prev_line)  # checking that all entities were monitored
+
+        # move (equivalent to delete and create new) directory with including files to new location
+        ::FileUtils.mv MOVE_SRC_DIR + MOVE_DIR, MOVE_DEST_DIR + MOVE_DIR
+        log_prev_pos = log.pos
+        log_prev_line = log.lineno
+        test_dir.monitor
+        sleep(1)
+        log.pos= log_prev_pos
+        log.each_line do |line|
+          if (line.include?(MOVE_SRC_DIR + MOVE_DIR))
+            assert_equal(true, line.include?(FileStatEnum::NON_EXISTING))
+          elsif (line.include?(MOVE_DEST_DIR + MOVE_DIR))
+            assert_equal(true, line.include?(FileStatEnum::NEW))
+          elsif (line.include?(MOVE_SRC_DIR) or line.include?(MOVE_DEST_DIR))
+            assert_not_equal(true, line.include?(FileStatEnum::UNCHANGED))
+            assert_equal(true, line.include?(FileStatEnum::CHANGED))
           end
-          # old and new containing directories: 2
-          # moved directory: 1
-          # moved files: @numb_of_copies + 1
-          assert_equal(4 + @numb_of_copies, log.lineno - log_prev_line)
-
-          # move (equivalent to delete and create new) file
-          log_prev_pos = log.pos
-          log_prev_line = log.lineno
-          ::FileUtils.mv MOVE_SRC_DIR + MOVE_FILE, MOVE_DEST_DIR + MOVE_FILE
-          test_dir.monitor
-          sleep(1)
-          log.pos= log_prev_pos
-          log.each_line do |line|
-            if (line.include?MOVE_SRC_DIR + MOVE_FILE)
-              assert_equal(true, line.include?(FileStatEnum::NON_EXISTING))
-            elsif (line.include?MOVE_DEST_DIR + MOVE_FILE)
-              assert_equal(true, line.include?(FileStatEnum::NEW))
-            elsif (line.include?MOVE_SRC_DIR or line.include?MOVE_DEST_DIR)
-              assert_equal(true, line.include?(FileStatEnum::CHANGED))
-            end
+        end
+        # old and new containing directories: 2
+        # moved directory: 1
+        # deleted directory: 1
+        # moved files: @numb_of_copies + 1
+        assert_equal(5 + @numb_of_copies, log.lineno - log_prev_line)  # checking that only  MOVE_DIR_SRC, MOVE_DIR_DEST states were changed
+
+        # no changes:
+        # changed and new files moved to UNCHANGED
+        log_prev_pos = log.pos
+        log_prev_line = log.lineno
+        test_dir.monitor
+        sleep(1)
+        log.pos= log_prev_pos
+        log.each_line do |line|
+          assert_equal(true, line.include?(FileStatEnum::UNCHANGED))
+        end
+        # old and new containing directories: 2
+        # moved directory: 1
+        # moved files: @numb_of_copies + 1
+        assert_equal(4 + @numb_of_copies, log.lineno - log_prev_line)
+
+        # move (equivalent to delete and create new) file
+        log_prev_pos = log.pos
+        log_prev_line = log.lineno
+        ::FileUtils.mv MOVE_SRC_DIR + MOVE_FILE, MOVE_DEST_DIR + MOVE_FILE
+        test_dir.monitor
+        sleep(1)
+        log.pos= log_prev_pos
+        log.each_line do |line|
+          if (line.include?MOVE_SRC_DIR + MOVE_FILE)
+            assert_equal(true, line.include?(FileStatEnum::NON_EXISTING))
+          elsif (line.include?MOVE_DEST_DIR + MOVE_FILE)
+            assert_equal(true, line.include?(FileStatEnum::NEW))
+          elsif (line.include?MOVE_SRC_DIR or line.include?MOVE_DEST_DIR)
+            assert_equal(true, line.include?(FileStatEnum::CHANGED))
           end
-          # old and new containing directories: 2
-          # removed file: 1
-          # new file: 1
-          assert_equal(4, log.lineno - log_prev_line)
-
-          # all files were moved to UNCHANGED
+        end
+        # old and new containing directories: 2
+        # removed file: 1
+        # new file: 1
+        assert_equal(4, log.lineno - log_prev_line)
+
+        # all files were moved to UNCHANGED
+        test_dir.monitor
+
+        # check that all entities moved to stable
+        log_prev_pos = log.pos
+        log_prev_line = log.lineno
+        (test_dir.stable_state + 1).times do
           test_dir.monitor
-
-          # check that all entities moved to stable
-          log_prev_pos = log.pos
-          log_prev_line = log.lineno
-          (test_dir.stable_state + 1).times do
-            test_dir.monitor
-          end
-          sleep(1)
-          log.pos= log_prev_pos
-          log.each_line do |line|
-            assert_equal(true, line.include?(FileStatEnum::STABLE))
-          end
-          assert_equal(@numb_entities, log.lineno - log_prev_line)
-
-          log.close
         end
-      end
-
+        sleep(1)
+        log.pos= log_prev_pos
+        log.each_line do |line|
+          assert_equal(true, line.include?(FileStatEnum::STABLE))
+        end
+        assert_equal(@numb_entities, log.lineno - log_prev_line)
 
+        log.close
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_monitoring
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -76,33 +76,32 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Deamon for monitoring file changes in set of patterns (blobs).
-email: kolmanv@gmail.com
+email: bbfsdev@gmail.com
 executables:
 - file_monitoring
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/file_monitoring.rb
-- lib/file_monitoring/daemon_win32.rb
-- lib/file_monitoring/file_monitoring.rb
 - lib/file_monitoring/monitor_path.rb
 - lib/file_monitoring/version.rb
+- lib/file_monitoring/file_monitoring.rb
 - test/file_monitoring/file_monitoring_test/conf.yml
-- test/file_monitoring/file_monitoring_test/conf_win32.yml
 - test/file_monitoring/file_monitoring_test/log
-- test/file_monitoring/file_monitoring_test.rb
-- test/file_monitoring/monitor_path_test/dir1000/test_file.1000
-- test/file_monitoring/monitor_path_test/dir1000/test_file.1000.0
+- test/file_monitoring/file_monitoring_test/conf_win32.yml
+- test/file_monitoring/monitor_path_test/test_file.500.0
 - test/file_monitoring/monitor_path_test/dir1000/test_file.1000.1
+- test/file_monitoring/monitor_path_test/dir1000/test_file.1000.0
+- test/file_monitoring/monitor_path_test/dir1000/test_file.1000
+- test/file_monitoring/monitor_path_test/test_file.500.1
+- test/file_monitoring/monitor_path_test/test_file.500
 - test/file_monitoring/monitor_path_test/dir1500/test_file.1500
 - test/file_monitoring/monitor_path_test/dir1500/test_file.1500.0
 - test/file_monitoring/monitor_path_test/dir1500/test_file.1500.1
-- test/file_monitoring/monitor_path_test/test_file.500
-- test/file_monitoring/monitor_path_test/test_file.500.0
-- test/file_monitoring/monitor_path_test/test_file.500.1
+- test/file_monitoring/file_monitoring_test.rb
 - test/file_monitoring/monitor_path_test.rb
 - bin/file_monitoring
-homepage: http://github.com/kolmanv/bbfs
+homepage: http://github.com/bbfsdev/bbfs
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -128,16 +127,16 @@ specification_version: 3
 summary: Deamon for monitoring file changes.
 test_files:
 - test/file_monitoring/file_monitoring_test/conf.yml
-- test/file_monitoring/file_monitoring_test/conf_win32.yml
 - test/file_monitoring/file_monitoring_test/log
-- test/file_monitoring/file_monitoring_test.rb
-- test/file_monitoring/monitor_path_test/dir1000/test_file.1000
-- test/file_monitoring/monitor_path_test/dir1000/test_file.1000.0
+- test/file_monitoring/file_monitoring_test/conf_win32.yml
+- test/file_monitoring/monitor_path_test/test_file.500.0
 - test/file_monitoring/monitor_path_test/dir1000/test_file.1000.1
+- test/file_monitoring/monitor_path_test/dir1000/test_file.1000.0
+- test/file_monitoring/monitor_path_test/dir1000/test_file.1000
+- test/file_monitoring/monitor_path_test/test_file.500.1
+- test/file_monitoring/monitor_path_test/test_file.500
 - test/file_monitoring/monitor_path_test/dir1500/test_file.1500
 - test/file_monitoring/monitor_path_test/dir1500/test_file.1500.0
 - test/file_monitoring/monitor_path_test/dir1500/test_file.1500.1
-- test/file_monitoring/monitor_path_test/test_file.500
-- test/file_monitoring/monitor_path_test/test_file.500.0
-- test/file_monitoring/monitor_path_test/test_file.500.1
+- test/file_monitoring/file_monitoring_test.rb
 - test/file_monitoring/monitor_path_test.rb

data/lib/file_monitoring/daemon_win32.rb

@@ -1,29 +0,0 @@
-require 'win32/daemon'
-include Win32
-require 'rubygems'
-
-begin
-require "./file_monitoring/file_monitoring.rb"
-
-conf_file_path = (ARGV.length > 0 ? "#{ARGV[0]}" : '~/.bbfs/etc/file_monitoring.yml')
-conf_file_path = File.expand_path(conf_file_path)
-
-CONFIG_FILE_PATH = "#{conf_file_path}"
-
-  class Daemon
-    def service_main
-      while running?
-        monitor_files(CONFIG_FILE_PATH)
-      end
-    end
-
-    def service_stop
-      exit!
-    end
-  end
-
-  Daemon.mainloop
-
-rescue Exception => err
-  raise
-end