rtbackup 0.1.21

data/lib/server_backups/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ServerBackups
+    class BackupCreationError < StandardError
+        attr_reader :backup_class, :backup_type
+        def initialize(msg, backup_class, backup_type)
+            @backup_class = backup_class
+            @backup_type = backup_type
+            super(msg)
+        end
+    end
+
+    class RestoreTarError < BackupCreationError; end
+end

data/lib/server_backups/mysql_backup.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module ServerBackups
+    class MysqlBackup < BackupBase
+        attr_reader :database_name
+
+        SYSTEM_DATABASES = %w[sys information_schema mysql performance_schema].freeze
+
+        def initialize(config_file, working_directory, backup_type, database_name)
+            @database_name = database_name
+            super(config_file, working_directory, backup_type)
+        end
+
+        def do_backup
+            if database_name == 'all'
+                backup_all_databases
+            else
+                super
+            end
+        end
+
+        def backup_all_databases
+            @database_name = 'mysql'
+            all_databases.each do |database|
+                self.class.send(backup_type,
+                                config.config_file,
+                                working_directory,
+                                database).do_backup
+            end
+        end
+
+        class << self
+            def daily(config_file, working_directory, database_name)
+                new(config_file, working_directory, :daily, database_name)
+            end
+
+            def weekly(config_file, working_directory, database_name)
+                new(config_file, working_directory, :weekly, database_name)
+            end
+
+            def monthly(config_file, working_directory, database_name)
+                new(config_file, working_directory, :monthly, database_name)
+            end
+
+            def incremental(config_file, working_directory, database_name)
+                MysqlIncrementalBackup.new(config_file, working_directory, database_name)
+            end
+        end
+
+        def create_archive_command
+            cmd = config.mysqldump_bin + ' --quick --single-transaction --create-options '
+            cmd += ' --flush-logs --master-data=2 --delete-master-logs ' if binary_logging?
+            cmd + cli_options + ' | gzip > ' + backup_path
+        end
+
+        def s3_prefix
+            File.join(config.prefix, self.class.name.demodulize.underscore,
+                      database_name, backup_type.to_s, '/')
+        end
+
+        def backup_filename
+            "mysql_backup.#{backup_type}.#{timestamp}.sql.gz"
+        end
+
+        def all_databases
+            execute_sql('show databases;').reject do |db_name|
+                db_name.in?(SYSTEM_DATABASES)
+            end
+        end
+
+        private
+
+        def binary_logging?
+            !config.bin_log.blank?
+        end
+
+        def cli_options
+            cmd = config.password.blank? ? '' : " -p'#{config.password}' "
+            cmd + " -u'#{config.user}' -h #{config.db_host} " + database_name
+        end
+
+        def execute_sql(sql)
+            cmd = "#{config.mysql_bin} --silent --skip-column-names -e \"#{sql}\" #{cli_options}"
+            logger.debug "Executing raw SQL against #{database_name}\n#{cmd}"
+            output = `#{cmd}`
+            logger.debug "Returned #{$CHILD_STATUS.inspect}. STDOUT was:\n#{output}"
+            output.split("\n") unless output.blank?
+        end
+    end
+end

data/lib/server_backups/mysql_incremental_backup.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ServerBackups
+    class MysqlIncrementalBackup < MysqlBackup
+        def initialize(config_file, working_directory, database_name)
+            database_name = 'mysql' if database_name == 'all'
+
+            super(config_file, working_directory, :incremental, database_name)
+        end
+
+        class BinlogFilename
+            attr_reader :path
+            def initialize(path)
+                @path = path
+            end
+
+            def log_index
+                /(\d{6})/.match(File.basename(path)).captures.first
+            end
+        end
+
+        def do_backup
+            load_resources
+            flush_logs
+            each_bin_log do |file|
+                index = BinlogFilename.new(file).log_index
+                next if index.in?(already_stored_log_indexes)
+                backup_single_bin_log(file)
+            end
+        end
+
+        def s3_prefix
+            File.join(config.prefix, 'mysql_backup', 'incremental', '/')
+        end
+
+        def flush_logs
+            execute_sql('flush logs;')
+        end
+
+        def each_bin_log
+            # execute 'flush logs'
+            logs = Dir.glob("#{config.bin_log}.[0-9]*").sort_by { |f| f[/\d+/].to_i }
+            logs_to_backup = logs[0..-2] # all logs except the last, which is in use
+            logs_to_backup.each do |log_file|
+                yield log_file
+            end
+        end
+
+        # def each_remote_bin_log
+        #     remote_bin_logs.each do |file|
+        #         yield(**parse_remote_binlog_filename(file))
+        #     end
+        # end
+
+        # def parse_remote_binlog_filename(file)
+        #     filename = File.basename(file.key)
+        #     prefix, index, timestamp = REMOTE_FILENAME_REGEX.match(filename).captures
+        #     {
+        #         key: file.key,
+        #         file: file,
+        #         prefix: prefix,
+        #         index: index,
+        #         timestamp: timestamp,
+        #         datetime: Time.zone.strptime(timestamp, TIMESTAMP_FORMAT)
+        #     }
+        # end
+
+        private
+
+        REMOTE_FILENAME_REGEX = /(.*)\.(\d+)\.(.{15})/
+        def already_stored_log_indexes
+            remote_bin_logs.map do |s3object|
+                _, index = REMOTE_FILENAME_REGEX.match(s3object.key).captures
+                index
+            end
+        end
+
+        def remote_bin_logs
+            s3.bucket.objects(prefix: s3_prefix)
+        end
+
+        def backup_single_bin_log(file)
+            logger.debug "Backing up #{file}."
+            dest_filename = File.basename(file) + '.' + timestamp
+            logger.info "Storing #{file} to #{dest_filename}"
+            s3.save file, File.join(s3_prefix, dest_filename)
+        end
+    end
+end

