validations 0.0.3

data/lib/validations.rb

@@ -0,0 +1,4 @@
+require 'validations/index_validations'
+
+module Validations
+end

data/lib/validations/index_validations.rb

@@ -0,0 +1,113 @@
+require 'params'
+require 'log'
+require 'content_data'
+require 'file_indexing/index_agent'
+
+# TODO additional params?
+# TODO are params names good enough?
+module Validations
+  class IndexValidations
+
+    # TODO should it be renamed cause it can validate any indexes, not specially remote, one against another.
+
+    # Validates remote index against local file system.
+    # Remote index defined valid when every remote content has at least one valid local instance.
+    #
+    # There are two levels of validation, controlled by instance_check_level system parameter:
+    # * shallow - quick, tests instance for file existence and attributes.
+    # * deep - can take more time, in addition to shallow recalculates hash sum.
+    # For more infoemation see <tt>ContentData</tt> documentation.
+    # @param [ContentData] remote_index it's contents should be validate against local index
+    # @param [ContentData] local_index contains local contents and instances used for validation
+    # @param [Hash] params hash of parameters of validation, can be used to return additional data
+    #
+    #     Supported key/value combinations:
+    #     * key is <tt>:failed</tt> value is <tt>ContentData</tt> used to return failed instances
+    # @return [Boolean] true when every remote content has at least one valid local instance, false otherwise
+    # @raise [ArgumentError] when instance_check_level is incorrect
+    def IndexValidations.validate_remote_index(remote_index, local_index, params = nil)
+      raise ArgumentError 'remote_index must be defined' if remote_index.nil?
+      raise ArgumentError 'local index must be defined' if local_index.nil?
+
+      # used to answer whether specific param was set
+      param_exists = Proc.new do |param|
+        !(params.nil? || params[param].nil?)
+      end
+
+      # used to process method parameters centrally
+      process_params = Proc.new do |values|
+        # values is a Hash with keys: :content, :instance and value appropriate to key
+        if param_exists.call :failed
+          unless values[:content].nil?
+            params[:failed].add_content values[:content]
+          end
+          unless values[:instance].nil?
+            # appropriate content should be already added
+            params[:failed].add_instance values[:instance]
+          end
+        end
+      end
+
+      # result variable
+      is_valid = true
+      # contains contents absent or without valid instances on local system
+      # and corresponding local instances
+      failed = ContentData::ContentData.new
+      # contains checksums of contains absent in local
+      absent_checksums = Array.new
+
+      # contains local instances corresponding to given remote index contents
+      local_index_to_check = ContentData::ContentData.new
+
+      # check whether remote contents exist locally and add them for further validations
+      remote_index.contents.each_key do |checksum|
+        if local_index.content_exists checksum
+          local_index_to_check.add_content local_index.contents[checksum]
+        else
+          is_valid = false
+          failed.add_content remote_index.contents[checksum]
+          absent_checksums << checksum
+        end
+      end
+
+      # add instances of contents that should be check
+      local_index.instances.each_value do |instance|
+        if remote_index.content_exists instance.checksum
+          local_index_to_check.add_instance instance
+        end
+      end
+
+
+      # validate against local file system
+      is_valid = local_index_to_check.validate(:failed => failed) && is_valid
+
+      # contains contents that have at least one valid local instance,
+      # then also corresponding remote content defined valid
+      contents_with_succeeded_instances = ContentData::ContentData.remove_instances failed, local_index
+
+      # write summary to log
+      # TODO should be controlled from params?
+      failed.contents.each_key do |checksum|
+        if absent_checksums.include? checksum
+          Log.warning "Content #{checksum} is absent in the local file system"
+        elsif !contents_with_succeeded_instances.content_exists checksum
+          # if checked content have no valid local instances
+          # then content defined invalid
+          Log.warning "Content #{checksum} is invalid in the local file system"
+        end
+      end
+
+      # if needed process output params
+      unless params.nil? || params.empty?
+        remote_index.instances.each_value do |instance|
+          unless contents_with_succeeded_instances.content_exists instance.checksum
+            process_params.call :content => remote_index.contents[instance.checksum], :instance => instance
+          end
+        end
+      end
+
+      is_valid
+    end
+
+  end  # class IndexValidations
+end  # module Validations

data/lib/validations/version.rb

@@ -0,0 +1,3 @@
+module Validations
+  VERSION = "0.0.3"
+end

data/spec/validations/index_validations_spec.rb

