backupii 0.1.0.pre.alpha.1

data/lib/backup/database/mongodb.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Backup
+  module Database
+    class MongoDB < Base
+      class Error < Backup::Error; end
+
+      ##
+      # Name of the database that needs to get dumped
+      attr_accessor :name
+
+      ##
+      # Credentials for the specified database
+      attr_accessor :username, :password, :authdb
+
+      ##
+      # 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
+
+      ##
+      # Forces mongod to flush all pending write operations to the disk and
+      # locks the entire mongod instance to prevent additional writes until the
+      # dump is complete.
+      #
+      # Note that if Profiling is enabled, this will disable it and will not
+      # re-enable it after the dump is complete.
+      attr_accessor :lock
+
+      ##
+      # Creates a dump of the database that includes an oplog, to create a
+      # point-in-time snapshot of the state of a mongod instance.
+      #
+      # If this option is used, you would not use the `lock` option.
+      #
+      # This will only work against nodes that maintain a oplog.
+      # This includes all members of a replica set, as well as master nodes in
+      # master/slave replication deployments.
+      attr_accessor :oplog
+
+      def initialize(model, database_id = nil, &block)
+        super
+        instance_eval(&block) if block_given?
+      end
+
+      def perform!
+        super
+
+        lock_database if @lock
+        dump!
+        package!
+      ensure
+        unlock_database if @lock
+      end
+
+      private
+
+      ##
+      # Performs all required mongodump commands, dumping the output files
+      # into the +dump_packaging_path+ directory for packaging.
+      def dump!
+        FileUtils.mkdir_p dump_packaging_path
+
+        collections = Array(only_collections)
+        if collections.empty?
+          run(mongodump)
+        else
+          collections.each do |collection|
+            run("#{mongodump} --collection='#{collection}'")
+          end
+        end
+      end
+
+      ##
+      # Creates a tar archive of the +dump_packaging_path+ directory
+      # and stores it in the +dump_path+ using +dump_filename+.
+      #
+      #   <trigger>/databases/MongoDB[-<database_id>].tar[.gz]
+      #
+      # If successful, +dump_packaging_path+ is removed.
+      def package!
+        pipeline = Pipeline.new
+        dump_ext = "tar".dup
+
+        pipeline << "#{utility(:tar)} -cf - " \
+                    "-C '#{dump_path}' '#{dump_filename}'"
+
+        if model.compressor
+          model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
+
+        pipeline << "#{utility(:cat)} > " \
+          "'#{File.join(dump_path, dump_filename)}.#{dump_ext}'"
+
+        pipeline.run
+        if pipeline.success?
+          FileUtils.rm_rf dump_packaging_path
+          log!(:finished)
+        else
+          raise Error, "Dump Failed!\n#{pipeline.error_messages}"
+        end
+      end
+
+      def dump_packaging_path
+        File.join(dump_path, dump_filename)
+      end
+
+      def mongodump
+        "#{utility(:mongodump)} #{name_option} #{credential_options} " \
+          "#{connectivity_options} #{ipv6_option} #{oplog_option} " \
+          "#{user_options} --out='#{dump_packaging_path}'"
+      end
+
+      def name_option
+        return unless name
+
+        "--db='#{name}'"
+      end
+
+      def credential_options
+        opts = []
+        opts << "--username='#{username}'" if username
+        opts << "--password='#{password}'" if password
+        opts << "--authenticationDatabase='#{authdb}'" if authdb
+        opts.join(" ")
+      end
+
+      def connectivity_options
+        opts = []
+        opts << "--host='#{host}'" if host
+        opts << "--port='#{port}'" if port
+        opts.join(" ")
+      end
+
+      def ipv6_option
+        "--ipv6" if ipv6
+      end
+
+      def oplog_option
+        "--oplog" if oplog
+      end
+
+      def user_options
+        Array(additional_options).join(" ")
+      end
+
+      def lock_database
+        lock_command = <<-EOS.gsub(%r{^ +}, "")
+          echo 'use admin
+          db.setProfilingLevel(0)
+          db.fsyncLock()' | #{mongo_shell}
+        EOS
+
+        run(lock_command)
+      end
+
+      def unlock_database
+        unlock_command = <<-EOS.gsub(%r{^ +}, "")
+          echo 'use admin
+          db.fsyncUnlock()' | #{mongo_shell}
+        EOS
+
+        run(unlock_command)
+      end
+
+      def mongo_shell
+        cmd = "#{utility(:mongo)} #{connectivity_options}".rstrip
+        cmd << " #{credential_options}".rstrip
+        cmd << " #{ipv6_option}".rstrip
+        cmd << " '#{name}'" if name
+        cmd
+      end
+    end
+  end
+end

