backup_minister 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af89f01465c72c52b25a8e609c50519a15fe6ab6
+  data.tar.gz: 62c62db31e310a4e6b22abdab8bfb69c2732f69f
+SHA512:
+  metadata.gz: 411b3d4bcb3c1a841d7440f5bc8d3904fc26b7da9afce45feee939116c4e9b5b51259a79d16a95e1df3a39b0225e0bce8437470b53d9b3cde5557ea6dcd65204
+  data.tar.gz: 1bd6a245ba4a09435506db87cf257251ebe873bdbd897a63136452d18114f480dc9219f10902f5fb11fcf0eed571928528bbe48436a7a71db7c2f841ec5d1185

data/bin/backup_minister

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'backup_minister'
+require 'thor'
+
+class CLI < Thor
+  desc 'backup_database', 'Move database TAR GZ archive to destination directory'
+  option :project_name, type: :string, required: true, aliases: :name
+  option :file, type: :string, required: true, banner: '</Path/to/database/backup.tar.gz>'
+  def backup_database
+    server = BackupMinister::Server.new
+    server.place_database_backup(options[:project_name], options[:file])
+  end
+
+  desc 'sync_path', 'Server\'s path for files'
+  option :project_name, type: :string, required: true, aliases: :name
+  def sync_path
+    server = BackupMinister::Server.new
+    path = server.project_files_location(options[:project_name])
+    if path.nil?
+      exit!(true)
+    else
+      puts path
+    end
+  end
+end
+
+CLI.start(ARGV)

data/lib/backup_minister/agent.rb

@@ -0,0 +1,198 @@
+require 'yaml'
+require 'rubygems/package'
+require 'tempfile'
+
+CONFIG_FILE_NAME = 'config.yml'
+DATABASE_DRIVERS = %i(docker)
+
+class BackupMinister::Agent < BackupMinister
+  @projects = nil
+  @config_file_name = nil
+
+  def initialize(file_name = nil)
+    super
+    load_projects(config)
+  end
+
+  # Get setting item value
+  #
+  # @param name [String] Settings name
+  #
+  # @return [Object, nil] return settings value if present
+  def setting(name)
+    if @config['settings'].nil?
+      LOGGER.error 'Settings are empty'
+    elsif @config['settings'][name].nil?
+      LOGGER.error "Setting #{name} is missing."
+    else
+      @config['settings'][name]
+    end
+  end
+
+  # Create TAR GZ archive with database backup
+  #
+  # @param project_name [String]
+  #
+  # @return [String, nil]
+  def backup_database(project_name)
+    base_name = project_name + '_' + Time.new.strftime('%Y%m%d_%H%M')
+    if project_config(name: project_name)['database']
+      backup_file = make_database_backup(project_config(name: project_name)['database'], base_name)
+      if backup_file.nil?
+        LOGGER.error "Can't create database backup for project #{project_name}."
+      else
+        archive_file_name = archive_and_remove_file("#{base_name}.tar.gz", backup_file)
+        if archive_file_name
+          LOGGER.debug "Database archive file #{archive_file_name} created."
+          return archive_file_name
+        end
+      end
+    else
+      LOGGER.error "No database config found for #{project_name}."
+    end
+
+    nil
+  end
+
+  # Check connection settings
+  #
+  # @return [Bool] is it possible to establish connection?
+  def check_server_requirements
+    result = false
+    host = system_config('server', 'host')
+    user = system_config('server', 'user')
+
+    if user and host
+      begin
+        connection = Net::SSH.start(host, user)
+        LOGGER.info "Connection with server #{user}@#{host} established."
+
+        remote_install = connection.exec!("gem list -i #{APP_NAME}")
+        if remote_install == 'true'
+          LOGGER.debug "#{APP_NAME} installed on remote server."
+          result = true
+        else
+          LOGGER.error "#{APP_NAME} is not installed on remote server: `#{remote_install.strip}`."
+        end
+      rescue Exception => error
+        LOGGER.error "Could not establish connection: #{error.message}"
+          result = false
+      ensure
+        connection.close if !connection.nil? and !connection.closed?
+      end
+    else
+      LOGGER.error 'Server user or host (or both of them) are not defined.'
+    end
+
+    result
+  end
+
+  # Load projects list if exists
+  def load_projects(config)
+    if config['projects'].nil? or config['projects'].empty?
+      LOGGER.warn 'No projects found. Nothing to do.'
+    else
+      @projects = config['projects'].keys
+      LOGGER.info "Found projects: #{@projects.join(', ')}."
+    end
+  end
+
+  # Generate database SQL backup file
+  #
+  # @param database_config [Hash] connection database settings
+  # @param base_name [String] name for backup
+  #
+  # @return [File, nil] path to SQL file
+  def make_database_backup(database_config, base_name, container_name = nil)
+    raise ArgumentError, "Driver #{database_config['driver']} not supported." unless DATABASE_DRIVERS.include?(database_config['driver'])
+
+    container_name = setting('database_container')
+    if container_name
+      backup_file_name = base_name + '.sql'
+      command = "docker exec -i #{container_name} pg_dump #{database_config['name']}"
+      command += " -U#{database_config['user']}" if database_config['user']
+      command += " > #{backup_file_name}"
+      if execute(command)
+        if File.exist?(backup_file_name)
+          LOGGER.debug "Database backup file #{backup_file_name} created."
+          file = File.open(backup_file_name, 'r')
+          database_file_valid?(file) ? file : nil
+        else
+          LOGGER.error "Can't create database backup file `#{backup_file_name}`."
+        end
+      end
+    else
+      LOGGER.error 'Database container name is missing. Can\'t backup.'
+    end
+  end
+
+  # Check basic content of SQL backup file
+  #
+  # @param file [File]
+  #
+  # @return [Bool]
+  def database_file_valid?(file)
+    if file.size
+      LOGGER.debug "File #{file.path} is #{file.size} bytes."
+      content = file.read
+      if Regexp.new('(.)+(PostgreSQL database dump)(.)+(PostgreSQL database dump complete)(.)+', Regexp::MULTILINE).match(content).to_a.count >= 4
+        LOGGER.debug "File #{file.path} looks like DB dump."
+        result = true
+      else
+        LOGGER.warn "File #{file.path} doesn't looks like DB dump."
+        result = false
+      end
+    else
+      LOGGER.warn "File #{file.path} has 0 length or doesn't exists."
+      result = false
+    end
+
+    result
+  end
+
+  # Create TAR GZ single file archive
+  #
+  # @param file_name [String] file name for new archive (including extension)
+  # @param file [String, nil] target file name to archive
+  def archive_file(file_name, file)
+    target = Tempfile.new(file.path)
+    Gem::Package::TarWriter.new(target) do |tar|
+      file = File.open(file.path, 'r')
+      tar.add_file(file.path, file.stat.mode) do |io|
+        io.write(file.read)
+      end
+      file.close
+    end
+    target.close
+
+    final_file_name = "#{File.expand_path(File.dirname(file.path))}/#{file_name}"
+    Zlib::GzipWriter.open(final_file_name) do |gz|
+      gz.mtime = File.mtime(target.path)
+      gz.orig_name = final_file_name
+      gz.write IO.binread(target.path)
+    end
+
+    if File.exist?(file_name)
+      file_name
+    else
+      nil
+    end
+  ensure
+    target.close if target and !target.closed?
+    nil
+  end
+
+  # Create TAR GZ archive and delete original file
+  # @see #archive_file for arguments description
+  def archive_and_remove_file(file_name, file)
+    archive_name = archive_file(file_name, file)
+    begin
+      File.delete(file)
+      # LOGGER.log "File #{file.path} was deleted."
+      archive_name
+    rescue StandardError => error
+      LOGGER.warn "Can't delete file #{file.path} with error: #{error}."
+      nil
+    end
+  end
+end

