backup_checksum 3.0.23

data/lib/backup/database/mysql.rb

@@ -0,0 +1,163 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class MySQL < Base
+
+      ##
+      # Name of the database that needs to get dumped
+      # To dump all databases, set this to `:all` or leave blank.
+      attr_accessor :name
+
+      ##
+      # Credentials for the specified database
+      attr_accessor :username, :password
+
+      ##
+      # Connectivity options
+      attr_accessor :host, :port, :socket
+
+      ##
+      # Tables to skip while dumping the database
+      attr_accessor :skip_tables
+
+      ##
+      # Tables to dump, tables that aren't specified won't get dumped
+      attr_accessor :only_tables
+
+      ##
+      # 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(model, &block)
+        super(model)
+
+        @skip_tables        ||= Array.new
+        @only_tables        ||= Array.new
+        @additional_options ||= Array.new
+
+        instance_eval(&block) if block_given?
+
+        @name ||= :all
+
+        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
+
+      ##
+      # Performs the mysqldump command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        super
+
+        pipeline = Pipeline.new
+        dump_ext = 'sql'
+
+        pipeline << mysqldump
+        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?
+          Logger.message "#{ database_name } Complete!"
+        else
+          raise Errors::Database::PipelineError,
+              "#{ database_name } Dump Failed!\n" +
+              pipeline.error_messages
+        end
+      end
+
+      private
+
+      ##
+      # Builds the full mysqldump string based on all attributes
+      def mysqldump
+        "#{ mysqldump_utility } #{ credential_options } #{ connectivity_options } " +
+        "#{ user_options } #{ db_name } #{ tables_to_dump } #{ tables_to_skip }"
+      end
+
+      ##
+      # Returns the filename to use for dumping the database(s)
+      def dump_filename
+        dump_all? ? 'all-databases' : name
+      end
+
+      ##
+      # Builds the credentials MySQL syntax to authenticate the user
+      # to perform the database dumping process
+      def credential_options
+        %w[username password].map do |option|
+          next if send(option).to_s.empty?
+          "--#{option}='#{send(option)}'".gsub('--username', '--user')
+        end.compact.join(' ')
+      end
+
+      ##
+      # Builds the MySQL 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}='#{send(option)}'"
+        end.compact.join(' ')
+      end
+
+      ##
+      # Builds a MySQL compatible string for the additional options
+      # specified by the user
+      def user_options
+        additional_options.join(' ')
+      end
+
+      ##
+      # Returns the database name to use in the mysqldump command.
+      # When dumping all databases, the database name is replaced
+      # with the command option to dump all databases.
+      def db_name
+        dump_all? ? '--all-databases' : name
+      end
+
+      ##
+      # Builds the MySQL syntax for specifying which tables to dump
+      # during the dumping of the database
+      def tables_to_dump
+        only_tables.join(' ') unless dump_all?
+      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|
+          table = (dump_all? || table['.']) ? table : "#{ name }.#{ table }"
+          "--ignore-table='#{ table }'"
+        end.join(' ')
+      end
+
+      ##
+      # Return true if we're dumping all databases.
+      # `name` will be set to :all if it is not set,
+      # so this will be true by default
+      def dump_all?
+        name == :all
+      end
+
+    end
+  end
+end

data/lib/backup/database/postgresql.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class PostgreSQL < Base
+
+      ##
+      # Name of the database that needs to get dumped
+      attr_accessor :name
+
+      ##
+      # Credentials for the specified database
+      attr_accessor :username, :password
+
+      ##
+      # Connectivity options
+      attr_accessor :host, :port, :socket
+
+      ##
+      # Tables to skip while dumping the database
+      attr_accessor :skip_tables
+
+      ##
+      # Tables to dump, tables that aren't specified won't get dumped
+      attr_accessor :only_tables
+
+      ##
+      # 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(model, &block)
+        super(model)
+
+        @skip_tables        ||= Array.new
+        @only_tables        ||= Array.new
+        @additional_options ||= Array.new
+
+        instance_eval(&block) if block_given?
+
+        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
+
+      ##
+      # Performs the pgdump command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        super
+
+        pipeline = Pipeline.new
+        dump_ext = 'sql'
+
+        pipeline << pgdump
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
+        pipeline << "cat > '#{ File.join(@dump_path, name) }.#{ dump_ext }'"
+
+        pipeline.run
+        if pipeline.success?
+          Logger.message "#{ database_name } Complete!"
+        else
+          raise Errors::Database::PipelineError,
+              "#{ database_name } Dump Failed!\n" +
+              pipeline.error_messages
+        end
+      end
+
+      ##
+      # 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
+        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
+
+      ##
+      # Builds the PostgreSQL connectivity options syntax to connect the user
+      # to perform the database dumping process, socket gets gsub'd to host since
+      # that's the option PostgreSQL takes for socket connections as well. In case
+      # 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).to_s.empty?
+          "--#{option}='#{send(option)}'".gsub('--socket=', '--host=')
+        end.compact.join(' ')
+      end
+
+      ##
+      # Builds a PostgreSQL compatible string for the additional options
+      # specified by the user
+      def user_options
+        additional_options.join(' ')
+      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(' ')
+      end
+
+      ##
+      # 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
+  end
+end

data/lib/backup/database/redis.rb

@@ -0,0 +1,139 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class Redis < Base
+
+      ##
+      # Name of and path to the database that needs to get dumped
+      attr_accessor :name, :path
+
+      ##
+      # Credentials for the specified database
+      attr_accessor :password
+
+      ##
+      # Determines whether Backup should invoke the SAVE command through
+      # the 'redis-cli' utility to persist the most recent data before
+      # copying over the dump file
+      attr_accessor :invoke_save
+
+      ##
+      # Connectivity options
+      attr_accessor :host, :port, :socket
+
+      ##
+      # 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(model, &block)
+        super(model)
+
+        @additional_options ||= Array.new
+
+        instance_eval(&block) if block_given?
+
+        @name ||= 'dump'
+
+        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
+
+      ##
+      # Performs the Redis backup by using the 'cp' unix utility
+      # to copy the persisted Redis dump file to the Backup archive.
+      # Additionally, when 'invoke_save' is set to true, it'll tell
+      # the Redis server to persist the current state to the dump file
+      # before copying the dump to get the most recent updates in to the backup
+      def perform!
+        super
+
+        invoke_save! if invoke_save
+        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("#{ 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.
+            The #{ database } file might not contain the most recent data.
+            Please check if the server is running, the credentials (if any) are correct,
+            and the host/port/socket are correct.
+
+            Redis CLI response: #{ response }
+          EOS
+        end
+      end
+
+      ##
+      # Performs the copy command to copy over the Redis dump file to the Backup archive
+      def copy!
+        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 #{ src_path }
+          EOS
+        end
+
+        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

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class Riak < Base
+
+      ##
+      # Name is the name of the backup
+      attr_accessor :name
+
+      ##
+      # Node is the node from which to perform the backup.
+      attr_accessor :node
+
+      ##
+      # 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(model, &block)
+        super(model)
+
+        instance_eval(&block) if block_given?
+
+        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
+
+      ##
+      # Performs the riak-admin command and outputs the
+      # 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.
+        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
+  end
+end