fingerprint 1.4.0 → 3.2.0

data/lib/fingerprint/command/verify.rb

@@ -0,0 +1,86 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+
+require_relative '../checker'
+require_relative '../record'
+
+module Fingerprint
+	module Command
+		class Verify < Samovar::Command
+			self.description = "Check an existing fingerprint against the filesystem."
+			
+			options do
+				option "-n/--name <name>", "The fingerprint file name.", default: INDEX_FINGERPRINT
+				
+				option "-f/--force", "Force all operations to complete despite warnings."
+				option "-x/--extended", "Include extended information about files and directories."
+				
+				option "-s/--checksums <SHA2.256>", "Specify what checksum algorithms to use (#{Fingerprint::CHECKSUMS.keys.join(', ')}).", default: Fingerprint::DEFAULT_CHECKSUMS
+				
+				option "--progress", "Print structured progress to standard error."
+				option "--verbose", "Verbose fingerprint output, e.g. excluded paths."
+				
+				option "--fail-on-errors", "Exit with non-zero status if errors are encountered."
+			end
+			
+			many :paths, "Paths relative to the root to use for verification, or ./ if not specified.", default: ["./"]
+			
+			attr :error_count
+			
+			def call
+				input_file = @options[:name]
+
+				unless File.exist? input_file
+					abort "Can't find index #{input_file}. Aborting."
+				end
+
+				options = @options.dup
+				options[:output] = @parent.output
+
+				master = RecordSet.new
+
+				File.open(input_file, "r") do |io|
+					master.parse(io)
+				end
+
+				if master.configuration
+					options.merge!(master.configuration.options)
+				end
+
+				scanner = Scanner.new(@paths, **options)
+				
+				# We use a sparse record set here, so we can't check for additions.
+				copy = SparseRecordSet.new(scanner)
+
+				@error_count = Checker.verify(master, copy, **options)
+				
+				if @options[:fail_on_errors]
+					abort "Data inconsistent, #{error_count} error(s) found!" if error_count != 0
+				end
+			end
+		end
+	end
+end

data/lib/fingerprint/command.rb

@@ -0,0 +1,90 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+
+require_relative 'scanner'
+
+require_relative 'command/scan'
+require_relative 'command/analyze'
+require_relative 'command/verify'
+require_relative 'command/compare'
+require_relative 'command/duplicates'
+
+module Fingerprint
+	module Command
+		def self.call(*args)
+			Top.call(*args)
+		end
+		
+		class Top < Samovar::Command
+			self.description = "A file checksum analysis and verification tool."
+			
+			options do
+				option '--root <path>', "Work in the given root directory."
+				
+				option '-o/--output <path>', "Output the transcript to a specific file rather than stdout."
+				
+				option '-h/--help', "Print out help information."
+				option '-v/--version', "Print out the application version."
+			end
+			
+			def chdir(&block)
+				if root = @options[:root]
+					Dir.chdir(root, &block)
+				else
+					yield
+				end
+			end
+			
+			def output
+				if path = @options[:output]
+					File.open(path, "w")
+				else
+					$stdout
+				end
+			end
+			
+			nested :command, {
+				'scan' => Scan,
+				'analyze' => Analyze,
+				'verify' => Verify,
+				'compare' => Compare,
+				'duplicates' => Duplicates
+			}, default: 'analyze'
+			
+			def call
+				if @options[:version]
+					puts "fingerprint v#{VERSION}"
+				elsif @options[:help]
+					self.print_usage
+				else
+					chdir do
+						@command.call
+					end
+				end
+			end
+		end
+	end
+end

data/{test/test_fingerprint.rb → lib/fingerprint/find.rb}

@@ -1,6 +1,4 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2007, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -20,42 +18,23 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'rubygems'
-
-require 'test/unit'
-require 'fileutils'
-require 'pathname'
-require 'fingerprint'
-
-require 'timeout'
-
-class TestFingerprint < Test::Unit::TestCase
-	def test_analyze_verify
-		File.open("junk.txt", "w") { |fp| fp.write("foobar") }
-		
-		result = system("fingerprint --analyze ./ -f")
-		
-		File.open("junk.txt", "w") { |fp| fp.write("foobar") }
-		
-		result = system("fingerprint --verify ./")
-		
-		assert_equal true, result
-		
-		File.open("junk.txt", "w") { |fp| fp.write("foobaz") }
-		
-		result = system("fingerprint -X --verify ./")
-		
-		assert_equal false, result
-	end
+require 'find'
+require 'build/files/path'
+require 'build/files/system'
 