data/lib/backup_minister/core/string.rb

@@ -0,0 +1,10 @@
+class String
+  def underscore
+    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+      gsub(/([a-z\d])([A-Z])/, '\1_\2').
+      tr('-', '_').
+      gsub(/\s/, '_').
+      gsub(/__+/, '_').
+      downcase
+  end
+end

data/lib/backup_minister/server.rb

@@ -0,0 +1,105 @@
+class BackupMinister::Server < BackupMinister
+
+  # Is it possible to wright to target backups location?
+  #
+  # @return [Bool]
+  def location_accessible?
+    result = false
+
+    location = system_config('server', 'location')
+    if location.nil?
+      LOGGER.error 'Location path is not set.'
+    else
+      if File.directory?(location)
+        LOGGER.debug "Directory `#{location}` exists."
+        result = true
+      else
+        LOGGER.debug "Directory `#{location}` doesn't exists. Will try to create it."
+        result = create_nested_directory(location)
+      end
+    end
+
+    result
+  end
+
+  # @param project_name [String]
+  # @param backup_file_path [String]
+  # @param project_config [Hash]
+  def place_database_backup(project_name, backup_file_path, project_config = {})
+    return false unless location_accessible?
+
+    result = false
+    project_location = project_location(project_name, project_config)
+    result = place_file(backup_file_path, "#{project_location}/database") if project_location
+
+    result
+  end
+
+  # Place file to directory
+  #
+  # @param file [String]
+  # @param location [String]
+  def place_file(file, location)
+    result = false
+
+    if File.exist?(file)
+      if File.directory?(location) or create_nested_directory(location)
+        begin
+          FileUtils.move file, location
+          LOGGER.debug "File #{file} moved to #{location}."
+          result = true
+        rescue Error => error
+          LOGGER.warn "Can't move file with error: #{error.message}."
+        end
+      end
+    else
+      LOGGER.warn "No such file #{file}."
+    end
+
+    result
+  end
+
+
+  # Path to root project's directory
+  #
+  # @param project_name [String]
+  # @param project_config [Hash]
+  #
+  # @return [String, nil]
+  def project_location(project_name, project_config = {})
+    result = nil
+
+    project_dir = project_config['remote_project_location'] || project_name.underscore
+    project_dir = /[^\/]([a-zA-Z0-9\-_])+([\/])?\z/.match(project_dir).to_a.first
+    if project_dir
+      project_full_path = system_config('server', 'location') + '/' + project_dir
+      if File.directory?(project_full_path) or create_nested_directory(project_full_path)
+        LOGGER.debug "Project location is #{project_full_path}."
+        result = project_full_path
+      end
+    else
+      LOGGER.error "Could not get project location for #{project_name}."
+    end
+
+    result
+  end
+
+  # Path to project directory for files
+  #
+  # @param project_name [String]
+  # @param project_config [Hash]
+  #
+  # @return [String, nil]
+  def project_files_location(project_name, project_config = {})
+    result = nil
+
+    project_dir = project_location(project_name, project_config)
+    if project_dir
+      files_path = '/files'
+      full_files_path = project_dir + files_path
+      result = full_files_path if File.directory?(full_files_path) or create_nested_directory(full_files_path)
+    end
+
+    result
+  end
+end

