backup_monitor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc3244e3fc514e8900ddd48ef4790e859ccaf522
+  data.tar.gz: aa5fc44a704cc6989ef0cc29e37933b65728ef9d
+SHA512:
+  metadata.gz: 084a8f544d62ff76127d611874571223cf05199a827d43783b0670b9c4da0455ddc5ede37710ae005a2d93cd1944658cb3fd9ef6f61fcf4c517cf515f2c2ec91
+  data.tar.gz: a431ef968c778e166a6af23f1da3c5b82c8ef6863926e1d47a97a6a7eecf92f5790da69aa1c5ee883c074ffc4963e4d9ce3f50fa723d77561b19a2e2b7639ae4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in backup_monitor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aaron Ten Clay
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,29 @@
+# BackupMonitor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'backup_monitor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backup_monitor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/backup_monitor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rake/testtask'
+
+
+Rake::TestTask.new do |t|
+	t.test_files = FileList['test/test_*.rb']
+end
+
+
+task default: :test

data/backup_monitor.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path '../lib', __FILE__
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+require 'backup_monitor/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'backup_monitor'
+	spec.version       = BackupMonitor::VERSION
+	spec.authors       = ['Aaron Ten Clay']
+	spec.email         = ['backup_monitor_gem@aarontc.com']
+	spec.summary       = %q{Checks the modification age of a directory hierarchy to locate stale backups.}
+	spec.description   = spec.summary
+	spec.homepage      = 'https://github.com/AaronTC/backup_monitor'
+	spec.license       = 'MIT'
+
+	spec.files         = `git ls-files -z`.split "\x0"
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep %r{^(test|spec|features)/}
+	spec.require_paths = %w[lib]
+
+	%w[coalesce thor].each do |gem|
+		spec.add_dependency gem
+	end
+
+	spec.add_development_dependency 'bundler', '~> 1.6'
+	%w[fakefs minitest minitest-ci rake rr simplecov simplecov-rcov spork spork-minitest].each do |gem|
+		spec.add_development_dependency gem
+	end
+end

data/bin/backup_monitor

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'backup_monitor/cli'
+BackupMonitor::CLI.start

data/lib/backup_monitor.rb

@@ -0,0 +1,3 @@
+require 'backup_monitor/version'
+
+require 'backup_monitor/checker'

data/lib/backup_monitor/checker.rb

@@ -0,0 +1,35 @@
+require 'coalesce'
+require 'pathname'
+require 'backup_monitor/directory_hierarchy_modification_time'
+
+module BackupMonitor
+	class Checker
+		def initialize(options = {})
+			@warning_threshold = options.delete(:warning_threshold)._? { raise ArgumentError, ':warning_threshold (seconds) must be supplied in options hash' }
+		end
+
+		def check(path)
+			pathname = real_path path
+			result = {}
+			Dir[pathname.join('*')].each do |d|
+				full_path = pathname.join d
+				next if %w[. ..].include? d
+				next unless File.directory? full_path
+				dir_mtime = DirectoryHierarchyModificationTime.modification_time full_path
+				if dir_mtime.nil?
+					# No files in the tree
+					result[full_path] = Time.at(0)
+				else
+					result[full_path] = dir_mtime if (Time.now - dir_mtime).to_i > @warning_threshold
+				end
+			end
+			result
+		end
+
+
+		# This method wrapper exists solely for testing due to some outstanding bugs in FakeFS
+		def real_path(path)
+			Pathname.new(path).realpath
+		end
+	end
+end

data/lib/backup_monitor/cli.rb

@@ -0,0 +1,26 @@
+require 'thor'
+require 'backup_monitor/checker'
+
+module BackupMonitor
+	class CLI < Thor
+
+		desc 'check', 'Checks a directory of directories for modification times'
+		method_option :threshold, aliases: '-t', desc: 'Warning threshold, in seconds', type: :numeric, default: 300
+		def check(base_path = nil)
+			base_path ||= Dir.pwd
+
+			checker = Checker.new warning_threshold: options[:threshold].to_i
+			result = checker.check base_path
+			if result.empty?
+				STDOUT.puts 'No stale directories found'
+			else
+				STDERR.puts 'Found stale directories:'
+				result.each_pair do |key, value|
+					STDERR.puts "\t#{value} - #{key}"
+				end
+			end
+		end
+
+		default_task :check
+	end
+end

