backup 3.0.19 → 3.0.20

data/lib/backup/storage/s3.rb

@@ -20,27 +20,10 @@ module Backup
       # Region of the specified S3 bucket
       attr_accessor :region
 
-      ##
-      # Creates a new instance of the Amazon S3 storage object
-      # First it sets the defaults (if any exist) and then evaluates
-      # the configuration block which may overwrite these defaults
-      #
-      # Currently available regions:
-      #   eu-west-1, us-east-1, ap-southeast-1, us-west-1
-      def initialize(&block)
-        load_defaults!
-
-        @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-      end
-
       ##
       # This is the remote path to where the backup files will be stored
       def remote_path
-        File.join(path, TRIGGER).sub(/^\//, '')
+        File.join(path, TRIGGER, @time).sub(/^\//, '')
       end
 
       ##
@@ -52,12 +35,28 @@ module Backup
       ##
       # Performs the backup transfer
       def perform!
+        super
         transfer!
         cycle!
       end
 
     private
 
+      ##
+      # Set configuration defaults before evaluating configuration block,
+      # after setting defaults from Storage::Base
+      def pre_configure
+        super
+        @path ||= 'backups'
+      end
+
+      ##
+      # Adjust configuration after evaluating configuration block,
+      # after adjustments from Storage::Base
+      def post_configure
+        super
+      end
+
       ##
       # Establishes a connection to Amazon S3 and returns the Fog object.
       # Not doing any instance variable caching because this object gets persisted in YAML
@@ -65,7 +64,7 @@ module Backup
       # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
       # background anyway so even if it were a bit slower it shouldn't matter.
       def connection
-        Fog::Storage.new(
+        @connection ||= Fog::Storage.new(
           :provider               => provider,
           :aws_access_key_id      => access_key_id,
           :aws_secret_access_key  => secret_access_key,
@@ -76,26 +75,29 @@ module Backup
       ##
       # Transfers the archived file to the specified Amazon S3 bucket
       def transfer!
-        begin
-          Logger.message("#{ self.class } started transferring \"#{ remote_file }\" to bucket \"#{ bucket }\"")
-          connection.sync_clock
+        connection.sync_clock
+        files_to_transfer do |local_file, remote_file|
+          Logger.message "#{storage_name} started transferring " +
+              "'#{ local_file }' to bucket '#{ bucket }'"
+
           connection.put_object(
             bucket,
             File.join(remote_path, remote_file),
             File.open(File.join(local_path, local_file))
           )
-        rescue Excon::Errors::NotFound
-          raise "An error occurred while trying to transfer the backup, please make sure the bucket exists."
         end
       end
 
       ##
       # Removes the transferred archive file from the Amazon S3 bucket
       def remove!
-        begin
-          connection.sync_clock
+        connection.sync_clock
+        transferred_files do |local_file, remote_file|
+          Logger.message "#{storage_name} started removing " +
+              "'#{ local_file }' from bucket '#{ bucket }'"
+
           connection.delete_object(bucket, File.join(remote_path, remote_file))
-        rescue Excon::Errors::SocketError; end
+        end
       end
 
     end

data/lib/backup/storage/scp.rb

@@ -23,31 +23,16 @@ module Backup
       # Path to store backups to
       attr_accessor :path
 
-      ##
-      # Creates a new instance of the SCP storage object
-      # First it sets the defaults (if any exist) and then evaluates
-      # the configuration block which may overwrite these defaults
-      def initialize(&block)
-        load_defaults!
-
-        @port ||= 22
-        @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-        @path = path.sub(/^\~\//, '')
-      end
-
       ##
       # This is the remote path to where the backup files will be stored
       def remote_path
-        File.join(path, TRIGGER)
+        File.join(path, TRIGGER, @time)
       end
 
       ##
       # Performs the backup transfer
       def perform!
+        super
         transfer!
         cycle!
       end
@@ -55,34 +40,69 @@ module Backup
     private
 
       ##
-      # Establishes a connection to the remote server and returns the Net::SSH object.
-      # Not doing any instance variable caching because this object gets persisted in YAML
-      # format to a file and will issues. This, however has no impact on performance since it only
-      # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
-      # background anyway so even if it were a bit slower it shouldn't matter.
-      #
-      # We will be using Net::SSH, and use Net::SCP through Net::SSH to transfer backups
+      # Set configuration defaults before evaluating configuration block,
+      # after setting defaults from Storage::Base
+      def pre_configure
+        super
+        @port ||= 22
+        @path ||= 'backups'
+      end
+
+      ##
+      # Adjust configuration after evaluating configuration block,
+      # after adjustments from Storage::Base
+      def post_configure
+        super
+        @path = path.sub(/^\~\//, '')
+      end
+
+      ##
+      # Establishes a connection to the remote server
+      # and yields the Net::SSH connection.
+      # Net::SCP will use this connection to transfer backups
       def connection
-        Net::SSH.start(ip, username, :password => password, :port => port)
+        Net::SSH.start(
+          ip, username, :password => password, :port => port
+        ) {|ssh| yield ssh }
       end
 
       ##
       # Transfers the archived file to the specified remote server
       def transfer!
-        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
-        create_remote_directories!
-        connection.scp.upload!(
-          File.join(local_path, local_file),
-          File.join(remote_path, remote_file)
-        )
+        connection do |ssh|
+          create_remote_directories(ssh)
+
+          files_to_transfer do |local_file, remote_file|
+            Logger.message "#{storage_name} started transferring " +
+                "'#{local_file}' to '#{ip}'."
+
+            ssh.scp.upload!(
+              File.join(local_path, local_file),
+              File.join(remote_path, remote_file)
+            )
+          end
+        end
       end
 
       ##
       # Removes the transferred archive file from the server
       def remove!
-        response = connection.exec!("rm #{ File.join(remote_path, remote_file) }")
-        if response =~ /No such file or directory/
-          Logger.warn "Could not remove file \"#{ File.join(remote_path, remote_file) }\"."
+        messages = []
+        transferred_files do |local_file, remote_file|
+          messages << "#{storage_name} started removing '#{local_file}' from '#{ip}'."
+        end
+        Logger.message messages.join("\n")
+
+        errors = []
+        connection do |ssh|
+          ssh.exec!("rm -r '#{remote_path}'") do |ch, stream, data|
+            errors << data if stream == :stderr
+          end
+        end
+        unless errors.empty?
+          raise Errors::Storage::SCP::SSHError,
+            "Net::SSH reported the following errors:\n" +
+              errors.join("\n"), caller(1)
         end
       end
 
@@ -93,11 +113,11 @@ module Backup
       # Instead, we split the parts up in to an array (for each '/') and loop through
       # that to create the directories one by one. Net::SCP raises an exception when
       # the directory it's trying ot create already exists, so we have rescue it
-      def create_remote_directories!
+      def create_remote_directories(ssh)
         path_parts = Array.new
         remote_path.split('/').each do |path_part|
           path_parts << path_part
-          connection.exec!("mkdir '#{ path_parts.join('/') }'")
+          ssh.exec!("mkdir '#{path_parts.join('/')}'")
         end
       end
 

data/lib/backup/storage/sftp.rb

@@ -20,37 +20,39 @@ module Backup
       # Path to store backups to
       attr_accessor :path
 
-      ##
-      # Creates a new instance of the SFTP storage object
-      # First it sets the defaults (if any exist) and then evaluates
-      # the configuration block which may overwrite these defaults
-      def initialize(&block)
-        load_defaults!
-
-        @port ||= 22
-        @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-        @path = path.sub(/^\~\//, '')
-      end
-
       ##
       # This is the remote path to where the backup files will be stored
       def remote_path
-        File.join(path, TRIGGER)
+        File.join(path, TRIGGER, @time)
       end
 
       ##
       # Performs the backup transfer
       def perform!
+        super
         transfer!
         cycle!
       end
 
     private
 
+      ##
+      # Set configuration defaults before evaluating configuration block,
+      # after setting defaults from Storage::Base
+      def pre_configure
+        super
+        @port ||= 22
+        @path ||= 'backups'
+      end
+
+      ##
+      # Adjust configuration after evaluating configuration block,
+      # after adjustments from Storage::Base
+      def post_configure
+        super
+        @path = path.sub(/^\~\//, '')
+      end
+
       ##
       # Establishes a connection to the remote server and returns the Net::SFTP object.
       # Not doing any instance variable caching because this object gets persisted in YAML
@@ -58,29 +60,43 @@ module Backup
       # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
       # background anyway so even if it were a bit slower it shouldn't matter.
       def connection
-        Net::SFTP.start(ip, username, :password => password, :port => port)
+        Net::SFTP.start(
+          ip, username,
+          :password => password,
+          :port     => port
+        ) {|sftp| yield sftp }
       end
 
       ##
       # Transfers the archived file to the specified remote server
       def transfer!
-        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
-        create_remote_directories!
-        connection.upload!(
-          File.join(local_path, local_file),
-          File.join(remote_path, remote_file)
-        )
+        connection do |sftp|
+          create_remote_directories(sftp)
+
+          files_to_transfer do |local_file, remote_file|
+            Logger.message "#{storage_name} started transferring " +
+                "'#{ local_file }' to '#{ ip }'."
+
+            sftp.upload!(
+              File.join(local_path, local_file),
+              File.join(remote_path, remote_file)
+            )
+          end
+        end
       end
 
       ##
       # Removes the transferred archive file from the server
       def remove!
-        begin
-          connection.remove!(
-            File.join(remote_path, remote_file)
-          )
-        rescue Net::SFTP::StatusException
-          Logger.warn "Could not remove file \"#{ File.join(remote_path, remote_file) }\"."
+        connection do |sftp|
+          transferred_files do |local_file, remote_file|
+            Logger.message "#{storage_name} started removing " +
+                "'#{ local_file }' from '#{ ip }'."
+
+            sftp.remove!(File.join(remote_path, remote_file))
+          end
+
+          sftp.rmdir!(remote_path)
         end
       end
 
@@ -90,13 +106,13 @@ module Backup
       # paths to directories that don't yet exist when creating new directories.
       # Instead, we split the parts up in to an array (for each '/') and loop through
       # that to create the directories one by one. Net::SFTP raises an exception when
-      # the directory it's trying ot create already exists, so we have rescue it
-      def create_remote_directories!
+      # the directory it's trying to create already exists, so we have rescue it
+      def create_remote_directories(sftp)
         path_parts = Array.new
         remote_path.split('/').each do |path_part|
           path_parts << path_part
           begin
-            connection.mkdir!(path_parts.join('/'))
+            sftp.mkdir!(path_parts.join('/'))
           rescue Net::SFTP::StatusException; end
         end
       end

data/lib/backup/syncer/base.rb

@@ -3,7 +3,7 @@
 module Backup
   module Syncer
     class Base
-      include Backup::CLI
+      include Backup::CLI::Helpers
       include Backup::Configuration::Helpers
     end
   end

data/lib/backup/syncer/rsync.rb

@@ -67,7 +67,7 @@ module Backup
       def perform!
         Logger.message("#{ self.class } started syncing #{ directories }.")
         Logger.silent(
-          run("#{ utility(:rsync) } -vhP #{ options } #{ directories } '#{ username }@#{ ip }:#{ path }'")
+          run("#{ utility(:rsync) } #{ options } #{ directories } '#{ username }@#{ ip }:#{ path }'")
         )
 
         remove_password_file!

data/lib/backup/template.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'erb'
+
+module Backup
+  class Template
+
+    # Holds a binding object. Nil if not provided.
+    attr_accessor :binding
+
+    ##
+    # Creates a new instance of the Backup::Template class
+    # and optionally takes an argument that can be either a binding object, a Hash or nil
+    def initialize(object = nil)
+      if object.is_a?(Binding)
+        @binding = object
+      elsif object.is_a?(Hash)
+        @binding = Backup::Binder.new(object).get_binding
+      else
+        @binding = nil
+      end
+    end
+
+    ##
+    # Renders the provided file (in the context of the binding if any) to the console
+    def render(file)
+      puts result(file)
+    end
+
+    ##
+    # Returns a String object containing the contents of the file (in the context of the binding if any)
+    def result(file)
+      ERB.new(file_contents(file), nil, '<>').result(binding)
+    end
+
+  private
+
+    ##
+    # Reads and returns the contents of the provided file path,
+    # relative from the Backup::TEMPLATE_PATH
+    def file_contents(file)
+      File.read(File.join(Backup::TEMPLATE_PATH, file))
+    end
+
+  end
+end

data/lib/backup/version.rb

@@ -13,7 +13,7 @@ module Backup
     #  Defines the minor version
     # PATCH:
     #  Defines the patch version
-    MAJOR, MINOR, PATCH = 3, 0, 19
+    MAJOR, MINOR, PATCH = 3, 0, 20
 
     ##
     # Returns the major version ( big release based off of multiple minor releases )

data/spec/archive_spec.rb

@@ -1,16 +1,16 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/spec_helper'
+require File.expand_path('../spec_helper.rb', __FILE__)
 
 describe Backup::Archive do
 
   let(:archive) do
     Backup::Archive.new(:dummy_archive) do |a|
       a.add '/home/rspecuser/somefile'
-      a.add '/home/rspecuser/logs/'
-      a.add '/home/rspecuser/dotfiles/'
+      a.add '/home/rspecuser/logs'
+      a.add '/home/rspecuser/dotfiles'
       a.exclude '/home/rspecuser/badfile'
-      a.exclude '/home/rspecuser/wrongdir/'
+      a.exclude '/home/rspecuser/wrongdir'
     end
   end
 
@@ -39,7 +39,7 @@ describe Backup::Archive do
   describe '#paths_to_package' do
     it 'should return a tar -c friendly string' do
       archive.send(:paths_to_package).should ==
-      "'/home/rspecuser/somefile' '/home/rspecuser/logs/' '/home/rspecuser/dotfiles/'"
+      "'/home/rspecuser/somefile' '/home/rspecuser/logs' '/home/rspecuser/dotfiles'"
     end
   end
 
@@ -51,7 +51,7 @@ describe Backup::Archive do
 
     it 'should return a tar -c friendly string' do
       archive.send(:paths_to_exclude).should ==
-      "--exclude='/home/rspecuser/badfile' --exclude='/home/rspecuser/wrongdir/'"
+      "--exclude='/home/rspecuser/badfile' --exclude='/home/rspecuser/wrongdir'"
     end
   end
 
@@ -63,7 +63,10 @@ describe Backup::Archive do
     context 'when both paths were added and paths that should be excluded were added' do
       it 'should render both the syntax for the paths that be included as well as excluded' do
         archive.expects(:mkdir).with(File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive'))
-        archive.expects(:run).with("tar -c -f '#{File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive', "#{:dummy_archive}.tar")}' --exclude='/home/rspecuser/badfile' --exclude='/home/rspecuser/wrongdir/' '/home/rspecuser/somefile' '/home/rspecuser/logs/' '/home/rspecuser/dotfiles/' 2> /dev/null")
+        archive.expects(:run).with(
+          "tar  -cf '#{File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive', "#{:dummy_archive}.tar")}' --exclude='/home/rspecuser/badfile' --exclude='/home/rspecuser/wrongdir' '/home/rspecuser/somefile' '/home/rspecuser/logs' '/home/rspecuser/dotfiles'",
+          :ignore_exit_codes => [1]
+        )
         archive.expects(:utility).with(:tar).returns(:tar)
         archive.perform!
       end
@@ -76,13 +79,35 @@ describe Backup::Archive do
         end
 
         archive.stubs(:utility).returns(:tar)
-        archive.expects(:run).with("tar -c -f '#{File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive', "#{:dummy_archive}.tar")}'  '/path/to/archive' 2> /dev/null")
+        archive.expects(:run).with(
+          "tar  -cf '#{File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive', "#{:dummy_archive}.tar")}'  '/path/to/archive'",
+          :ignore_exit_codes => [1]
+        )
         archive.perform!
       end
     end
 
+    context 'when tar_options are given' do
+      it 'should add the options to the tar command' do
+        archive = Backup::Archive.new(:dummy_archive) do |a|
+          a.add '/path/to/archive'
+          a.tar_options '-h --xattrs'
+        end
+
+        archive.stubs(:utility).returns(:tar)
+        archive.expects(:run).with(
+          "tar -h --xattrs -cf '#{File.join(Backup::TMP_PATH, Backup::TRIGGER, 'archive', "#{:dummy_archive}.tar")}'  '/path/to/archive'",
+          :ignore_exit_codes => [1]
+        )
+        archive.perform!
+      end
+    end
     it 'should log the status' do
-      Backup::Logger.expects(:message).with("Backup::Archive started packaging and archiving \"/home/rspecuser/somefile\", \"/home/rspecuser/logs/\", \"/home/rspecuser/dotfiles/\".")
+      Backup::Logger.expects(:message).
+          with("Backup::Archive started packaging and archiving:\n" +
+               "  /home/rspecuser/somefile\n" +
+               "  /home/rspecuser/logs\n" +
+               "  /home/rspecuser/dotfiles")
       archive.perform!
     end
   end