backup 3.0.23 → 3.0.24

data/spec-live/spec_helper.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+## # Use Bundler
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'bundler/setup'
+
+##
+# Load Backup
+require 'backup'
+
+module Backup
+  module SpecLive
+    PATH = File.expand_path('..', __FILE__)
+    # to archive local backups, etc...
+    TMP_PATH = PATH + '/tmp'
+    SYNC_PATH = PATH + '/sync'
+
+    config = PATH + '/backups/config.yml'
+    if File.exist?(config)
+      CONFIG = YAML.load_file(config)
+    else
+      puts "The 'spec-live/backups/config.yml' file is required."
+      puts "Use 'spec-live/backups/config.yml.template' to create one"
+      exit!
+    end
+
+    module ExampleHelpers
+
+      def h_set_trigger(trigger)
+        Backup::Logger.clear!
+        Backup::Model.all.clear
+        Backup::Config.load_config!
+        FileUtils.mkdir_p(File.join(Backup::Config.data_path, trigger))
+        Backup::Model.find(trigger)
+      end
+
+      def h_clean_data_paths!
+        paths = [:data_path, :log_path, :tmp_path ].map do |name|
+          Backup::Config.send(name)
+        end + [Backup::SpecLive::TMP_PATH]
+        paths.each do |path|
+          h_safety_check(path)
+          FileUtils.rm_rf(path)
+          FileUtils.mkdir_p(path)
+        end
+      end
+
+      def h_safety_check(path)
+        # Rule #1: Do No Harm.
+        unless (
+          path.start_with?(Backup::SpecLive::PATH) &&
+            Backup::SpecLive::PATH.end_with?('spec-live')
+        ) || path.include?('spec_live_test_dir')
+          warn "\nSafety Check Failed:\nPath: #{path}\n\n" +
+              caller(1).join("\n")
+          exit!
+        end
+      end
+
+    end # ExampleHelpers
+  end
+
+  Config.update(:root_path => SpecLive::PATH + '/backups')
+
+  Logger.quiet = true unless ENV['VERBOSE']
+end
+
+##
+# Use Mocha to mock with RSpec
+require 'rspec'
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.include Backup::SpecLive::ExampleHelpers
+  config.before(:each) do
+    h_clean_data_paths!
+    if ENV['VERBOSE']
+      /spec-live\/(.*):/ =~ self.example.metadata[:example_group][:block].inspect
+      puts "\n\nSPEC: #{$1}"
+      puts "DESC: #{self.example.metadata[:full_description]}"
+      puts '-' * 78
+    end
+  end
+end
+
+puts "\n\nRuby version: #{RUBY_DESCRIPTION}\n\n"

data/spec-live/storage/dropbox_spec.rb

@@ -0,0 +1,151 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe 'Storage::Dropbox',
+    :if => Backup::SpecLive::CONFIG['storage']['dropbox']['specs_enabled'] do
+  let(:trigger) { 'archive_dropbox' }
+
+  def remote_files_for(storage, package)
+    remote_path = storage.send(:remote_path_for, package)
+
+    files = []
+    storage.send(:transferred_files_for, package) do |local_file, remote_file|
+      files << File.join(remote_path, remote_file)
+    end
+    files
+  end
+
+  def check_remote_for(storage, package, expectation = true)
+    remote_path = storage.send(:remote_path_for, package)
+
+    # search the remote_path folder for the trigger (base file name)
+    metadata = storage.send(:connection).search(
+      remote_path, package.trigger
+    )
+    files_found = metadata.map {|entry| File.basename(entry['path']) }
+
+    files = remote_files_for(storage, package).map {|file| File.basename(file) }
+
+    if expectation
+      files_found.sort.should == files.sort
+    else
+      files_found.should be_empty
+    end
+  end
+
+  def clean_remote!(storage, package)
+    storage.send(:remove!, package)
+  end
+
+  it 'should store the archive on the remote', :init => true do
+    model = h_set_trigger(trigger)
+
+    model.perform!
+
+    storage = model.storages.first
+    package = model.package
+    files = remote_files_for(storage, package)
+    files.count.should == 1
+
+    check_remote_for(storage, package)
+
+    clean_remote!(storage, package)
+  end
+
+  describe 'Storage::Dropbox Cycling' do
+    context 'when archives exceed `keep` setting' do
+      it 'should remove the oldest archive' do
+        packages = []
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+        sleep 1
+
+        check_remote_for(storage, packages[0])
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+        sleep 1
+
+        check_remote_for(storage, packages[1])
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+
+        check_remote_for(storage, packages[2])
+        clean_remote!(storage, packages[2])
+
+        check_remote_for(storage, packages[1])
+        clean_remote!(storage, packages[1])
+
+        check_remote_for(storage, packages[0], false)
+      end
+    end
+
+    context 'when an archive to be removed does not exist' do
+      it 'should log a warning and continue' do
+        packages = []
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+        sleep 1
+
+        check_remote_for(storage, packages[0])
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+
+        check_remote_for(storage, packages[1])
+
+        # remove archive directory cycle! will attempt to remove
+        clean_remote!(storage, packages[0])
+
+        check_remote_for(storage, packages[0], false)
+
+        check_remote_for(storage, packages[1])
+
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        expect do
+          model.perform!
+        end.not_to raise_error
+
+        Backup::Logger.has_warnings?.should be_true
+
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+
+        check_remote_for(storage, packages[1])
+        clean_remote!(storage, packages[1])
+
+        check_remote_for(storage, packages[2])
+        clean_remote!(storage, packages[2])
+      end
+    end
+
+  end # describe 'Storage::SCP Cycling'
+
+end