data/lib/backup_monitor/directory_hierarchy_modification_time.rb

@@ -0,0 +1,18 @@
+module BackupMonitor
+	class DirectoryHierarchyModificationTime
+		# TODO: This is slow and kludgy
+		def self.modification_time(root_path)
+			newest_mtime = nil
+			newest_path = nil
+			Dir["#{root_path}/**"].each do |f|
+				next if File.directory? f
+				mtime = File.mtime f
+				if newest_mtime.nil? or mtime > newest_mtime
+					newest_mtime = mtime
+					newest_path = f
+				end
+			end
+			newest_mtime
+		end
+	end
+end

data/lib/backup_monitor/version.rb

@@ -0,0 +1,3 @@
+module BackupMonitor
+	VERSION = '0.0.1'
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+require 'simplecov-rcov'
+
+# Configure code coverage
+SimpleCov.coverage_dir 'build/output/coverage'
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start unless SimpleCov.running
+
+# Configure minitest
+require 'minitest/pride'
+require 'minitest/autorun'
+require 'rr'
+
+# Test dependencies
+require 'fakefs/safe'
+
+Minitest::Ci.clean = false
+Minitest::Ci.report_dir = 'build/output/test'

data/test/test_backup_monitor_checker.rb

@@ -0,0 +1,52 @@
+require_relative 'helper'
+
+require 'backup_monitor/checker'
+
+class TestBackupMonitorChecker < Minitest::Test
+	def test_with_two_old_backups
+		mock(BackupMonitor::DirectoryHierarchyModificationTime).modification_time('/backups/host1.domain') { Time.new 2014, 7, 14, 16, 15, 22, '-07:00' }
+		mock(BackupMonitor::DirectoryHierarchyModificationTime).modification_time('/backups/host2.domain') { Time.new 2014, 8, 2, 1, 3, 5, '-07:00' }
+		mock(BackupMonitor::DirectoryHierarchyModificationTime).modification_time('/backups/host3.otherdomain') { Time.new 2014, 2, 4, 22, 45, 8, '-07:00' }
+		mock(FakeFS::Dir).[]('/backups/*') { %w[. .. host1.domain host2.domain host3.otherdomain].shuffle }
+		mock(FakeFS::File).directory?('/backups/host1.domain') { true }
+		mock(FakeFS::File).directory?('/backups/host2.domain') { true }
+		mock(FakeFS::File).directory?('/backups/host3.otherdomain') { true }
+		stub(Time).now { Time.new 2014, 8, 3, 16, 23, 26, '-07:00' }
+
+		actual = nil
+		FakeFS do
+			uut = BackupMonitor::Checker.new warning_threshold: (3 * 24 * 60 * 60)
+			stub(uut).real_path.with_any_args { stub!.join.with_any_args { |x| "/backups/#{x}" } }
+			actual = uut.check '/backups'
+		end
+
+		expected = {
+			'/backups/host1.domain' => Time.new(2014, 7, 14, 16, 15, 22, '-07:00'),
+			'/backups/host3.otherdomain' => Time.new(2014, 2, 4, 22, 45, 8, '-07:00')
+		}
+
+		assert_equal expected, actual, 'Checker did not return expected list of outdated directories'
+	end
+
+
+	def test_with_no_old_backups
+		mock(BackupMonitor::DirectoryHierarchyModificationTime).modification_time('/backups/other/host44.domain') { Time.new 2014, 8, 2, 7, 32, 16, '-07:00' }
+		mock(BackupMonitor::DirectoryHierarchyModificationTime).modification_time('/backups/other/host45.domain') { Time.new 2014, 8, 2, 2, 17, 52, '-07:00' }
+		mock(BackupMonitor::DirectoryHierarchyModificationTime).modification_time('/backups/other/host46.otherdomain') { Time.new 2014, 8, 2, 4, 3, 41, '-07:00' }
+		mock(FakeFS::Dir).[]('/backups/other/*') { %w[. .. host44.domain host45.domain host46.otherdomain].shuffle }
+		mock(FakeFS::File).directory?('/backups/other/host44.domain') { true }
+		mock(FakeFS::File).directory?('/backups/other/host45.domain') { true }
+		mock(FakeFS::File).directory?('/backups/other/host46.otherdomain') { true }
+		stub(Time).now { Time.new 2014, 8, 3, 16, 23, 26, '-07:00' }
+
+		actual = nil
+		FakeFS do
+			uut = BackupMonitor::Checker.new warning_threshold: (3 * 24 * 60 * 60)
+			stub(uut).real_path.with_any_args { stub!.join.with_any_args { |x| "/backups/other/#{x}" } }
+			actual = uut.check '/backups/other'
+		end
+
+		expected = {}
+		assert_equal expected, actual, 'Checker did not return empty hash with no old backups for #check'
+	end
+end

