backup 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0598ab928bc914fc5be6f4e473a2dba3f3b80c41
-  data.tar.gz: d8c34be3b2896bb9a1cc024c67df93783ae1853c
+  metadata.gz: b7e83c99df63edb4998a75a49d81a06b0d1039ca
+  data.tar.gz: 5080aa4b34f9fc9104a1f312ad7418398b041148
 SHA512:
-  metadata.gz: eed55c0c9b7e63ba902db61e8148413a430d21755175c34926ae5348318aefde89876a5dd8231dccef11adaad44ec08575f3e244e7b3ab235e2100e764b9b079
-  data.tar.gz: 20d0efa09f22cf70b9bdaf94ac49d43f1fbe0d499b44bfe31ac93c0b867559c3db83c87a70953d5def9cfe53caff2308f36dc40cc0b1406cf284d310749c80b2
+  metadata.gz: 2e80a87dbf0a0d93cdb5ce0fb9a3f10c9b68b7d2ab2d49b5f30e8a77e3bf5763669ee7f0b853800283f3097c3c18fe0fc53f186dd0fbdb2bb5bacaf58b423c61
+  data.tar.gz: 2dacfb012d43a5e19434427d76ddd0ddb3b03913eba7dce02ce3947397be1b7b3f663fb74bcd04e93ee5006c27c7487c2c5cdb61cff1e2200562e5e0bbe0a413

data/README.md

@@ -1,5 +1,7 @@
 Backup v4.x
 ===========
+[![Code Climate](https://codeclimate.com/github/meskyanichi/backup.png)](https://codeclimate.com/github/meskyanichi/backup)
+[![Build Status](https://travis-ci.org/meskyanichi/backup.svg?branch=master)](https://travis-ci.org/meskyanichi/backup)
 
 Backup is a system utility for Linux and Mac OS X, distributed as a RubyGem, that allows you to easily perform backup
 operations. It provides an elegant DSL in Ruby for _modeling_ your backups. Backup has built-in support for various

data/lib/backup.rb

@@ -108,6 +108,8 @@ module Backup
     autoload :Slack,     File.join(NOTIFIER_PATH, 'slack')
     autoload :HttpPost,  File.join(NOTIFIER_PATH, 'http_post')
     autoload :Nagios,    File.join(NOTIFIER_PATH, 'nagios')
+    autoload :FlowDock,  File.join(NOTIFIER_PATH, 'flowdock')
+    autoload :Zabbix,    File.join(NOTIFIER_PATH, 'zabbix')
   end
 
   ##

data/lib/backup/config/dsl.rb

@@ -42,7 +42,8 @@ module Backup
               ],
               # Notifiers
               ['Mail', 'Twitter', 'Campfire', 'Prowl',
-              'Hipchat', 'Pushover', 'HttpPost', 'Nagios', 'Slack']
+              'Hipchat', 'Pushover', 'HttpPost', 'Nagios',
+              'Slack', 'FlowDock', 'Zabbix']
             ]
           )
         end

data/lib/backup/database/mysql.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+require 'shellwords'
 
 module Backup
   module Database
@@ -32,28 +33,48 @@ module Backup
       attr_accessor :only_tables
 
       ##
-      # Additional "mysqldump" options
+      # Additional "mysqldump" or "innobackupex (backup creation)" options
       attr_accessor :additional_options
 
+      ##
+      # Additional innobackupex log preparation phase ("apply-logs") options
+      attr_accessor :prepare_options
+
+      ##
+      # Default is :mysqldump (which is built in MySQL and generates
+      # a textual SQL file), but can be changed to :innobackupex, which
+      # has more feasible restore times for large databases.
+      # See: http://www.percona.com/doc/percona-xtrabackup/
+      attr_accessor :backup_engine
+
+      ##
+      # If set the backup engine command block is executed as the given user
+      attr_accessor :sudo_user
+
+      ##
+      # If set, do not suppress innobackupdb output (useful for debugging)
+      attr_accessor :verbose
+
       def initialize(model, database_id = nil, &block)
         super
         instance_eval(&block) if block_given?
 
         @name ||= :all
