fingerprint 1.4.0 → 3.0.1

data/spec/fingerprint/command/verify_spec.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env rspec
+
+# 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.
+
+require 'fingerprint/command'
+
+require_relative 'source_fingerprint'
+
+RSpec.describe Fingerprint::Command::Verify do
+	include_context "source fingerprint"
+	
+	it "should analyze a different path" do
+		Fingerprint::Command::Top["analyze", "-n", fingerprint_name, "-f", source_directory].call
+		
+		expect(File).to be_exist(fingerprint_name)
+		
+		top = Fingerprint::Command::Top["verify", "-n", fingerprint_name, "-f", source_directory].tap(&:call)
+		
+		expect(top.command.error_count).to be == 0
+	end
+end

data/spec/fingerprint/corpus/README.md

@@ -0,0 +1,3 @@
+# Corpus
+
+This directory contains some sample files.

data/spec/fingerprint/scanner_spec.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env rspec
+
+# 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.
+
+require 'fingerprint/scanner'
+
+RSpec.shared_examples "scanner checksum" do |digests|
+	let(:scanner) {Fingerprint::Scanner.new([__dir__], checksums: subject)}
+	
+	it "computes checksums correctly" do
+		digests.each do |path, required_metadata|
+			record = scanner.scan_path(path)
+			
+			expect(record.metadata).to include(required_metadata)
+		end
+	end
+end
+
+RSpec.describe "defaults" do
+	it "defaults to SHA2.256 only" do
+		expect(Fingerprint::DEFAULT_CHECKSUMS).to eq(['SHA2.256'])
+	end
+end
+
+RSpec.describe ['MD5'] do
+	it_behaves_like "scanner checksum",
+		"corpus/README.md" => {
+			"file.size" => 52,
+			"key.MD5" => "2d7157522d94e7d1621daefd5b92817f",
+		}
+end
+
+RSpec.describe ['SHA1'] do
+	it_behaves_like "scanner checksum",
+		"corpus/README.md" => {
+			"file.size" => 52,
+			"key.SHA1" => "a36492a961d2672efc481059860af5c1dd9a2aed"
+		}
+end
+
+RSpec.describe ['SHA2.256', 'SHA2.384', 'SHA2.512'] do
+	it_behaves_like "scanner checksum",
+		"corpus/README.md" => {
+			"file.size" => 52,
+			"key.SHA2.256" => "0d991d01d74c50cd5dcce8140e61e4da5a06e468d9df704195e84863269ce20f",
+			"key.SHA2.384" => "8d9b81d6aa761b9611dbcb76471e667854ece77a134aa53953651938e233791fe6a4b6aa2db3eb7b9531bdb49ce5a31f",
+			"key.SHA2.512" => "73c9d10f92ca7a0d53641efe59860a7bd358185cfe5ba51fe7b19a6894344f3109de8840d3ae73742c5a059daffcbdda865111f1925604e3f6c59d33443bde2c",
+		}
+end

data/{test/test_fingerprint.rb → spec/fingerprint_spec.rb}

@@ -1,6 +1,6 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env rspec
 
-# 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 +20,14 @@
 # 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
+describe Fingerprint do
+	it "should check the same path and not report any differences" do
+		expect(Fingerprint).to be_identical(__dir__, __dir__)
 	end
-
-	def test_check_paths
-		errors = 0
-		test_path = File.dirname(__FILE__)
-		
-		Fingerprint::check_paths(test_path, test_path) do |record, result, message|
-			errors += 1
-		end
-		
-		assert_equal errors, 0
+	
+	it "should check different paths and report differences" do
+		expect(Fingerprint).to_not be_identical(__dir__, File.expand_path("../", __dir__))
 	end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# Copyright, 2019, 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.
+
+require 'bundler/setup'
+require 'covered/rspec'
+
+RSpec.configure do |config|
+	# Enable flags like --only-failures and --next-failure
+	config.example_status_persistence_file_path = ".rspec_status"
+	
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+end

metadata

@@ -1,55 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: fingerprint
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: samovar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: build-files
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lockfile
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: "\t\tFingerprint is a general purpose data integrity tool that uses cryptographic
@@ -62,22 +104,39 @@ email:
 - samuel.williams@oriontransfer.co.nz
 executables:
 - fingerprint
-- fingerprint-diff
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- GUIDE.md
 - Gemfile
 - README.md
+- Rakefile
 - bin/fingerprint
-- bin/fingerprint-diff
 - fingerprint.gemspec
 - lib/fingerprint.rb
 - lib/fingerprint/checker.rb
+- lib/fingerprint/checksums.rb
+- lib/fingerprint/command.rb
+- lib/fingerprint/command/analyze.rb
+- lib/fingerprint/command/compare.rb
+- lib/fingerprint/command/duplicates.rb
+- lib/fingerprint/command/scan.rb
+- lib/fingerprint/command/verify.rb
+- lib/fingerprint/find.rb
 - lib/fingerprint/record.rb
 - lib/fingerprint/scanner.rb
 - lib/fingerprint/version.rb