data/lib/backup/database/mysql.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module Backup
+  module Database
+    class MySQL < Base
+      class Error < Backup::Error; end
+
+      ##
+      # 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
+      #
+      # If `name` is set to :all (or not specified), these must include
+      # a database name. e.g. 'name.table'.
+      # If `name` is given, these may simply be table names.
+      attr_accessor :skip_tables
+
+      ##
+      # Tables to dump. This in only valid if `name` is specified.
+      # If none are given, the entire database will be dumped.
+      attr_accessor :only_tables
+
+      ##
+      # 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 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
+
+      ##
+      # 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
+        @prepare_backup = true if @prepare_backup.nil?
+      end
+
+      ##
+      # Performs the mysqldump or innobackupex command and outputs
+      # the dump file in the +dump_path+ using +dump_filename+.
+      #
+      #   <trigger>/databases/MySQL[-<database_id>].[sql|tar][.gz]
+      def perform!
+        super
+
+        pipeline = Pipeline.new
+        dump_ext = (sql_backup? ? "sql" : "tar").dup
+
+        pipeline << sudo_option(sql_backup? ? mysqldump : innobackupex)
+
+        if model.compressor
+          model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
+
+        pipeline << "#{utility(:cat)} > " \
+          "'#{File.join(dump_path, dump_filename)}.#{dump_ext}'"
+
+        pipeline.run
+        if pipeline.success?
+          log!(:finished)
+        else
+          raise Error, "Dump Failed!\n#{pipeline.error_messages}"
+        end
+      end
+
+      private
+
+      def mysqldump
+        "#{utility(:mysqldump)} #{user_options} #{credential_options} " \
+          "#{connectivity_options} #{name_option} " \
+          "#{tables_to_dump} #{tables_to_skip}"
+      end
+
+      def credential_options
+        opts = []
+        opts << "--user=#{Shellwords.escape(username)}" if username
+        opts << "--password=#{Shellwords.escape(password)}" if password
+        opts.join(" ")
+      end
+
+      def connectivity_options
+        return "--socket='#{socket}'" if socket
+
+        opts = []
+        opts << "--host='#{host}'" if host
+        opts << "--port='#{port}'" if port
+        opts.join(" ")
+      end
+
+      def user_options
+        Array(additional_options).join(" ")
+      end
+
+      def user_prepare_options
+        Array(prepare_options).join(" ")
+      end
+
+      def name_option
+        dump_all? ? "--all-databases" : name
+      end
+
+      def tables_to_dump
+        Array(only_tables).join(" ") unless dump_all?
+      end
+
+      def tables_to_skip
+        Array(skip_tables).map do |table|
+          table = dump_all? || table["."] ? table : "#{name}.#{table}"
+          "--ignore-table='#{table}'"
+        end.join(" ")
+      end
+
+      def dump_all?
+        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} && " +
+          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
+
+        "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/openldap.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Backup
+  module Database
+    class OpenLDAP < Base
+      class Error < Backup::Error; end
+
+      ##
+      # Name of the ldap backup
+      attr_accessor :name
+
+      ##
+      # run slapcat under sudo if needed make sure to set SUID on a file, to let
+      # you run the file with permissions of file owner
+      #
+      # eg. sudo chmod u+s /usr/sbin/slapcat
+      attr_accessor :use_sudo
+
+      ##
+      # Stores the location of the slapd.conf or slapcat confdir
+      attr_accessor :slapcat_conf
+
+      ##
+      # Additional slapcat options
+      attr_accessor :slapcat_args
+
+      ##
+      # Path to slapcat utility (optional)
+      attr_accessor :slapcat_utility
+
+      ##
+      # Takes the name of the archive and the configuration block
+      def initialize(model, database_id = nil, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @name             ||= "ldap_backup"
+        @use_sudo         ||= false
+        @slapcat_args     ||= []
+        @slapcat_utility  ||= utility(:slapcat)
+        @slapcat_conf     ||= "/etc/ldap/slapd.d"
+      end
+
+      ##
+      # Performs the slapcat command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        super
+
+        pipeline = Pipeline.new
+        dump_ext = "ldif".dup
+
+        pipeline << slapcat
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
+
+        pipeline << "#{utility(:cat)} > " \
+            "'#{File.join(dump_path, dump_filename)}.#{dump_ext}'"
+
+        pipeline.run
+        if pipeline.success?
+          log!(:finished)
+        else
+          raise Error, "Dump Failed!\n" + pipeline.error_messages
+        end
+      end
+
+      private
+
+      ##
+      # Builds the full slapcat string based on all attributes
+      def slapcat
+        command = "#{slapcat_utility} #{slapcat_conf_option} " \
+                  "#{slapcat_conf} #{user_options}".dup
+        command.prepend("sudo ") if use_sudo
+        command
+      end
+
+      ##
+      # Uses different slapcat switch depending on confdir or conffile set
+      def slapcat_conf_option
+        @slapcat_conf.include?(".d") ? "-F" : "-f"
+      end
+
+      ##
+      # Builds a compatible string for the additional options
+      # specified by the user
+      def user_options
+        slapcat_args.join(" ")
+      end
+    end
+  end
+end

data/lib/backup/database/postgresql.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Backup
+  module Database
+    class PostgreSQL < Base
+      class Error < Backup::Error; end
+
+      ##
+      # Name of the database that needs to get dumped.
+      # To dump all databases, set this to `:all` or leave blank.
+      # +username+ must be a PostgreSQL superuser to run `pg_dumpall`.
+      attr_accessor :name
+
+      ##
+      # Credentials for the specified database
+      attr_accessor :username, :password
+
+      ##
+      # If set the pg_dump(all) command is executed as the given user
+      attr_accessor :sudo_user
+
+      ##
+      # Connectivity options
+      attr_accessor :host, :port, :socket
+
+      ##
+      # Tables to skip while dumping the database.
+      # If `name` is set to :all (or not specified), these are ignored.
+      attr_accessor :skip_tables
+
+      ##
+      # Tables to dump. This in only valid if `name` is specified.
+      # If none are given, the entire database will be dumped.
+      attr_accessor :only_tables
+
+      ##
+      # Additional "pg_dump" or "pg_dumpall" options
+      attr_accessor :additional_options
+
+      def initialize(model, database_id = nil, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @name ||= :all
+      end
+
+      ##
+      # Performs the pgdump command and outputs the dump file
+      # in the +dump_path+ using +dump_filename+.
+      #
+      #   <trigger>/databases/PostgreSQL[-<database_id>].sql[.gz]
+      def perform!
+        super
+
+        pipeline = Pipeline.new
+        dump_ext = "sql".dup
+
+        pipeline << (dump_all? ? pgdumpall : pgdump)
+
+        if model.compressor
+          model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
+
+        pipeline << "#{utility(:cat)} > " \
+          "'#{File.join(dump_path, dump_filename)}.#{dump_ext}'"
+
+        pipeline.run
+        if pipeline.success?
+          log!(:finished)
+        else
+          raise Error, "Dump Failed!\n" + pipeline.error_messages
+        end
+      end
+
+      def pgdump
+        password_option.to_s +
+          sudo_option.to_s +
+          "#{utility(:pg_dump)} #{username_option} #{connectivity_options} " \
+          "#{user_options} #{tables_to_dump} #{tables_to_skip} #{name}"
+      end
+
+      def pgdumpall
+        password_option.to_s +
+          sudo_option.to_s +
+          "#{utility(:pg_dumpall)} #{username_option} " \
+          "#{connectivity_options} #{user_options}"
+      end
+
+      def password_option
+        "PGPASSWORD=#{Shellwords.escape(password)} " if password
+      end
+
+      def sudo_option
+        "#{utility(:sudo)} -n -H -u #{sudo_user} " if sudo_user
+      end
+
+      def username_option
+        "--username=#{Shellwords.escape(username)}" if username
+      end
+
+      def connectivity_options
+        return "--host='#{socket}'" if socket
+
+        opts = []
+        opts << "--host='#{host}'" if host
+        opts << "--port='#{port}'" if port
+        opts.join(" ")
+      end
+
+      def user_options
+        Array(additional_options).join(" ")
+      end
+
+      def tables_to_dump
+        Array(only_tables).map do |table|
+          "--table='#{table}'"
+        end.join(" ")
+      end
+
+      def tables_to_skip
+        Array(skip_tables).map do |table|
+          "--exclude-table='#{table}'"
+        end.join(" ")
+      end
+
+      def dump_all?
+        name == :all
+      end
+    end
+  end
+end