data/lib/server_backups/mysql_restore.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+module ServerBackups
+    class MysqlRestore < RestoreBase
+        ALL_DATABASES = 'all'
+
+        def initialize(config_file, working_dir, restore_point, database)
+            @database = database
+            super config_file, working_dir, restore_point
+        end
+
+        def full_backup_file
+            full_backup_prefix = File.join(config.prefix, 'mysql_backup', database)
+            s3.get_ordered_collection(full_backup_prefix).full_backup_for(restore_point)
+        end
+
+        def incremental_backups
+            incr_backup_prefix = File.join(config.prefix, 'mysql_backup')
+            s3.get_ordered_collection(incr_backup_prefix).incremental_backups_for(restore_point)
+        end
+
+        def restore_script_path
+            File.join(working_dir, "#{database}.sql")
+        end
+
+        ETC_TIMEZONE = '/etc/timezone'
+
+        def formatted_restore_point_in_system_time_zone
+            restore_point.in_time_zone(config.system_time_zone) \
+                         .strftime('%Y-%m-%d %H:%M:%S')
+        end
+
+        def do_restore
+            full_backup_file.get response_target: (restore_script_path + '.gz')
+            system "gunzip #{restore_script_path}.gz"
+
+            incremental_backups.each do |s3object|
+                file = Tempfile.new('foo')
+                begin
+                    s3object.get response_target: file
+                    file.close
+                    system config.mysqlbinlog_bin + ' ' + file.path + \
+                           " --stop-datetime='#{formatted_restore_point_in_system_time_zone}'" \
+                           " --database=#{database} >> " + restore_script_path
+                ensure
+                    file.close
+                    file.unlink # deletes the temp file
+                end
+            end
+
+            execute_script restore_script_path
+        end
+        # #{@config.bin_path}mysqlbinlog --database=#{@config.database} #{file}
+        class << self
+            def restore(config_file, working_dir, restore_point, database)
+                return new(config_file, working_dir, restore_point, database).do_restore \
+                    if database != ALL_DATABASES
+
+                all_databases(config_file, working_dir).each do |db_name|
+                    new(config_file, working_dir, restore_point, db_name).do_restore
+                end
+            end
+
+            def all_databases(config_file, working_dir)
+                MysqlBackup.new(config_file, working_dir, 'daily', 'mysql').all_databases
+            end
+        end
+
+        private
+
+        def cli_options
+            cmd = config.password.blank? ? '' : " -p'#{config.password}' "
+            cmd + " -u'#{config.user}' " + database
+        end
+
+        def execute_script(path)
+            cmd = "#{config.mysql_bin} --silent --skip-column-names #{cli_options}"
+            logger.debug "Executing raw SQL against #{ database}\n#{cmd}"
+            output = `#{cmd} < #{path}`
+            logger.debug "Returned #{$CHILD_STATUS.inspect}. STDOUT was:\n#{output}"
+            output.split("\n") unless output.blank?
+        end
+    end
+end

data/lib/server_backups/notifier.rb

@@ -0,0 +1,33 @@
+require 'slack-notifier'
+
+module ServerBackups
+    class Notifier
+        attr_reader :config
+
+        def initialize(config_path)
+            @config = Config.new(config_path)
+        end
+
+        def notify_success
+            return unless config.slack_webhook && config.notify_on_success
+
+            notifier = Slack::Notifier.new config.slack_webhook
+            message = "Backups at `#{config.prefix}` succeeded. "
+            message += config.slack_mention_on_success.map{|t| "<@#{t}>"}.to_sentence
+            notifier.post text: message, icon_emoji: ':100:'
+        end
+
+        def notify_failure(errors)
+            return unless config.slack_webhook
+
+            notifier = Slack::Notifier.new config.slack_webhook
+            message = "Backups at `#{config.prefix}` failed. "
+            message += config.slack_mention_on_failure.map{|t| "<@#{t}>"}.to_sentence
+            attachments = []
+            for error in errors do
+                attachments << {text: error.message + "\n" + error.backtrace.join("\n")}
+            end
+            notifier.post text: message, icon_emoji: ':bomb:', attachments: attachments
+        end
+    end
+end