+        @backup_engine ||= :mysqldump
       end
 
       ##
-      # Performs the mysqldump command and outputs the dump file
-      # in the +dump_path+ using +dump_filename+.
+      # Performs the mysqldump or innobackupex command and outputs
+      # the dump file in the +dump_path+ using +dump_filename+.
       #
-      #   <trigger>/databases/MySQL[-<database_id>].sql[.gz]
+      #   <trigger>/databases/MySQL[-<database_id>].[sql|tar][.gz]
       def perform!
         super
 
         pipeline = Pipeline.new
-        dump_ext = 'sql'
+        dump_ext = sql_backup? ? 'sql' : 'tar'
 
-        pipeline << mysqldump
+        pipeline << sudo_option(sql_backup? ? mysqldump : innobackupex)
 
         model.compressor.compress_with do |command, ext|
           pipeline << command
@@ -81,8 +102,8 @@ module Backup
 
       def credential_options
         opts = []
-        opts << "--user='#{ username }'" if username
-        opts << "--password='#{ password }'" if password
+        opts << "--user=#{ Shellwords.escape(username) }" if username
+        opts << "--password=#{ Shellwords.escape(password) }" if password
         opts.join(' ')
       end
 
@@ -99,6 +120,10 @@ module Backup
         Array(additional_options).join(' ')
       end
 
+      def user_prepare_options
+        Array(prepare_options).join(' ')
+      end
+
       def name_option
         dump_all? ? '--all-databases' : name
       end
@@ -118,6 +143,39 @@ module Backup
         name == :all
       end
 
+      def sql_backup?
+        backup_engine.to_sym == :mysqldump
+      end
+
+      def innobackupex
+        # Creation phase
+        "#{ utility(:innobackupex) } #{ credential_options } " +
+        "#{ connectivity_options } #{ user_options } " +
+        "--no-timestamp #{ temp_dir } #{ quiet_option } && " +
+        # Log applying phase (prepare for restore)
+        "#{ utility(:innobackupex) } --apply-log #{ temp_dir } " +
+        "#{ user_prepare_options }  #{ quiet_option } && " +
+        # Move files to tar-ed stream on stdout
+        "#{ utility(:tar) } --remove-files -cf -  " +
+        "-C #{ File.dirname(temp_dir) } #{ File.basename(temp_dir) }"
+      end
+
+      def sudo_option(command_block)
+        return command_block unless sudo_user
+
+        "sudo -s -u #{ sudo_user } -- <<END_OF_SUDO\n" +
+        "#{command_block}\n" +
+        "END_OF_SUDO\n"
+      end
+
+      def quiet_option
+        verbose ? "" : " 2> /dev/null "
+      end
+
+      def temp_dir
+        File.join(dump_path, dump_filename + ".bkpdir")
+      end
+
     end
   end
 end

data/lib/backup/database/postgresql.rb

@@ -45,7 +45,7 @@ module Backup
       end
 
       ##
-      # Performs the mysqldump command and outputs the dump file
+      # Performs the pgdump command and outputs the dump file
       # in the +dump_path+ using +dump_filename+.
       #
       #   <trigger>/databases/PostgreSQL[-<database_id>].sql[.gz]

data/lib/backup/logger/logfile.rb

@@ -35,6 +35,19 @@ module Backup
         # @return [String] Default: 'log'
         attr_reader :log_path
 
+        ##
+        # Backup's logfile in which backup logs can be written
+        #
+        # As there is already a log_path, this can simply be just a file name
+        # that will be created (If not exists) on log_path directory
+        #
+        # This may also be set on the command line using +--log-file+.
+        # If set on the command line, any setting here will be ignored.
+        #
+        # @param [String]
+        # @return [String] Default: 'backup.log'
+        attr_reader :log_file
+
         ##
         # Size in bytes to truncate logfile to before backup jobs are run.
         #
