backup 3.0.27 → 3.1.0

data/lib/backup/model.rb

@@ -2,8 +2,6 @@
 
 module Backup
   class Model
-    include Backup::CLI::Helpers
-
     class << self
       ##
       # The Backup::Model.all class method keeps track of all the models
@@ -14,23 +12,14 @@ module Backup
       end
 
       ##
-      # Return the first model matching +trigger+.
-      # Raises Errors::MissingTriggerError if no matches are found.
-      def find(trigger)
-        trigger = trigger.to_s
-        all.each do |model|
-          return model if model.trigger == trigger
+      # Return an Array of Models matching the given +trigger+.
+      def find_by_trigger(trigger)
+        if trigger.include?('*')
+          regex = /^#{ trigger.to_s.gsub('*', '(.*)') }$/
+          all.select {|model| regex =~ model.trigger }
+        else
+          all.select {|model| trigger == model.trigger }
         end
-        raise Errors::Model::MissingTriggerError,
-            "Could not find trigger '#{trigger}'."
-      end
-
-      ##
-      # Find and return an Array of all models matching +trigger+
-      # Used to match triggers using a wildcard (*)
-      def find_matching(trigger)
-        regex = /^#{ trigger.to_s.gsub('*', '(.*)') }$/
-        all.select {|model| regex =~ model.trigger }
       end
     end
 
@@ -183,18 +172,6 @@ module Backup
       end
     end
 
-    ##
-    # Ensure DATA_PATH and DATA_PATH/TRIGGER are created
-    # if they do not yet exist
-    #
-    # Clean any temporary files and/or package files left over
-    # from the last time this model/trigger was performed.
-    # Logs warnings if files exist and are cleaned.
-    def prepare!
-      FileUtils.mkdir_p(File.join(Config.data_path, trigger))
-      Cleaner.prepare(self)
-    end
-
     ##
     # Performs the backup process
     ##
@@ -248,6 +225,8 @@ module Backup
       @time = @started_at.strftime("%Y.%m.%d.%H.%M.%S")
       log!(:started)
 
+      prepare!
+
       if databases.any? or archives.any?
         procedures.each do |procedure|
           (procedure.call; next) if procedure.is_a?(Proc)
@@ -260,41 +239,25 @@ module Backup
       log!(:finished)
 
     rescue Exception => err
-      fatal = !err.is_a?(StandardError)
-
-      err = Errors::ModelError.wrap(err, <<-EOS)
-        Backup for #{label} (#{trigger}) Failed!
-        An Error occured which has caused this Backup to abort before completion.
-      EOS
-      Logger.error err
-      Logger.error "\nBacktrace:\n\s\s" + err.backtrace.join("\n\s\s") + "\n\n"
-
-      Cleaner.warnings(self)
-
-      if fatal
-        Logger.error Errors::ModelError.new(<<-EOS)
-          This Error was Fatal and Backup will now exit.
-          If you have other Backup jobs (triggers) configured to run,
-          they will not be processed.
-        EOS
-      else
-        Logger.message Errors::ModelError.new(<<-EOS)
-          If you have other Backup jobs (triggers) configured to run,
-          Backup will now attempt to continue...
-        EOS
-      end
-
-      notifiers.each do |n|
-        begin
-          n.perform!(true)
-        rescue Exception; end
-      end
-
-      exit(1) if fatal
+      log!(:failure, err)
+      send_failure_notifications
+      exit(1) unless err.is_a?(StandardError)
     end
 
     private
 
+    ##
+    # Ensure DATA_PATH and DATA_PATH/TRIGGER are created
+    # if they do not yet exist
+    #
+    # Clean any temporary files and/or package files left over
+    # from the last time this model/trigger was performed.
+    # Logs warnings if files exist and are cleaned.
+    def prepare!
+      FileUtils.mkdir_p(File.join(Config.data_path, trigger))
+      Cleaner.prepare(self)
+    end
+
     ##
     # After all the databases and archives have been dumped and sorted,
     # these files will be bundled in to a .tar archive (uncompressed),