data/test/test_directory_hierarchy_modification_time.rb

@@ -0,0 +1,47 @@
+require_relative 'helper'
+
+require 'backup_monitor/directory_hierarchy_modification_time'
+
+class TestDirectoryHierarchyModificationTime < Minitest::Test
+	def test_modification_time_with_some_files
+		actual = nil
+		expected = Time.new 2014, 8, 3, 15, 05, 01, '-07:00'
+
+		FakeFS do
+			# There is a bug in FakeFS, the following line should work but doesn't:
+			#FileUtils.mkdir_p '/my_directory/some_cool/files_here'
+
+			# This is the workaround:
+			FileUtils.mkdir '/my_directory'
+			FileUtils.mkdir '/my_directory/some_cool'
+			FileUtils.mkdir '/my_directory/some_cool/files_here'
+
+			FileUtils.touch '/my_directory/LICENSE.md', mtime: (expected - 1000)
+			FileUtils.touch '/my_directory/some_cool/files_here/my_file.txt', mtime: expected
+			FileUtils.touch '/my_directory/some_cool/README.md', mtime: (expected - 100)
+
+			actual = BackupMonitor::DirectoryHierarchyModificationTime.modification_time '/my_directory'
+		end
+
+		assert_equal expected, actual, 'The modification time returned was incorrect'
+	end
+
+
+	def test_modification_time_with_no_files
+		actual = nil
+
+		FakeFS do
+			# There is a bug in FakeFS, the following line should work but doesn't:
+			#FileUtils.mkdir_p '/my_directory/some_cool/files_here'
+
+			# This is the workaround:
+			FileUtils.mkdir '/my_directory2'
+			FileUtils.mkdir '/my_directory2/some_cool'
+			FileUtils.mkdir '/my_directory2/some_cool/files_here'
+
+			actual = BackupMonitor::DirectoryHierarchyModificationTime.modification_time '/my_directory2'
+		end
+
+		assert_nil actual, 'The modification time returned was not nil and should have been'
+	end
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: backup_monitor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aaron Ten Clay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coalesce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  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: minitest
+  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: minitest-ci
+  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: rake
+  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: rr
+  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: simplecov
+  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: simplecov-rcov
+  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: spork
+  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: spork-minitest
+  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'
+description: Checks the modification age of a directory hierarchy to locate stale
+  backups.
+email:
+- backup_monitor_gem@aarontc.com
+executables:
+- backup_monitor
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backup_monitor.gemspec
+- bin/backup_monitor
+- lib/backup_monitor.rb
+- lib/backup_monitor/checker.rb
+- lib/backup_monitor/cli.rb
+- lib/backup_monitor/directory_hierarchy_modification_time.rb
+- lib/backup_monitor/version.rb
+- test/helper.rb
+- test/test_backup_monitor_checker.rb
+- test/test_directory_hierarchy_modification_time.rb
+homepage: https://github.com/AaronTC/backup_monitor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.14
+signing_key: 
+specification_version: 4
+summary: Checks the modification age of a directory hierarchy to locate stale backups.
+test_files:
+- test/helper.rb
+- test/test_backup_monitor_checker.rb
+- test/test_directory_hierarchy_modification_time.rb