backup 3.0.20 → 3.0.21

data/lib/backup/database/mysql.rb

@@ -28,32 +28,57 @@ module Backup
       # Additional "mysqldump" options
       attr_accessor :additional_options
 
+      ##
+      # Path to mysqldump utility (optional)
+      attr_accessor :mysqldump_utility
+
       ##
       # Creates a new instance of the MySQL adapter object
-      def initialize(&block)
-        load_defaults!
+      def initialize(model, &block)
+        super(model)
 
         @skip_tables        ||= Array.new
         @only_tables        ||= Array.new
         @additional_options ||= Array.new
 
-        instance_eval(&block)
+        instance_eval(&block) if block_given?
+
+        if @utility_path
+          Logger.warn "[DEPRECATED] " +
+            "Database::MySQL#utility_path has been deprecated.\n" +
+            "  Use Database::MySQL#mysqldump_utility instead."
+          @mysqldump_utility ||= @utility_path
+        end
+        @mysqldump_utility ||= utility(:mysqldump)
       end
 
       ##
-      # Builds the MySQL syntax for specifying which tables to skip
-      # during the dumping of the database
-      def tables_to_skip
-        skip_tables.map do |table|
-          "--ignore-table='#{name}.#{table}'"
-        end.join("\s")
+      # Performs the mysqldump command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        super
+
+        dump_ext = 'sql'
+        dump_cmd = "#{ mysqldump }"
+
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            dump_cmd << " | #{command}"
+            dump_ext << ext
+          end
+        end
+
+        dump_cmd << " > '#{ File.join(@dump_path, name) }.#{ dump_ext }'"
+        run(dump_cmd)
       end
 
+      private
+
       ##
-      # Builds the MySQL syntax for specifying which tables to dump
-      # during the dumping of the database
-      def tables_to_dump
-        only_tables.join("\s")
+      # Builds the full mysqldump string based on all attributes
+      def mysqldump
+        "#{ mysqldump_utility } #{ credential_options } #{ connectivity_options } " +
+        "#{ user_options } #{ name } #{ tables_to_dump } #{ tables_to_skip }"
       end
 
       ##
@@ -61,9 +86,9 @@ module Backup
       # to perform the database dumping process
       def credential_options
         %w[username password].map do |option|
-          next if send(option).nil? or send(option).empty?
+          next if send(option).to_s.empty?
           "--#{option}='#{send(option)}'".gsub('--username', '--user')
-        end.compact.join("\s")
+        end.compact.join(' ')
       end
 
       ##
@@ -71,32 +96,32 @@ module Backup
       # to perform the database dumping process
       def connectivity_options
         %w[host port socket].map do |option|
-          next if send(option).nil? or (send(option).respond_to?(:empty?) and send(option).empty?)
+          next if send(option).to_s.empty?
           "--#{option}='#{send(option)}'"
-        end.compact.join("\s")
+        end.compact.join(' ')
       end
 
       ##
       # Builds a MySQL compatible string for the additional options
       # specified by the user
-      def options
-        additional_options.join("\s")
+      def user_options
+        additional_options.join(' ')
       end
 
       ##
-      # Builds the full mysqldump string based on all attributes
-      def mysqldump
-        "#{ utility(:mysqldump) } #{ credential_options } #{ connectivity_options } " +
-        "#{ options } #{ name } #{ tables_to_dump } #{ tables_to_skip }"
+      # Builds the MySQL syntax for specifying which tables to dump
+      # during the dumping of the database
+      def tables_to_dump
+        only_tables.join(' ')
       end
 
       ##
-      # Performs the mysqldump command and outputs the
-      # data to the specified path based on the 'trigger'
-      def perform!
-        super
-
-        run("#{mysqldump} > '#{File.join(dump_path, name)}.sql'")
+      # Builds the MySQL syntax for specifying which tables to skip
+      # during the dumping of the database
+      def tables_to_skip
+        skip_tables.map do |table|
+          "--ignore-table='#{name}.#{table}'"
+        end.join(' ')
       end
 
     end

data/lib/backup/database/postgresql.rb

@@ -28,53 +28,72 @@ module Backup
       # Additional "pg_dump" options
       attr_accessor :additional_options
 
+      ##
+      # Path to pg_dump utility (optional)
+      attr_accessor :pg_dump_utility
+
       ##
       # Creates a new instance of the PostgreSQL adapter object
       # Sets the PGPASSWORD environment variable to the password
       # so it doesn't prompt and hang in the process
-      def initialize(&block)
-        load_defaults!
+      def initialize(model, &block)
+        super(model)
 
         @skip_tables        ||= Array.new
         @only_tables        ||= Array.new
         @additional_options ||= Array.new
 
-        instance_eval(&block)
-        ENV['PGPASSWORD'] = password
-      end
+        instance_eval(&block) if block_given?
 