@@ -352,11 +315,11 @@ module Backup
     end
 
     ##
-    # Logs messages when the backup starts and finishes
-    def log!(action)
+    # Logs messages when the backup starts, finishes or fails
+    def log!(action, exception = nil)
       case action
       when :started
-        Logger.message "Performing Backup for '#{label} (#{trigger})'!\n" +
+        Logger.info "Performing Backup for '#{label} (#{trigger})'!\n" +
             "[ backup #{ Version.current } : #{ RUBY_DESCRIPTION } ]"
 
       when :finished
@@ -365,7 +328,30 @@ module Backup
         if Logger.has_warnings?
           Logger.warn msg % 'Successfully (with Warnings)'
         else
-          Logger.message msg % 'Successfully'
+          Logger.info msg % 'Successfully'
+        end
+
+      when :failure
+        err = Errors::ModelError.wrap(exception, <<-EOS)
+          Backup for #{label} (#{trigger}) Failed!
+          An Error occured which has caused this Backup to abort before completion.
+        EOS
+        Logger.error err
+        Logger.error "\nBacktrace:\n\s\s" + err.backtrace.join("\n\s\s") + "\n\n"
+
+        Cleaner.warnings(self)
+
+        if exception.is_a?(StandardError)
+          Logger.info Errors::ModelError.new(<<-EOS)
+            If you have other Backup jobs (triggers) configured to run,
+            Backup will now attempt to continue...
+          EOS
+        else
+          Logger.error Errors::ModelError.new(<<-EOS)
+            This Error was Fatal and Backup will now exit.
+            If you have other Backup jobs (triggers) configured to run,
+            they will not be processed.
+          EOS
         end
       end
     end
@@ -381,5 +367,21 @@ module Backup
       '%02d:%02d:%02d' % [hours, minutes, seconds]
     end
 
+    ##
+    # Sends notifications when a backup fails.
+    # Errors are logged and rescued, since the error that caused the
+    # backup to fail could have been an error with a notifier.
+    def send_failure_notifications
+      notifiers.each do |n|
+        begin
+          n.perform!(true)
+        rescue Exception => err
+          Logger.error Errors::ModelError.wrap(err, <<-EOS)
+            #{ n.class } Failed to send notification of backup failure.
+          EOS
+        end
+      end
+    end
+
   end
 end

data/lib/backup/notifier/base.rb

@@ -73,7 +73,7 @@ module Backup
       # Logs a message to the console and log file to inform
       # the client that Backup is notifying about the process
       def log!
-        Logger.message "#{ notifier_name } started notifying about the process."
+        Logger.info "#{ notifier_name } started notifying about the process."
       end
 
     end

data/lib/backup/notifier/hipchat.rb

@@ -83,7 +83,7 @@ module Backup
 
       def send_message(msg, color)
         client = HipChat::Client.new(token)
-        [rooms_notified].flatten.each do |room|
+        Array(rooms_notified).map {|r| r.split(',').map(&:strip) }.flatten.each do |room|
           client[room].send(from, msg, :color => color, :notify => notify_users)
         end
       end

data/lib/backup/notifier/mail.rb

@@ -150,7 +150,7 @@ module Backup
           email.convert_to_multipart
           email.attachments["#{@model.time}.#{@model.trigger}.log"] = {
             :mime_type => 'text/plain;',
-            :content   => Logger.messages.join("\n")
+            :content   => Logger.messages.map(&:formatted_lines).flatten.join("\n")
           }
         end
 

data/lib/backup/notifier/pushover.rb

@@ -14,7 +14,8 @@ module Backup
       attr_accessor :token
 
       ##
-      # The user's device identifier to sent he message directly to that device rather than all of the user's devices
+      # The user's device identifier to sent the message directly to,
+      # rather than all of the user's devices
       attr_accessor :device
 
       ##
@@ -68,7 +69,7 @@ module Backup
         url = URI.parse("https://api.pushover.net/1/messages.json")
 
         request = Net::HTTP::Post.new(url.path)
