backup_zh 4.0.3.1

data/lib/backup/notifier/slack.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+require 'uri'
+require 'json'
+
+module Backup
+  module Notifier
+    class Slack < Base
+
+      ##
+      # The Team name
+      attr_accessor :team
+
+      ##
+      # The Integration Token
+      attr_accessor :token
+
+      ##
+      # The channel to send messages to
+      attr_accessor :channel
+
+      ##
+      # The username to display along with the notification
+      attr_accessor :username
+
+      ##
+      # The emoji icon to display along with the notification
+      #
+      # See http://www.emoji-cheat-sheet.com for a list of icons.
+      #
+      # Default: :floppy_disk:
+      attr_accessor :icon_emoji
+
+      ##
+      # Array of statuses for which the log file should be attached.
+      #
+      # Available statuses are: `:success`, `:warning` and `:failure`.
+      # Default: [:warning, :failure]
+      attr_accessor :send_log_on
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @send_log_on ||= [:warning, :failure]
+        @icon_emoji  ||= ':floppy_disk:'
+      end
+
+      private
+
+      ##
+      # Notify the user of the backup operation results.
+      #
+      # `status` indicates one of the following:
+      #
+      # `:success`
+      # : The backup completed successfully.
+      # : Notification will be sent if `on_success` is `true`.
+      #
+      # `:warning`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      # `:failure`
+      # : The backup operation failed.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      def notify!(status)
+        tag = case status
+              when :success then '[Backup::Success]'
+              when :failure then '[Backup::Failure]'
+              when :warning then '[Backup::Warning]'
+              end
+        message = "#{ tag } #{ model.label } (#{ model.trigger })"
+
+        data = { :text => message }
+        [:channel, :username, :icon_emoji].each do |param|
+          val = send(param)
+          data.merge!(param => val) if val
+        end
+
+        data.merge!(:attachments => [attachment(status)])
+
+        options = {
+          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
+          :body     => URI.encode_www_form(:payload => JSON.dump(data))
+        }
+        options.merge!(:expects => 200) # raise error if unsuccessful
+        Excon.post(uri, options)
+      end
+
+      def attachment(status)
+        {
+          :fallback => "#{title(status)} - Job: #{model.label} (#{model.trigger})",
+          :text     => title(status),
+          :color    => color(status),
+          :fields   => [
+            {
+              :title => "Job",
+              :value => "#{model.label} (#{model.trigger})",
+              :short => false
+            },
+            {
+              :title => "Started",
+              :value => model.started_at,
+              :short => true
+            },
+            {
+              :title => "Finished",
+              :value => model.finished_at,
+              :short => true
+            },
+            {
+              :title => "Duration",
+              :value => model.duration,
+              :short => true
+            },
+            {
+              :title => "Version",
+              :value => "Backup v#{Backup::VERSION}\nRuby: #{RUBY_DESCRIPTION}",
+              :short => false
+            },
+            log_field(status)
+          ].compact
+        }
+      end
+
+      def log_field(status)
+        send_log = send_log_on.include?(status)
+
+        return {
+          :title => "Detailed Backup Log",
+          :value => Logger.messages.map(&:formatted_lines).flatten.join("\n"),
+          :short => false,
+        } if send_log
+      end
+
+      def color(status)
+        case status
+        when :success then 'good'
+        when :failure then 'danger'
+        when :warning then 'warning'
+        end
+      end
+
+      def title(status)
+        case status
+        when :success then 'Backup Completed Successfully!'
+        when :failure then 'Backup Failed!'
+        when :warning then 'Backup Completed Successfully (with Warnings)!'
+        end
+      end
+
+      def uri
+        @uri ||= "https://#{team}.slack.com/services/hooks/incoming-webhook?token=#{token}"
+      end
+    end
+  end
+end