@@ -0,0 +1,100 @@
+require 'rspec'
+require_relative '../../lib/validations.rb'
+
+module Validations
+  module Spec
+    describe 'Index validation' do
+      context 'of index from other file system' do
+        before :all do
+          @size = 100
+          @path = '/dir1/dir2/file'
+          @path2 = '/dir3/dir4/file'
+          @path3 = '/dir5/dir6/file'
+          @path4 = '/dir7/dir8/file'
+          @mod_time = 123456
+          @checksum = 'abcde987654321'
+          @checksum2 = '987654321abcde'
+        end
+
+        before :each do
+          @index = ContentData::ContentData.new
+          @remote_index = ContentData::ContentData.new
+
+          @content = double :content, :checksum => @checksum,
+            :size => @size, :first_appearance_time => @mod_time
+          @content2 = double :content2, :checksum => @checksum2,
+            :size => @size, :first_appearance_time => @mod_time
+
+          @instance = double :instance, :checksum => @checksum, :global_path => @path,
+            :size => @size, :full_path => @path, :modification_time => @mod_time
+          @instance2 = double :instance2, :checksum => @checksum2, :global_path => @path2,
+            :size => @size, :full_path => @path2, :modification_time => @mod_time
+          @instance3 = double :instance3, :checksum => @checksum, :global_path => @path3,
+            :size => @size, :full_path => @path3, :modification_time => @mod_time
+          @instance4 = double :instance4, :checksum => @checksum2, :global_path => @path4,
+            :size => @size, :full_path => @path4, :modification_time => @mod_time
+
+          @index.add_content @content
+          @index.add_content @content2
+          @index.add_instance @instance
+          @index.add_instance @instance2
+
+          @remote_index.add_content @content
+          @remote_index.add_content @content2
+          @remote_index.add_instance @instance3
+          @remote_index.add_instance @instance4
+
+          File.stub(:exists?).and_return(true)
+          File.stub(:size).and_return(@size)
+          File.stub(:mtime).and_return(@mod_time)
+          #ContentData::ContentData.stub(:format_time).with(@mod_time).and_return(@mod_time)
+          Params['instance_check_level'] = 'shallow'
+        end
+
+        it 'succeeds when all remote contents has valid local instance' do
+          IndexValidations.validate_remote_index(@remote_index, @index).should be_true
+        end
+
+        it 'fails when remote content is absent' do
+          absent_checksum = '123'
+          absent_content = double :absent_content, :checksum => absent_checksum, \
+            :size => @size, :first_appearance_time => @mod_time
+          @remote_index.add_content absent_content
+          IndexValidations.validate_remote_index(@remote_index, @index).should be_false
+        end
+
+        it 'fails when local instance of remote content is invalid' do
+          modified_mtime = @mod_time + 10
+          File.stub(:mtime).with(@path).and_return(modified_mtime)
+          #ContentData::ContentData.stub(:format_time).with(modified_mtime).and_return(modified_mtime)
+          IndexValidations.validate_remote_index(@remote_index, @index).should be_false
+        end
+
+        it ':failed param returns index of absent contents or contents without valid instances' do
+          absent_checksum = '123'
+          absent_path = '/dir9/dir10/absent_file'
+          absent_content = double :absent_content, :checksum => absent_checksum, \
+            :size => @size, :first_appearance_time => @mod_time
+          absent_instance = double :instance, :checksum => absent_checksum, :global_path => absent_path,
+            :size => @size, :full_path => absent_path, :modification_time => @mod_time
+          @remote_index.add_content absent_content
+          @remote_index.add_instance absent_instance
+
+          # invalid instance has @path2 path on local and @path4 on remote
+          modified_mtime = @mod_time + 10
+          File.stub(:mtime).with(@path2).and_return(modified_mtime)
+          #ContentData::ContentData.stub(:format_time).with(modified_mtime).and_return(modified_mtime)
+
+          failed = ContentData::ContentData.new
+          IndexValidations.validate_remote_index(@remote_index, @index, :failed => failed)
+          failed.contents.should have(2).items
+          failed.contents.keys.should include(absent_checksum, @checksum2)
+          failed.instances.should have(2).items
+          failed.instances.keys.should include(@path4)
+
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: validations
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Genady Petelko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: params
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: content_data
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: file_indexing
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Used to validate ContentData objects.
+email: nukegluk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/validations.rb
+- lib/validations/index_validations.rb
+- lib/validations/version.rb
+- spec/validations/index_validations_spec.rb
+homepage: http://github.com/kolmanv/bbfs
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Library for validating data.
+test_files:
+- spec/validations/index_validations_spec.rb
+has_rdoc: