backup 3.6.0 → 3.7.0

data/lib/backup/database/redis.rb

@@ -3,6 +3,7 @@
 module Backup
   module Database
     class Redis < Base
+      class Error < Backup::Error; end
 
       ##
       # Name of the redis dump file.
@@ -65,7 +66,7 @@ module Backup
       def invoke_save!
         resp = run(redis_save_cmd)
         unless resp =~ /OK$/
-          raise Errors::Database::Redis::CommandError, <<-EOS
+          raise Error, <<-EOS
             Could not invoke the Redis SAVE command.
             Command was: #{ redis_save_cmd }
             Response was: #{ resp }
@@ -76,7 +77,7 @@ module Backup
       def copy!
         src_path = File.join(path, name + '.rdb')
         unless File.exist?(src_path)
-          raise Errors::Database::Redis::NotFoundError, <<-EOS
+          raise Error, <<-EOS
             Redis database dump not found
             File path was #{ src_path }
           EOS

data/lib/backup/encryptor/gpg.rb

@@ -69,6 +69,8 @@ module Backup
     #   end
     #
     class GPG < Base
+      class Error < Backup::Error; end
+
       MODES = [:asymmetric, :symmetric, :both]
 
       ##
@@ -102,8 +104,7 @@ module Backup
       attr_reader :mode
       def mode=(mode)
         @mode = mode.to_sym
-        raise Errors::Encryptor::GPG::InvalidModeError,
-            "'#{ @mode }' is not a valid mode." unless MODES.include?(@mode)
+        raise Error, "'#{ @mode }' is not a valid mode." unless MODES.include?(@mode)
       end
 
       ##
@@ -421,8 +422,7 @@ module Backup
         prepare
 
         if mode_options.empty?
-          raise Errors::Encryptor::GPG::EncryptionError,
-              "Encryption could not be performed for mode '#{ mode }'"
+          raise Error, "Encryption could not be performed for mode '#{ mode }'"
         end
 
         yield "#{ utility(:gpg) } #{ base_options } #{ mode_options }", '.gpg'
@@ -491,7 +491,7 @@ module Backup
         path
 
       rescue => err