data/lib/backup_minister.rb

@@ -0,0 +1,107 @@
+require 'net/ssh'
+require 'open3'
+require 'logger'
+require 'fileutils'
+
+LOGGER = Logger.new(STDOUT)
+APP_NAME = 'backup_minister'
+
+class BackupMinister
+  @projects = nil
+  @config_file_name = nil
+
+  def initialize(file_name = nil)
+    @config_file_name = file_name || CONFIG_FILE_NAME
+    @config = check_config_file_exists
+  end
+
+  def system_config(*path)
+    path.unshift 'settings'
+    @config.dig(*path)
+  end
+
+  # Get project configuration
+  #
+  # @param name: [Symbol] Project name
+  # @param index: [Integer] Project index
+  #
+  # @return [Hash]
+  def project_config(name: nil, index: nil)
+    raise ArgumentError, 'At least one of arguments required' if name.nil? and index.nil?
+    project_name = name.nil? ? @projects[index] : name.to_s
+
+    if project_name and @config['projects'][project_name]
+      @config['projects'][project_name]
+    else
+      raise ArgumentError, "No project #{name ? name : index} found."
+    end
+  end
+
+  # Check if backup_minister is installed
+  #
+  # @return [Bool]
+  def backup_minister_installed?
+    software_installed?(APP_NAME)
+  end
+
+  # Check if software is installed
+  #
+  # @return [Bool]
+  def software_installed?(name)
+    result = execute_with_result('type', name)
+    result and /\A(#{name})(.)+(#{name})$/.match(result).to_a.count >= 3
+  end
+
+  # Wrapper for `system` with check
+  #
+  # @return [Bool] true if exit status is 0
+  def execute(command)
+    system command
+    code = $?.exitstatus
+    if code > 0
+      LOGGER.warn "Failed to execute command `#{command}` with code #{code}."
+      false
+    else
+      true
+    end
+  end
+
+  # @return [Bool]
+  def create_nested_directory(path)
+    result = false
+
+    begin
+      FileUtils::mkdir_p(path)
+      LOGGER.debug "Directory `#{path}` created."
+      result = true
+    rescue Error => error
+      LOGGER.error "Can't create directory `#{path}` with error #{error.message}."
+    end
+
+    result
+  end
+
+  def execute_with_result(command, arguments = [])
+    out, st = Open3.capture2(command, arguments)
+    LOGGER.warn "Failed to execute command `#{command}` with code #{st.exitstatus}." unless st.success?
+    out
+  end
+
+  private
+
+  attr_accessor :config
+
+  def check_config_file_exists
+    if File.exists?(@config_file_name)
+      YAML.load File.read(@config_file_name)
+    else
+      raise RuntimeError, "No config file #{@config_file_name} found"
+    end
+  end
+end
+
+require 'backup_minister/agent'
+require 'backup_minister/server'
+
+# Extensions
+require 'backup_minister/core/string'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: backup_minister
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ilya Krigouzov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: Provide tools for multi-server backups with docker support
+email: webmaster@oniksfly.com
+executables:
+- backup_minister
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/backup_minister
+- lib/backup_minister.rb
+- lib/backup_minister/agent.rb
+- lib/backup_minister/core/string.rb
+- lib/backup_minister/server.rb
+homepage: https://github.com/oniksfly/backup-minister
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Backup Minister
+test_files: []