backup 2.4.5.1 → 3.0.0.build.0

data/lib/backup/database/mongodb.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class MongoDB < 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
+
+      ##
+      # IPv6 support (disabled by default)
+      attr_accessor :ipv6
+
+      ##
+      # Collections to dump, collections that aren't specified won't get dumped
+      attr_accessor :only_collections
+
+      ##
+      # Additional "mongodump" options
+      attr_accessor :additional_options
+
+      ##
+      # Creates a new instance of the MongoDB database object
+      def initialize(&block)
+        load_defaults!
+
+        @only_collections   ||= Array.new
+        @additional_options ||= Array.new
+        @ipv6               ||= false
+
+        instance_eval(&block)
+        prepare!
+      end
+
+      ##
+      # Builds the MongoDB credentials syntax to authenticate the user
+      # to perform the database dumping process
+      def credential_options
+        %w[username password].map do |option|
+          next if send(option).nil? or send(option).empty?
+          "--#{option}='#{send(option)}'"
+        end.compact.join("\s")
+      end
+
+      ##
+      # Builds the MongoDB connectivity options syntax to connect the user
+      # to perform the database dumping process
+      def connectivity_options
+        %w[host port].map do |option|
+          next if send(option).nil? or (send(option).respond_to?(:empty?) and send(option).empty?)
+          "--#{option}='#{send(option)}'"
+        end.compact.join("\s")
+      end
+
+      ##
+      # Builds a MongoDB compatible string for the
+      # additional options specified by the user
+      def additional_options
+        @additional_options.join("\s")
+      end
+
+      ##
+      # Returns an array of collections to dump
+      def collections_to_dump
+        @only_collections
+      end
+
+      ##
+      # Returns the MongoDB database selector syntax
+      def database
+        "--db='#{ name }'"
+      end
+
+      ##
+      # Returns the mongodump syntax for enabling ipv6
+      def ipv6
+        @ipv6.eql?(true) ? '--ipv6' : ''
+      end
+
+      ##
+      # Returns the MongoDB syntax for determining where to output all the database dumps,
+      # e.g. ~/Backup/.tmp/MongoDB/<databases here>/<database collections>
+      def dump_directory
+        "--out='#{ dump_path }'"
+      end
+
+      ##
+      # Builds the full mongodump string based on all attributes
+      def mongodump
+        "#{ utility(:mongodump) } #{ database } #{ credential_options } " +
+        "#{ connectivity_options } #{ ipv6 } #{ additional_options } #{ dump_directory }"
+      end
+
+      ##
+      # Performs the mongodump command and outputs the data to the
+      # specified path based on the 'trigger'. If the user hasn't specified any
+      # specific collections to dump, it'll dump everything. If the user has specified
+      # collections to dump, it'll loop through the array of collections and invoke the
+      # 'mongodump' command once per collection
+      def perform!
+        log!
+
+        if collections_to_dump.is_a?(Array) and not collections_to_dump.empty?
+          specific_collection_dump!
+        else
+          dump!
+        end
+      end
+
+      ##
+      # Builds and runs the mongodump command
+      def dump!
+        run(mongodump)
+      end
+
+      ##
+      # For each collection in the @only_collections array, it'll
+      # build the whole 'mongodump' command, append the '--collection' option,
+      # and run the command built command
+      def specific_collection_dump!
+        collections_to_dump.each do |collection|
+          run("#{mongodump} --collection='#{collection}'")
+        end
+      end
+
+    end
+  end
+end

data/lib/backup/database/mysql.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+module Backup
+  module Database
+    class MySQL < 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 "mysqldump" options
+      attr_accessor :additional_options
+
+      ##
+      # Creates a new instance of the MySQL adapter object
+      def initialize(&block)
+        load_defaults!
+
+        @skip_tables        ||= Array.new
+        @only_tables        ||= Array.new
+        @additional_options ||= Array.new
+
+        instance_eval(&block)
+        prepare!
+      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")
+      end
+
+      ##
+      # Builds the MySQL syntax for specifying which tables to dump
+      # during the dumping of the database
+      def tables_to_dump
+        only_tables.join("\s")
+      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).nil? or send(option).empty?
+          "--#{option}='#{send(option)}'".gsub('--username', '--user')
+        end.compact.join("\s")
+      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).nil? or (send(option).respond_to?(:empty?) and send(option).empty?)
+          "--#{option}='#{send(option)}'"
+        end.compact.join("\s")
+      end
+
+      ##
+      # Builds a MySQL compatible string for the additional options
+      # specified by the user
+      def options
+        additional_options.join("\s")
+      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 }"
+      end
+
+      ##
+      # Performs the mysqldump command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        log!
+        run("#{mysqldump} > '#{File.join(dump_path, name)}.sql'")
+      end
+
+    end
+  end
+end

data/lib/backup/database/postgresql.rb

@@ -0,0 +1,111 @@
+# 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
+
+      ##
+      # 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!
+
+        @skip_tables        ||= Array.new
+        @only_tables        ||= Array.new
+        @additional_options ||= Array.new
+
+        instance_eval(&block)
+        prepare!
+        ENV['PGPASSWORD'] = password
+      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("\s")
+      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")
+      end
+
+      ##
+      # Builds the credentials PostgreSQL syntax to authenticate the user
+      # to perform the database dumping process
+      def credential_options
+        return '' unless username.is_a?(String) and not username.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).nil? or (send(option).respond_to?(:empty?) and send(option).empty?)
+          "--#{option}='#{send(option)}'".gsub('--socket=', '--host=')
+        end.compact.join("\s")
+      end
+
+      ##
+      # Builds a PostgreSQL compatible string for the additional options
+      # specified by the user
+      def options
+        additional_options.join("\s")
+      end
+
+      ##
+      # Builds the full pgdump string based on all attributes
+      def pgdump
+        "#{ utility(:pg_dump) } #{ credential_options } #{ connectivity_options } " +
+        "#{ options } #{ tables_to_dump } #{ tables_to_skip } #{ name }"
+      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!
+        log!
+        run("#{pgdump} > '#{File.join(dump_path, name)}.sql'")
+        ENV['PGPASSWORD'] = nil
+      end
+
+    end
+  end
+end

data/lib/backup/database/redis.rb

@@ -0,0 +1,105 @@
+# 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
+
+      ##
+      # Creates a new instance of the Redis database object
+      def initialize(&block)
+        load_defaults!
+
+        @additional_options ||= Array.new
+
+        instance_eval(&block)
+        prepare!
+      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
+
+      ##
+      # Builds a Redis compatible string for the
+      # additional options specified by the user
+      def additional_options
+        @additional_options.join("\s")
+      end
+
+      ##
+      # Returns the Redis database file name
+      def database
+        "#{ name }.rdb"
+      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!
+        log!
+
+        invoke_save! if invoke_save
+        copy!
+      end
+
+      ##
+      # 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")
+        unless response =~ /OK/
+          Logger.error "Could not invoke the Redis SAVE command. The #{ database } file might not be contain the most recent data."
+          Logger.error "Please check if the server is running, the credentials (if any) are correct, and the host/port/socket are correct."
+        end
+      end
+
+      ##
+      # Performs the copy command to copy over the Redis dump file to the Backup archive
+      def copy!
+        unless File.exist?(File.join(path, database))
+          Logger.error "Redis database dump not found in '#{ File.join(path, database) }'"
+          exit
+        end
+
+        run("#{ utility(:cp) } '#{ File.join(path, database) }' '#{ File.join(dump_path, database) }'")
+      end
+    end
+  end
+end