@@ -89,7 +102,8 @@ module Backup
           path = File.join(Backup::Config.root_path, path)
         end
         FileUtils.mkdir_p(path)
-        path = File.join(path, 'backup.log')
+        log_file = @options.log_file || 'backup.log'
+        path = File.join(path, log_file)
         if File.exist?(path) && !File.writable?(path)
           raise Error, "Log File at '#{ path }' is not writable"
         end

data/lib/backup/notifier/flowdock.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+require 'flowdock'
+
+module Backup
+  module Notifier
+    class FlowDock < Base
+
+      ##
+      # The Flowdock API token
+      attr_accessor :token
+
+      ##
+      # Who the notification should appear from
+      attr_accessor :from_name
+
+      # Which email the notification should appear from
+      attr_accessor :from_email
+
+      ##
+      # source for message
+      attr_accessor :source
+
+      ##
+      # Subject for message
+      attr_accessor :subject
+
+      ##
+      # tag message in inbox
+      attr_accessor :tags
+
+      ##
+      # link for message
+      attr_accessor :link
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @subject        ||= default_subject
+        @source         ||= default_source
+        @tags           ||= []
+      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)
+        @tags  += default_tags(status)
+        message = "#{ model.label } (#{ model.trigger })"
+        send_message(message)
+      end
+
+      # Flowdock::Client will raise an error if unsuccessful.
+      def send_message(msg)
+        client = Flowdock::Flow.new(:api_token => token, :source => source,
+                                    :from => {:name => from_name, :address => from_email })
+
+        client.push_to_team_inbox(:subject => subject,
+                                  :content => msg,
+                                  :tags => tags,
+                                  :link => link )
+      end
+
+      # set related tags
+      def default_tags(status)
+        case status
+        when :success then ['#BackupSuccess']
+        when :warning then ['#BackupWarning']
+        when :failure then ['#BackupFailure']
+        end
+      end
+
+
+      #set default source
+      def default_source
+        "Backup #{ model.label }"
+      end
+
+      # set default subject
+      def default_subject
+        'Backup Notification'
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/nagios.rb

@@ -12,6 +12,10 @@ module Backup
       # Port of Nagios server to notify on backup completion.
       attr_accessor :nagios_port
 
+      ##
+      # Nagios nrpe configuration file.
+      attr_accessor :send_nsca_cfg     
+ 
       ##
       # Name of the Nagios service for the backup check.
       attr_accessor :service_name
@@ -26,6 +30,7 @@ module Backup
 
         @nagios_host  ||= Config.hostname
         @nagios_port  ||= 5667
+        @send_nsca_cfg||= "/etc/nagios/send_nsca.cfg"
         @service_name ||= "Backup #{ model.trigger }"
         @service_host ||= Config.hostname
       end
@@ -59,7 +64,7 @@ module Backup
       end
 
       def send_message(message)
-        cmd = "#{ utility(:send_nsca) } -H '#{ nagios_host }' -p '#{ nagios_port }'"
+        cmd = "#{ utility(:send_nsca) } -H '#{ nagios_host }' -p '#{ nagios_port }' -c '#{ send_nsca_cfg }'"
         msg = [service_host, service_name, model.exit_status, message].join("\t")
         run("echo '#{ msg }' | #{ cmd }")
       end

data/lib/backup/notifier/twitter.rb

@@ -49,14 +49,13 @@ module Backup
 
       # Twitter::Client will raise an error if unsuccessful.
       def send_message(message)
-        ::Twitter.configure do |config|
-          config.consumer_key       = @consumer_key
-          config.consumer_secret    = @consumer_secret
-          config.oauth_token        = @oauth_token
-          config.oauth_token_secret = @oauth_token_secret
+        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 = ::Twitter::Client.new
         client.update(message)
       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/utilities.rb

@@ -8,11 +8,13 @@ module Backup
     NAMES = %w{
       tar cat split sudo chown hostname
       gzip bzip2
-      mongo mongodump mysqldump pg_dump pg_dumpall redis-cli riak-admin
+      mongo mongodump mysqldump innobackupex
+      pg_dump pg_dumpall redis-cli riak-admin
       gpg openssl
       rsync ssh
       sendmail exim
       send_nsca
+      zabbix_sender
     }
 
     module DSL
