backup_zh 4.0.3.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a5011f86294da25fd2e264a84a51bce114bcc8a
-  data.tar.gz: 4b0f2ae51ead1af4a112028233cfff9f6c1fe8e4
+  metadata.gz: 7fc3367bd1a9cebd38de0ac0c15c1b81dfaa3d2f
+  data.tar.gz: 986424c3cce771ff3e7dad33d6fa72437381387f
 SHA512:
-  metadata.gz: 496a87045fd14afc4010458132c8d7a38306a5952abb0781f1ce2e5f54d49eba9680f12e974eabae8ac3cac86a9d75a620f076e634439d7e1eecb822a9dda555
-  data.tar.gz: c1e4e9403cfca3b4fc228ee0f6cdbeba389836042e2c7efb527174792b09305a56fdef0d8491ee311174ff11be9ae495cfbba1476401a5da73281cf18d179621
+  metadata.gz: 94aed25187160ef0525c37f22f8ddef4c0afbe54e60103d21e54446a60a1c1277837045ece5ffbf6d7270aba4149a7a040588512957ac50b5fa62f807e37850f
+  data.tar.gz: 34a46c8e8ad9d11611af22671ac1979f11a9c005baca98cfc56358c5a815b5ccf4d964afb5ecebc360f3f7ffa6ada951762564b6599b7e46256a12336e435585

data/README.md

@@ -1,21 +1,29 @@
 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)