-      ##
-      # Builds the PostgreSQL syntax for specifying which tables to skip
-      # during the dumping of the database
-      def tables_to_skip
-        skip_tables.map do |table|
-          "--exclude-table='#{table}'"
-        end.join("\s")
+        if @utility_path
+          Logger.warn "[DEPRECATED] " +
+            "Database::PostgreSQL#utility_path has been deprecated.\n" +
+            "  Use Database::PostgreSQL#pg_dump_utility instead."
+          @pg_dump_utility ||= @utility_path
+        end
+        @pg_dump_utility ||= utility(:pg_dump)
       end
 
       ##
-      # Builds the PostgreSQL syntax for specifying which tables to dump
-      # during the dumping of the database
-      def tables_to_dump
-        only_tables.map do |table|
-          "--table='#{table}'"
-        end.join("\s")
+      # Performs the pgdump command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        super
+
+        dump_ext = 'sql'
+        dump_cmd = "#{ pgdump }"
+
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            dump_cmd << " | #{command}"
+            dump_ext << ext
+          end
+        end
+
+        dump_cmd << " > '#{ File.join(@dump_path, name) }.#{ dump_ext }'"
+        run(dump_cmd)
       end
 
       ##
-      # Builds the credentials PostgreSQL syntax to authenticate the user
-      # to perform the database dumping process
-      def username_options
-        return '' unless username.is_a?(String) and not username.empty?
-        "--username='#{username}'"
+      # Builds the full pgdump string based on all attributes
+      def pgdump
+        "#{password_options}" +
+        "#{ pg_dump_utility } #{ username_options } #{ connectivity_options } " +
+        "#{ user_options } #{ tables_to_dump } #{ tables_to_skip } #{ name }"
       end
 
       ##
       # Builds the password syntax PostgreSQL uses to authenticate the user
       # to perform database dumping
       def password_options
-        return '' unless password.is_a?(String) and not username.empty?
-        "PGPASSWORD='#{password}'"
+        password.to_s.empty? ? '' : "PGPASSWORD='#{password}' "
+      end
+
+      ##
+      # Builds the credentials PostgreSQL syntax to authenticate the user
+      # to perform the database dumping process
+      def username_options
+        username.to_s.empty? ? '' : "--username='#{username}'"
       end
 
       ##
@@ -84,35 +103,34 @@ module Backup
       # both the host and the socket are specified, the socket will take priority over the host
       def connectivity_options
         %w[host port socket].map do |option|
-          next if send(option).nil? or (send(option).respond_to?(:empty?) and send(option).empty?)
+          next if send(option).to_s.empty?
           "--#{option}='#{send(option)}'".gsub('--socket=', '--host=')
-        end.compact.join("\s")
+        end.compact.join(' ')
       end
 
       ##
       # Builds a PostgreSQL compatible string for the additional options
       # specified by the user
-      def options
-        additional_options.join("\s")
+      def user_options
+        additional_options.join(' ')
       end
 
       ##
-      # Builds the full pgdump string based on all attributes
-      def pgdump
-        ("#{password_options} " +
-        "#{ utility(:pg_dump) } #{ username_options } #{ connectivity_options } " +
-        "#{ options } #{ tables_to_dump } #{ tables_to_skip } #{ name }").strip
+      # Builds the PostgreSQL syntax for specifying which tables to dump
+      # during the dumping of the database
+      def tables_to_dump
+        only_tables.map do |table|
+          "--table='#{table}'"
+        end.join(' ')
       end
 
       ##
-      # Performs the pgdump command and outputs the
-      # data to the specified path based on the 'trigger'
-      # and resets the 'PGPASSWORD' environment variable to nil
-      def perform!
-        super
-
-        run("#{pgdump} > '#{File.join(dump_path, name)}.sql'")
-        ENV['PGPASSWORD'] = nil
+      # Builds the PostgreSQL syntax for specifying which tables to skip
+      # during the dumping of the database
+      def tables_to_skip
+        skip_tables.map do |table|
+          "--exclude-table='#{table}'"
+        end.join(' ')
       end
 
     end

data/lib/backup/database/redis.rb

@@ -26,43 +26,28 @@ module Backup
       # Additional "redis-cli" options
       attr_accessor :additional_options
 
+      ##
+      # Path to the redis-cli utility (optional)
+      attr_accessor :redis_cli_utility
+
       ##
       # Creates a new instance of the Redis database object
-      def initialize(&block)
-        load_defaults!
+      def initialize(model, &block)
+        super(model)
 
         @additional_options ||= Array.new
 
-        instance_eval(&block)
-      end
-
-      ##
-      # Builds the Redis credentials syntax to authenticate the user
-      # to perform the database dumping process
-      def credential_options
-        return "-a '#{password}'" if password; String.new
-      end
-
-      ##
-      # Builds the Redis connectivity options syntax to connect the user
-      # to perform the database dumping process
-      def connectivity_options
-        %w[host port socket].map do |option|
-          next if send(option).nil?; "-#{option[0,1]} '#{send(option)}'"
-        end.compact.join("\s")
-      end
+        instance_eval(&block) if block_given?
 
-      ##
-      # Builds a Redis compatible string for the
-      # additional options specified by the user
-      def additional_options
-        @additional_options.join("\s")
-      end
+        @name ||= 'dump'
 