@@ -94,6 +96,7 @@ module Backup
       #     sendmail  '/path/to/sendmail'
       #     exim      '/path/to/exim'
       #     send_nsca '/path/to/send_nsca'
+      #     zabbix_sender '/path/to/zabbix_sender'
       #   end
       #
       # These paths may be set using absolute paths, or relative to the

data/lib/backup/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Backup
-  VERSION = '4.0.2'
+  VERSION = '4.0.3'
 end

data/templates/cli/notifier/zabbix

@@ -0,0 +1,15 @@
+##
+# Zabbix [Notifier]
+#
+notify_by Zabbix do |zabbix|
+    zabbix.on_success = true
+    zabbix.on_warning = true
+    zabbix.on_failure = true
+
+    zabbix.zabbix_host  = "zabbix_server_hostname"
+    zabbix.zabbix_port  = 10051
+    zabbix.service_name = "Backup trigger"
+    zabbix.service_host = "zabbix_host"
+    zabbix.item_key     = "backup_status"
+  end
+

data/templates/cli/notifiers/flowdock

@@ -0,0 +1,16 @@
+  ##
+  # Flowdock [Notifier]
+  #
+  notify_by FlowDock do |flowdock|
+    flowdock.on_success = true
+    flowdock.on_warning = true
+    flowdock.on_failure = true
+
+    flowdock.token          = "token"
+    flowdock.from_name      = 'my_name'
+    flowdock.from_email     = 'email@example.com'
+    flowdock.subject        = 'My Daily Backup'
+    flowdock.source         = 'Backup'
+    flowdock.tags           = ['prod', 'backup']
+    flowdock.link           = 'www.example.com'
+  end

data/templates/cli/notifiers/slack

@@ -0,0 +1,23 @@
+  ##
+  # Slack [Notifier]
+  #
+  notify_by Slack do |slack|
+    slack.on_success = true
+    slack.on_warning = true
+    slack.on_failure = true
+
+    # The team name
+    slack.team = 'my_team'
+
+    # The integration token
+    slack.token = 'xxxxxxxxxxxxxxxxxxxxxxxx'
+
+    ##
+    # Optional
+    #
+    # The channel to which messages will be sent
+    # slack.channel = 'my_channel'
+    #
+    # The username to display along with the notification
+    # slack.username = 'my_username'
+  end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -136,6 +136,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: flowdock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
@@ -576,6 +590,7 @@ files:
 - lib/backup/model.rb
 - lib/backup/notifier/base.rb
 - lib/backup/notifier/campfire.rb
+- lib/backup/notifier/flowdock.rb
 - lib/backup/notifier/hipchat.rb
 - lib/backup/notifier/http_post.rb
 - lib/backup/notifier/mail.rb
@@ -584,6 +599,7 @@ files:
 - lib/backup/notifier/pushover.rb
 - lib/backup/notifier/slack.rb
 - lib/backup/notifier/twitter.rb
+- lib/backup/notifier/zabbix.rb
 - lib/backup/package.rb
 - lib/backup/packager.rb
 - lib/backup/pipeline.rb
@@ -624,13 +640,16 @@ files:
 - templates/cli/encryptor/gpg
 - templates/cli/encryptor/openssl
 - templates/cli/model
+- templates/cli/notifier/zabbix
 - templates/cli/notifiers/campfire
+- templates/cli/notifiers/flowdock
 - templates/cli/notifiers/hipchat
 - templates/cli/notifiers/http_post
 - templates/cli/notifiers/mail
 - templates/cli/notifiers/nagios
 - templates/cli/notifiers/prowl
 - templates/cli/notifiers/pushover
+- templates/cli/notifiers/slack
 - templates/cli/notifiers/twitter
 - templates/cli/splitter
 - templates/cli/storages/cloud_files