-        request.set_form_data(parameters.merge ({:message => message}))
+        request.set_form_data(parameters.merge({:message => message}))
         response = Net::HTTP.new(url.host, url.port)
 
         response.use_ssl = true
@@ -80,7 +81,9 @@ module Backup
       # List available parameters
       def parameters
         @values = {}
-        [:token, :user, :message, :title, :priority, :device].each { |k| @values.merge! k => self.instance_variable_get("@#{k}") }
+        [:token, :user, :message, :title, :priority, :device].each do |k|
+          @values.merge! k => self.instance_variable_get("@#{k}")
+        end
         @values
       end
     end

data/lib/backup/packager.rb

@@ -3,7 +3,7 @@
 module Backup
   module Packager
     class << self
-      include Backup::CLI::Helpers
+      include Backup::Utilities::Helpers
 
       ##
       # Build the final package for the backup model.
@@ -13,11 +13,11 @@ module Backup
         @splitter  = model.splitter
         @pipeline  = Pipeline.new
 
-        Logger.message "Packaging the backup files..."
+        Logger.info "Packaging the backup files..."
         procedure.call
 
         if @pipeline.success?
-          Logger.message "Packaging Complete!"
+          Logger.info "Packaging Complete!"
         else
           raise Errors::Packager::PipelineError,
               "Failed to Create Backup Package\n" +
@@ -81,7 +81,7 @@ module Backup
         else
           stack << lambda do
             outfile = File.join(Config.tmp_path, @package.basename)
-            @pipeline << "cat > #{ outfile }"
+            @pipeline << "#{ utility(:cat) } > #{ outfile }"
             stack.shift.call
           end
         end

data/lib/backup/pipeline.rb

@@ -2,12 +2,13 @@
 
 module Backup
   class Pipeline
-    include Backup::CLI::Helpers
+    include Backup::Utilities::Helpers
 
     attr_reader :stderr, :errors
 
     def initialize
       @commands = []
+      @success_codes = []
       @errors = []
       @stderr = ''
     end
@@ -16,8 +17,21 @@ module Backup
     # Adds a command to be executed in the pipeline.
     # Each command will be run in the order in which it was added,
     # with it's output being piped to the next command.
-    def <<(command)
+    #
+    # +success_codes+ must be an Array of Integer exit codes that will
+    # be considered successful for the +command+.
+    def add(command, success_codes)
       @commands << command
+      @success_codes << success_codes
+    end
+
+    ##
+    # Commands added using this method will only be considered successful
+    # if their exit status is 0.
+    #
+    # Use #add if successful exit status codes need to be specified.
+    def <<(command)
+      add(command, [0])
     end
 
     ##
@@ -39,7 +53,7 @@ module Backup
         pipestatus = stdout.read.gsub("\n", '').split(':').sort
         pipestatus.each do |status|
           index, exitstatus = status.split('|').map(&:to_i)