data/lib/backup/notifier/twitter.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+require 'twitter'
+
+module Backup
+  module Notifier
+    class Twitter < Base
+
+      ##
+      # Twitter consumer key credentials
+      attr_accessor :consumer_key, :consumer_secret
+
+      ##
+      # OAuth credentials
+      attr_accessor :oauth_token, :oauth_token_secret
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+      end
+
+      private
+
+      ##
+      # Notify the user of the backup operation results.
+      #
+      # `status` indicates one of the following:
+      #
+      # `:success`
+      # : The backup completed successfully.
+      # : Notification will be sent if `on_success` is `true`.
+      #
+      # `:warning`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      # `:failure`
+      # : The backup operation failed.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      def notify!(status)
+        tag = case status
+              when :success then '[Backup::Success]'
+              when :warning then '[Backup::Warning]'
+              when :failure then '[Backup::Failure]'
+              end
+        message = "#{ tag } #{ model.label } (#{ model.trigger }) (@ #{ model.time })"
+        send_message(message)
+      end
+
+      # Twitter::Client will raise an error if unsuccessful.
+      def send_message(message)
+        client = ::Twitter::REST::Client.new do |config|
+          config.consumer_key        = @consumer_key
+          config.consumer_secret     = @consumer_secret
+          config.access_token        = @oauth_token
+          config.access_token_secret = @oauth_token_secret
+        end
+
+        client.update(message)
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/zabbix.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+module Backup
+  module Notifier
+    class Zabbix < Base
+
+      attr_accessor :zabbix_host
+
+      attr_accessor :zabbix_port
+
+      attr_accessor :service_name
+
+      attr_accessor :service_host
+
+      attr_accessor :item_key
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @zabbix_host  ||= Config.hostname
+        @zabbix_port  ||= 10051
+        @service_name ||= "Backup #{ model.trigger }"
+        @service_host ||= Config.hostname
+        @item_key     ||= 'backup_status'
+      end
+
+      private
+
+      ##
+      # Notify the user of the backup operation results.
+      #
+      # `status` indicates one of the following:
+      #
+      # `:success`
+      # : The backup completed successfully.
+      # : Notification will be sent if `on_success` is `true`.
+      #
+      # `:warning`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      # `:failure`
+      # : The backup operation failed.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      def notify!(status)
+        message = case status
+              when :success then 'Completed Successfully'
+              when :warning then 'Completed Successfully (with Warnings)'
+              when :failure then 'Failed'
+              end
+        send_message("#{ message } in #{ model.duration }")
+      end
+
+      def send_message(message)
+        msg = [service_host, service_name, model.exit_status, message].join("\t")
+        cmd = "#{ utility(:zabbix_sender) }" +
+              " -z '#{ zabbix_host }'" +
+              " -p '#{ zabbix_port }'" +
+              " -s #{ service_host }"  +
+              " -k #{ item_key }"      +
+              " -o '#{ msg }'"
+        run("echo '#{ msg }' | #{ cmd }")
+      end
+    end
+  end
+end

data/lib/backup/package.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module Backup
+  class Package
+
+    ##
+    # The time when the backup initiated (in format: 2011.02.20.03.29.59)
+    attr_accessor :time
+
+    ##
+    # The trigger which initiated the backup process
+    attr_reader :trigger
+
+    ##
+    # Extension for the final archive file(s)
+    attr_accessor :extension
+
+    ##
+    # Set by the Splitter if the final archive was "chunked"
+    attr_accessor :chunk_suffixes
+
+    ##
+    # If true, the Cycler will not attempt to remove the package when Cycling.
+    attr_accessor :no_cycle
+
+    ##
+    # The version of Backup used to create the package
+    attr_reader :version
+
+    def initialize(model)
+      @trigger = model.trigger
+      @extension = 'tar'
+      @chunk_suffixes = Array.new
+      @no_cycle = false
+      @version = VERSION
+    end
+
+    def filenames
+      if chunk_suffixes.empty?
+        [basename]
+      else
+        chunk_suffixes.map {|suffix| "#{ basename }-#{ suffix }" }
+      end
+    end
+
+    def basename
+      "#{ trigger }.#{ extension }"
+    end
+
+  end
+end

data/lib/backup/packager.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+
+module Backup
+  module Packager
+    class Error < Backup::Error; end
+
+    class << self
+      include Utilities::Helpers
+
+      ##
+      # Build the final package for the backup model.
+      def package!(model)
+        @package   = model.package
+        @encryptor = model.encryptor
+        @splitter  = model.splitter
+        @pipeline  = Pipeline.new
+
+        Logger.info "Packaging the backup files..."
+        procedure.call
+
+        if @pipeline.success?
+          Logger.info "Packaging Complete!"
+        else
+          raise Error, "Failed to Create Backup Package\n" +
+              @pipeline.error_messages
+        end
+      end
+
+      private
+
+      ##
+      # Builds a chain of nested Procs which adds each command to a Pipeline
+      # needed to package the final command to package the backup.
+      # This is done so that the Encryptor and Splitter have the ability
+      # to perform actions before and after the final command is executed.
+      # No Encryptors currently utilize this, however the Splitter does.
+      def procedure
+        stack = []
+
+        ##
+        # Initial `tar` command to package the temporary backup folder.
+        # The command's output will then be either piped to the Encryptor
+        # or the Splitter (if no Encryptor), or through `cat` into the final
+        # output file if neither are configured.
+        @pipeline << "#{ utility(:tar) } -cf - " +
+            "-C '#{ Config.tmp_path }' '#{ @package.trigger }'"
+
+        ##
+        # If an Encryptor was configured, it will be called first
+        # to add the encryption utility command to be piped through,
+        # and amend the final package extension.
+        # It's output will then be either piped into a Splitter,
+        # or through `cat` into the final output file.
+        if @encryptor
+          stack << lambda do
+            @encryptor.encrypt_with do |command, ext|
+              @pipeline << command
+              @package.extension << ext
+              stack.shift.call
+            end
+          end
+        end
+
+        ##
+        # If a Splitter was configured, the `split` utility command will be
+        # added to the Pipeline to split the final output into multiple files.
+        # Once the Proc executing the Pipeline has completed and returns back
+        # to the Splitter, it will check the final output files to determine
+        # if the backup was indeed split.
+        # If so, it will set the package's chunk_suffixes. If not, it will
+        # remove the '-aa' suffix from the only file created by `split`.
+        #
+        # If no Splitter was configured, the final file output will be
+        # piped through `cat` into the final output file.
+        if @splitter
+          stack << lambda do
+            @splitter.split_with do |command|
+              @pipeline << command
+              stack.shift.call
+            end
+          end
+        else
+          stack << lambda do
+            outfile = File.join(Config.tmp_path, @package.basename)
+            @pipeline << "#{ utility(:cat) } > #{ outfile }"
+            stack.shift.call
+          end
+        end
+
+        ##
+        # Last Proc to be called runs the Pipeline the procedure built.
+        # Once complete, the call stack will unwind back through the
+        # preceeding Procs in the stack (if any)
+        stack << lambda { @pipeline.run }
+
+        stack.shift
+      end
+
+    end
+  end
+end