-	def test_check_paths
-		errors = 0
-		test_path = File.dirname(__FILE__)
-		
-		Fingerprint::check_paths(test_path, test_path) do |record, result, message|
-			errors += 1
+module Fingerprint
+	module Find
+		def self.find(root)
+			# Ensure root is a directory:
+			root += File::SEPARATOR unless root.end_with?(File::SEPARATOR)
+			
+			::Find.find(root) do |path|
+				yield Build::Files::Path.new(path, root)
+			end
 		end
 		
-		assert_equal errors, 0
+		def self.prune
+			::Find.prune
+		end
 	end
 end

data/lib/fingerprint/record.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2011, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -25,6 +25,7 @@ module Fingerprint
 	MODES = {
 		:configuration => 'C',
 		:file => 'F',
+		:link => 'L',
 		:directory => 'D',
 		:summary => 'S',
 		:warning => 'W',
@@ -84,6 +85,16 @@ module Fingerprint
 	end
 	
 	class RecordSet
+		def self.load_file(path)
+			File.open(path, "r") do |io|
+				self.load(io)
+			end
+		end
+		
+		def self.load(io)
+			self.new.tap{|record_set| record_set.parse(io)}
+		end
+		
 		def initialize
 			@records = []
 			@paths = {}
@@ -115,6 +126,14 @@ module Fingerprint
 			end
 		end
 
+		def include?(path)
+			@paths.include?(path)
+		end
+		
+		def empty?
+			@paths.empty?
+		end
+
 		def lookup(path)
 			return @paths[path]
 		end

data/lib/fingerprint/scanner.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2011, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,28 +19,33 @@
 # THE SOFTWARE.
 
 require 'stringio'
-require 'find'
 require 'etc'
 require 'digest/sha2'
 
-module Fingerprint
+require_relative 'find'
+require_relative 'record'
+require_relative 'version'
 
+module Fingerprint
+	INDEX_FINGERPRINT = "index.fingerprint"
+	
 	CHECKSUMS = {
 		'MD5' => lambda { Digest::MD5.new },
 		'SHA1' => lambda { Digest::SHA1.new },
 		'SHA2.256' => lambda { Digest::SHA2.new(256) },
+		'SHA2.384' => lambda { Digest::SHA2.new(384) },
 		'SHA2.512' => lambda { Digest::SHA2.new(512) },
 	}
 
-	DEFAULT_CHECKSUMS = ['MD5', 'SHA2.256']
+	DEFAULT_CHECKSUMS = ['SHA2.256']
 
 	# The scanner class can scan a set of directories and produce an index.
 	class Scanner
 		# Initialize the scanner to scan a given set of directories in order.
 		# [+options[:excludes]+]  An array of regular expressions of files to avoid indexing.
 		# [+options[:output]+]    An +IO+ where the results will be written.
-		def initialize(roots, options = {})
-			@roots = roots
+		def initialize(roots, pwd: Dir.pwd, **options)
+			@roots = roots.collect{|root| File.expand_path(root, pwd)}
 
 			@excludes = options[:excludes] || []
 			@options = options
@@ -84,14 +89,14 @@ module Fingerprint
 			end
 
 			File.open(path, "rb") do |file|
-				buf = ""
-				while file.read(1024 * 1024 * 10, buf)
-					total += buf.size
+				buffer = ""
+				while file.read(1024 * 1024 * 10, buffer)
+					total += buffer.bytesize
 					
 					@progress.call(total) if @progress
 					
 					@digests.each do |key, digest|
-						digest << buf
+						digest << buffer
 					end
 				end
 			end
@@ -106,35 +111,61 @@ module Fingerprint
 		end
 
 		def metadata_for(type, path)
-			stat = File.stat(path)
 			metadata = {}
+			
+			if type == :link
+				metadata['file.symlink'] = File.readlink(path)
+			else
+				stat = File.stat(path)
+
+				if type == :file
+					metadata['file.size'] = stat.size
+					digests = digests_for(path)
+					metadata.merge!(digests)
+				elsif type == :blockdev or type == :chardev
+					metadata['file.dev_major'] = stat.dev_major
+					metadata['file.dev_minor'] = stat.dev_minor
+				end
 
-			if type == :file
-				metadata['file.size'] = stat.size
-				digests = digests_for(path)
-				metadata.merge!(digests)
-			end
-
-			# Extended information
-			if @options[:extended]
-				metadata['posix.time.modified'] = File.mtime(path)
+				# Extended information
+				if @options[:extended]
+					metadata['posix.time.modified'] = File.mtime(path)
 
-				metadata['posix.mode'] = stat.mode.to_s(8)
+					metadata['posix.mode'] = stat.mode.to_s(8)
 
-				metadata['posix.permissions.user.id'] = stat.uid
-				metadata['posix.permissions.user.name'] = Etc.getpwuid(stat.uid).name
-				metadata['posix.permissions.group.id'] = stat.gid
-				metadata['posix.permissions.group.name'] = Etc.getgrgid(stat.gid).name
+					metadata['posix.permissions.user.id'] = stat.uid
+					metadata['posix.permissions.user.name'] = Etc.getpwuid(stat.uid).name
+					metadata['posix.permissions.group.id'] = stat.gid
+					metadata['posix.permissions.group.name'] = Etc.getgrgid(stat.gid).name
+				end
 			end
-
+			
 			return metadata
 		end
 		
 		# Output a directory header.
 		def directory_record_for(path)
-			Record.new(:directory, path, metadata_for(:directory, path))
+			Record.new(:directory, path.relative_path, metadata_for(:directory, path))
 		end
 
+		def link_record_for(path)
+			metadata = metadata_for(:link, path)
+			
+			Record.new(:link, path.relative_path, metadata)
+		end
+		
+		def blockdev_record_for(path)
+			metadata = metadata_for(:blockdev, path)
+			
+			Record.new(:blockdev, path.relative_path, metadata)
+		end
+		
+		def chardev_record_for(path)
+			metadata = metadata_for(:chardev, path)
+			
+			Record.new(:chardev, path.relative_path, metadata)
+		end
+		
 		# Output a file and associated metadata.
 		def file_record_for(path)
 			metadata = metadata_for(:file, path)
@@ -142,12 +173,30 @@ module Fingerprint
 			# Should this be here or in metadata_for?
 			# metadata.merge!(digests_for(path))
 			
-			Record.new(:file, path, metadata)
+			Record.new(:file, path.relative_path, metadata)
 		end
 
 		# Add information about excluded paths.
 		def excluded_record_for(path)
-			Record.new(:excluded, path)
+			Record.new(:excluded, path.relative_path)
+		end
+
+		def record_for(path)
+			stat = File.stat(path)
+			
+			if stat.symlink?
+				return link_record_for(path)
+			elsif stat.blockdev?
+				return blockdev_record_for(path)
+			elsif stat.chardev?
+				return chardev_record_for(path)
+			elsif stat.socket?
+				return socket_record_for(path)
+			elsif stat.file?
+				return file_record_for(path)
+			end
+		rescue Errno::ENOENT
+			return nil
 		end
 
 		public
@@ -163,17 +212,13 @@ module Fingerprint
 			return false
 		end
 
-		def valid_file?(path)
-			!(excluded?(path) || File.symlink?(path) || !File.file?(path) || !File.readable?(path))
-		end
-
 		def scan_path(path)
+			return nil if excluded?(path)
+			
 			@roots.each do |root|
-				Dir.chdir(root) do
-					if valid_file?(path)
-						return file_record_for(path)
-					end
-				end
+				full_path = Build::Files::Path.join(root, path)
+				
+				return record_for(full_path)
 			end
 			
 			return nil
@@ -192,23 +237,21 @@ module Fingerprint
 			# Estimate the number of files and amount of data to process..
 			if @options[:progress]
 				@roots.each do |root|
-					Dir.chdir(root) do
-						Find.find("./") do |path|
-							if @options[:progress]
-								$stderr.puts "# Scanning: #{path}"
-							end
-							
-							if File.directory?(path)
-								if excluded?(path)
-									Find.prune # Ignore this directory
-								end
-							else
-								# Skip anything that isn't a valid file (e.g. pipes, sockets, symlinks).
-								if valid_file?(path)
-									total_count += 1
-									total_size += File.size(path)
-								end
-							end
+					Find.find(root) do |path|
+						# Some special files fail here, and this was the simplest fix.
+						Find.prune unless File.exist?(path)
+						
+						if @options[:progress]
+							$stderr.puts "# Scanning: #{path}"
+						end
+						
+						if excluded?(path)
+							Find.prune if path.directory?
+						elsif path.symlink?
+							total_count += 1
+						elsif path.file?
+							total_count += 1
+							total_size += File.size(path)
 						end
 					end
 				end
@@ -216,52 +259,52 @@ module Fingerprint
 			
 			if @options[:progress]
 				@progress = lambda do |read_size|
-					$stderr.puts "# Progress: File #{processed_count} / #{total_count}; Byte #{processed_size + read_size} / #{total_size} = #{sprintf('%0.3f%', (processed_size + read_size).to_f / total_size.to_f * 100.0)} (#{read_size}, #{processed_size}, #{total_size})"
+					$stderr.puts "# Progress: File #{processed_count} / #{total_count}; Byte #{processed_size + read_size} / #{total_size} = #{sprintf('%0.3f%%', (processed_size + read_size).to_f / total_size.to_f * 100.0)} (#{read_size}, #{processed_size}, #{total_size})"
 				end
 			end
 			
 			@roots.each do |root|
-				Dir.chdir(root) do
-					recordset << header_for(root)
+				recordset << header_for(root)
+				
+				Find.find(root) do |path|
+					# Some special files fail here, and this was the simplest fix.
+					Find.prune unless File.exist?(path)
 					
-					Find.find("./") do |path|
-						if @options[:progress]
-							$stderr.puts "# Path: #{path}"
-						end
+					if @options[:progress]
+						$stderr.puts "# Path: #{path.relative_path}"
+					end
+					
+					if excluded?(path)
+						excluded_count += 1
 						
-						if File.directory?(path)
-							if excluded?(path)
-								excluded_count += 1
-								
-								if @options[:verbose]
-									recordset << excluded_record_for(path)
-								end
-								
-								Find.prune # Ignore this directory
-							else
-								directory_count += 1
-								
-								recordset << directory_record_for(path)
-							end
-						else
-							# Skip anything that isn't a valid file (e.g. pipes, sockets, symlinks).
-							if valid_file?(path)
-								recordset << file_record_for(path)
-
-								processed_count += 1
-								processed_size += File.size(path)
-							else
-								excluded_count += 1
-								
-								if @options[:verbose]
-									recordset << excluded_record_for(path)
-								end
-							end
+						if @options[:verbose]
+							recordset << excluded_record_for(path)
 						end
 						
-						# Print out a progress summary if requested
-						@progress.call(0) if @progress
+						Find.prune if path.directory?
+					elsif path.directory?
+						directory_count += 1
+						
+						recordset << directory_record_for(path)
+					elsif path.symlink?
+						recordset << link_record_for(path)
+						
+						processed_count += 1
+					elsif path.file?
+						recordset << file_record_for(path)
+
+						processed_count += 1
+						processed_size += File.size(path)
+					else
+						excluded_count += 1
+						
+						if @options[:verbose]
+							recordset << excluded_record_for(path)
+						end
 					end
+					
+					# Print out a progress summary if requested
+					@progress.call(0) if @progress
 				end
 			end
 			
@@ -280,7 +323,7 @@ module Fingerprint
 		end
 
 		# A helper function to scan a set of directories.
-		def self.scan_paths(paths, options = {})
+		def self.scan_paths(paths, **options)
 			if options[:output]
 				if options.key? :recordset
 					recordset = options[:recordset]
@@ -291,7 +334,7 @@ module Fingerprint
 				options[:recordset] = RecordSetPrinter.new(recordset, options[:output])
 			end
 
-			scanner = Scanner.new(paths, options)
+			scanner = Scanner.new(paths, **options)
 
 			scanner.scan(options[:recordset])
 

data/lib/fingerprint/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2011, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -18,7 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-
 module Fingerprint
-	VERSION = "1.4.0"
+	VERSION = "3.2.0"
 end

data/lib/fingerprint.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2011, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -25,7 +25,7 @@ require 'fingerprint/checker'
 
 module Fingerprint
 	# A helper function to check two paths for consistency. Provides callback from +Fingerprint::Checker+.
-	def self.check_paths(master_path, copy_path, &block)
+	def self.check_paths(master_path, copy_path, **options, &block)
 		master = Scanner.new([master_path])
 		copy = Scanner.new([copy_path])
 		
@@ -34,10 +34,23 @@ module Fingerprint
 		
 		master.scan(master_recordset)
 		
-		checker = Checker.new(master_recordset, copy_recordset)
+		checker = Checker.new(master_recordset, copy_recordset, **options)
 		
 		checker.check(&block)
 		
 		return checker
 	end
+	
+	# Returns true if the given paths contain identical files. Useful for expectations, e.g. `expect(Fingerprint).to be_identical(source, destination)`
+	def self.identical?(source, destination, &block)
+		failures = 0
+		
+		check_paths(source, destination) do |record, name, message|
+			failures += 1
+			
+			yield(record) if block_given?
+		end
+		
+		return failures == 0
+	end
 end