-          if exitstatus > 0
+          unless @success_codes[index].include?(exitstatus)
             command = command_name(@commands[index])
             @errors << SystemCallError.new(
               "'#{ command }' returned exit code: #{ exitstatus }", exitstatus

data/lib/backup/splitter.rb

@@ -2,7 +2,7 @@
 
 module Backup
   class Splitter
-    include Backup::CLI::Helpers
+    include Backup::Utilities::Helpers
 
     def initialize(model, chunk_size)
       @model = model
@@ -32,7 +32,7 @@ module Backup
     # be suffixed using 'aa', 'ab', and so on... for each file.
     def before_packaging
       @package = @model.package
-      Logger.message "Splitter configured with a chunk size of " +
+      Logger.info "Splitter configured with a chunk size of " +
           "#{ @chunk_size }MB."
 
       @split_command = "#{ utility(:split) } -b #{ @chunk_size }m - " +

data/lib/backup/storage/base.rb

@@ -89,9 +89,9 @@ module Backup
       # containing the original error message.
       def cycle!
         return unless keep.to_i > 0
-        Logger.message "#{ storage_name }: Cycling Started..."
+        Logger.info "#{ storage_name }: Cycling Started..."
         Cycler.cycle!(self, @package)
-        Logger.message "#{ storage_name }: Cycling Complete!"
+        Logger.info "#{ storage_name }: Cycling Complete!"
       end
 
     end

data/lib/backup/storage/cloudfiles.rb

@@ -58,7 +58,7 @@ module Backup
         remote_path = remote_path_for(@package)
 
         files_to_transfer_for(@package) do |local_file, remote_file|
-          Logger.message "#{storage_name} started transferring '#{ local_file }'."
+          Logger.info "#{storage_name} started transferring '#{ local_file }'."
 
           File.open(File.join(local_path, local_file), 'r') do |file|
             connection.put_object(
@@ -76,7 +76,7 @@ module Backup
         remote_path = remote_path_for(package)
 
         transferred_files_for(package) do |local_file, remote_file|
-          Logger.message "#{storage_name} started removing '#{ local_file }' " +
+          Logger.info "#{storage_name} started removing '#{ local_file }' " +
               "from container '#{ container }'."
           connection.delete_object(container, File.join(remote_path, remote_file))
         end

data/lib/backup/storage/dropbox.rb

@@ -55,7 +55,7 @@ module Backup
         return @connection if @connection
 
         unless session = cached_session
-          Logger.message "Creating a new session!"
+          Logger.info "Creating a new session!"
           session = create_write_and_return_new_session!
         end
 
@@ -73,7 +73,7 @@ module Backup
         if cache_exists?
           begin
             session = DropboxSession.deserialize(File.read(cached_file))
-            Logger.message "Session data loaded from cache!"
+            Logger.info "Session data loaded from cache!"
 
           rescue => err
             Logger.warn Errors::Storage::Dropbox::CacheError.wrap(err, <<-EOS)
@@ -91,7 +91,7 @@ module Backup
         remote_path = remote_path_for(@package)
 
         files_to_transfer_for(@package) do |local_file, remote_file|
-          Logger.message "#{storage_name} started transferring '#{ local_file }'."
+          Logger.info "#{storage_name} started transferring '#{ local_file }'."
           File.open(File.join(local_path, local_file), 'r') do |file|
             connection.put_file(File.join(remote_path, remote_file), file)
           end
@@ -110,7 +110,7 @@ module Backup
           messages << "#{storage_name} started removing " +
               "'#{ local_file }' from Dropbox."
         end
-        Logger.message messages.join("\n")
+        Logger.info messages.join("\n")
 
         connection.file_delete(remote_path)
       end

data/lib/backup/storage/ftp.rb

@@ -67,7 +67,7 @@ module Backup
           create_remote_path(remote_path, ftp)
 
           files_to_transfer_for(@package) do |local_file, remote_file|
-            Logger.message "#{storage_name} started transferring " +
+            Logger.info "#{storage_name} started transferring " +
                 "'#{ local_file }' to '#{ ip }'."
             ftp.put(
               File.join(local_path, local_file),
@@ -86,7 +86,7 @@ module Backup
 
         connection do |ftp|
           transferred_files_for(package) do |local_file, remote_file|
-            Logger.message "#{storage_name} started removing " +
+            Logger.info "#{storage_name} started removing " +
                 "'#{ local_file }' from '#{ ip }'."
 
             ftp.delete(File.join(remote_path, remote_file))

data/lib/backup/storage/local.rb

@@ -32,7 +32,7 @@ module Backup
         FileUtils.mkdir_p(remote_path)
 
         files_to_transfer_for(@package) do |local_file, remote_file|
-          Logger.message "#{storage_name} started transferring '#{ local_file }'."
+          Logger.info "#{storage_name} started transferring '#{ local_file }'."
 
           src_path = File.join(local_path, local_file)
           dst_path = File.join(remote_path, remote_file)
@@ -51,7 +51,7 @@ module Backup
         transferred_files_for(package) do |local_file, remote_file|
           messages << "#{storage_name} started removing '#{ local_file }'."
         end
-        Logger.message messages.join("\n")
+        Logger.info messages.join("\n")
 
         FileUtils.rm_r(remote_path)
       end