-- rakefile.rb
-- test/test_fingerprint.rb
+- spec/fingerprint/command/analyze_spec.rb
+- spec/fingerprint/command/duplicates_spec.rb
+- spec/fingerprint/command/source_fingerprint.rb
+- spec/fingerprint/command/verify_spec.rb
+- spec/fingerprint/corpus/README.md
+- spec/fingerprint/scanner_spec.rb
+- spec/fingerprint_spec.rb
+- spec/spec_helper.rb
 homepage: http://www.codeotaku.com/projects/fingerprint
 licenses:
 - MIT
@@ -88,20 +147,26 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Fingerprint is a tool for creating checksums of entire directory structures,
   and comparing them for inconsistencies.
 test_files:
-- test/test_fingerprint.rb
+- spec/fingerprint/command/analyze_spec.rb
+- spec/fingerprint/command/duplicates_spec.rb
+- spec/fingerprint/command/source_fingerprint.rb
+- spec/fingerprint/command/verify_spec.rb
+- spec/fingerprint/corpus/README.md
+- spec/fingerprint/scanner_spec.rb
+- spec/fingerprint_spec.rb
+- spec/spec_helper.rb

data/bin/fingerprint-diff

@@ -1,145 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
-# 
-# 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.
-
-require 'optparse'
-require 'pathname'
-require 'fingerprint'
-require 'lockfile'
-require 'fileutils'
-
-OPTIONS = {
-	:mode => nil,
-	:output => $stdout,
-	:verbose => false,
-	:force => false,
-	:extended => false,
-	:inverse => false
-}
-
-$options = nil
-
-ARGV.options do |o|
-	$options = o
-	
-	script_name = File.basename($0)
-
-	o.banner = "Usage: #{script_name} [options] [path]"
-	o.define_head "This script is used to calculate the differences between two fingerprints."
-
-	o.separator ""
-	o.separator "Set operations between fingerprints:"
-	
-	o.on("--duplicates", "Calculate files in copy that already exist in master") do |master, copy|
-		OPTIONS[:mode] = :duplicates
-	end
-		
-	o.separator ""
-	o.separator "Output manipulation:"
-	
-	o.on("-o [output-path]", String, "Write the fingerprint output to the given file.") do |path|
-		OPTIONS[:output] = File.open(path, "w")
-	end
-	
-	o.on("--verbose", "Verbose output, include additional details in the file transcript.") do
-		OPTIONS[:verbose] = true
-	end
-	
-	o.on("--progress", "Print percentage progress to standard error.") do
-		OPTIONS[:progress] = true
-	end
-	
-	o.on("--inverse", "Show the inverse of the selected operation.") do
-		OPTIONS[:inverse] = true
-	end
-	
-	o.separator ""
-	o.separator "Help and Copyright information:"
-
-	o.on_tail("--copy", "Display copyright and warranty information") do
-		$stderr.puts "#{script_name} v#{Fingerprint::VERSION::STRING}. Copyright (c) 2011 Samuel Williams."
-		$stderr.puts "This software is released under the MIT license and comes with ABSOLUTELY NO WARRANTY."
-		$stderr.puts "See http://www.oriontransfer.co.nz/ for more information."
-		exit
-	end
-
-	o.on_tail("-h", "--help", "Show this help message.") do
-		$stderr.puts o
-		exit
-	end
-end.parse!
-
-case (OPTIONS[:mode])
-when :duplicates
-	options = OPTIONS.dup
-	
-	include Fingerprint
-	
-	duplicates_recordset = RecordSet.new
-	results = RecordSetPrinter.new(duplicates_recordset, OPTIONS[:output])
-	
-	master_file_path = ARGV.shift
-	File.open(master_file_path) do |master_file|
-		master_recordset = RecordSet.new
-		master_recordset.parse(master_file)
-		
-		ignore_similar = false
-		
-		copy_file_paths = ARGV
-		if copy_file_paths.size == 0
-			copy_file_paths = [master_file_path]
-			ignore_similar = true
-		end
-		
-		copy_file_paths.each do |copy_file_path|
-			File.open(copy_file_path) do |copy_file|
-				copy_recordset = RecordSet.new
-				copy_recordset.parse(copy_file)
-				
-				copy_recordset.records.each do |record|
-					record.metadata['fingerprint'] = copy_file_path
-					# We need to see if the record exists in the master
-					
-					if OPTIONS[:verbose]
-						$stderr.puts "Checking #{record.inspect}"
-					end
-					
-					main_record = master_recordset.find_by_key(record)
-					
-					# If we are scanning the same index, don't print out every file, just those that are duplicates within the single file.
-					if ignore_similar && main_record && (main_record.path == record.path)
-						main_record = nil
-					end
-					
-					if main_record
-						record.metadata['original.path'] = main_record.path
-						record.metadata['original.fingerprint'] = master_file_path
-						results << record if !OPTIONS[:inverse]
-					else
-						results << record if OPTIONS[:inverse]
-					end
-				end
-			end
-		end
-	end
-else
-	puts $options
-end