data/lib/server_backups/ordered_backup_file_collection.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ServerBackups
+    class OrderedBackupFileCollection
+        attr_reader :s3_collection
+        def initialize(s3_collection)
+            @s3_collection = s3_collection
+        end
+
+        def full_backup_for(restore_point)
+            sorted(full_backups).reverse.find do |file|
+                get_timestamp_from_s3_object(file) <= restore_point
+            end
+        end
+
+        def incremental_backups_for(restore_point)
+            sorted eligible_incremental_backups(restore_point)
+        end
+
+        INCREMENTAL = /incremental/i
+        def full_backups
+            s3_collection.reject { |file| INCREMENTAL =~ file.key }
+        end
+
+        def incremental_backups
+            @incremental_backups ||=
+                sorted(s3_collection.select { |file| INCREMENTAL =~ file.key }).to_a
+        end
+
+        private
+
+        TIMESTAMP_REGEXP = /(\d{4})-(\d{2})-(\d{2})T(\d{2})00\.UTC([+-]\d{4})/
+        def get_timestamp_from_s3_object(file)
+            time_parts = TIMESTAMP_REGEXP.match(file.key).captures
+            time_parts[-1].insert(3, ':')
+            # Add in hours and seconds arguments
+            # https://ruby-doc.org/core-2.2.0/Time.html#method-c-new
+            time_parts.insert(4, 0, 0)
+            Time.new(*time_parts)
+        end
+
+        def sorted(coll)
+            coll.sort_by { |file| get_timestamp_from_s3_object file }
+        end
+
+        def eligible_incremental_backups(restore_point)
+            full_backup_timestamp = get_timestamp_from_s3_object full_backup_for(restore_point)
+            incremental_backups.select do |file|
+                get_timestamp_from_s3_object(file) > full_backup_timestamp &&
+                    get_timestamp_from_s3_object(file) <= restore_point
+            end
+        end
+    end
+end

data/lib/server_backups/restore_base.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ServerBackups
+    class RestoreBase
+        attr_reader :config, :s3, :working_dir, :restore_point, :database
+
+        def initialize(config_file, working_dir, restore_point)
+            @working_dir = working_dir
+            @config = Config.new(config_file)
+            Time.zone = config.time_zone
+            @restore_point = if restore_point.present?
+                                 restore_point
+                             else
+                                 Time.zone.now
+                             end
+            @s3 = S3.new(config)
+            logger.debug "Initialized #{title}."
+        end
+
+        private
+
+        def title
+            self.class.name.demodulize.titleize
+        end
+
+        TIMESTAMP_REGEXP = /(\d{4})-(\d{2})-(\d{2})T(\d{2})00\.UTC([+-]\d{4})/
+        def extract_backup_time_from_filename(filename)
+            time_parts = TIMESTAMP_REGEXP.match(filename).captures
+            # Add in hours and seconds arguments
+            # https://ruby-doc.org/core-2.2.0/Time.html#method-c-new
+            time_parts.insert(4, 0, 0)
+            Time.new(*time_parts)
+        end
+
+        def all_files
+            @all_files ||= s3.get_ordered_collection(s3_prefix)
+        end
+
+        def logger
+            config.logger
+        end
+
+        def last_command_succeeded?
+            $CHILD_STATUS.exitstatus.zero?
+        end
+    end
+end

data/lib/server_backups/s3.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+module ServerBackups
+    class S3
+        PROVIDER = 'AWS'
+        attr_reader :config, :logger
+        def initialize(config)
+            @config = config
+            @logger = config.logger
+        end
+
+        def client
+            @client ||= begin
+                Aws.config[:credentials] = Aws::Credentials.new(
+                    config.access_key_id, config.secret_access_key
+                )
+                Aws::S3::Client.new region: config.region
+            end
+        end
+
+        def bucket
+            @bucket ||= Aws::S3::Bucket.new(config.bucket, client: client)
+        end
+
+        def get_ordered_collection(prefix)
+            OrderedBackupFileCollection.new bucket.objects(prefix: prefix)
+        end
+
+        def delete_files_not_newer_than(key, age)
+            bucket.objects(prefix: key).each do |file|
+                destroy key, true unless file.last_modified.to_datetime > age
+            end
+        end
+
+        def exists?(path)
+            logger.debug "Exists? #{config.bucket}  #{path}"
+            !bucket.objects(prefix: path).to_a.empty?
+            # !!client.head_object(bucket: config.bucket, key: path)
+        end
+
+        def destroy(key, existence_known = false)
+            return unless existence_known || exists?(key)
+            client.delete_object bucket: config.bucket, key: key
+        end
+
+        def save(local_file_name, s3_key)
+            full_path = if s3_key[-1] == '/'
+                            File.join(s3_key, File.basename(local_file_name))
+                        else
+                            s3_key
+                        end
+
+            return if exists?(full_path)
+            file = Aws::S3::Object.new(config.bucket, full_path, client: client)
+            file.put(
+                acl: 'private',
+                body: File.open(local_file_name, 'rb'),
+                content_md5: md5of(local_file_name),
+                storage_class: 'STANDARD_IA'
+            )
+        end
+
+        private
+
+        def md5of(local_file_name)
+            Digest::MD5.base64digest(File.read(local_file_name))
+        end
+    end
+end