+
+[![Code Climate](https://codeclimate.com/github/backup/backup.png)](https://codeclimate.com/github/backup/backup)
+[![Build Status](https://travis-ci.org/backup/backup.svg?branch=master)](https://travis-ci.org/backup/backup)
+[![Join the chat at https://gitter.im/backup/backup](https://badges.gitter.im/Join%20Chat.svg)][Gitter]
 
 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
 databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It
 was built with modularity, extensibility and simplicity in mind.
 
-[Installation][] · [Release Notes][] · [Documentation][]
+[Installation][] · [Release Notes][] · [Documentation][] · [Issues][] · [Features][] · [Chat][Gitter]
 
+Please use the Backup features [issue tracker][Features] to suggest new features.
+Only use the Backup gem [issue tracker][Issues] for bugs and other issues.
+We're also available on [Gitter][] for questions and problems.
 
-**Copyright (c) 2009-2014 [Michael van Rooijen][] ( [@meskyanichi][] )**  
+**Copyright (c) 2009-2015 [Michael van Rooijen][] ( [@meskyanichi][] )**  
 Released under the **MIT** [License](LICENSE.md).
 
-[Installation]:  http://meskyanichi.github.io/backup/v4/installation
-[Release Notes]: http://meskyanichi.github.io/backup/v4/release-notes
-[Documentation]: http://meskyanichi.github.io/backup/v4
+[Installation]:  http://backup.github.io/backup/v4/installation
+[Release Notes]: http://backup.github.io/backup/v4/release-notes
+[Documentation]: http://backup.github.io/backup/v4
+[Issues]: https://github.com/backup/backup/issues
+[Features]: https://github.com/backup/backup-features/issues
+[Gitter]: https://gitter.im/backup/backup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
 [Michael van Rooijen]: http://michaelvanrooijen.com
 [@meskyanichi]: http://twitter.com/#!/meskyanichi

data/lib/backup.rb

@@ -11,6 +11,7 @@ require 'thread'
 
 require 'open4'
 require 'thor'
+require 'shellwords'
 
 require 'excon'
 # Include response.inspect in error messages.
@@ -78,6 +79,7 @@ module Backup
     autoload :Redis,      File.join(DATABASE_PATH, 'redis')
     autoload :Riak,       File.join(DATABASE_PATH, 'riak')
     autoload :OpenLDAP,   File.join(DATABASE_PATH, 'openldap')
+    autoload :SQLite,     File.join(DATABASE_PATH, 'sqlite')
   end
 
   ##
@@ -106,12 +108,16 @@ module Backup
     autoload :Campfire,  File.join(NOTIFIER_PATH, 'campfire')
     autoload :Prowl,     File.join(NOTIFIER_PATH, 'prowl')
     autoload :Hipchat,   File.join(NOTIFIER_PATH, 'hipchat')
+    autoload :PagerDuty, File.join(NOTIFIER_PATH, 'pagerduty')
     autoload :Pushover,  File.join(NOTIFIER_PATH, 'pushover')
     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')
+    autoload :DataDog,   File.join(NOTIFIER_PATH, 'datadog')
+    autoload :Ses,       File.join(NOTIFIER_PATH, 'ses')
+    autoload :Command,   File.join(NOTIFIER_PATH, 'command')
   end
 
   ##

data/lib/backup/cli.rb

@@ -142,6 +142,9 @@ module Backup
 
       rescue Exception => err
         Logger.error Error.wrap(err)
+        unless Helpers.is_backup_error? err
+          Logger.error err.backtrace.join("\n")
+        end
         # Logger configuration will be ignored
         # and messages will be output to the console only.
         Logger.abort!
@@ -219,6 +222,9 @@ module Backup
         Config.load(options)
       rescue Exception => err
         Logger.error Error.wrap(err)
+        unless Helpers.is_backup_error? err
+          Logger.error err.backtrace.join("\n")
+        end
       end
 
       if Logger.has_warnings? || Logger.has_errors?
@@ -357,6 +363,10 @@ module Backup
           exec(cmd)
         end
 
+        def is_backup_error?(error)
+          error.class.ancestors.include? Backup::Error
+        end
+
       end
     end
 

data/lib/backup/config/dsl.rb

@@ -27,7 +27,7 @@ module Backup
           create_modules(
             DSL,
             [ # Databases
-              ['MySQL', 'PostgreSQL', 'MongoDB', 'Redis', 'Riak', 'OpenLDAP'],
+              ['MySQL', 'PostgreSQL', 'MongoDB', 'Redis', 'Riak', 'OpenLDAP', 'SQLite'],
               # Storages
               ['S3', 'CloudFiles', 'Ninefold', 'Dropbox', 'FTP',
               'SFTP', 'SCP', 'RSync', 'Local', 'QiNiu'],
@@ -42,8 +42,8 @@ module Backup
               ],
               # Notifiers
               ['Mail', 'Twitter', 'Campfire', 'Prowl',
-              'Hipchat', 'Pushover', 'HttpPost', 'Nagios',
-              'Slack', 'FlowDock', 'Zabbix']
+              'Hipchat', 'PagerDuty', 'Pushover', 'HttpPost', 'Nagios',
+              'Slack', 'FlowDock', 'Zabbix', 'Ses', 'DataDog', 'Command']
             ]
           )
         end

data/lib/backup/database/mysql.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'shellwords'
 
 module Backup
   module Database
@@ -47,6 +46,12 @@ module Backup
       # See: http://www.percona.com/doc/percona-xtrabackup/
       attr_accessor :backup_engine
 
+      ##
+      # If true (which is the default behaviour), the backup will be prepared
+      # after it has been successfuly created. This option is only valid if
+      # :backup_engine is set to :innobackupex.
+      attr_accessor :prepare_backup
+
       ##
       # If set the backup engine command block is executed as the given user
       attr_accessor :sudo_user
@@ -61,6 +66,7 @@ module Backup
 
         @name ||= :all
         @backup_engine ||= :mysqldump
+        @prepare_backup = true if @prepare_backup.nil?
       end
 
       ##
@@ -95,8 +101,8 @@ module Backup
       private
 
       def mysqldump
-        "#{ utility(:mysqldump) } #{ credential_options } " +
-        "#{ connectivity_options } #{ user_options } #{ name_option } " +
+        "#{ utility(:mysqldump) } #{ user_options } #{ credential_options } " +
+        "#{ connectivity_options } #{ name_option } " +
         "#{ tables_to_dump } #{ tables_to_skip }"
       end
 
@@ -152,14 +158,19 @@ module Backup
         "#{ 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 } && " +
+        innobackupex_prepare +
         # Move files to tar-ed stream on stdout
         "#{ utility(:tar) } --remove-files -cf -  " +
         "-C #{ File.dirname(temp_dir) } #{ File.basename(temp_dir) }"
       end
 
+      def innobackupex_prepare
+        return "" unless @prepare_backup
+        # Log applying phase (prepare for restore)
+        "#{ utility(:innobackupex) } --apply-log #{ temp_dir } " +
+        "#{ user_prepare_options }  #{ quiet_option } && "
+      end
+
       def sudo_option(command_block)
         return command_block unless sudo_user
 

data/lib/backup/database/postgresql.rb

@@ -88,7 +88,7 @@ module Backup
       end
 
       def password_option
-        "PGPASSWORD='#{ password }' " if password
+        "PGPASSWORD=#{ Shellwords.escape(password) } " if password
       end
 
       def sudo_option
@@ -96,7 +96,7 @@ module Backup
       end
 
       def username_option
-        "--username='#{ username }'" if username
+        "--username=#{ Shellwords.escape(username) }" if username
       end
 
       def connectivity_options

data/lib/backup/database/sqlite.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class SQLite < Base
+      class Error < Backup::Error; end
+
+      ##
+      # Path to the sqlite3 file
+      attr_accessor :path
+
+      ##
+      # Path to sqlite utility (optional)
+      attr_accessor :sqlitedump_utility
+
+      ##
+      # Creates a new instance of the SQLite adapter object
+      def initialize(model, database_id = nil, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @sqlitedump_utility ||= utility(:sqlitedump)
+      end
+
+      ##
+      # Performs the sqlitedump command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        super
+
+        dump = "echo '.dump' | #{ sqlitedump_utility } #{ path }"
+
+        pipeline = Pipeline.new
+        dump_ext = 'sql'
+
+        pipeline << dump
+        if model.compressor
+          model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
+
+        pipeline << "cat > '#{ File.join( dump_path , dump_filename) }.#{ dump_ext }'"
+
+        pipeline.run
+
+        if pipeline.success?
+          log!(:finished)
+        else
+          raise Error,
+            "#{ database_name } Dump Failed!\n" + pipeline.error_messages
+        end
+      end
+    end
+  end
+end

data/lib/backup/encryptor/open_ssl.rb

@@ -62,8 +62,13 @@ module Backup
         opts = ['aes-256-cbc']
         opts << '-base64' if @base64
         opts << '-salt'   if @salt
-        opts << ( @password_file.to_s.empty? ?
-                "-k '#{@password}'" : "-pass file:#{@password_file}" )
+
+        if @password_file.to_s.empty?
+          opts << "-k #{Shellwords.escape(@password)}"
+        else
+          opts << "-pass file:#{@password_file}"
+        end
+
         opts.join(' ')
       end
 

data/lib/backup/model.rb

@@ -303,7 +303,7 @@ module Backup
       return [] unless databases.any? || archives.any?
 
       [lambda { prepare! }, databases, archives,
-       lambda { package! }, storages, lambda { clean! }]
+       lambda { package! }, lambda { store! }, lambda { clean! }]
     end
 
     ##
@@ -325,6 +325,31 @@ module Backup
       Cleaner.remove_packaging(self)
     end
 
+    ##
+    # Attempts to use all configured Storages, even if some of them result in exceptions.
+    # Returns true or raises first encountered exception.
+    def store!
+      storage_results = storages.map do |storage|
+        begin
+          storage.perform!
+        rescue => ex
+          ex
+        end
+      end
+
+      first_exception, *other_exceptions = storage_results.select { |result| result.is_a? Exception }
+
+      if first_exception
+        other_exceptions.each do |exception|
+         Logger.error exception.to_s
+         Logger.error exception.backtrace.join('\n')
+        end
+        raise first_exception
+      else
+        true
+      end
+    end
+
     ##
     # Removes the final package file(s) once all configured Storages have run.
     def clean!

data/lib/backup/notifier/base.rb

@@ -36,6 +36,15 @@ module Backup
       # Default: 30
       attr_accessor :retry_waitsec
 
+      ##
+      # Message to send. Depends on notifier implementation if this is used.
+      # Default: lambda returning:
+      # "#{ message } #{ model.label } (#{ model.trigger })"
+      #
+      # @yieldparam [model] Backup::Model
+      # @yieldparam [data] Hash containing `message` and `key` values.
+      attr_accessor :message
+
       attr_reader :model
 
       def initialize(model)
@@ -47,6 +56,9 @@ module Backup
         @on_failure = true if on_failure.nil?
         @max_retries    ||= 10
         @retry_waitsec  ||= 30
+        @message        ||= lambda do |model, data|
+          "[#{ data[:status][:message] }] #{ model.label } (#{ model.trigger })"
+        end
       end
 
       # This method is called from an ensure block in Model#perform! and must
@@ -93,6 +105,24 @@ module Backup
         self.class.to_s.sub('Backup::', '')
       end
 
+      ##
+      # Return status data for message creation
+      def status_data_for(status)
+        {
+          :success => {
+            :message => 'Backup::Success',
+            :key => :success
+          },
+          :warning => {
+            :message => 'Backup::Warning',
+            :key => :warning
+          },
+          :failure => {
+            :message => 'Backup::Failure',
+            :key => :failure
+          }
+        }[status]
+      end
     end
   end
 end

data/lib/backup/notifier/campfire.rb

@@ -42,13 +42,7 @@ module Backup
       # : 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 })"
-        send_message(message)
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       def send_message(message)

data/lib/backup/notifier/command.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+
+module Backup
+  module Notifier
+    class Command < Base
+
+      ##
+      # Command to execute.
+      #
+      # Make sure it is accessible from your $PATH, or provide
+      # the absolute path to the command.
+      attr_accessor :command
+
+      ##
+      # Arguments to pass to the command.
+      #
+      # Must be an array of strings or callable objects.
+      #
+      # Callables will be invoked with #call(model, status),
+      # and the return value used as the argument.
+      #
+      # In strings you can use the following placeholders:
+      #
+      # %l - Model label
+      # %t - Model trigger
+      # %s - Status (success/failure/warning)
+      # %v - Status verb (succeeded/failed/succeeded with warnings)
+      #
+      # All placeholders can be used with uppercase letters to capitalize
+      # the value.
+      #
+      # Defaults to ["%L %v"]
+      attr_accessor :args
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @args ||= ["%L %v"]
+      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)
+        IO.popen([@command] + args.map { |arg| format_arg(arg, status) })
+      end
+
+      def format_arg(arg, status)
+        if arg.respond_to?(:call)
+          arg.call(model, status)
+        else
+          arg.gsub(/%(\w)/) do |match|
+            ph = match[1]
+            val = case ph.downcase
+                  when "l"
+                    model.label
+                  when "t"
+                    model.trigger.to_s
+                  when "v"
+                    status_verb(status)
+                  when "s"
+                    status.to_s
+                  end
+            val.capitalize! if ph == ph.upcase
+            val
+          end
+        end
+      end
+
+      def status_verb(status)
+        case status
+        when :success
+          "succeeded"
+        when :failure
+          "failed"
+        when :warning
+          "succeeded with warnings"
+        end
+      end
+    end
+  end
+end