-        raise Errors::Encryptor::GPG::HomedirError.wrap(
+        raise Error.wrap(
             err, "Failed to create or set permissions for #gpg_homedir")
       end
 
@@ -524,8 +524,7 @@ module Backup
 
       rescue => err
         cleanup
-        raise Errors::Encryptor::GPG::GPGConfigError.wrap(
-            err, "Error creating temporary file for #gpg_config.")
+        raise Error.wrap(err, "Error creating temporary file for #gpg_config.")
       end
 
       ##
@@ -591,8 +590,7 @@ module Backup
         file.path
 
       rescue => err
-        Logger.warn Errors::Encryptor::GPG::PassphraseError.wrap(
-            err, "Error creating temporary passphrase file.")
+        Logger.warn Error.wrap(err, "Error creating temporary passphrase file.")
         false
       end
 
@@ -691,7 +689,7 @@ module Backup
         keyid
 
       rescue => err
-        Logger.warn Errors::Encryptor::GPG::KeyImportError.wrap(
+        Logger.warn Error.wrap(
             err, "Public key import failed for '#{ identifier }'")
         nil
       end

data/lib/backup/errors.rb

@@ -1,89 +1,58 @@
 # encoding: utf-8
 
 module Backup
-  ##
-  # - automatically defines module namespaces referenced under Backup::Errors
-  # - any constant name referenced that ends with 'Error' will be created
-  #   as a subclass of Backup::Errors::Error
-  # - any constant name referenced that ends with 'FatalError' will be created
-  #   as a subclass of Backup::Errors::FatalError
-  #
-  # e.g.
-  #   err = Backup::Errors::Foo::Bar::FooError.new('error message')
-  #   err.message => "Foo::Bar::FooError: error message"
-  #
-  #   err = Backup::Errors::Foo::Bar::FooFatalError.new('error message')
-  #   err.message => "Foo::Bar::FooFatalError: error message"
-  #
-  module ErrorsHelper
-    def const_missing(const)
-      if const.to_s.end_with?('FatalError')
-        module_eval("class #{const} < Backup::Errors::FatalError; end")
-      elsif const.to_s.end_with?('Error')
-        module_eval("class #{const} < Backup::Errors::Error; end")
-      else
-        module_eval("module #{const}; extend Backup::ErrorsHelper; end")
-      end
-      const_get(const)
-    end
-  end
-
-  module Errors
-    extend ErrorsHelper
 
-    # Provides cascading errors with formatted messages.
-    # See the specs for details.
-    module NestedExceptions
+  # Provides cascading errors with formatted messages.
+  # See the specs for details.
+  module NestedExceptions
 
-      def self.included(klass)
-        klass.extend Module.new {
-          def wrap(wrapped_exception, msg = nil)
-            new(msg, wrapped_exception)
-          end
-        }
-      end
-
-      def initialize(obj = nil, wrapped_exception = nil)
-        @wrapped_exception = wrapped_exception
-        msg = (obj.respond_to?(:to_str) ? obj.to_str : obj.to_s).
-              gsub(/^ */, '  ').strip
-        msg = clean_name(self.class.name) + (msg.empty? ? '' : ": #{ msg }")
-
-        if wrapped_exception
-          msg << "\n--- Wrapped Exception ---\n"
-          class_name = clean_name(wrapped_exception.class.name)
-          msg << class_name + ': ' unless
-              wrapped_exception.message.start_with? class_name
-          msg << wrapped_exception.message
+    def self.included(klass)
+      klass.extend Module.new {
+        def wrap(wrapped_exception, msg = nil)
+          new(msg, wrapped_exception)
         end
+      }
+    end
 
-        super(msg)
-        set_backtrace(wrapped_exception.backtrace) if wrapped_exception
+    def initialize(obj = nil, wrapped_exception = nil)
+      @wrapped_exception = wrapped_exception
+      msg = (obj.respond_to?(:to_str) ? obj.to_str : obj.to_s).
+            gsub(/^ */, '  ').strip
+      msg = clean_name(self.class.name) + (msg.empty? ? '' : ": #{ msg }")
+
+      if wrapped_exception
+        msg << "\n--- Wrapped Exception ---\n"
+        class_name = clean_name(wrapped_exception.class.name)
+        msg << class_name + ': ' unless
+            wrapped_exception.message.start_with? class_name
+        msg << wrapped_exception.message
       end
 
-      def exception(obj = nil)
-        return self if obj.nil? || equal?(obj)
+      super(msg)
+      set_backtrace(wrapped_exception.backtrace) if wrapped_exception
+    end
 
-        ex = self.class.new(obj, @wrapped_exception)
-        ex.set_backtrace(backtrace) unless ex.backtrace
-        ex
-      end
+    def exception(obj = nil)
+      return self if obj.nil? || equal?(obj)
 
-      private
+      ex = self.class.new(obj, @wrapped_exception)
+      ex.set_backtrace(backtrace) unless ex.backtrace
+      ex
+    end
 
-      def clean_name(name)
-        name.sub(/^Backup::Errors::/, '')
-      end
+    private
 
+    def clean_name(name)
+      name.sub(/^Backup::/, '')
     end
 
-    class Error < StandardError
-      include NestedExceptions
-    end
+  end
 
-    class FatalError < Exception
-      include NestedExceptions
-    end
+  class Error < StandardError
+    include NestedExceptions
+  end
 
+  class FatalError < Exception
+    include NestedExceptions
   end
 end

data/lib/backup/logger.rb

@@ -3,6 +3,7 @@
 require 'backup/logger/console'
 require 'backup/logger/logfile'
 require 'backup/logger/syslog'
+require 'backup/logger/fog_adapter'
 
 module Backup
   class Logger
@@ -118,6 +119,8 @@ module Backup
       end
     end
 
+    MUTEX = Mutex.new
+
     ##
     # Returns an Array of Message objects for all logged messages received.
     # These are used to attach log files to Mail notifications.
@@ -134,7 +137,9 @@ module Backup
     # Sends a message to the Logger using the specified log level.
     # +obj+ may be any Object that responds to #to_s (i.e. an Exception)
     [:info, :warn, :error].each do |level|
-      define_method level, lambda {|obj| log(obj, level) }
+      define_method level, lambda {|obj|
+        MUTEX.synchronize { log(obj, level) }
+      }
     end
 
     ##
@@ -180,7 +185,7 @@ module Backup
     private
 
     def log(obj, level)
-      message = Message.new(Time.now, level, obj.to_s.split("\n"))
+      message = Message.new(Time.now.utc, level, obj.to_s.split("\n"))
 
       message.level = :info if message.level == :warn &&
           message.matches?(@config.ignores)

data/lib/backup/logger/fog_adapter.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+# require only the logger
+require 'formatador'
+require 'fog/core/logger'
+
+module Backup
+  class Logger
+    module FogAdapter
+      class << self
+
+        # Logged as :info so these won't generate warnings.
+        # This is mostly to keep STDOUT clean and to provide
+        # supplemental messages for our own warnings.
+        # These will generally occur during retry attempts.
+        def write(message)
+          Logger.info message.split("\n").
+              map {|line| "[fog] #{ line }" }.join("\n")
+        end
+
+        def tty?
+          false
+        end
+
+      end
+    end
+  end
+end
+
+Fog::Logger[:warning] = Backup::Logger::FogAdapter

data/lib/backup/model.rb

@@ -2,6 +2,9 @@
 
 module Backup
   class Model
+    class Error < Backup::Error; end
+    class FatalError < Backup::FatalError; end
+
     class << self
       ##
       # The Backup::Model.all class method keeps track of all the models
@@ -73,6 +76,14 @@ module Backup
     # The time when the backup initiated (in format: 2011.02.20.03.29.59)
     attr_reader :time
 
+    ##
+    # The time when the backup initiated (as a Time object)
+    attr_reader :started_at
+
+    ##
+    # The time when the backup finished (as a Time object)
+    attr_reader :finished_at
+
     ##
     # Result of this model's backup process.
     #
@@ -136,7 +147,7 @@ module Backup
       # Warn user of DSL changes
       case name.to_s
       when 'Backup::Config::RSync'
-        Logger.warn Errors::ConfigError.new(<<-EOS)
+        Logger.warn Error.new(<<-EOS)
           Configuration Update Needed for Syncer::RSync
           The RSync Syncer has been split into three separate modules:
           RSync::Local, RSync::Push and RSync::Pull
@@ -146,7 +157,7 @@ module Backup
         name = 'RSync::Push'
       when /(Backup::Config::S3|Backup::Config::CloudFiles)/
         syncer = $1.split('::')[2]
-        Logger.warn Errors::ConfigError.new(<<-EOS)
+        Logger.warn Error.new(<<-EOS)
           Configuration Update Needed for '#{ syncer }' Syncer.
           This Syncer is now referenced as Cloud::#{ syncer }
           i.e. 'sync_with #{ syncer }' is now 'sync_with Cloud::#{ syncer }'
@@ -184,7 +195,7 @@ module Backup
       if chunk_size.is_a?(Integer)
         @splitter = Splitter.new(self, chunk_size)
       else
-        raise Errors::Model::ConfigurationError, <<-EOS
+        raise Error, <<-EOS
           Invalid Chunk Size for Splitter
           Argument to #split_into_chunks_of() must be an Integer
         EOS
@@ -250,8 +261,8 @@ module Backup
     # those files *** will be removed *** before the next scheduled backup for
     # the same trigger.
     def perform!
-      @started_at = Time.now
-      @time = package.time = @started_at.strftime("%Y.%m.%d.%H.%M.%S")
+      @started_at = Time.now.utc
+      @time = package.time = started_at.strftime("%Y.%m.%d.%H.%M.%S")
 
       log!(:started)
       before_hook
@@ -267,10 +278,18 @@ module Backup
 
     ensure
       set_exit_status
+      @finished_at = Time.now.utc
       log!(:finished)
       after_hook
     end
 
+    ##
+    # The duration of the backup process (in format: HH:MM:SS)
+    def duration
+      return unless finished_at
+      elapsed_time(started_at, finished_at)
+    end
+
     private
 
     ##
@@ -359,8 +378,7 @@ module Backup
 
     rescue Exception => err
       @before_hook_failed = true
-      ex = err.is_a?(StandardError) ?
-          Errors::Model::HookError : Errors::Model::HookFatalError
+      ex = err.is_a?(StandardError) ? Error : FatalError
       raise ex.wrap(err, 'Before Hook Failed!')
     end
 
@@ -379,7 +397,7 @@ module Backup
 
     rescue Exception => err
       fatal = !err.is_a?(StandardError)
-      ex = fatal ? Errors::Model::HookFatalError : Errors::Model::HookError
+      ex = fatal ? FatalError : Error
       Logger.error ex.wrap(err, 'After Hook Failed!')
       # upgrade exit_status if needed
       (@exit_status = fatal ? 3 : 2) unless exit_status == 3
@@ -398,7 +416,7 @@ module Backup
 
       when :finished
         if exit_status > 1
-          ex = exit_status == 2 ? Errors::ModelError : Errors::ModelFatalError
+          ex = exit_status == 2 ? Error : FatalError
           err = ex.wrap(exception, "Backup for #{ label } (#{ trigger }) Failed!")
           Logger.error err
           Logger.error "\nBacktrace:\n\s\s" + err.backtrace.join("\n\s\s") + "\n\n"
@@ -407,10 +425,10 @@ module Backup
         else
           msg = "Backup for '#{ label } (#{ trigger })' "
           if exit_status == 1
-            msg << "Completed Successfully (with Warnings) in #{ elapsed_time }"
+            msg << "Completed Successfully (with Warnings) in #{ duration }"
             Logger.warn msg
           else
-            msg << "Completed Successfully in #{ elapsed_time }"
+            msg << "Completed Successfully in #{ duration }"
             Logger.info msg
           end
         end
@@ -418,9 +436,9 @@ module Backup
     end
 
     ##
-    # Returns a string representing the elapsed time since the backup started.
-    def elapsed_time
-      duration  = Time.now.to_i - @started_at.to_i
+    # Returns a string representing the elapsed time in HH:MM:SS.
+    def elapsed_time(start_time, finish_time)
+      duration  = finish_time.to_i - start_time.to_i
       hours     = duration / 3600
       remainder = duration - (hours * 3600)
       minutes   = remainder / 60

data/lib/backup/notifier/base.rb

@@ -2,6 +2,8 @@
 
 module Backup
   module Notifier
+    class Error < Backup::Error; end
+
     class Base
       include Backup::Utilities::Helpers
       include Backup::Configuration::Helpers
@@ -66,7 +68,7 @@ module Backup
         end
 
       rescue Exception => err
-        Logger.error Errors::NotifierError.wrap(err, "#{ notifier_name } Failed!")
+        Logger.error Error.wrap(err, "#{ notifier_name } Failed!")
       end
 
       private
@@ -79,8 +81,7 @@ module Backup
           retries += 1
           raise if retries > max_retries
 
-          Logger.info Errors::NotifierError.
-              wrap(err, "Retry ##{ retries } of #{ max_retries }.")
+          Logger.info Error.wrap(err, "Retry ##{ retries } of #{ max_retries }.")
           sleep(retry_waitsec)
           retry
         end

data/lib/backup/notifier/campfire.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'excon'
 require 'json'
 
 module Backup