-      ##
-      # Returns the Redis database file name
-      def database
-        "#{ name }.rdb"
+        if @utility_path
+          Logger.warn "[DEPRECATED] " +
+            "Database::Redis#utility_path has been deprecated.\n" +
+            "  Use Database::Redis#redis_cli_utility instead."
+          @redis_cli_utility ||= @utility_path
+        end
+        @redis_cli_utility ||= utility('redis-cli')
       end
 
       ##
@@ -78,12 +63,14 @@ module Backup
         copy!
       end
 
+      private
+
       ##
       # Tells Redis to persist the current state of the
       # in-memory database to the persisted dump file
       def invoke_save!
-        response = run("#{ utility('redis-cli') } #{ credential_options } " +
-                       "#{ connectivity_options } #{ additional_options } SAVE")
+        response = run("#{ redis_cli_utility } #{ credential_options } " +
+                       "#{ connectivity_options } #{ user_options } SAVE")
         unless response =~ /OK/
           raise Errors::Database::Redis::CommandError, <<-EOS
             Could not invoke the Redis SAVE command.
@@ -99,19 +86,54 @@ module Backup
       ##
       # Performs the copy command to copy over the Redis dump file to the Backup archive
       def copy!
-        unless File.exist?(File.join(path, database))
+        src_path = File.join(path, database)
+        unless File.exist?(src_path)
           raise Errors::Database::Redis::NotFoundError, <<-EOS
             Redis database dump not found
-            File path was #{ File.join(path, database) }
+            File path was #{ src_path }
           EOS
         end
 
-        # Temporarily remove a custom `utility_path` setting so that the system
-        # `cp` utility can be found, then restore the old value just in case.
-        old_path, self.utility_path = self.utility_path, nil
-        run("#{ utility(:cp) } '#{ File.join(path, database) }' '#{ File.join(dump_path, database) }'")
-        self.utility_path = old_path
+        dst_path = File.join(@dump_path, database)
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            run("#{ command } -c #{ src_path } > #{ dst_path + ext }")
+          end
+        else
+          FileUtils.cp(src_path, dst_path)
+        end
+      end
+
+      ##
+      # Returns the Redis database file name
+      def database
+        "#{ name }.rdb"
+      end
+
+      ##
+      # Builds the Redis credentials syntax to authenticate the user
+      # to perform the database dumping process
+      def credential_options
+        password.to_s.empty? ? '' : "-a '#{password}'"
       end
+
+      ##
+      # Builds the Redis connectivity options syntax to connect the user
+      # to perform the database dumping process
+      def connectivity_options
+        %w[host port socket].map do |option|
+          next if send(option).to_s.empty?
+          "-#{option[0,1]} '#{send(option)}'"
+        end.compact.join(' ')
+      end
+
+      ##
+      # Builds a Redis compatible string for the
+      # additional options specified by the user
+      def user_options
+        @additional_options.join(' ')
+      end
+
     end
   end
 end

data/lib/backup/database/riak.rb

@@ -16,18 +16,24 @@ module Backup
       # Cookie is the Erlang cookie/shared secret used to connect to the node.
       attr_accessor :cookie
 
+      ##
+      # Path to riak-admin utility (optional)
+      attr_accessor :riak_admin_utility
+
       ##
       # Creates a new instance of the Riak adapter object
-      def initialize(&block)
-        load_defaults!
+      def initialize(model, &block)
+        super(model)
 
-        instance_eval(&block)
-      end
+        instance_eval(&block) if block_given?
 
-      ##
-      # Builds the full riak-admin string based on all attributes
-      def riakadmin
-        "riak-admin backup #{node} #{cookie}"
+        if @utility_path
+          Logger.warn "[DEPRECATED] " +
+            "Database::Riak#utility_path has been deprecated.\n" +
+            "  Use Database::Riak#riak_admin_utility instead."
+          @riak_admin_utility ||= @utility_path
+        end
+        @riak_admin_utility ||= utility('riak-admin')
       end
 
       ##
@@ -35,9 +41,27 @@ module Backup
       # data to the specified path based on the 'trigger'
       def perform!
         super
-        # have to make riak the owner since the riak-admin tool runs as the riak user in a default setup.
-        run("chown -R riak.riak #{dump_path}")
-        run("#{riakadmin} #{File.join(dump_path, name)} node")
+        # have to make riak the owner since the riak-admin tool runs
+        # as the riak user in a default setup.
+        FileUtils.chown_R('riak', 'riak', @dump_path)
+
+        backup_file = File.join(@dump_path, name)
+        run("#{ riakadmin } #{ backup_file } node")
+
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            run("#{ command } -c #{ backup_file } > #{ backup_file + ext }")
+            FileUtils.rm_f(backup_file)
+          end
+        end
+      end
+
+      private
+
+      ##
+      # Builds the full riak-admin string based on all attributes
+      def riakadmin
+        "#{ riak_admin_utility } backup #{ node } #{ cookie }"
       end
 
     end