data/lib/backup/pipeline.rb

@@ -0,0 +1,124 @@
+# encoding: utf-8
+
+module Backup
+  class Pipeline
+    class Error < Backup::Error; end
+
+    include Utilities::Helpers
+
+    attr_reader :stderr, :errors
+
+    def initialize
+      @commands = []
+      @success_codes = []
+      @errors = []
+      @stderr = ''
+    end
+
+    ##
+    # 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.
+    #
+    # +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
+
+    ##
+    # Runs the command line from `#pipeline` and collects STDOUT/STDERR.
+    # STDOUT is then parsed to determine the exit status of each command.
+    # For each command with a non-zero exit status, a SystemCallError is
+    # created and added to @errors. All STDERR output is set in @stderr.
+    #
+    # Note that there is no accumulated STDOUT from the commands themselves.
+    # Also, the last command should not attempt to write to STDOUT.
+    # Any output on STDOUT from the final command will be sent to STDERR.
+    # This in itself will not cause #run to fail, but will log warnings
+    # when all commands exit with non-zero status.
+    #
+    # Use `#success?` to determine if all commands in the pipeline succeeded.
+    # If `#success?` returns `false`, use `#error_messages` to get an error report.
+    def run
+      Open4.popen4(pipeline) do |pid, stdin, stdout, stderr|
+        pipestatus = stdout.read.gsub("\n", '').split(':').sort
+        pipestatus.each do |status|
+          index, exitstatus = status.split('|').map(&:to_i)
+          unless @success_codes[index].include?(exitstatus)
+            command = command_name(@commands[index])
+            @errors << SystemCallError.new(
+              "'#{ command }' returned exit code: #{ exitstatus }", exitstatus
+            )
+          end
+        end
+        @stderr = stderr.read.strip
+      end
+      Logger.warn(stderr_messages) if success? && stderr_messages
+    rescue Exception => err
+      raise Error.wrap(err, 'Pipeline failed to execute')
+    end
+
+    def success?
+      @errors.empty?
+    end
+
+    ##
+    # Returns a multi-line String, reporting all STDERR messages received
+    # from the commands in the pipeline (if any), along with the SystemCallError
+    # (Errno) message for each command which had a non-zero exit status.
+    def error_messages
+      @error_messages ||= (stderr_messages || '') +
+          "The following system errors were returned:\n" +
+          @errors.map {|err| "#{ err.class }: #{ err.message }" }.join("\n")
+    end
+
+    private
+
+    ##
+    # Each command is added as part of the pipeline, grouped with an `echo`
+    # command to pass along the command's index in @commands and it's exit status.
+    # The command's STDERR is redirected to FD#4, and the `echo` command to
+    # report the "index|exit status" is redirected to FD#3.
+    # Each command's STDOUT will be connected to the STDIN of the next subshell.
+    # The entire pipeline is run within a container group, which redirects
+    # FD#3 to STDOUT and FD#4 to STDERR so these can be collected.
+    # FD#1 is redirected to STDERR so that any output from the final command
+    # on STDOUT will generate warnings, since the final command should not
+    # attempt to write to STDOUT, as this would interfere with collecting
+    # the exit statuses.
+    #
+    # There is no guarantee as to the order of this output, which is why the
+    # command's index in @commands is passed along with it's exit status.
+    # And, if multiple commands output messages on STDERR, those messages
+    # may be interleaved. Interleaving of the "index|exit status" outputs
+    # should not be an issue, given the small byte size of the data being written.
+    def pipeline
+      parts = []
+      @commands.each_with_index do |command, index|
+        parts << %Q[{ #{ command } 2>&4 ; echo "#{ index }|$?:" >&3 ; }]
+      end
+      %Q[{ #{ parts.join(' | ') } } 3>&1 1>&2 4>&2]
+    end
+
+    def stderr_messages
+      @stderr_messages ||= @stderr.empty? ? false : <<-EOS.gsub(/^ +/, '  ')
+        Pipeline STDERR Messages:
+        (Note: may be interleaved if multiple commands returned error messages)
+
+        #{ @stderr }
+      EOS
+    end
+
+  end
+end