data/spec-live/storage/local_spec.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe 'Storage::Local' do
+  let(:trigger) { 'archive_local' }
+
+  def archive_file_for(model)
+    File.join(
+      Backup::SpecLive::TMP_PATH,
+      "#{model.trigger}", model.time, "#{model.trigger}.tar"
+    )
+  end
+
+  it 'should store a local archive' do
+    model = h_set_trigger(trigger)
+    model.perform!
+    File.exist?(archive_file_for(model)).should be_true
+  end
+
+  describe 'Storage::Local Cycling' do
+
+    context 'when archives exceed `keep` setting' do
+      it 'should remove the oldest archive' do
+        archives = []
+
+        model = h_set_trigger(trigger)
+        model.perform!
+        archives << archive_file_for(model)
+        sleep 1
+
+        model = h_set_trigger(trigger)
+        model.perform!
+        archives << archive_file_for(model)
+        sleep 1
+
+        model = h_set_trigger(trigger)
+        model.perform!
+        archives << archive_file_for(model)
+
+        File.exist?(archives[0]).should be_false
+        File.exist?(archives[1]).should be_true
+        File.exist?(archives[2]).should be_true
+      end
+    end
+
+    context 'when an archive to be removed does not exist' do
+      it 'should log a warning and continue' do
+        archives = []
+
+        model = h_set_trigger(trigger)
+        model.perform!
+        archives << archive_file_for(model)
+        sleep 1
+
+        model = h_set_trigger(trigger)
+        model.perform!
+        archives << archive_file_for(model)
+        sleep 1
+
+        File.exist?(archives[0]).should be_true
+        File.exist?(archives[1]).should be_true
+        # remove archive directory cycle! will attempt to remove
+        dir = archives[0].split('/')[0...-1].join('/')
+        h_safety_check(dir)
+        FileUtils.rm_r(dir)
+        File.exist?(archives[0]).should be_false
+
+        expect do
+          model = h_set_trigger(trigger)
+          model.perform!
+          archives << archive_file_for(model)
+        end.not_to raise_error
+
+        Backup::Logger.has_warnings?.should be_true
+
+        File.exist?(archives[1]).should be_true
+        File.exist?(archives[2]).should be_true
+      end
+    end
+
+  end # describe 'Storage::Local Cycling'
+end

data/spec-live/storage/scp_spec.rb

@@ -0,0 +1,193 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe 'Storage::SCP',
+    :if => Backup::SpecLive::CONFIG['storage']['scp']['specs_enabled'] do
+  let(:trigger) { 'archive_scp' }
+
+  def remote_files_for(storage, package)
+    remote_path = storage.send(:remote_path_for, package)
+
+    files = []
+    storage.send(:transferred_files_for, package) do |local_file, remote_file|
+      files << File.join(remote_path, remote_file)
+    end
+    files
+  end
+
+  def check_remote_for(storage, files)
+    if (storage.username == Backup::Config.user) &&
+        (storage.ip == 'localhost')
+      files.each do |file|
+        if !File.exist?(file)
+          return false
+        end
+      end
+      true
+    else
+      errors = []
+      storage.send(:connection) do |ssh|
+        files.each do |file|
+          ssh.exec!("ls '#{file}'") do |ch, stream, data|
+            errors << data if stream == :stderr
+          end
+        end
+      end
+      errors.empty?
+    end
+  end
+
+  def clean_remote!(storage, package)
+    return if (storage.username == Backup::Config.user) &&
+        (storage.ip == 'localhost') &&
+        (storage.path == Backup::SpecLive::TMP_PATH)
+
+    remote_path = storage.send(:remote_path_for, package)
+    h_safety_check(remote_path)
+    storage.send(:connection) do |ssh|
+      ssh.exec!("rm -r '#{remote_path}'")
+    end
+  end
+
+  it 'should store the archive on the remote' do
+    model = h_set_trigger(trigger)
+
+    model.perform!
+
+    storage = model.storages.first
+    package = model.package
+    files = remote_files_for(storage, package)
+    files.count.should == 1
+
+    check_remote_for(storage, files).should be_true
+
+    clean_remote!(storage, package)
+  end
+
+  describe 'Storage::SCP Cycling' do
+    context 'when archives exceed `keep` setting' do
+      it 'should remove the oldest archive' do
+        packages = []
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+        sleep 1
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[0])
+        ).should be_true
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+        sleep 1
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[1])
+        ).should be_true
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[2])
+        ).should be_true
+        clean_remote!(storage, packages[2])
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[1])
+        ).should be_true
+        clean_remote!(storage, packages[1])
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[0])
+        ).should be_false
+      end
+    end
+
+    context 'when an archive to be removed does not exist' do
+      it 'should log a warning and continue' do
+        packages = []
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+        sleep 1
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[0])
+        ).should be_true
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        model.perform!
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[1])
+        ).should be_true
+
+        # remove archive directory cycle! will attempt to remove
+
+        if (storage.username == Backup::Config.user) &&
+            (storage.ip == 'localhost')
+          remote_path = storage.send(:remote_path_for, packages[0])
+          h_safety_check(remote_path)
+          FileUtils.rm_r(remote_path)
+        else
+          clean_remote!(storage, packages[0])
+        end
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[0])
+        ).should be_false
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[1])
+        ).should be_true
+
+
+        model = h_set_trigger(trigger)
+        storage = model.storages.first
+        expect do
+          model.perform!
+        end.not_to raise_error
+
+        Backup::Logger.has_warnings?.should be_true
+
+        package = model.package
+        package.filenames.count.should == 1
+        packages << package
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[1])
+        ).should be_true
+        clean_remote!(storage, packages[1])
+
+        check_remote_for(
+          storage, remote_files_for(storage, packages[2])
+        ).should be_true
+        clean_remote!(storage, packages[2])
+      end
+    end
+
+  end # describe 'Storage::SCP Cycling'
+
+end